PC Oscilloscopes Programmer's Guide - Pico … application will communicate with a PicoScope 4000 API driver called ps4000.dll, which is supplied in 32-bit and 64-bit versions. The

Copyright © 2008–2016 Pico Technology Ltd. All rights reserved.

Programmer's Guide

ps4000pg.en r9

PC Oscilloscopes

PicoScope® 4000 Series

IPicoScope 4000 Series Programmer's Guide

Copyright © 2008–2016 Pico Technology Ltd. All rights reserved. ps4000pg.en r9

Contents1 Introduction ................................................................................................................................ 1

1 Welcome ........................................................................................................................................... 1

2 Software license conditions ................................................................................................................. 1

3 Trademarks ........................................................................................................................................ 2

4 System requirements .......................................................................................................................... 2

2 Programming with the PicoScope 4000 Series ........................................................................... 3

1 Driver ................................................................................................................................................ 3

2 Voltage ranges .................................................................................................................................... 4

3 Channel selection ................................................................................................................................ 5

4 Triggering ........................................................................................................................................... 5

5 Oversampling ..................................................................................................................................... 6

6 Timebases .......................................................................................................................................... 7

3 Sampling modes .......................................................................................................................... 8

1 Block mode ........................................................................................................................................ 8

1 Using block mode ................................................................................................................... 9

2 Rapid block mode ............................................................................................................................. 10

1 Using rapid block mode ......................................................................................................... 10

2 Rapid block mode example 1: no aggregation ......................................................................... 11

3 Rapid block mode example 2: using aggregation ..................................................................... 13

3 ETS (Equivalent Time Sampling) ........................................................................................................ 14

1 Using ETS mode .................................................................................................................... 15

4 Streaming mode ............................................................................................................................... 15

1 Using streaming mode ........................................................................................................... 16

5 Retrieving stored data ....................................................................................................................... 17

4 Combining several oscilloscopes ............................................................................................... 18

5 API functions ............................................................................................................................ 19

1 ps4000BlockReady ........................................................................................................................... 21

2 ps4000CloseUnit .............................................................................................................................. 22

3 ps4000DataReady ............................................................................................................................. 23

4 ps4000EnumerateUnits ..................................................................................................................... 24

5 ps4000FlashLed ................................................................................................................................ 25

6 ps4000GetChannelInformation ......................................................................................................... 26

7 ps4000GetMaxDownSampleRatio ..................................................................................................... 27

8 ps4000GetNoOfCaptures ................................................................................................................. 28

9 ps4000GetStreamingLatestValues ..................................................................................................... 29

10 ps4000GetTimebase ....................................................................................................................... 30

11 ps4000GetTimebase2 ..................................................................................................................... 31

12 ps4000GetTriggerChannelTimeOffset .............................................................................................. 32

13 ps4000GetTriggerChannelTimeOffset64 .......................................................................................... 34

14 ps4000GetTriggerTimeOffset .......................................................................................................... 35

15 ps4000GetTriggerTimeOffset64 ...................................................................................................... 37

ContentsII

Copyright © 2008–2016 Pico Technology Ltd. All rights reserved.ps4000pg.en r9

16 ps4000GetUnitInfo ......................................................................................................................... 38

17 ps4000GetValues ............................................................................................................................ 39

18 ps4000GetValuesAsync ................................................................................................................... 41

19 ps4000GetValuesBulk ..................................................................................................................... 42

20 ps4000GetValuesTriggerChannelTimeOffsetBulk ............................................................................. 43

21 ps4000GetValuesTriggerChannelTimeOffsetBulk64 ......................................................................... 44

22 ps4000GetValuesTriggerTimeOffsetBulk ......................................................................................... 45

23 ps4000GetValuesTriggerTimeOffsetBulk64 ..................................................................................... 47

24 ps4000HoldOff ............................................................................................................................... 48

25 ps4000IsLedFlashing ....................................................................................................................... 49

26 ps4000IsReady ................................................................................................................................ 50

27 ps4000IsTriggerOrPulseWidthQualifierEnabled ............................................................................... 51

28 ps4000MemorySegments ................................................................................................................ 52

29 ps4000NoOfStreamingValues .......................................................................................................... 53

30 ps4000OpenUnit ............................................................................................................................ 54

31 ps4000OpenUnitAsync ................................................................................................................... 55

32 ps4000OpenUnitAsyncEx ................................................................................................................ 56

33 ps4000OpenUnitEx ........................................................................................................................ 57

34 ps4000OpenUnitProgress ............................................................................................................... 58

35 ps4000PingUnit .............................................................................................................................. 59

36 ps4000RunBlock ............................................................................................................................. 60

37 ps4000RunStreaming ...................................................................................................................... 62

38 ps4000RunStreamingEx .................................................................................................................. 64

39 ps4000SetBwFilter .......................................................................................................................... 66

40 ps4000SetChannel .......................................................................................................................... 67

41 ps4000SetDataBuffer ...................................................................................................................... 69

42 ps4000SetDataBufferBulk ............................................................................................................... 70

43 ps4000SetDataBuffers ..................................................................................................................... 71

44 ps4000SetDataBuffersWithMode .................................................................................................... 72

45 ps4000SetDataBufferWithMode ...................................................................................................... 73

46 ps4000SetEts .................................................................................................................................. 74

47 ps4000SetEtsTimeBuffer ................................................................................................................. 75

48 ps4000SetEtsTimeBuffers ................................................................................................................ 76

49 ps4000SetExtTriggerRange ............................................................................................................. 77

50 ps4000SetNoOfCaptures ................................................................................................................ 78

51 ps4000SetPulseWidthQualifier ........................................................................................................ 79

1 PWQ_CONDITIONS structure ............................................................................................. 80

52 ps4000SetSigGenArbitrary .............................................................................................................. 81

1 AWG index modes ............................................................................................................... 84

2 Calculating deltaPhase ........................................................................................................... 84

53 ps4000SetSigGenBuiltIn .................................................................................................................. 86

54 ps4000SetSimpleTrigger ................................................................................................................. 88

55 ps4000SetTriggerChannelConditions ............................................................................................... 89

1 TRIGGER_CONDITIONS structure ....................................................................................... 90

56 ps4000SetTriggerChannelDirections ................................................................................................ 91

IIIPicoScope 4000 Series Programmer's Guide


57 ps4000SetTriggerChannelProperties ................................................................................................ 92

1 TRIGGER_CHANNEL_PROPERTIES structure ...................................................................... 93

58 ps4000SetTriggerDelay ................................................................................................................... 94

59 ps4000SigGenArbitraryMinMaxValues ............................................................................................. 95

60 ps4000SigGenFrequencyToPhase ..................................................................................................... 96

61 ps4000SigGenSoftwareControl ........................................................................................................ 97

62 ps4000Stop .................................................................................................................................... 98

63 ps4000StreamingReady ................................................................................................................... 99

64 Wrapper functions ........................................................................................................................ 100

6 Further information ................................................................................................................ 102

1 Programming examples ................................................................................................................... 102

2 Driver status codes ......................................................................................................................... 102

3 Enumerated types and constants ...................................................................................................... 102

4 Numeric data types ......................................................................................................................... 102

7 Glossary ................................................................................................................................. 103

Index ......................................................................................................................................... 105

PicoScope 4000 Series Programmer's Guide 1


1 Introduction1.1 Welcome

The PicoScope 4000 Series of PC Oscilloscopesfrom Pico Technology is a range of compact,high-resolution scope units designed to replacetraditional bench-top oscilloscopes.

This manual explains how to use the ApplicationProgramming Interface (API) for the PicoScope4000 Series scopes. The API supports thefollowing models:

PicoScope 4224 and 4424 12-bit oscilloscopeswith optional IEPE interfacePicoScope 4262 16-bit high-resolution oscilloscopePicoScope 4226 and 4227 oscilloscopes (discontinued)

For more information on the hardware, see the PicoScope 4000 Series User's Guide,available as a separate manual.

1.2 Software license conditionsThe material contained in this release is licensed, not sold. Pico Technology Limitedgrants a license to the person who installs this software, subject to the conditionslisted below.

Access. The licensee agrees to allow access to this software only to persons who havebeen informed of these conditions and agree to abide by them.

Usage. The software in this release is for use only with Pico Technology products orwith data collected using Pico Technology products.

Copyright. Pico Technology Ltd. claims the copyright of, and retains the rights to, allmaterial (software, documents, etc.) contained in this software development kit (SDK)except the example programs. You may copy and distribute the SDK withoutrestriction, as long as you do not remove any Pico Technology copyright statements.The example programs in the SDK may be modified, copied and distributed for thepurpose of developing programs to collect data using Pico Technology products.

Liability. Pico Technology and its agents shall not be liable for any loss, damage orinjury, howsoever caused, related to the use of Pico Technology equipment orsoftware, unless excluded by statute.

Fitness for purpose. As no two applications are the same, Pico Technology cannotguarantee that its equipment or software is suitable for a given application. It is yourresponsibility, therefore, to ensure that the product is suitable for your application.

Mission-critical applications. This software is intended for use on a computer thatmay be running other software products. For this reason, one of the conditions of thelicense is that it excludes use in mission-critical applications, for example life supportsystems.

Viruses. This software was continuously monitored for viruses during production, butyou are responsible for virus-checking the software once it is installed.

Introduction2


Support. If you are dissatisfied with the performance of this software, please contactour technical support staff, who will try to fix the problem within a reasonable time. Ifyou are still dissatisfied, please return the product and software to your supplier within14 days of purchase for a full refund.

Upgrades. We provide upgrades, free of charge, from our web site atwww.picotech.com. We reserve the right to charge for updates or replacements sentout on physical media.

1.3 TrademarksPico Technology and PicoScope are trademarks of Pico Technology Limited,registered in the United Kingdom and other countries.

PicoScope and Pico Technology are registered in the U.S. Patent and TrademarkOffice.

Windows, Excel and Visual Basic for Applications are registered trademarks ortrademarks of Microsoft Corporation in the USA and other countries. LabVIEW is aregistered trademark of National Instruments Corporation. MATLAB is a registeredtrademark of The MathWorks, Inc.

1.4 System requirementsUsing with PicoScope for Windows

To ensure that your PicoScope 4000 Series PC Oscilloscope operates correctly with thePicoScope software, you must have a computer with at least the minimum systemrequirements to run one of the supported operating systems, as shown in the followingtable. The performance of the oscilloscope will be better with a more powerful PC.Please note the PicoScope software is not installed as part of the SDK.

Item Specification

Operating systemWindows 7, Windows 8 or Windows 1032 bit and 64 bit versions supported

Processor

As required by the operating systemMemory

Free disk space

PortsUSB 3.0 compliant portUSB 2.0 compliant port

USB 1.1 compliant port (not recommended)

Using with custom applications

Drivers are available for the operating systems mentioned above.



2 Programming with the PicoScope 4000 SeriesThe ps4000.dll dynamic link library in the lib subdirectory of the Pico Technology

SDK installation directory allows you to program a PicoScope 4000 Series oscilloscopeusing standard C function calls.

A typical program for capturing data consists of the following steps:

Open the scope unit.Set up the input channels with the required voltage ranges and coupling mode.Set up triggering.Start capturing data. (See Sampling modes, where programming is discussed inmore detail).Wait until the scope unit is ready.Copy data to a buffer.Stop capturing data.Close the scope unit.

Numerous sample programs are installed with the SDK. These show how to use thefunctions of the driver software in each of the modes available.

2.1 DriverYour application will communicate with a PicoScope 4000 API driver called ps4000.dll, which is supplied in 32-bit and 64-bit versions. The driver exports the

ps4000 function definitions in standard C format, but this does not limit you toprogramming in C. You can use the API with any programming language that supportsstandard C calls.

The API driver depends on a low-level driver called WinUsb.sys. This and another

DLL, picoipp.dll (supplied in 32-bit and 64-bit versions), are installed by the SDK

and configured when you plug the oscilloscope into each USB port for the first time.Your application does not call these drivers directly.

Programming with the PicoScope 4000 Series4


2.2 Voltage rangesThe ps4000SetChannel function allows you to set the voltage range of each input

channel of the scope. Each device in the PicoScope 4000 Series has its own set ofvoltage ranges described in its data sheet. Each sample is normalized to 16 bitsresulting in values returned to your application as follows:

Constant VoltageValue returned

decimal hex

PS4000_MIN_VALUEorPS4262_MIN_VALUE

minimum–32 764

–32 767

8004

8001

N/A zero 0 0000

PS4000_MAX_VALUEorPS4262_MAX_VALUE

maximum32 764

32 767

7FFC

7FFF

PS4000_LOST_DATA Note 1 -32 768 8000

1. In streaming mode, this special value indicates a buffer overrun.

Example, using the PicoScope 4262

1. Call ps4000SetChannelwith range set to

PS4000_1V.

2. Apply a sine wave inputof 500 mV amplitude tothe oscilloscope.

3. Capture some data usingthe desired samplingmode.

4. The data will be encodedas shown opposite.

External trigger input

The PicoScope 4226, 4227 and 4262 models have an external trigger input (markedEXT). The external trigger input is scaled to a 16-bit value as follows. Note that thePicoScope 4262 has two external trigger input voltage ranges.

PicoScope 4262

Voltage Constant Digital value

−500 mV PS4000_EXT_MIN_VALUE –32 767

0 V 0

+500 mV PS4000_EXT_MAX_VALUE +32 767


−5 V PS4000_EXT_MIN_VALUE –32 767

0 V 0

+5 V PS4000_EXT_MAX_VALUE +32 767



PicoScope 4226 and 4227


−20 V PS4000_EXT_MIN_VALUE –32 767

0 V 0

+20 V PS4000_EXT_MAX_VALUE +32 767

2.3 Channel selectionYou can switch each channel on and off, and set its coupling mode to either AC or DC,using the ps4000SetChannel function.

DC coupling: The scope accepts all input frequencies from zero (DC) up to itsmaximum analog bandwidth.

AC coupling: The scope accepts input frequencies from a few hertz up to itsmaximum analog bandwidth. The lower -3 dB cutoff frequency isabout 1 hertz.

2.4 TriggeringPicoScope 4000 Series PC Oscilloscopes can either start collecting data immediately, orbe programmed to wait for a trigger event to occur. In both cases you need to use thetrigger function ps4000SetSimpleTrigger, which in turn calls:

ps4000SetTriggerChannelConditionsps4000SetTriggerChannelDirectionsps4000SetTriggerChannelProperties

These can also be called individually, rather than using ps4000SetSimpleTrigger,in order to set up advanced trigger types such as pulse width.

A trigger event can occur when one of the signal or trigger input channels crosses athreshold voltage on either a rising or a falling edge. It is also possible to combine upto four inputs using the logic trigger function.

The driver supports these triggering methods:

Simple EdgeAdvanced EdgeWindowingPulse widthLogicDelayDrop-outRunt

The pulse width, delay and drop-out triggering methods additionally require the use ofthe pulse width qualifier function, ps4000SetPulseWidthQualifier.

Programming with the PicoScope 4000 Series6


2.5 OversamplingWhen the oscilloscope is operating at sampling rates less than its maximum, it ispossible to oversample. Oversampling is taking more than one measurement duringa time interval and returning the average as one sample. The number ofmeasurements per sample is called the oversampling factor. If the signal contains asmall amount of Gaussian noise, this technique can increase the effective verticalresolution of the oscilloscope by n bits, where n is given approximately by theequation below:

n = log (oversampling factor) / log 4

Conversely, for an improvement in resolution of n bits, the oversampling factor youneed is given approximately by:

oversampling factor = 4n

Applicability Available in block mode only.

Cannot be used at the same time as aggregation.



2.6 Timebases

The API allows you to select one of 230 different timebases related to the maximumsampling rate of the oscilloscope. The timebases allow slow enough sampling in blockmode to overlap the streaming mode sampling intervals, so that you can make asmooth transition between block mode and streaming mode.

For all PicoScope 4000 Series scopes except the PicoScope 4262, the range oftimebase values is divided into "low" and "high" subranges, with the low subrangespecifying a power of 2 and the high subrange specifying a fraction of the clockfrequency. The PicoScope 4262 has a single range of timebases specifying a fraction ofthe clock frequency.

Timebase(n)

Sampling interval (t)

PicoScope 4223PicoScope 4224PicoScope 4423PicoScope 4424

PicoScope 4226PicoScope 4227

PicoScope 4262

Low

2n / 80,000,000

n=0: 12.5 nsn=1: 25 nsn=2: 50 ns

2n / 250,000,000

n=0*: 4 nsn=1: 8 nsn=2: 16 nsn=3: 32 ns

(n+1) / 10,000,000

n=0: 100 nsn=1: 200 nsn=2: 300 ns

...

n=230-1:~107 sHigh

(n-1) / 20,000,000

n=3: 100 nsn=4: 150 nsn=5: 200 ns

...

n=230-1: ~54 s

(n-2) / 31,250,000

n=4: 64 nsn=5: 96 nsn=6: 128 ns

...

n=230-1: ~34 s

* PicoScope 4227 only

Note: The fastest available sampling rate may depend on which channels are enabledand on the sampling mode. Please refer to the oscilloscope data sheet for samplingrate specifications. In streaming mode, the speed of the USB port may affect the rateof data transfer.

Applicability Use ps4000GetTimebase API call.

Sampling modes8


3 Sampling modesPicoScope 4000 Series PC Oscilloscopes can run in various sampling modes.

Block mode. In this mode, the scope stores data in its buffer memory and thentransfers it to the PC. When the data has been collected it is possible to examinethe data, with an optional aggregation factor. The data is lost when a new run isstarted in the same segment, the settings are changed, or the scope is powereddown.

Rapid block mode. This is a variant of block mode that allows you to capture morethan one waveform at a time with a minimum of delay between captures. You canuse aggregation in this mode if you wish.

Streaming mode. In this mode, data is passed directly to the PC without beingstored in the scope's buffer memory. This enables long periods of slow datacollection for chart recorder and data-logging applications. Streaming modeprovides fast streaming at up to 6.6 MS/s (150 ns per sample). Aggregation andtriggering are supported in this mode.

In all sampling modes, the driver returns data asynchronously using a callback. This isa call to one of the functions in your own application. When you request data from thescope, you pass to the driver a pointer to your callback function. When the driver haswritten the data to your buffer, it makes a callback (calls your function) to signal thatthe data is ready. The callback function then signals to the application that the data isavailable.

Because the callback is called asynchronously from the rest of your application, in aseparate thread, you must ensure that it does not corrupt any global variables while itruns.

In block mode and rapid block mode, you can also poll the driver instead of using acallback.

3.1 Block modeIn block mode, the computer prompts a PicoScope 4000 Series PC Oscilloscope tocollect a block of data into its internal memory. When the oscilloscope has collectedthe whole block, it signals that it is ready and then transfers the whole block to thecomputer's memory through the USB port.

Block size. The maximum number of values depends upon the size of theoscilloscope's memory. The memory buffer is shared between the enabled channels,so if two channels are enabled, each receives half the memory. These features arehandled transparently by the driver. The block size also depends on the number ofmemory segments in use (see ps4000MemorySegments).

Sampling rate. The PicoScope 4000 Series PC Oscilloscopes can sample at anumber of different rates according to their model, selected timebase and thecombination of channels that are enabled. The maximum sampling rate can beachieved with a single channel enabled, or with these two-channel combinations:AC, AD, BC and BD. All other combinations limit the maximum sampling rate ofscope, as specified in its Data Sheet.



Setup time. The driver normally performs a number of setup operations, which cantake up to 50 milliseconds, before collecting each block of data. If you need tocollect data with the minimum time interval between blocks, use rapid block modeand avoid calling setup functions between calls to ps4000RunBlock, ps4000Stopand ps4000GetValues.

Aggregation. When the data has been collected, you can set an optionalaggregation factor and examine the data. Aggregation is a process that reduces theamount of data by combining adjacent samples using a maximum/minimumalgorithm. It is useful for zooming in and out of the data without having torepeatedly transfer the entire contents of the scope's buffer to the PC.

Memory segmentation. The scope's internal memory can be divided intosegments so that you can capture several waveforms in succession. Configure thisusing ps4000MemorySegments.

Data retention. The data is lost when a new run is started in the same segment orthe scope is powered down.

See Using block mode for programming details.

3.1.1 Using block mode

This is the general procedure for reading and displaying data in block mode using asingle memory segment:

1. Open the oscilloscope using ps4000OpenUnit.

2. Select channel ranges and AC/DC coupling using ps4000SetChannel.

3. Using ps4000GetTimebase, select timebases until the required nanoseconds

per sample is located.4. Use the trigger setup functions ps4000SetTriggerChannelConditions,

ps4000SetTriggerChannelDirections and

ps4000SetTriggerChannelProperties to set up the trigger if required.

5. Start the oscilloscope running using ps4000RunBlock.

6. Wait until the oscilloscope is ready using the ps4000BlockReady callback.

7. Use ps4000SetDataBuffer to tell the driver where your memory buffer is. For

greater efficiency with multiple captures, you can call this function outside theloop, after step 4.

8. Transfer the block of data from the oscilloscope using ps4000GetValues.

9. Display the data.10. Repeat steps 5 to 9.11. Stop the oscilloscope using ps4000Stop.

Sampling modes10


12. Request new views of stored data using different aggregation parameters: seeRetrieving stored data.

13. Close the device using ps4000CloseUnit.

3.2 Rapid block modeIn normal block mode, the PicoScope 4000 Series scopes collect one waveform at atime. You start the device running, wait until all samples are collected by the device,and then download the data to the PC or start another run. There is a time overhead oftens of milliseconds associated with starting a run, causing a gap between waveforms.When you collect data from the device, there is another minimum time overheadwhich is most noticeable when using a small number of samples.

Rapid block mode allows you to sample several waveforms at a time with theminimum time between waveforms. It reduces the gap from milliseconds to about 2.5microseconds, at the fastest timebase. See Using rapid block mode for details.

3.2.1 Using rapid block mode

You can use rapid block mode with or without aggregation. The following procedureshows you how to use it without aggregation.

Without aggregation



3. Set the number of memory segments equal to or greater than the number ofcaptures required using ps4000MemorySegments. Use

ps4000SetNoOfCaptures before each run to specify the number of waveforms

to capture.4. Using ps4000GetTimebase, select timebases until the required nanoseconds

per sample is located. This will indicate the number of samples per channelavailable for each segment. If you know that the number of samples you willcollect will not exceed the limit, you can call this function after step 5, unless youare using a pulse width qualifier.

5. Use the trigger setup functions ps4000SetTriggerChannelConditions,




7. Wait until the oscilloscope is ready using the ps4000BlockReady callback.



8. Use ps4000SetDataBufferBulk to tell the driver where your memory buffers

are. Call the function once for each channel/segment combination for which yourequire data. For greater efficiency of data retrieval or for multiple captures, youcan call this function outside the loop, after step 5.

9. Transfer the blocks of data from the oscilloscope using ps4000GetValuesBulk.

10. Retrieve the time offset for each data segment usingps4000GetValuesTriggerTimeOffsetBulk64.

11. Display the data.12. Repeat steps 6 to 11 if necessary.13. Stop the oscilloscope using ps4000Stop.

14. Close the device using ps4000CloseUnit.

With aggregation

To use rapid block mode with aggregation, follow steps 1 to 9 above and then proceedas follows:

10a. Call ps4000SetDataBuffers to set up one pair of buffers for every waveform

segment required.11a. Call ps4000GetValues for each pair of buffers.

12a. Retrieve the time offset for each data segment usingps4000GetTriggerTimeOffset64.

Continue from step 13 above.

3.2.2 Rapid block mode example 1: no aggregation#define MAX_WAVEFORMS 100#define MAX_SAMPLES 1000

Set up the device up as usual.

Open the deviceChannelsTriggerNumber of memory segments (this should be equal or more than the no of capturesrequired)

// Set the number of waveforms to MAX_WAVEFORMSps4000SetNoOfCaptures (handle, MAX_WAVEFORMS);

pParameter = false;ps4000RunBlock(

handle,0, //noOfPreTriggerSamples,10000, // noOfPostTriggerSamples,1, // timebase to be used,1, // oversample&timeIndisposedMs,0, // segmentIndexlpReady,&pParameter

);

Comment: these variables have been set as an example and can be any valid value.pParameter will be set true by your callback function lpReady.

Sampling modes12


while (!pParameter) Sleep (0);

for (int32_t i = 0; i < 10; i++){

for (int32_t c = PS4000_CHANNEL_A; c <= PS4000_CHANNEL_D; c++){

ps4000SetDataBufferBulk(

handle,c,buffer[c][i],MAX_SAMPLES,i

);}

}

Comments: buffer has been created as a two-dimensional array of pointers to int16_t, which will contain 1000 samples as defined by MAX_SAMPLES. There are

only 10 buffers set, but it is possible to set up to the number of captures you haverequested.

ps4000GetValuesBulk(

handle,&noOfSamples, // set to MAX_SAMPLES on entering the function10, // fromSegmentIndex,19, // toSegmentIndex,overflow // an array of size 10 int16_t

)

Comments: the number of samples could be up to noOfPreTriggerSamples +noOfPostTriggerSamples, the values set in ps4000RunBlock. The samples are

always returned from the first sample taken, unlike the ps4000GetValues function

which allows the sample index to be set. This function does not support aggregation.The above segments start at 10 and finish at 19 inclusive. It is possible for the fromSegmentIndex to wrap around to the toSegementIndex, by setting the

fromSegmentIndex to 98 and the toSegmentIndex to 7.

ps4000GetValuesTriggerTimeOffsetBulk64(

handle,times,timeUnits,10,19

)

Comments: the above segments start at 10 and finish at 19 inclusive. It is possible forthe fromSegmentIndex to wrap around to the toSegmentIndex, if the

fromSegmentIndex is set to 98 and the toSegmentIndex to 7.



3.2.3 Rapid block mode example 2: using aggregation#define MAX_WAVEFORMS 100#define MAX_SAMPLES 1000

Set up the device up as usual.

Open the deviceChannelsTriggerNumber of memory segments (this should be equal or more than the no of capturesrequired)

// Set the number of waveforms to MAX_WAVEFORMSps4000SetNoOfCaptures (handle, MAX_WAVEFORMS);

pParameter = false;ps4000RunBlock(

handle,0, //noOfPreTriggerSamples,1000000, // noOfPostTriggerSamples,1, // timebase to be used,1, // oversample&timeIndisposedMs,0, //segmentIndexlpReady,&pParameter

);

Comments: the set-up for running the device is exactly the same whether or notaggregation will be used when you retrieve the samples.

for (int32_t c = PS4000_CHANNEL_A; c <= PS4000_CHANNEL_D; c++){

ps4000SetDataBuffers(

handle,c,bufferMax[c],bufferMin[c]MAX_SAMPLES,

);}

Comments: since only one waveform will be retrieved at a time, you only need to setup one pair of buffers; one for the maximum samples and one for the minimumsamples. Again, the buffer sizes are 1000 samples.

for (int32_t segment = 10; segment < 20; segment++){

ps4000GetValues(

handle,0,&noOfSamples, // set to MAX_SAMPLES on entering1000, downSampleRatioMode, //set to RATIO_MODE_AGGREGATEindex,overflow

Sampling modes14


);

ps4000GetTriggerTimeOffset64 (

handle,&time,&timeUnits,index

)}

Comments: each waveform is retrieved one at a time from the driver with anaggregation of 1000.

3.3 ETS (Equivalent Time Sampling)Note: only the PicoScope 4226 and 4227 oscilloscopes support ETS mode.

ETS is a way of increasing the effective sampling rate of the scope when capturingrepetitive signals. It is a modified form of block mode, and is controlled by theps4000SetTrigger and ps4000SetEts functions.

Overview. ETS works by capturing several cycles of a repetitive waveform, thencombining them to produce a composite waveform that has a higher effectivesampling rate than the individual captures. The maximum effective sampling ratesthat can be achieved with this method are listed in the User's Guide for the scopedevice.

Trigger stability. Because of the high sensitivity of ETS mode to small timedifferences, the trigger must be set up to provide a stable waveform that varies aslittle as possible from one capture to the next.

Callback. ETS mode returns data to your application using theps4000BlockReady callback function.

Applicability Available in block mode only.

Not suitable for one-shot (non-repetitive) signals.

Aggregation and oversampling are not supported.

Edge-triggering only.

Auto trigger delay (autoTriggerMilliseconds) is ignored.



3.3.1 Using ETS mode

This is the general procedure for reading and displaying data in ETS mode using asingle memory segment:



3. Use ps4000GetTimebase to verify the number of samples to be collected.

4. Set up ETS using ps4000SetEts.

5. Use the trigger setup functions ps4000SetTriggerChannelConditions,




7. Wait until the oscilloscope is ready using the ps4000BlockReady callback (or

poll using ps4000IsReady).

8. Use ps4000SetDataBuffer to tell the driver where to store sampled data.

8a. Use ps4000SetEtsTimeBuffer or ps4000SetEtsTimeBuffers to tell the

driver where to store sample times.9. Transfer the block of data from the oscilloscope using ps4000GetValues.

10. Display the data.11. While you want to collect updated captures, repeat steps 7 to 10.12. Stop the oscilloscope using ps4000Stop.

13. Repeat steps 6 to 12.14. Close the device driver using ps4000CloseUnit.

3.4 Streaming modeStreaming mode can capture data without the gaps that occur between blocks whenusing block mode. It can transfer data to the PC at speeds of up to 6.6 million samplesper second (150 nanoseconds per sample), depending on the computer's performance.This makes it suitable for high-speed data acquisition, allowing you to capture longdata sets limited only by the computer's memory.

Aggregation. The driver returns aggregated readings while the device isstreaming. If aggregation is set to 1 then only one buffer is returned per channel.When aggregation is set above 1 then two buffers (maximum and minimum) perchannel are returned.

Sampling modes16


Memory segmentation. The memory can be divided into segments to reduce thelatency of data transfers to the PC. However, this increases the risk of losing data ifthe PC cannot keep up with the device's sampling rate.

See Using streaming mode for programming details.

3.4.1 Using streaming mode

This is the general procedure for reading and displaying data in streaming mode usinga single memory segment:


2. Select channels, ranges and AC/DC coupling using ps4000SetChannel.

3. Use the trigger setup functions [1] [2] [3] to set up the trigger if required.4. Call ps4000SetDataBuffer to tell the driver where your data buffer is.

5. Set up aggregation and start the oscilloscope running usingps4000RunStreaming.

6. Call ps4000GetStreamingLatestValues to get data.

7. Process data returned to your application's function. This example is usingautoStop, so after the driver has received all the data points requested by the

application, it stops the device streaming.8. Call ps4000Stop, even if autoStop is enabled.

9. Request new views of stored data using different aggregation parameters: seeRetrieving stored data.

10. Close the oscilloscope using ps4000CloseUnit.



3.5 Retrieving stored dataYou can collect data from the PicoScope 4000 driver with a different aggregation factorwhen ps4000RunBlock or ps4000RunStreaming has already been called and has

successfully captured all the data. Use ps4000GetValuesAsync.

Combining several oscilloscopes18


4 Combining several oscilloscopesIt is possible to collect data using up to 64 PicoScope 4000 Series PC Oscilloscopes atthe same time, depending on the capabilities of the PC. Each oscilloscope must beconnected to a separate USB port. The ps4000OpenUnit function returns a handle to

an oscilloscope. All the other functions require this handle for oscilloscopeidentification. For example, to collect data from two oscilloscopes at the same time:

CALLBACK ps4000BlockReady(...)// Define callback function specific to application

handle1 = ps4000OpenUnithandle2 = ps4000OpenUnit

ps4000SetChannel(handle1)// Set up unit 1ps4000RunBlock(handle1)

ps4000SetChannel(handle2)// Set up unit 2ps4000RunBlock(handle2)

// Data will be stored in buffers and application will be// notified using callback

ready = FALSEwhile not ready

ready = handle1_readyready &= handle2_ready

Note: It is not possible to synchronize the collection of data between oscilloscopes thatare being used in combination.



5 API functionsThe PicoScope 4000 Series API exports the following functions for you to use in yourown applications. All functions are C functions using the standard call namingconvention (__stdcall). They are all exported with both decorated and undecorated

names.

ps4000BlockReady: receive notification when block-mode data readyps4000CloseUnit: close a scope deviceps4000DataReady: indicate when post-collection data readyps4000EnumerateUnits: find out how many units are connectedps4000FlashLed: flash the front-panel LEDps4000GetChannelInformation: find out if extra ranges availableps4000GetMaxDownSampleRatio: find out aggregation ratio for dataps4000GetStreamingLatestValues: get streaming data while scope is runningps4000GetTimebase: find out what timebases are availableps4000GetTimebase2: find out what timebases are availableps4000GetTriggerChannelTimeOffset: get trigger times from specified channelps4000GetTriggerChannelTimeOffset64: get trigger times from specified channelps4000GetTriggerTimeOffset: find out when trigger occurred (32-bit)ps4000GetTriggerTimeOffset64: find out when trigger occurred (64-bit)ps4000GetUnitInfo: read information about scope deviceps4000GetValues: retrieve block-mode data with callbackps4000GetValuesAsync: retrieve streaming data with callbackps4000GetValuesBulk: retrieve more than one waveform at a timeps4000GetValuesTriggerChannelTimeOffsetBulk: retrieve time offset from a channelps4000GetValuesTriggerChannelTimeOffsetBulk64: retrieve time offset (64-bit)ps4000GetValuesTriggerTimeOffsetBulk: retrieve time offset for a group of waveformsps4000GetValuesTriggerTimeOffsetBulk64: set the buffers for each waveform (64-bit)ps4000HoldOff: set trigger holdoffps4000IsLedFlashing: read status of LEDps4000IsReady: poll driver in block modeps4000IsTriggerOrPulseWidthQualifierEnabled: find out whether trigger is enabledps4000MemorySegments: divide scope memory into segmentsps4000NoOfStreamingValues: get number of samples in streaming modeps4000OpenUnit: open a scope deviceps4000OpenUnitAsync: open a scope device without waitingps4000OpenUnitAsyncEx: open a specified device without waitingps4000OpenUnitEx: open a specified deviceps4000OpenUnitProgress: check progress of ps4000OpenUnit callps4000RunBlock: start block modeps4000RunStreaming: start streaming modeps4000RunStreamingEx: start streaming mode with a specified data reduction modeps4000SetChannel: set up input channelsps4000SetDataBuffer: register data buffer with driverps4000SetDataBufferBulk: set the buffers for each waveformps4000SetDataBuffers: register min/max data buffers with driverps4000SetDataBuffersWithMode: register data buffers and specify aggregation modeps4000SetDataBufferWithMode: register data buffer and specify aggregation modeps4000SetEts: set up equivalent-time sampling (ETS)ps4000SetEtsTimeBuffer: set up 64-bit buffer for ETS time dataps4000SetEtsTimeBuffers: set up 32-bit buffers for ETS time dataps4000SetExtTriggerRange: set EXT trigger input rangeps4000SetPulseWidthQualifier: set up pulse width triggeringps4000SetSigGenArbitrary: set up arbitrary waveform generatorps4000SetSigGenBuiltIn: set up function generatorps4000SetSimpleTrigger: set up level triggers onlyps4000SetTriggerChannelConditions: specify which channels to trigger onps4000SetTriggerChannelDirections: set up signal polarities for triggeringps4000SetTriggerChannelProperties: set up trigger thresholdsps4000SetTriggerDelay: set up post-trigger delayps4000SigGenArbitraryMinMaxValues: get AWG sample value limitsps4000SigGenFrequencyToPhase: get phase increment for signal generatorps4000SigGenSoftwareControl: trigger the signal generator

API functions20


ps4000Stop: stop data captureps4000StreamingReady: indicate when streaming-mode data ready



5.1 ps4000BlockReadytypedef void (CALLBACK *ps4000BlockReady)(

int16_t handle,PICO_STATUS status,void * pParameter

)

This callback function is part of your application. You register it with the PicoScope4000 Series driver using ps4000RunBlock, and the driver calls it back when block-

mode data is ready. You can then download the data using the ps4000GetValuesfunction.

Applicability Block mode only

Arguments handle, identifies the scope device returning the samples

status, indicates whether an error occurred during collection of the

data

pParameter, a void pointer passed from ps4000RunBlock. The

callback function can write to this location to send any data, such asa status flag, back to your application.

Returns nothing

API functions22


5.2 ps4000CloseUnitPICO_STATUS ps4000CloseUnit(

int16_t handle)

This function shuts down a PicoScope 4000 scope device.

Applicability All modes

Arguments handle, returned by ps4000OpenUnit, identifies the scope device

to be closed

Returns PICO_OKPICO_HANDLE_INVALID



5.3 ps4000DataReadytypedef void (CALLBACK *ps4000DataReady)(

int16_t handle,int32_t noOfSamples,int16_t overflow,uint32_t triggerAt,int16_t triggered,void * pParameter

)

This function handles post-collection data returned by the driver after a call to ps4000GetValuesAsync. It is a callback function that is part of your application. You

register it with the PicoScope 4000 Series driver using ps4000GetValuesAsync, and

the driver calls it back when the data is ready.



noOfSamples, the number of samples collected

overflow, returns a flag that indicates whether an overvoltage has

occurred on any of the channels. It is a bit pattern with bit 0denoting Channel A and bit 1 Channel B.

triggerAt, an index to the buffer indicating the location of the

trigger point. This parameter is valid only when triggered is non-

zero.

triggered, a flag indicating whether a trigger occurred. If non-

zero, a trigger occurred at the location indicated by triggerAt.

pParameter, a void pointer passed from

ps4000GetValuesAsync. The callback function can write to this

location to send any data, such as a status flag, back to theapplication. The data type is defined by the application programmer.

Returns nothing

API functions24


5.4 ps4000EnumerateUnitsPICO_STATUS ps4000EnumerateUnits(

int16_t * count,int8_t * serials,int16_t * serialLth

)

This function counts the number of PicoScope 4000 Series units connected to thecomputer, and returns a list of serial numbers as a string. Note that this function willonly detect devices that are not yet being controlled by an application.


Arguments * count, on exit, the number of scopes found

* serials, on exit, a list of serial numbers separated by commas

and terminated by a final null. Example: AQ005/139,VDR61/356,ZOR14/107. Can be NULL on entry if serial

numbers are not required.

* serialLth, on entry, the length of the int8_t buffer pointed to

by serials; on exit, the length of the string written to serials

Returns PICO_OKPICO_BUSYPICO_NULL_PARAMETERPICO_FW_FAILPICO_CONFIG_FAILPICO_MEMORY_FAILPICO_ANALOG_BOARDPICO_CONFIG_FAIL_AWGPICO_INITIALISE_FPGA



5.5 ps4000FlashLedPICO_STATUS ps4000FlashLed(

int16_t handle,int16_t start

)

This function flashes the LED on the front of the scope without blocking the callingthread. Calls to ps4000RunStreaming and ps4000RunBlock cancel any flashing

started by this function.


Arguments handle, identifies the scope device

start, the action required:

< 0 :flash the LED indefinitely.0 :stop the LED flashing.> 0 :flash the LED start times. If the LED is already flashing

on entry to this function, the flash count will be reset to start.

Returns PICO_OKPICO_HANDLE_INVALIDPICO_BUSY

API functions26


5.6 ps4000GetChannelInformationPICO_STATUS ps4000GetChannelInformation(

int16_t handle,PS4000_CHANNEL_INFO info,int32_t probe,int32_t * ranges,int32_t * length,int32_t channel

)

This function queries which extra ranges are available on a scope device.

Applicability Reserved for future expansion


info, the type of information required, chosen from the list of

PS4000_CHANNEL_INFO values

probe, not used, must be set to 0

ranges, an array that will be populated with available ranges for

the given value of info. May be NULL. See PS4000_RANGE for

possible values.

length, on entry: the length of the ranges array; on exit: the

number of elements written to ranges or, if ranges is NULL, the

number of elements that would have been written

channel, the channel for which the information is required. See

PS4000_CHANNEL for possible values.

Returns PICO_OKPICO_INVALID_HANDLEPICO_INVALID_PARAMETER



5.7 ps4000GetMaxDownSampleRatioPICO_STATUS ps4000GetMaxDownSampleRatio(

int16_t handle,uint32_t noOfUnaggregatedSamples,uint32_t * maxDownSampleRatio, int16_t downSampleRatioMode,uint16_t segmentIndex

)

This function returns the maximum downsampling ratio that can be used for a givennumber of samples.



noOfUnaggregatedSamples, the number of unaggregated

samples to be used to calculate the maximum downsampling ratio

maxDownSampleRatio, returns the aggregation ratio

downSampleRatioMode, see ps4000GetValues

segmentIndex, the memory segment where the data is stored

Returns PICO_OKPICO_INVALID_HANDLEPICO_NO_SAMPLES_AVAILABLEPICO_NULL_PARAMETERPICO_INVALID_PARAMETERPICO_SEGMENT_OUT_OF_RANGEPICO_TOO_MANY_SAMPLES

API functions28


5.8 ps4000GetNoOfCapturesPICO_STATUS ps4000GetNoOfCaptures( int16_t handle, uint16_t * nCaptures)

This function returns the number of captures the device has made in rapid block mode,since you called ps4000RunBlock. You can call ps4000GetNoOfCaptures during

device capture, after collection has completed or after interrupting waveform collectionby calling ps4000Stop. The returned value (nCaptures) can then be used to iterate

through the number of segments using ps4000GetValues, or in a single call to

ps4000GetValuesBulk, where it is used to calculate the toSegmentIndexparameter.

Applicability Rapid block mode

Arguments handle, handle of the required device.

* nCaptures, output: the number of available captures that has

been collected from calling ps4000RunBlock.

Returns PICO_OKPICO_DRIVER_FUNCTIONPICO_INVALID_HANDLEPICO_NOT_RESPONDINGPICO_NO_SAMPLES_AVAILABLEPICO_NULL_PARAMETERPICO_INVALID_PARAMETERPICO_SEGMENT_OUT_OF_RANGEPICO_TOO_MANY_SAMPLES



5.9 ps4000GetStreamingLatestValuesPICO_STATUS ps4000GetStreamingLatestValues (

int16_t handle,ps4000StreamingReady lpPs4000Ready,void * pParameter

)

This function is used to collect the next block of values while streaming is running. Youmust call ps4000RunStreaming beforehand to set up streaming.

Applicability Streaming mode only


lpPs4000Ready, a pointer to your ps4000StreamingReadycallback function that will return the latest aggregated values

pParameter, a void pointer that will be passed to the

ps4000StreamingReady callback function

Returns PICO_OKPICO_INVALID_HANDLEPICO_NO_SAMPLES_AVAILABLEPICO_INVALID_CALLPICO_BUSYPICO_NOT_RESPONDING

API functions30


5.10 ps4000GetTimebasePICO_STATUS ps4000GetTimebase (

int16_t handle,uint32_t timebase,int32_t noSamples,int32_t * timeIntervalNanoseconds,int16_t oversample,int32_t * maxSamplesuint16_t segmentIndex

)

This function discovers which timebases are available on the oscilloscope. You shouldset up the channels using ps4000SetChannel first.



timebase, a code between 0 and 230–1 that specifies the sampling

interval (see timebase guide)

noSamples, the number of samples required. This value is used to

calculate the most suitable time unit to use.

timeIntervalNanoseconds, a pointer to the time interval

between readings at the selected timebase. If a null pointer ispassed, nothing will be written here.

oversample, the amount of oversample required. An oversample

of 4, for example, would quadruple the time interval and quarter themaximum samples, and at the same time would increase theeffective resolution by one bit. See the topic on oversampling.

maxSamples, a pointer to the maximum number of samples

available. The scope allocates a certain amount of memory forinternal overheads and this may vary depending on the number ofsegments, number of channels enabled, the timebase chosen and theoversample selected. If this pointer is null, nothing will be writtenhere.

segmentIndex, the number of the memory segment to use

Returns PICO_OKPICO_INVALID_HANDLEPICO_TOO_MANY_SAMPLESPICO_INVALID_CHANNELPICO_INVALID_TIMEBASEPICO_INVALID_PARAMETER



5.11 ps4000GetTimebase2PICO_STATUS ps4000GetTimebase2 (

int16_t handle,uint32_t timebase,int32_t noSamples,float * timeIntervalNanoseconds,int16_t oversample,int32_t * maxSamplesuint16_t segmentIndex

)

This function differs from ps4000GetTimebase only in the float * type of the

timeIntervalNanoseconds argument.


Arguments timeIntervalNanoseconds, a pointer to the time interval

between readings at the selected timebase. If a null pointer ispassed, nothing will be written here.

All others as in ps4000GetTimebase.

Returns See ps4000GetTimebase.

API functions32


5.12 ps4000GetTriggerChannelTimeOffsetPICO_STATUS ps4000GetTriggerChannelTimeOffset(

int16_t handle,uint32_t * timeUpper,uint32_t * timeLower,PS4000_TIME_UNITS * timeUnits,uint16_t segmentIndex,PS4000_CHANNEL channel

)

This function is for use in applications that display signal data graphically, and issuitable for use with oscilloscopes that use interleaved sampling: PicoScope 4224,4424 and 4262.

With a digital signal, the trigger point occurs after the last pre-trigger sample and at orbefore the first post-trigger sample, so there may be a time offset between the triggerpoint and the post-trigger sample point. ps4000GetTriggerChannelTimeOffsetretrieves this time offset, as lower and upper 32-bit values, for a waveform obtainedin block mode or rapid block mode, adjusted for the time skew of the specified channelrelative to the trigger source. This allows you to plot a stable trace relative to thetrigger point.

A 64-bit version of this function, ps4000GetTriggerChannelTimeOffset64, is

available for use with programming languages that support 64-bit integers.



Applicability Block mode, rapid block mode

Recommended for PicoScope 4224, 4424 and 4262 variants only

You can also call this function on the PicoScope 4226 and 4227variants, which use simultaneous sampling, but the results will be thesame for all four channels: we recommend users of these models call ps4000GetTriggerTimeOffset instead.


timeUpper, a pointer to the most significant 32 bits of the time

offset for segmentIndex. The array must be long enough to hold the

number of requested times.

timeLower, a pointer to the least significant 32 bits of the time



timeUnits, a pointer to PS4000_TIME_UNITS, which returns the

units in which timeUpper and timeLower are measured. The

allowable values are:PS4000_FS: femtoseconds

PS4000_PS: picoseconds

PS4000_NS: nanoseconds

PS4000_US: microseconds

PS4000_MS: milliseconds

PS4000_S: seconds

segmentIndex, the number of the memory segment for which the

information is required

channel, the scope channel for which the information is required

Returns PICO_OKPICO_INVALID_HANDLEPICO_DEVICE_SAMPLINGPICO_SEGMENT_OUT_OF_RANGEPICO_NULL_PARAMETERPICO_NO_SAMPLES_AVAILABLE

API functions34


5.13 ps4000GetTriggerChannelTimeOffset64PICO_STATUS ps4000GetTriggerChannelTimeOffset64(

int16_t handle,int64_t * time,PS4000_TIME_UNITS * timeUnits,uint16_t segmentIndex,PS4000_CHANNEL channel

)

This function gets the trigger time offset for a waveform. It is equivalent to ps4000GetTriggerChannelTimeOffset except that the time offset is returned as a

single 64-bit value instead of two 32-bit values.

ps4000GetTriggerChannelTimeOffset64 is for use in applications that display

signal data graphically, and is suitable for use with oscilloscopes that use interleavedsampling: PicoScope 4224, 4424 and 4262.


Recommended for PicoScope 4224, 4424 and 4262 variants only, asthese models use interleaved sampling

You can also call this function on the PicoScope 4226 and 4227variants, which use simultaneous sampling, but the results will be thesame for all four channels: we recommend users of these models call ps4000GetTriggerTimeOffset64 instead.


time, a pointer to the time offset for segmentIndex. The array

must be long enough to hold the number of requested times.








PS4000_S: seconds



channel, the scope channel for which the information is required




5.14 ps4000GetTriggerTimeOffsetPICO_STATUS ps4000GetTriggerTimeOffset(

int16_t handleuint32_t * timeUpperuint32_t * timeLowerPS4000_TIME_UNITS * timeUnitsuint16_t segmentIndex

)

This function retrieves the trigger time offset for multiple waveforms obtained in blockmode or rapid block mode, and is suitable for use with oscilloscopes that useinterleaved sampling: PicoScope 4224, 4424 and 4262. It is a more efficientalternative to calling ps4000GetTriggerChannelTimeOffset once for each

waveform required. See ps4000GetTriggerTimeOffset for an explanation of

trigger time offsets.

A 64-bit version of this function, ps4000GetValuesTriggerChannelTimeOffsetBulk64, is available for use with

programming languages that support 64-bit integers.

API functions36



Recommended for PicoScope 4226 and 4227 variants only

You can also call this function on the PicoScope 4224, 4424 and 4262variants, which use interleaved sampling, but the results will only beaccurate to one sample period: users of these models can obtaingreater accuracy by calling ps4000GetTriggerChannelTimeOffset instead.


timeUpper, a pointer to the most significant 32 bits of the time



timeLower, a pointer to the least significant 32 bits of the time










PS4000_S: seconds


information is required.




5.15 ps4000GetTriggerTimeOffset64PICO_STATUS ps4000GetTriggerTimeOffset64(

int16_t handle,int64_t * time,PS4000_TIME_UNITS * timeUnits,uint16_t segmentIndex

)

This function is for use in applications that display signal data graphically, and issuitable for use with oscilloscopes that use simultaneous sampling: PicoScope 4226and 4227. It is equivalent to ps4000GetTriggerTimeOffset except that the time

offset is returned as a single 64-bit value instead of two 32-bit values.



You can also call this function on the PicoScope 4224, 4424 and 4262variants, which use interleaved sampling, but the results will only beaccurate to one sample period: users of these models can obtaingreater accuracy by calling ps4000GetTriggerChannelTimeOffset instead.


time, a pointer to the time offset for segmentIndex. The array

must be long enough to hold the number of requested times.








PS4000_S: seconds




API functions38


5.16 ps4000GetUnitInfoPICO_STATUS ps4000GetUnitInfo (

int16_t handle, int8_t * string,int16_t stringLength,int16_t * requiredSizePICO_INFO info

)

This function writes information about the specified scope device to an int8_t string.

If the device fails to open, only the driver version and error code are available toexplain why the last open unit call failed.


Arguments handle, identifies the scope device from which information is

required. If an invalid handle is passed, the error code from the lastunit that failed to open is returned.

string, a pointer to the int8_t string buffer in the calling

function where the unit information string (selected with info) will

be stored. If a null pointer is passed, only the requiredSize,

pointer to an int16_t, of the int8_t string buffer is returned.

stringLength, used to return the size of the int8_t string buffer

requiredSize, used to return the required int8_t string buffer

size

info, an enumerated type specifying what information is required

from the driver

Returns PICO_OKPICO_INVALID_HANDLEPICO_NULL_PARAMETERPICO_INVALID_INFOPICO_INFO_UNAVAILABLE

PICO_INFO constant Example

0: PICO_DRIVER_VERSION, version number of PicoScope 4000 DLL 1,0,0,1

1: PICO_USB_VERSION, type of USB connection to device: 1.1 or

2.0

2.0

2: PICO_HARDWARE_VERSION, hardware version of device 1

3: PICO_VARIANT_INFO, variant number of device 4224

4: PICO_BATCH_AND_SERIAL, batch and serial number of device KJL87/6

5: PICO_CAL_DATE, calibration date of device 11Nov08

6: PICO_KERNEL_VERSION, version of kernel driver 1,1,2,4



5.17 ps4000GetValuesPICO_STATUS ps4000GetValues(

int16_t handle,uint32_t startIndex,uint32_t * noOfSamples,uint32_t downSampleRatio,int16_t downSampleRatioMode,uint16_t segmentIndex,int16_t * overflow

)

This function returns block-mode data, either with or without aggregation, starting atthe specified sample number. It is used to get the stored data from the device afterdata collection has stopped.

API functions40




startIndex, a zero-based index that indicates the start point for

data collection. It is measured in sample intervals from the start ofthe buffer.

noOfSamples, on entry: the number of samples requested; on exit,

the number of samples actually returned

downSampleRatio, the aggregation factor that will be applied to

the raw data

downSampleRatioMode, whether to use aggregation to reduce the

amount of data. The available values are:RATIO_MODE_NONE (downSampleRatio is ignored)RATIO_MODE_AGGREGATE (uses aggregation)RATIO_MODE_AVERAGE

RATIO_MODE_AGGREGATE and RATIO_MODE_AVERAGE are single-

bit constants that can be ORed to apply multiple downsamplingmodes to the same data.

segmentIndex, the zero-based number of the memory segment

where the data is stored

overflow, returns a set of flags that indicate whether an

overvoltage has occurred on any of the channels. It is a bit patternwith bit 0 denoting Channel A and bit 1 Channel B.

Returns PICO_OKPICO_INVALID_HANDLEPICO_NO_SAMPLES_AVAILABLEPICO_DEVICE_SAMPLINGPICO_NULL_PARAMETERPICO_SEGMENT_OUT_OF_RANGEPICO_INVALID_PARAMETERPICO_TOO_MANY_SAMPLESPICO_DATA_NOT_AVAILABLEPICO_STARTINDEX_INVALIDPICO_INVALID_SAMPLERATIOPICO_INVALID_CALLPICO_NOT_RESPONDINGPICO_MEMORY



5.18 ps4000GetValuesAsyncPICO_STATUS ps4000GetValuesAsync(

int16_t handle,uint32_t startIndex,uint32_t noOfSamples,uint32_t downSampleRatio,int16_t downSampleRatioMode,uint16_t segmentIndex,void * lpDataReady, void * pParameter

)

This function returns streaming data, either with or without aggregation, starting atthe specified sample number. It is used to get the stored data from the device (in block mode) or the driver (in streaming mode) after data collection has stopped. Itreturns the data using a callback.



startIndex,noOfSamples,downSampleRatio,downSampleRatioMode,segmentIndex: see ps4000GetValues

lpDataReady, a pointer to the ps4000StreamingReady function

that is called when the data is ready

pParameter, a void pointer that will be passed to the

ps4000StreamingReady callback function. The data type depends

on the design of the callback function, which is determined by theapplication programmer.

Returns PICO_OKPICO_INVALID_HANDLEPICO_NO_SAMPLES_AVAILABLEPICO_DEVICE_SAMPLING – streaming onlyPICO_NULL_PARAMETERPICO_STARTINDEX_INVALIDPICO_SEGMENT_OUT_OF_RANGEPICO_INVALID_PARAMETERPICO_DATA_NOT_AVAILABLEPICO_INVALID_SAMPLERATIOPICO_INVALID_CALL

API functions42


5.19 ps4000GetValuesBulkPICO_STATUS ps4000GetValuesBulk(

int16_t handle,uint32_t * noOfSamples,uint16_t fromSegmentIndex,uint16_t toSegmentIndex,int16_t * overflow

)

This function allows more than one waveform to be retrieved at a time in rapid blockmode. The waveforms must have been collected sequentially and in the same run. Thismethod of collection does not support aggregation.



* noOfSamples, On entry, the number of samples required. On

exit, the actual number retrieved. The number of samples retrievedwill not be more than the number requested. The data retrievedalways starts with the first sample captured.

fromSegmentIndex, the first segment from which the waveform

should be retrieved

toSegmentIndex, the last segment from which the waveform

should be retrieved

* overflow, equal to or larger than the number of waveforms to

be retrieved. Each segment index has a separate overflow element,

with overflow[0] containing the fromSegmentIndex, and the last

index the toSegmentIndex. Each element in the array is a bit field

as described under ps4000GetValues.

Returns PICO_OKPICO_INVALID_HANDLEPICO_INVALID_PARAMETERPICO_SEGMENT_OUT_OF_RANGEPICO_NO_SAMPLES_AVAILABLEPICO_STARTINDEX_INVALIDPICO_NOT_RESPONDING



5.20 ps4000GetValuesTriggerChannelTimeOffsetBulkPICO_STATUS ps4000GetValuesTriggerChannelTimeOffsetBulk(

int16_t handle,uint32_t * timesUpper,uint32_t * timesLower,PS4000_TIME_UNITS * timeUnits,uint16_t fromSegmentIndex,uint16_t toSegmentIndex,PS4000_CHANNEL channel

)

This function retrieves the trigger time offset for multiple waveforms obtained in rapidblock mode, and is suitable for use with oscilloscopes that use interleaved sampling:PicoScope 4224, 4424 and 4262. It is a more efficient alternative to calling ps4000GetTriggerChannelTimeOffset once for each waveform required. See

ps4000GetTriggerTimeOffset for an explanation of trigger time offsets.

A 64-bit version of this function, ps4000GetValuesTriggerChannelTimeOffsetBulk64, is available for use with




* timesUpper, a pointer to 32-bit integers. This will hold the most

significant 32 bits of the time offset for each requested segmentindex. times[0] will hold the fromSegmentIndex time offset and

the last times index will hold the toSegmentIndex time offset. The

array must be long enough to hold the number of requested times.

* timesLower, a pointer to 32-bit integers. This will hold the least-




* timeUnits, a pointer to a range of PS4000_TIME_UNITS. This

must be equal to or larger than the number of requested times. timeUnits[0] will contain the time unit for fromSegmentIndexand the last index will contain the time unit for toSegmentIndex.

fromSegmentIndex, the first segment for which the time offset is

required

toSegmentIndex, the last segment for which the time offset is

required. If toSegmentIndex is less than fromSegmentIndex then

the driver will wrap around from the last segment to the first.

channel, the channel for which the information is required

Returns PICO_OKPICO_INVALID_HANDLEPICO_NULL_PARAMETERPICO_DEVICE_SAMPLINGPICO_SEGMENT_OUT_OF_RANGEPICO_NO_SAMPLES_AVAILABLE

API functions44


5.21 ps4000GetValuesTriggerChannelTimeOffsetBulk64PICO_STATUS ps4000GetValuesTriggerChannelTimeOffsetBulk64(

int16_t handle,int64_t * times,PS4000_TIME_UNITS * timeUnits,uint16_t fromSegmentIndex,uint16_t toSegmentIndex,PS4000_CHANNEL channel

)

This function is equivalent to ps4000GetValuesTriggerChannelTimeOffsetBulkbut retrieves the trigger time offsets as 64-bit values instead of pairs of 32-bit values.



* times, a pointer to 64-bit integers. This will hold the time offset

for each requested segment index. times[0] will hold the time offset

for fromSegmentIndex, and the last times index will hold the time

offset for toSegmentIndex. The array must be long enough to hold

the number of times requested.


must be equal or larger than the number of requested times. timeUnits[0] will contain the time unit for fromSegmentIndex,

and the last index will contain the time unit for toSegmentIndex.


required. The result will be placed in times[0] and timeUnits[0].


required. The result will be placed in the last elements of the timesand timeUnits arrays. If toSegmentIndex is less than

fromSegmentIndex then the driver will wrap around from the last

segment to the first.

channel, the scope channel for which information is required




5.22 ps4000GetValuesTriggerTimeOffsetBulkPICO_STATUS ps4000GetValuesTriggerTimeOffsetBulk(

int16_t handle,uint32_t * timesUpper,uint32_t * timesLower,PS4000_TIME_UNITS * timeUnits,uint16_t fromSegmentIndex,uint16_t toSegmentIndex

)

This function retrieves the trigger time offset for multiple waveforms obtained in rapidblock mode. It is a more efficient alternative to callingps4000GetTriggerTimeOffset once for each waveform required. See

ps4000GetTriggerTimeOffset for an explanation of trigger time offsets.

ps4000GetValuesTriggerTimeOffsetBulk is suitable for use with oscilloscopes

that use simultaneous sampling: PicoScope 4226 and 4227. A 64-bit version of thisfunction, ps4000GetValuesTriggerTimeOffsetBulk64, is available for use with


API functions46




You can also call this function on the PicoScope 4224, 4424 and 4262variants, which use interleaved sampling, but the results will only beaccurate to one sample period: users of these models can obtaingreater accuracy by calling ps4000GetValuesTriggerChannelTimeOffsetBulk instead.


* timesUpper, a pointer to 32-bit integers. This will hold the most




* timesLower, a pointer to 32-bit integers. This will hold the least-





must be equal to or larger than the number of requested times. timeUnits[0] will contain the time unit for fromSegmentIndexand the last index will contain the time unit for toSegmentIndex.


required


required. If toSegmentIndex is less than fromSegmentIndex then

the driver will wrap around from the last segment to the first.




5.23 ps4000GetValuesTriggerTimeOffsetBulk64PICO_STATUS ps4000GetValuesTriggerTimeOffsetBulk64(

int16_t handle,int64_t * times,PS4000_TIME_UNITS * timeUnits,uint16_t fromSegmentIndex,uint16_t toSegmentIndex

)

This function is equivalent to ps4000GetValuesTriggerTimeOffsetBulk but

retrieves the trigger time offsets as 64-bit values instead of pairs of 32-bit values.



You can also call this function on the PicoScope 4224, 4424 and 4262variants, which use interleaved sampling, but the results will only beaccurate to one sample period: users of these models can obtaingreater accuracy by calling ps4000GetValuesTriggerChannelTimeOffsetBulk64 instead.


* times, a pointer to 64-bit integers. This will hold the time offset

for each requested segment index. times[0] will hold the time offset

for fromSegmentIndex, and the last times index will hold the time

offset for toSegmentIndex. The array must be long enough to hold

the number of times requested.


must be equal or larger than the number of requested times. timeUnits[0] will contain the time unit for fromSegmentIndex,

and the last index will contain the time unit for toSegmentIndex.


required. The result will be placed in times[0] and timeUnits[0].


required. The result will be placed in the last elements of the timesand timeUnits arrays. If toSegmentIndex is less than

fromSegmentIndex then the driver will wrap around from the last

segment to the first.


API functions48


5.24 ps4000HoldOffPICO_STATUS ps4000HoldOff ( int16_t handle, uint64_t holdoff, PS4000_HOLDOFF_TYPE type)

This function sets the holdoff time - the time that the scope waits after each triggerevent before allowing the next trigger event.

Applicability Not currently supported. Reserved for future use.

Arguments holdoff, the number of samples between trigger events. The time

is calculated by multiplying the sample interval by the hold-off.

type, the type of hold-off. Only hold-off by time is currently

supported:PS4000_TIME

Returns PICO_OK - successPICO_DRIVER_FUNCTIONPICO_INVALID_PARAMETER



5.25 ps4000IsLedFlashingPICO_STATUS ps4000IsLedFlashing(

int16_t handle,int16_t * status

)

This function reports whether or not the LED is flashing.



status, returns a flag indicating the status of the LED:

<> 0 : flashing0 : not flashing

Returns PICO_OKPICO_HANDLE_INVALIDPICO_NULL_PARAMETER

API functions50


5.26 ps4000IsReadyPICO_STATUS ps4000IsReady(

int16_t handle, int16_t * ready

)

This function may be used instead of a callback function to receive data from ps4000RunBlock. To use this method, pass a NULL pointer as the lpReady argument

to ps4000RunBlock. You must then poll the driver to see if it has finished collecting

the requested samples.

Applicability Block mode


ready, on exit, indicates the state of the collection. If zero, the

device is still collecting. If non-zero, the device has finished collectingand ps4000GetValues can be used to retrieve the data.

Returns



5.27 ps4000IsTriggerOrPulseWidthQualifierEnabledPICO_STATUS ps4000IsTriggerOrPulseWidthQualifierEnabled(

int16_t handle,int16_t * triggerEnabled,int16_t * pulseWidthQualifierEnabled

)

This function discovers whether a trigger, or pulse width triggering, is enabled.

Applicability Call after setting up the trigger, and just before calling either ps4000RunBlock or ps4000RunStreaming.


triggerEnabled, indicates whether the trigger will successfully be

set when ps4000RunBlock or ps4000RunStreaming is called. A

non-zero value indicates that the trigger is set, otherwise the triggeris not set.

pulseWidthQualifierEnabled, indicates whether the pulse

width qualifier will successfully be set when ps4000RunBlock or

ps4000RunStreaming is called. A non-zero value indicates that the

pulse width qualifier is set, otherwise the pulse width qualifier is notset.

Returns PICO_OKPICO_INVALID_HANDLEPICO_NULL_PARAMETER

API functions52


5.28 ps4000MemorySegmentsPICO_STATUS ps4000MemorySegments(

int16_t handleuint16_t nSegments,int32_t * nMaxSamples

)

This function sets the number of memory segments that the scope device will use.

By default, each capture fills the scope device's available memory. This function allowsyou to divide the memory into a number of segments so that the scope can storeseveral captures sequentially. The number of segments defaults to 1 when the scopedevice is opened.



nSegments, the number of segments to be used, from 1 to 8192

nMaxSamples, returns the number of samples that are available in

each segment. This is independent of the number of channels, so ifmore than one channel is in use then the number of samplesavailable to each channel is nMaxSamples divided by the number of

channels.

Returns PICO_OKPICO_USER_CALLBACKPICO_INVALID_HANDLEPICO_TOO_MANY_SEGMENTSPICO_MEMORY



5.29 ps4000NoOfStreamingValuesPICO_STATUS ps4000NoOfStreamingValues (

int16_t handle,uint32_t * noOfValues

)

This function returns the available number of samples from a streaming run.

Applicability Streaming mode. Call after ps4000Stop.


noOfValues, returns the number of samples

Returns PICO_OKPICO_INVALID_HANDLEPICO_NULL_PARAMETERPICO_NO_SAMPLES_AVAILABLEPICO_NOT_USEDPICO_BUSY

API functions54


5.30 ps4000OpenUnitPICO_STATUS ps4000OpenUnit (

int16_t * handle )

This function opens a scope device. The maximum number of units that can be openedis determined by the operating system, the kernel driver and the PC's hardware.


Arguments handle, pointer to an int16_t that receives the handle number:

-1 : if the unit fails to open,0 : if no unit is found> 0 : if successful (value is handle of the device opened)

The handle number must be used in all subsequent calls to APIfunctions to identify this scope device.

Returns PICO_OKPICO_OS_NOT_SUPPORTEDPICO_OPEN_OPERATION_IN_PROGRESSPICO_EEPROM_CORRUPTPICO_KERNEL_DRIVER_TOO_OLDPICO_FW_FAILPICO_MAX_UNITS_OPENEDPICO_NOT_FOUNDPICO_NOT_RESPONDING



5.31 ps4000OpenUnitAsyncPICO_STATUS ps4000OpenUnitAsync(

int16_t * status)

This function opens a scope device without blocking the calling thread. You can findout when it has finished by periodically calling ps4000OpenUnitProgress until that

function returns a non-zero value.


Arguments status, pointer to an int16_t that indicates:

0 if there is already an open operation in progress1 if the open operation is initiated

Returns PICO_OKPICO_OPEN_OPERATION_IN_PROGRESSPICO_OPERATION_FAILED

API functions56


5.32 ps4000OpenUnitAsyncExPICO_STATUS ps4000OpenUnitAsyncEx(

int16_t * status,int8_t * serial

)

This function opens a scope device selected by serial number without blocking thecalling thread. You can find out when it has finished by periodically calling ps4000OpenUnitProgress until that function returns a non-zero value.


Arguments status, pointer to a int16_t that indicates:

0 if there is already an open operation in progress1 if the open operation is initiated

serial, the serial number of the device to be opened. A null-

terminated string.

Returns PICO_OKPICO_OPEN_OPERATION_IN_PROGRESSPICO_OPERATION_FAILED



5.33 ps4000OpenUnitExPICO_STATUS ps4000OpenUnitEx(

int16_t * handle,int8_t * serial

)

This function opens a scope device. The maximum number of units that can be openedis determined by the operating system, the kernel driver and the PC's hardware.


Arguments handle, pointer to an int16_t that receives the handle number:

-1 : if the unit fails to open,0 : if no unit is found or> 0 : if successful (value is handle to the device opened)

The handle number must be used in all subsequent calls to APIfunctions to identify this scope device.

serial, the serial number of the device to be opened. A null-

terminated string.

Returns PICO_OKPICO_OS_NOT_SUPPORTEDPICO_OPEN_OPERATION_IN_PROGRESSPICO_EEPROM_CORRUPTPICO_KERNEL_DRIVER_TOO_OLDPICO_FW_FAILPICO_MAX_UNITS_OPENEDPICO_NOT_FOUNDPICO_NOT_RESPONDING

API functions58


5.34 ps4000OpenUnitProgressPICO_STATUS ps4000OpenUnitProgress (

int16_t * handle,int16_t * progressPercent,int16_t * complete

)

This function checks on the progress of ps4000OpenUnitAsync.

Applicability Use after ps4000OpenUnitAsync

Arguments handle, pointer to an int16_t where the unit handle is to be

written. -1 if the unit fails to open, 0 if no unit is found or a non-zerohandle to the device.

Note: This handle is not valid unless the function returnsPICO_OK.

progressPercent, pointer to an int16_t to which the

percentage progress is to be written. 100% implies that the openoperation is complete.

complete, pointer to an int16_t that is set to 1 when the open

operation has finished

Returns PICO_OKPICO_NULL_PARAMETERPICO_OPERATION_FAILED



5.35 ps4000PingUnitPICO_STATUS ps4000PingUnit (

int16_t handle)

This function can be used to check that the already opened device is still connected tothe USB port and communication is successful.



Returns PICO_OKPICO_INVALID_HANDLEPICO_DRIVER_FUNCTIONPICO_POWER_SUPPLY_CONNECTEDPICO_POWER_SUPPLY_NOT_CONNECTED PICO_BUSYPICO_NOT_RESPONDING

API functions60


5.36 ps4000RunBlockPICO_STATUS ps4000RunBlock (

int16_t handle,int32_t noOfPreTriggerSamples,int32_t noOfPostTriggerSamples,uint32_t timebase,int16_t oversample,int32_t * timeIndisposedMs,uint16_t segmentIndex,ps4000BlockReady lpReady,void * pParameter

)

This function starts a collection of data points (samples) in block mode.

The number of samples is determined by noOfPreTriggerSamples and

noOfPostTriggerSamples (see below for details). The total number of samples

must not be more than the memory depth of the segment referred to bysegmentIndex.





noOfPreTriggerSamples, the number of samples to return before

the trigger event. If no trigger has been set, then this argument isadded to noOfPostTriggerSamples to give the maximum number

of data points (samples) to collect.

noOfPostTriggerSamples, the number of samples to return after

the trigger event. If no trigger event has been set, then thisargument is added to noOfPreTriggerSamples to give the

maximum number of data points to collect. If a trigger condition hasbeen set, this specifies the number of data points to collect after atrigger has fired, and the number of data points to be collected is:

noOfPreTriggerSamples + noOfPostTriggerSamples

timebase, a number in the range 0 to 230–1. See the guide to

calculating timebase values.

oversample, the oversampling factor, a number in the range 1 to

16

timeIndisposedMs, returns the time, in milliseconds, that the

device will spend collecting samples. This does not include any autotrigger timeout. If this pointer is null, nothing will be written here.

segmentIndex, zero-based, specifies which memory segment to

use

lpReady, a pointer to the ps4000BlockReady callback that the

driver will call when the data has been collected. To use the ps4000IsReady polling method instead of a callback function, set

this pointer to NULL.

pParameter, a void pointer that is passed to the

ps4000BlockReady callback function. The callback can use the

pointer to return arbitrary data to your application.

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_SEGMENT_OUT_OF_RANGEPICO_INVALID_CHANNELPICO_INVALID_TRIGGER_CHANNELPICO_INVALID_CONDITION_CHANNELPICO_TOO_MANY_SAMPLESPICO_INVALID_TIMEBASEPICO_NOT_RESPONDINGPICO_CONFIG_FAILPICO_INVALID_PARAMETERPICO_NOT_RESPONDINGPICO_TRIGGER_ERROR

API functions62


5.37 ps4000RunStreamingPICO_STATUS ps4000RunStreaming(

int16_t handle, uint32_t * sampleInterval, PS4000_TIME_UNITS sampleIntervalTimeUnitsuint32_t maxPreTriggerSamples,uint32_t maxPostTriggerSamples,int16_t autoStopuint32_t downSampleRatio,uint32_t overviewBufferSize

)

This function tells the oscilloscope to start collecting data in streaming mode. Whendata has been collected from the device it is aggregated and the values returned tothe application. Call ps4000GetStreamingLatestValues to retrieve the data.

When a trigger is set, the sum of� maxPreTriggerSamples and

maxPostTriggerSamples is the total number of samples stored in the driver. If

autoStop is false then this will become the maximum number of unaggregated

samples.





sampleInterval, a pointer to the requested time interval between

data points on entry and the actual time interval assigned on exit

sampleIntervalTimeUnits, the unit of time that the

sampleInterval is set to. Use one of these values:PS4000_FSPS4000_PSPS4000_NSPS4000_USPS4000_MSPS4000_S

maxPreTriggerSamples, the maximum number of raw samples

before a trigger condition for each enabled channel. If no triggercondition is set this argument is ignored.

maxPostTriggerSamples, the maximum number of raw samples

after a trigger condition for each enabled channel. If no triggercondition is set this argument states the maximum number ofsamples to be stored.

autoStop, a flag to specify if the streaming should stop when all

of maxSamples have been taken

downSampleRatio, the number of raw values to each aggregated

value

overviewBufferSize, the size of the overview buffers. These are

temporary buffers used for storing the data before returning it to theapplication. The size is the same as the bufferLth value passed to

ps4000SetDataBuffer.

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_NULL_PARAMETERPICO_INVALID_PARAMETERPICO_STREAMING_FAILEDPICO_NOT_RESPONDINGPICO_TRIGGER_ERRORPICO_INVALID_SAMPLE_INTERVALPICO_INVALID_BUFFER

API functions64


5.38 ps4000RunStreamingExPICO_STATUS ps4000RunStreamingEx(

int16_t handle, uint32_t * sampleInterval, PS4000_TIME_UNITS sampleIntervalTimeUnitsuint32_t maxPreTriggerSamples,uint32_t maxPostTriggerSamples,int16_t autoStopuint32_t downSampleRatio,int16_t downSampleRatioMode,uint32_t overviewBufferSize

)

This function tells the oscilloscope to start collecting data in streaming mode and witha specified data reduction mode. When data has been collected from the device it is aggregated and the values returned to the application. Callps4000GetStreamingLatestValues to retrieve the data.

When a trigger is set, the sum of� maxPreTriggerSamples and

maxPostTriggerSamples is the total number of samples stored in the driver. If

autoStop is false then this will become the maximum number of unaggregated

samples.





sampleInterval, a pointer to the requested time interval between

data points on entry and the actual time interval assigned on exit

sampleIntervalTimeUnits, the unit of time that the

sampleInterval is set to. Use one of these values:PS4000_FSPS4000_PSPS4000_NSPS4000_USPS4000_MSPS4000_S

maxPreTriggerSamples, the maximum number of raw samples

before a trigger condition for each enabled channel. If no triggercondition is set this argument is ignored.

maxPostTriggerSamples, the maximum number of raw samples

after a trigger condition for each enabled channel. If no triggercondition is set this argument states the maximum number ofsamples to be stored.

autoStop, a flag to specify if the streaming should stop when all

of maxSamples have been taken

downSampleRatio, the number of raw values to each aggregated

value

downSampleRatioMode, the data reduction mode to use

overviewBufferSize, the size of the overview buffers. These are

temporary buffers used for storing the data before returning it to theapplication. The size is the same as the bufferLth value passed to

ps4000SetDataBuffer.

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_NULL_PARAMETERPICO_INVALID_PARAMETERPICO_STREAMING_FAILEDPICO_NOT_RESPONDINGPICO_TRIGGER_ERRORPICO_INVALID_SAMPLE_INTERVALPICO_INVALID_BUFFER

API functions66


5.39 ps4000SetBwFilterPICO_STATUS ps4000SetBwFilter( int16_t handle, PS4000_CHANNEL channel, int16_t enable)

This function enables or disables the bandwidth-limiting filter on the specified channel.

Applicability PicoScope 4262 only


channel, an enumerated type. The values are:PS4000_CHANNEL_APS4000_CHANNEL_B

enable, whether to enable or disable the filter:

TRUE = enable

FALSE = disable

Returns PICO_OKPICO_USER_CALLBACKPICO_INVALID_HANDLEPICO_INVALID_CHANNEL



5.40 ps4000SetChannelPICO_STATUS ps4000SetChannel (

int16_t handle,PS4000_CHANNEL channel,int16_t enabled,int16_t dc,PS4000_RANGE range

)

This function specifies whether an input channel is to be enabled, the AC/DC couplingmode and the voltage range.



channel, an enumerated type. The values are:PS4000_CHANNEL_APS4000_CHANNEL_BPS4000_CHANNEL_C (4-channel scopes only)

PS4000_CHANNEL_D (4-channel scopes only)

enabled, specifies if the channel is active. The values are:

TRUE = active

FALSE = inactive

dc, specifies the AC/DC coupling mode. The values are:

TRUE = DC

FALSE = AC

range, specifies the measuring range. Measuring ranges 0 to 12, for

standard scopes, are shown in the table below. Additional ranges forspecial-purpose scopes are listed under PS4000_RANGE. For

example, to enable IEPE input mode on an IEPE-enabled scope,select one of the ranges beginning with PS4000_ACCELEROMETER_.

Returns PICO_OKPICO_USER_CALLBACKPICO_INVALID_HANDLEPICO_INVALID_CHANNELPICO_INVALID_VOLTAGE_RANGE

API functions68


range Voltage range

0 PS4000_10MV ±10 mV

1 PS4000_20MV ±20 mV

2 PS4000_50MV ±50 mV

3 PS4000_100MV ±100 mV

4 PS4000_200MV ±200 mV

5 PS4000_500MV ±500 mV

6 PS4000_1V ±1 V

7 PS4000_2V ±2 V

8 PS4000_5V ±5 V

9 PS4000_10V ±10 V

10 PS4000_20V ±20 V

11 PS4000_50V ±50 V

12 PS4000_100V ±100 V



5.41 ps4000SetDataBufferPICO_STATUS ps4000SetDataBuffer(

int16_t handle,PS4000_CHANNEL channel,int16_t * buffer,int32_t bufferLth

)

This function registers your data buffer, for non-aggregated data, with the PicoScope4000 driver. You need to allocate the buffer before calling this function.

Applicability All modes.

For aggregated data, use ps4000SetDataBuffers instead.


channel, the channel for which you want to set the buffers. Use

one of these values:PS4000_CHANNEL_APS4000_CHANNEL_BPS4000_CHANNEL_C (4-channel scopes only)


buffer, a buffer to receive the data values

bufferLth, the size of the buffer array

Returns PICO_OKPICO_INVALID_HANDLEPICO_INVALID_CHANNEL

API functions70


5.42 ps4000SetDataBufferBulkPICO_STATUS ps4000SetDataBufferBulk(

int16_t handle,PS4000_CHANNEL channel,int16_t * buffer,int32_t bufferLth,uint16_t waveform

)

This function allows the buffers to be set for each waveform in rapid block mode. Thenumber of waveforms captured is determined by the nCaptures argument sent to

ps4000SetNoOfCaptures. There is only one buffer for each waveform, because bulk

collection does not support aggregation.



channel, the scope channel with which the buffer is to be

associated. The data should be retrieved from this channel by callingone of the GetValues functions.

* buffer, an array in which the captured data is stored

bufferLth, the size of the buffer

waveform, an index to the waveform number, between 0 andnCaptures–1

Returns PICO_OKPICO_INVALID_HANDLEPICO_INVALID_CHANNELPICO_INVALID_PARAMETER



5.43 ps4000SetDataBuffersPICO_STATUS ps4000SetDataBuffers(

int16_t handle,PS4000_CHANNEL channel,int16_t * bufferMax,int16_t * bufferMin,int32_t bufferLth

)

This function registers your data buffers, for receiving aggregated data, with thePicoScope 4000 driver. You need to allocate memory for the buffers before calling thisfunction.

Applicability All sampling modes.

For non-aggregated data, use ps4000SetDataBuffer instead.



one of these constants:PS4000_CHANNEL_APS4000_CHANNEL_BPS4000_CHANNEL_C (4-channel scopes only)


bufferMax, a buffer to receive the maximum data values in

aggregation mode, or the non-aggregated values otherwise

bufferMin, a buffer to receive the minimum data values when

downSampleRatio > 1. Not used when downSampleRatio is 1.

bufferLth, specifies the size of the bufferMax and bufferMinarrays


API functions72


5.44 ps4000SetDataBuffersWithModePICO_STATUS ps4000SetDataBuffersWithMode(

int16_t handle,PS4000_CHANNEL channel,int16_t * bufferMax,int16_t * bufferMin,int32_t bufferLth,RATIO_MODE mode

)

This function registers your data buffers, for receiving aggregated data, with thePicoScope 4000 driver. You need to allocate memory for the buffers before calling thisfunction.

Applicability All sampling modes.

For non-aggregated data, use ps4000SetDataBuffer instead.



one of these constants:PS4000_CHANNEL_APS4000_CHANNEL_BPS4000_CHANNEL_C (4-channel scopes only)


bufferMax, a buffer to receive the maximum data values in

aggregation mode, or the non-aggregated values otherwise

bufferMin, a buffer to receive the minimum data values when

downSampleRatio > 1. Not used when downSampleRatio is 1.

bufferLth, specifies the size of the bufferMax and bufferMinarrays

mode, the data reduction mode to use




5.45 ps4000SetDataBufferWithModePICO_STATUS ps4000SetDataBufferWithMode(

int16_t handle,PS4000_CHANNEL channel,int16_t * buffer,int32_t bufferLth,RATIO_MODE mode

)

This function registers your data buffer, for non-aggregated data, with the PicoScope4000 driver. You need to allocate the buffer before calling this function.


For aggregated data, use ps4000SetDataBuffers instead.



one of these values:PS4000_CHANNEL_APS4000_CHANNEL_BPS4000_CHANNEL_C (4-channel scopes only)


buffer, a buffer to receive the data values


mode, the type of data reduction to use


API functions74


5.46 ps4000SetEtsPICO_STATUS ps4000SetEts(

int16_t handle,PS4000_ETS_MODE mode,int16_t etsCycles,int16_t etsInterleave,int32_t * sampleTimePicoseconds

)

This function is used to enable or disable ETS (equivalent time sampling) and to setthe ETS parameters.

Applicability Block mode only. ETS is only supported by PicoScope 4226 and 4227.


mode, the ETS mode. Use one of these values:

PS4000_ETS_OFF disables ETS

PS4000_ETS_FAST enables ETS and provides etsCyclescycles of data, which may contain datafrom previously returned cycles

PS4000_ETS_SLOW enables ETS and provides fresh data

every etsCycles cycles. This mode

takes longer to provide each data set,but the data sets are more stable andare guaranteed to contain only new data.

etsCycles, the number of cycles to store: the computer can then

select etsInterleave cycles to give the most uniform spread of

samples. etsCycles should be between two and five times the value

of etsInterleave.

etsInterleave, the number of ETS interleaves to use. If the

sample time is 20 ns and the interleave is 10, the approximate timeper sample will be 2 ns.

sampleTimePicoseconds, returns the effective sample time used

by the function

Returns PICO_OKPICO_USER_CALLBACKPICO_INVALID_HANDLEPICO_INVALID_PARAMETER



5.47 ps4000SetEtsTimeBufferPICO_STATUS ps4000SetEtsTimeBuffer(

int16_t handle,int64_t * buffer,int32_t bufferLth

)

This function tells the PicoScope 4000 driver where to find your application's ETS timebuffers. These buffers contain the 64-bit timing information for each ETS sample afteryou run a block-mode ETS capture.

Applicability ETS mode only. ETS is only supported by PicoScope 4226 and 4227.

If your programming language does not support 64-bit data, use the32-bit version ps4000SetEtsTimeBuffers instead.


buffer, a pointer to a set of 64-bit words, each representing the

time in femtoseconds (10-15 s) at which the sample was captured



API functions76


5.48 ps4000SetEtsTimeBuffersPICO_STATUS ps4000SetEtsTimeBuffers(

int16_t handle,uint32_t * timeUpper,uint32_t * timeLower,int32_t bufferLth

)

This function tells the PicoScope 4000 driver where to find your application's ETS timebuffers. These buffers contain the timing information for each ETS sample after yourun a block-mode ETS capture. There are two buffers containing the upper and lower32-bit parts of the timing information, to allow programming languages that do notsupport 64-bit data to retrieve the timings correctly.

Applicability ETS mode only. ETS is only supported by PicoScope 4226 and 4227.

If your programming language supports 64-bit data, then you canuse ps4000SetEtsTimeBuffer instead.


timeUpper, a pointer to a set of 32-bit words, each representing

the upper 32 bits of the time in femtoseconds (10-15 s) at which thesample was captured

timeLower, a pointer to a set of 32-bit words, each representing

the lower 32 bits of the time in femtoseconds at which the samplewas captured

bufferLth, the size of the timeUpper and timeLower arrays




5.49 ps4000SetExtTriggerRangePICO_STATUS ps4000SetExtTriggerRange (

int16_t handle,PS4000_RANGE extRange

)

This function sets the range of the external trigger.

Applicability PicoScope 4262 only


extRange, specifies the range for the external trigger (±500 mV

or ±5 V)

Returns PICO_OKPICO_INVALID_PARAMETER

extRange Voltage range

5 PS4000_500MV ±500 mV

8 PS4000_5V ±5 V

API functions78


5.50 ps4000SetNoOfCapturesPICO_STATUS ps4000SetNoOfCaptures (

int16_t handle,uint16_t nCaptures

)

This function sets the number of captures to be collected in one run of rapid blockmode. If you do not call this function before a run, the driver will capture onewaveform.



nCaptures, the number of waveforms to be captured in one run

Returns PICO_OKPICO_INVALID_HANDLEPICO_INVALID_PARAMETER



5.51 ps4000SetPulseWidthQualifierPICO_STATUS ps4000SetPulseWidthQualifier(

int16_t handle,PWQ_CONDITIONS * conditions,int16_t nConditions,THRESHOLD_DIRECTION direction,uint32_t lower,uint32_t upper,PULSE_WIDTH_TYPE type

)

This function sets up pulse width qualification, which can be used on its own for pulsewidth triggering or combined with threshold triggering, level triggering or windowtriggering to produce more complex triggers. The pulse width qualifier is set bydefining one or more conditions structures that are then ORed together. Each structureis itself the AND of the states of one or more of the inputs. This AND-OR logic allowsyou to create any possible Boolean function of the scope's inputs.



conditions, a pointer to an array of PWQ_CONDITIONS structures

specifying the conditions that should be applied to each channel. Inthe simplest case, the array consists of a single element. When thereare several elements, the overall trigger condition is the logical OR ofall the elements. If conditions is set to null then the pulse width

qualifier is not used.

nConditions, the number of elements in the conditions array.

If nConditions is zero then the pulse width qualifier is not used.

direction, the direction of the signal required for the trigger to fire

lower, the lower limit of the pulse width counter

upper, the upper limit of the pulse width counter. This parameter is

used only when the type is set to PW_TYPE_IN_RANGE orPW_TYPE_OUT_OF_RANGE.

type, the pulse width type, one of these constants:

PW_TYPE_NONE (do not use the pulse width qualifier)

PW_TYPE_LESS_THAN (pulse width less than lower)

PW_TYPE_GREATER_THAN (pulse width greater than lower)

PW_TYPE_IN_RANGE (pulse width between lower and upper)

PW_TYPE_OUT_OF_RANGE (pulse width not between lower and

upper)

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_CONDITIONSPICO_PULSE_WIDTH_QUALIFIER

API functions80


5.51.1 PWQ_CONDITIONS structure

A structure of this type is passed to ps4000SetPulseWidthQualifier in the

conditions argument to specify the trigger conditions, and is defined as follows:

typedef struct tPwqConditions{

TRIGGER_STATE channelA;TRIGGER_STATE channelB;TRIGGER_STATE channelC;TRIGGER_STATE channelD;TRIGGER_STATE external;TRIGGER_STATE aux;

} PWQ_CONDITIONS

Each structure is the logical AND of the states of the scope's inputs. The ps4000SetPulseWidthQualifier function can OR together a number of these

structures to produce the final pulse width qualifier, which can be any possible Booleanfunction of the scope's inputs.

Elements channelA, channelB, channelC, channelD: the type of

condition that should be applied to each channel. Use these constants:CONDITION_DONT_CARECONDITION_TRUECONDITION_FALSE

The channels that are set to CONDITION_TRUE or CONDITION_FALSEmust all meet their conditions simultaneously to produce a trigger.Channels set to CONDITION_DONT_CARE are ignored.

external, aux: not used



5.52 ps4000SetSigGenArbitraryPICO_STATUS ps4000SetSigGenArbitrary(

int16_t handle,int32_t offsetVoltage,uint32_t pkToPk,uint32_t startDeltaPhase,uint32_t stopDeltaPhase,uint32_t deltaPhaseIncrement,uint32_t dwellCount,int16_t * arbitraryWaveform,int32_t arbitraryWaveformSize,SWEEP_TYPE sweepType,int16_t operationType,INDEX_MODE indexMode,uint32_t shots,uint32_t sweeps,SIGGEN_TRIG_TYPE triggerType,SIGGEN_TRIG_SOURCE triggerSource,int16_t extInThreshold

)

This function instructs the signal generator to produce an arbitrary waveform.

The arbitrary waveform generator (AWG) uses direct digital synthesis (DDS). Itmaintains a 32-bit phase accumulator that indicates the present location in thewaveform. The top bits of the phase accumulator are used as an index into a buffercontaining the arbitrary waveform. The remaining bits act as the fractional part of theindex, enabling high-resolution control of output frequency and allowing thegeneration of lower frequencies.

Applicability PicoScope 4226, 4227 and 4262 only

Arguments

handle, identifies the scope device

offsetVoltage, the voltage offset, in microvolts, to be applied to the waveform

pkToPk, the peak-to-peak voltage, in microvolts, of the waveform signal

startDeltaPhase, the initial value added to the phase counter as the generator

begins to step through the waveform buffer. Call ps4000SigGenFrequencyToPhaseto calculate this.

stopDeltaPhase, the final value added to the phase counter before the generator

restarts or reverses the sweep. When frequency sweeping is not required, set equalto startDeltaPhase. Call ps4000SigGenFrequencyToPhase to calculate this.

deltaPhaseIncrement, the amount added to the delta phase value every time

the dwellCount period expires. This determines the amount by which the generator

sweeps the output frequency in each dwell period. When frequency sweeping is notrequired, set to zero.

API functions82


dwellCount, the time, in multiples of dacPeriod, between successive additions of

deltaPhaseIncrement to the delta phase counter. This determines the rate at

which the generator sweeps the output frequency. Minimum allowable values are asfollows:

PicoScope 4226 and 4227: MIN_DWELL_COUNT (10)

PicoScope 4262: PS4262_MIN_DWELL_COUNT (3)

arbitraryWaveform, a pointer to a buffer that holds the waveform pattern as a

set of samples equally spaced in time. You can obtain the range of allowable valuesby calling ps4000SigGenArbitraryMinMaxValues. Sample value ranges are as

follows:PicoScope 4226 and 4227: [0, 4095]PicoScope 4262: [–32768, 32767]

arbitraryWaveformSize, the size of the arbitrary waveform buffer, in samples:

All models: Min: MIN_SIG_GEN_BUFFER_SIZE (1)

PicoScope 4226 and 4227: Max: MAX_SIG_GEN_BUFFER_SIZE (8192)

PicoScope 4262: Max: PS4262_MAX_WAVEFORM_BUFFER_SIZE (4096)

sweepType, determines whether the startDeltaPhase is swept up to the

stopDeltaPhase, or down to it, or repeatedly up and down. Use one of the

following values: UP, DOWN, UPDOWN, DOWNUP.

operationType, configures the white noise/PRBS (pseudo-random binary

sequence) generator:PS4000_OP_NONE: White noise/PRBS output disabled. The waveform is

defined by the other arguments.PS4000_WHITENOISE: The signal generator produces white noise and

ignores all settings except offsetVoltage andpkToPk

PS4000_PRBS: The signal generator produces a PRBS (PicoScope4262 only)

indexMode, specifies how the signal will be formed from the arbitrary waveform

data. SINGLE, DUAL and QUAD index modes are possible (see AWG index modes).

shots, the number of cycles of the waveform to be produced after a trigger event.

If this is set to a non-zero value [1, MAX_SWEEPS_SHOTS], then sweeps must be set

to zero.

sweeps, the number of times to sweep the frequency after a trigger event,

according to sweepType. If this is set to a non-zero value [1, MAX_SWEEPS_SHOTS],

then shots must be set to zero.

triggerType, the type of trigger that will be applied to the signal generator:SIGGEN_RISING: rising edgeSIGGEN_FALLING: falling edgeSIGGEN_GATE_HIGH: high level SIGGEN_GATE_LOW: low level

triggerSource, the source that will trigger the signal generator:SIGGEN_NONE: no trigger (free-running)SIGGEN_SCOPE_TRIG: the selected oscilloscope channel (see

ps4000SetSimpleTrigger)SIGGEN_EXT_IN: the EXT input



SIGGEN_SOFT_TRIG: a software trigger (see ps4000SigGenSoftwareControl)

If a trigger source other than SIGGEN_NONE is specified, then either shots or

sweeps, but not both, must be set to a non-zero value.

extInThreshold, an ADC count for use when the trigger source is

SIGGEN_EXT_IN. If the EXT input is also being used as the scope trigger then the

same ADC count must be specified in both places, otherwise a warning will be issued.Minimum and maximum 16-bit values correspond to the following voltages:

PicoScope 4226 & 4227: ±20 VPicoScope 4262: ±500 mV or ±5 V depending on range selected by

ps4000SetExtTriggerRange

Returns 0: if successful.Error code: if failed

API functions84


5.52.1 AWG index modes

The arbitrary waveform generator supports SINGLE, DUAL and QUAD index modes to

make the best use of the waveform buffer.

SINGLE mode. The generator outputs the raw

contents of the buffer repeatedly. This mode isthe only one that can generate asymmetricalwaveforms. You can also use this mode forsymmetrical waveforms, but the dual andquad modes make more efficient use of thebuffer memory.

DUAL mode. The generator outputs the

contents of the buffer from beginning to end,and then does a second pass in the reversedirection through the buffer. This allows youto specify only the first half of a waveformwith twofold symmetry, such as a Gaussianfunction, and let the generator fill in the otherhalf.

QUAD mode. The generator outputs the

contents of the buffer, then on its second passthrough the buffer outputs the same data inreverse order as in dual mode. On the thirdand fourth passes it does the same but with anegative version of the data. This allows youto specify only the first quarter of a waveformwith fourfold symmetry, such as a sine wave,and let the generator fill in the other threequarters.

5.52.2 Calculating deltaPhase

The AWG steps through the waveform by adding a deltaPhase value between 1 andphaseAccumulatorSize–1 to the phase accumulator every dacPeriod (1/dacFrequency).If the deltaPhase is constant, the AWG produces a waveform at a constant frequencythat can be calculated as follows:

where:

outputFrequency = repetition rate of the complete arbitrary waveformdacFrequency = update rate of AWG DAC (see table below)deltaPhase = calculated from startDeltaPhase and deltaPhaseIncrementphaseAccumulatorSize = maximum count of phase accumulator (see table below)awgBufferSize = maximum AWG buffer size (see table below)arbitraryWaveformSize = length in samples of the user-defined waveform

You can call ps4000SigGenFrequencyToPhase to calculate deltaPhase.



It is also possible to sweep the frequency by continually modifying the deltaPhase.This is done by setting up a deltaPhaseIncrement that the oscilloscope adds to thedeltaPhase at specified intervals.

Parameter PicoScope 4226/4227 PicoScope 4262

phaseAccumulatorSize 32 bits 32 bits

bufferAddressWidth 13 bits 12 bits

dacFrequency 20 MHz 192 kHz

dacPeriod (= 1/dacFrequency) 50 ns ≈ 5.208 µs

API functions86


5.53 ps4000SetSigGenBuiltInPICO_STATUS ps4000SetSigGenBuiltIn(

int16_t handle,int32_t offsetVoltage,uint32_t pkToPk,int16_t waveType,float startFrequency,float stopFrequency,float increment,float dwellTime,SWEEP_TYPE sweepType,int16_t operationType,uint32_t shots,uint32_t sweeps,SIGGEN_TRIG_TYPE triggerType,SIGGEN_TRIG_SOURCE triggerSource,int16_t extInThreshold

)

This function sets up the signal generator to produce a signal from a list of built-inwaveforms. If different start and stop frequencies are specified, the oscilloscope willsweep either up, down or up and down.

Applicability PicoScope 4226, 4227 and 4262 only


offsetVoltage, the voltage offset, in microvolts, to be applied to

the waveform

pkToPk, the peak-to-peak voltage, in microvolts, of the waveform

signal

waveType, the type of waveform to be generated by the

oscilloscope:

PS4000_SINE sine wavePS4000_SQUARE square wavePS4000_TRIANGLE triangle wavePS4000_RAMP_UP rising sawtoothPS4000_RAMP_DOWN falling sawtoothPS4000_SINC sin(x)/xPS4000_GAUSSIAN normal distributionPS4000_HALF_SINE full-wave rectified sinusoidPS4000_DC_VOLTAGE DC voltagePS4000_WHITE_NOISE random values

startFrequency, the frequency at which the signal generator

should begin. Range: MIN_SIG_GEN_FREQ to MAX_SIG_GEN_FREQ.

stopFrequency, the frequency at which the sweep should reverse

direction or return to the start frequency. Range: MIN_SIG_GEN_FREQ to MAX_SIG_GEN_FREQ.

increment, the amount by which the frequency rises or falls

every dwellTime seconds in sweep mode



dwellTime, the time in seconds between frequency changes in

sweep mode

sweepType,operationType,shots,sweeps,triggerType,triggerSource,extInThreshold: see ps4000SigGenArbitrary

Returns 0: if successful.Error code: if failed.

API functions88


5.54 ps4000SetSimpleTriggerPICO_STATUS ps4000SetSimpleTrigger(

int16_t handle,int16_t enable,PS4000_CHANNEL source,int16_t threshold,THRESHOLD_DIRECTION direction,uint32_t delay,int16_t autoTrigger_ms

)

This function simplifies arming the trigger. It supports only the LEVEL trigger typesand does not allow more than one channel to have a trigger applied to it. Any previouspulse width qualifier is canceled.



enabled, zero to disable the trigger, any non-zero value to set the

trigger

source, the channel on which to trigger

threshold, the ADC count at which the trigger will fire

direction, the direction in which the signal must move to cause a

trigger. The following directions are supported: ABOVE, BELOW,

RISING, FALLING and RISING_OR_FALLING.

delay, the time, in sample periods, between the trigger occurring

and the first sample being taken

autoTrigger_ms, the number of milliseconds the device will wait if

no trigger occurs

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_DRIVER_FUNCTION



5.55 ps4000SetTriggerChannelConditionsPICO_STATUS ps4000SetTriggerChannelConditions(

int16_t handle,TRIGGER_CONDITIONS * conditions,int16_t nConditions

)

This function sets up trigger conditions on the scope's inputs. The trigger is set up bydefining one or more TRIGGER_CONDITIONS structures that are then ORed together.Each structure is itself the AND of the states of one or more of the inputs. This AND-OR logic allows you to create any possible Boolean function of the scope's inputs.



conditions, a pointer to an array of TRIGGER_CONDITIONS

structures specifying the conditions that should be applied to eachchannel. In the simplest case, the array consists of a single element.When there are several elements, the overall trigger condition is thelogical OR of all the elements.

nConditions, the number of elements in the conditions array. If

nConditions is zero then triggering is switched off.

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_CONDITIONSPICO_MEMORY_FAIL

API functions90


5.55.1 TRIGGER_CONDITIONS structure

A structure of this type is passed to ps4000SetTriggerChannelConditions in the

conditions argument to specify the trigger conditions, and is defined as follows:

typedef struct tTriggerConditions{

TRIGGER_STATE channelA;TRIGGER_STATE channelB;TRIGGER_STATE channelC;TRIGGER_STATE channelD;TRIGGER_STATE external;TRIGGER_STATE aux;TRIGGER_STATE pulseWidthQualifier;

} TRIGGER_CONDITIONS

Each structure is the logical AND of the states of the scope's inputs. The ps4000SetTriggerChannelConditions function can OR together a number of

these structures to produce the final trigger condition, which can be any possibleBoolean function of the scope's inputs.

Elements channelA, channelB, channelC, channelD, external,pulseWidthQualifier: the type of condition that should be

applied to each channel. Use these constants:CONDITION_DONT_CARECONDITION_TRUECONDITION_FALSE

The channels that are set to CONDITION_TRUE or

CONDITION_FALSE must all meet their conditions simultaneously

to produce a trigger. Channels set to CONDITION_DONT_CARE are

ignored.

aux, not used



5.56 ps4000SetTriggerChannelDirectionsPICO_STATUS ps4000SetTriggerChannelDirections(

int16_t handle,THRESHOLD_DIRECTION channelA,THRESHOLD_DIRECTION channelB,THRESHOLD_DIRECTION channelC,THRESHOLD_DIRECTION channelD,THRESHOLD_DIRECTION ext,THRESHOLD_DIRECTION aux

)

This function sets the direction of the trigger for each channel.



channelA, channelB, channelC, channelD, ext all specify

the direction in which the signal must pass through the threshold toactivate the trigger. See the table below.

aux, not used

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_INVALID_PARAMETER

Trigger direction constants

Constant Type Direction

ABOVE gated above the upper threshold

ABOVE_LOWER gated above the lower threshold

BELOW gated below the upper threshold

BELOW_LOWER gated below the lower threshold

RISING threshold rising edge, using upper threshold

RISING_LOWER threshold rising edge, using lower threshold

FALLING threshold falling edge, using upper threshold

FALLING_LOWER threshold falling edge, using lower threshold

RISING_OR_FALLING threshold either edge

INSIDE window-qualified inside window

OUTSIDE window-qualified outside window

ENTER window entering the window

EXIT window leaving the window

ENTER_OR_EXIT window either entering or leaving the window

POSITIVE_RUNT window-qualified entering and leaving from below

NEGATIVE_RUNT window-qualified entering and leaving from above

NONE none none

API functions92


5.57 ps4000SetTriggerChannelPropertiesPICO_STATUS ps4000SetTriggerChannelProperties(

int16_t handle,TRIGGER_CHANNEL_PROPERTIES * channelPropertiesint16_t nChannelPropertiesint16_t auxOutputEnable,int32_t autoTriggerMilliseconds

)

This function is used to enable or disable triggering and set its parameters.



channelProperties, a pointer to an array of

TRIGGER_CHANNEL_PROPERTIES structures describing the requested

properties. The array can contain a single element describing theproperties of one channel, or a number of elements describing severalchannels. If null is passed, triggering is switched off.

nChannelProperties, the size of the channelProperties array.

If zero, triggering is switched off.

auxOutputEnable, not used

autoTriggerMilliseconds, the time in milliseconds for which the

scope device will wait before collecting data if no trigger event occurs.If this is set to zero, the scope device will wait indefinitely for atrigger.

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACKPICO_TRIGGER_ERRORPICO_MEMORY_FAILPICO_INVALID_TRIGGER_PROPERTY



5.57.1 TRIGGER_CHANNEL_PROPERTIES structure

A structure of this type is passed to ps4000SetTriggerChannelProperties in the

channelProperties argument to specify the trigger mechanism, and is defined as

follows:

typedef struct tTriggerChannelProperties{

int16_t thresholdUpper;uint16_t thresholdUpperHysteresis;int16_t thresholdLower;uint16_t thresholdLowerHysteresis;PS4000_CHANNEL channel;THRESHOLD_MODE thresholdMode;

} TRIGGER_CHANNEL_PROPERTIES

Elements thresholdUpper, the upper threshold at which the trigger must

fire. This is scaled in 16-bit ADC counts at the currently selected rangefor that channel.

thresholdUpperHysteresis, the hysteresis by which the trigger

must exceed the upper threshold before it will fire. It is scaled in 16-bit counts.

thresholdLower, the lower threshold at which the trigger must

fire. This is scaled in 16-bit ADC counts at the currently selected rangefor that channel.

thresholdLowerHysteresis, the hysteresis by which the trigger

must exceed the lower threshold before it will fire. It is scaled in 16-bit counts.

channel, the channel to which the properties apply. See

ps4000SetChannel for possible values.

thresholdMode, either a level or window trigger. Use one of these

constants:LEVELWINDOW

API functions94


5.58 ps4000SetTriggerDelayPICO_STATUS ps4000SetTriggerDelay(

int16_t handle,uint32_t delay

)

This function sets the post-trigger delay, which causes capture to start a defined timeafter the trigger event.

Applicability Block mode and rapid block mode only


delay, the time between the trigger occurring and the first sample,

in sample periods. For example, if delay = 100 then the scope would

wait 100 sample periods before sampling. Example: with thePicoScope 4224, at a timebase of 80 MS/s, or 12.5 ns per sample(timebase = 0) the total delay would then be 100 x 12.5 ns =

1.25 µs.

Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACK



5.59 ps4000SigGenArbitraryMinMaxValuesPICO_STATUS ps4000SigGenArbitraryMinMaxValues(

int16_t handle,int16_t * minArbitraryWaveformValue,int16_t * maxArbitraryWaveformValue,uint32_t * minArbitraryWaveformSize,uint32_t * maxArbitraryWaveformSize

)

This function returns the range of possible sample values and waveform buffer sizesthat can be supplied to ps4000SetSigGenArbitrary for setting up the arbitrary

waveform generator (AWG). These values may vary between different models.

Applicability All models with AWG


minArbitraryWaveformValue, on exit, the lowest sample value

allowed in the arbitraryWaveform buffer supplied tops4000SetSigGenArbitrary

maxArbitraryWaveformValue, on exit, the highest sample value

allowed in the arbitraryWaveform buffer supplied tops4000SetSigGenArbitrary

minArbitraryWaveformSize, on exit, the minimum value

allowed for the arbitraryWaveformSize argument supplied tops4000SetSigGenArbitrary

maxArbitraryWaveformSize, on exit, the maximum value

allowed for the arbitraryWaveformSize argument supplied tops4000SetSigGenArbitrary

Returns PICO_OKPICO_NOT_SUPPORTED_BY_THIS_DEVICE, if the device does not

have an arbitrary waveform generator.PICO_NULL_PARAMETER, if all the parameter pointers are NULL.PICO_INVALID_HANDLEPICO_DRIVER_FUNCTION

API functions96


5.60 ps4000SigGenFrequencyToPhasePICO_STATUS ps4000SigGenFrequencyToPhase(

int16_t handle,double frequency,PS4000_INDEX_MODE indexMode,uint32_t bufferLength,uint32_t * phase

)

This function converts a frequency to a phase count for use with the arbitrarywaveform generator (AWG). The value returned depends on the length of the buffer,the index mode passed and the device model. The phase count can then be sent to thedriver through ps4000SetSigGenArbitrary.

Applicability All models with AWG


frequency, the required AWG output frequency

indexMode, see AWG index modes

bufferLength, the number of samples in the AWG buffer

phase, on exit, the deltaPhase argument to be sent to the AWG

setup function

Returns PICO_OKPICO_NOT_SUPPORTED_BY_THIS_DEVICE, if the device does not

have an AWG.PICO_SIGGEN_FREQUENCY_OUT_OF_RANGE, if the frequency is out

of range.PICO_NULL_PARAMETER, if phase is a NULL pointer.

PICO_SIG_GEN_PARAM, if indexMode or bufferLength is out of

range.PICO_INVALID_HANDLEPICO_DRIVER_FUNCTION



5.61 ps4000SigGenSoftwareControlPICO_STATUS ps4000SigGenSoftwareControl(

int16_t handle,int16_t state

)

This function causes a trigger event, or starts and stops gating. It is used when thesignal generator is set to SIGGEN_SOFT_TRIG .

Applicability Use with ps4000SetSigGenBuiltIn or

ps4000SetSigGenArbitrary.


state, sets the trigger gate high or low when the trigger type is

set to either SIGGEN_GATE_HIGH or SIGGEN_GATE_LOW. Ignored

for other trigger types.

Returns PICO_OKPICO_INVALID_HANDLEPICO_NO_SIGNAL_GENERATOR PICO_SIGGEN_TRIGGER_SOURCE

API functions98


5.62 ps4000StopPICO_STATUS ps4000Stop(

int16_t handle)

This function stops the scope device from sampling data. If this function is calledbefore a trigger event occurs, the oscilloscope may not contain valid data.

When running the device in streaming mode, you should always call this function afterthe end of a capture to ensure that the scope is ready for the next capture.



Returns PICO_OKPICO_INVALID_HANDLEPICO_USER_CALLBACK



5.63 ps4000StreamingReadytypedef void (CALLBACK *ps4000StreamingReady)(

int16_t handle,int32_t noOfSamples,uint32_t startIndex,int16_t overflow,uint32_t triggerAt,int16_t triggered,int16_t autoStop,void * pParameter

)

This callback function is part of your application. You register it with the PicoScope4000 Series driver using ps4000GetStreamingLatestValues, and the driver calls it

back when streaming-mode data is ready. You can then download the data using the ps4000GetValuesAsync function. Your callback function should do nothing more

than copy the data to another buffer within your application. To maintain the bestapplication performance, the function should return as quickly as possible withoutattempting to process or display the data.



noOfSamples, the number of samples to collect

startIndex, an index to the first valid sample in the buffer. This is

the buffer that was previously passed to ps4000SetDataBuffer or

ps4000SetDataBuffers.

overflow, returns a set of flags that indicate whether an

overvoltage has occurred on any of the channels. It is a bit patternwith bit 0 corresponding to Channel A and so on.

triggerAt, an index to the buffer indicating the location of the

trigger point relative to startIndex. This parameter is valid only

when triggered is non-zero.

triggered, a flag indicating whether a trigger occurred. If non-

zero, a trigger occurred at the location indicated by triggerAt.

autoStop, the flag that was set in the call tops4000RunStreaming

pParameter, a void pointer passed from

ps4000GetStreamingLatestValues. The callback function can

write to this location to send any data, such as a status flag, back tothe application.

Returns nothing

API functions100


5.64 Wrapper functionsThe Software Development Kits (SDKs) for PicoScope devices contain wrapper dynamiclink library (DLL) files in the lib subdirectory of your SDK installation for 32-bit and

64-bit systems. The wrapper functions provided by the wrapper DLLs are for use withprogramming languages such as MathWorks MATLAB, National Instruments LabVIEWand Microsoft Excel VBA that do not support features of the C programming languagesuch as callback functions.

The source code contained in the Wrapper projects contains a description of thefunctions and the input and output parameters.

Below we explain the sequence of calls required to capture data in streaming modeusing the wrapper API functions.

The ps4000Wrap.dll wrapper DLL has a callback function for streaming data

collection that copies data from the driver buffer specified to a temporary applicationbuffer of the same size. To do this, the driver and application buffers must beregistered with the wrapper and the corresponding channel(s) must be specified asbeing enabled. You should process the data in the temporary application bufferaccordingly, for example by copying the data into a large array.

Procedure:


1a. Inform the wrapper of the number of channels on the device by calling setChannelCount.

2. Select channels, ranges and AC/DC coupling using ps4000SetChannel.

2a. Inform the wrapper which channels have been enabled by calling setEnabledChannels.

3. Use the appropriate trigger setup functions. For programming languages that do notsupport structures, use the wrapper's advanced trigger setup functions.

4. Call ps4000SetDataBuffer (or for aggregated data collection

ps4000SetDataBuffers) to tell the driver where your data buffer(s) is(are).

4a. Register the data buffer(s) with the wrapper and set the application buffer(s) intowhich the data will be copied. Call setAppAndDriverBuffers (or

setMaxMinAppAndDriverBuffers for aggregated data collection).

5. Start the oscilloscope running using ps4000RunStreaming.

6. Loop and call GetStreamingLatestValues and IsReady to get data and flag

when the wrapper is ready for data to be retrieved.

6a. Call the wrapper’s AvailableData function to obtain information on the number

of samples collected and the start index in the buffer.

6b. Call the wrapper’s IsTriggerReady function for information on whether a trigger

has occurred and the trigger index relative to the start index in the buffer.

7. Process data returned to your application data buffers.

8. Call AutoStopped if the autoStop parameter has been set to TRUE in the call to

ps4000RunStreaming.



9. Repeat steps 6 to 8 until AutoStopped returns true or you wish to stop data

collection.

10. Call ps4000Stop, even if the autoStop parameter has been set to TRUE.

11. To disconnect a device, call ps4000CloseUnit.

Further information102


6 Further information6.1 Programming examples

Your SDK installation includes programming examples in several languages anddevelopment environments. Please refer to the SDK for details.

6.2 Driver status codesEvery function in the ps4000.dll driver returns a driver status code from the list

of PICO_STATUS values in the PicoStatus.h header file, which is included in the

inc subdirectory of the Pico Technology SDK.

6.3 Enumerated types and constantsEnumerated types and constants are defined in the file ps4000Api.h, which is

included in the inc subdirectory of your Pico Technology SDK installation. We

recommend that you refer to these constants by name unless your programminglanguage allows only numerical values.

6.4 Numeric data typesHere is a list of the sizes and ranges of the numeric data types used in the PicoScope4000 Series API.

Type Bits Signed or unsigned?int16_t 16 signedenum 32 enumeratedint32_t 32 signeduint32_t 32 unsignedfloat 32 signed (IEEE 754)int64_t 64 signeduint64_t 64 unsigned



7 GlossaryADC. Analog-to-digital converter. The electronic component in a PC oscilloscope thatconverts analog signals from the inputs into digital data suitable for transmission tothe PC.

Aggregation. The PicoScope 4000 driver can use this method to reduce the amountof data your application needs to process. This means that for every block ofconsecutive samples, it stores only the minimum and maximum values. You can setthe number of samples in each block, called the aggregation parameter, when you call PS4000RunStreaming for real-time capture, and when you call

ps4000GetStreamingLatestValues to obtain post-processed data.

Block mode. A sampling mode in which the computer prompts the oscilloscope tocollect a block of data into its internal memory before stopping the oscilloscope andtransferring the whole block into computer memory. Choose this mode of operationwhen the input signal being sampled contains high frequencies. Note: To avoidsampling errors, the maximum input frequency must be less than half the samplingrate.

Buffer size. The size of the oscilloscope buffer memory, measured in samples. Thebuffer allows the oscilloscope to sample data faster than it can transfer it to thecomputer.

Callback. A mechanism that the PicoScope 4000 driver uses to communicateasynchronously with your application. At design time, you add a function (a callbackfunction) to your application to deal with captured data. At run time, when you requestcaptured data from the driver, you also pass it a pointer to your function. The driverthen returns control to your application, allowing it to perform other tasks until thedata is ready. When this happens, the driver calls your function in a new thread tosignal that the data is ready. It is then up to your function to communicate this fact tothe rest of your application.

Coupling mode. This mode selects either AC or DC coupling in the oscilloscope's inputpath. Use AC mode for small signals that may be superimposed on a DC level. Use DCmode for measuring absolute voltage levels. Set the coupling mode using ps4000SetChannel.

Driver. A program that controls a piece of hardware. The driver for the PicoScope4000 Series PC Oscilloscopes is supplied in the form of a 32-bit or 64-bit WindowsDLL, ps4000.dll. This is used by the PicoScope software, and by user-designed

applications, to control the oscilloscopes.

ETS. Equivalent-time sampling. A technique for increasing the effective sampling rateof an oscilloscope beyond the maximum sampling rate of its ADC. The scope triggerson successive cycles of a repetitive waveform and collects one sample from each cycle.Each sample is delayed relative to the trigger by a time that increases with each cycle,so that after a number of cycles a complete period of the waveform has been sampled.The waveform must be stable and repetitive for this method to work.

GS/s. Gigasamples per second. A gigasample is equal to one billion samples.

IEPE. Integrated Electronics Piezoelectric. A standard for accelerometers and otherpiezoelectric sensors that require an external power supply. Special IEPE-enabledPicoScope 4000 Series scopes have a phantom-powered input that supports thesesensors.

Glossary104


Maximum sampling rate. A figure indicating the maximum number of samples theoscilloscope can acquire per second. The higher the sampling rate of the oscilloscope,the more accurate the representation of the high-frequency details in a fast signal.

MS/s. Megasamples per second. A megasample is equal to one million samples.

Oversampling. Oversampling is taking measurements more frequently than therequested sample rate, and then combining them to produce the required number ofsamples. If, as is usually the case, the signal contains a small amount of noise, thistechnique can increase the effective vertical resolution of the oscilloscope.

PC Oscilloscope. A virtual instrument consisting of a PicoScope oscilloscope unit anda software application.

PicoScope 4000 Series. A range of high-resolution PC Oscilloscopes from PicoTechnology. The range includes two-channel and four-channel models, with or withouta built-in function generator and arbitrary waveform generator.

Streaming mode. A sampling mode in which the oscilloscope samples data andreturns it to the computer in an unbroken stream. This mode allows the capture ofdata sets whose size is not limited by the size of the scope's memory buffer, atsampling rates up to 6.6 million samples per second.

Timebase. The sampling rate that the scope uses to acquire data. The timebase canbe set to any value returned by the ps4000GetTimebase or ps4000GetTimebase2functions.

Trigger bandwidth. The external trigger input is less sensitive to very high-frequencyinput signals than to low-frequency signals. The trigger bandwidth is the frequency atwhich a trigger signal will be attenuated by 3 decibels.

USB 1.1. Universal Serial Bus (Full Speed). This is a standard port used to connectexternal devices to PCs. A typical USB 1.1 port supports a data transfer rate of 12megabits per second, so is much faster than an RS232 COM port.

USB 2.0. Universal Serial Bus (High Speed). This is a standard port used to connectexternal devices to PCs. A typical USB 2.0 port supports a data transfer rate 40 timesfaster than USB 1.1 when used with a USB 2.0 device, but can also be used with USB1.1 devices.

USB 3.0. A faster version of the Universal Serial Bus standard. Your PicoScope is fullycompatible with USB 3.0 ports and will operate with the same performance as on aUSB 2.0 port.

Vertical resolution. A value, in bits, indicating the precision with which theoscilloscope converts input voltages to digital values. Oversampling (see above) canimprove the effective vertical resolution.

Voltage range. The range of input voltages that the oscilloscope can measure. Forexample, a voltage range of ±100 mV means that the oscilloscope can measurevoltages between –100 mV and +100 mV. Input voltages outside this range will notdamage the instrument as long as they remain within the protection limits of ±200 V.



Index

AAC/DC control 103

AC/DC coupling 5

setting 67

ADC 103

Aggregation 15, 103

getting ratio 27

Analog-to-digital converter 103

API function calls 19

Arbitrary waveform generator 81

index modes 84

AWG 81

AWG index modes 84

BBandwidth-limiting filter 66

Block mode 5, 8, 8, 9, 21, 103

polling status 50

starting 60

Buffer size 103

Buffers

overrun 4

CCallback 103

Callback function

block mode 21

streaming mode 23, 99

Channel information, reading 26

Channel selection 5

settings 67

Closing a scope device 22

CONDITION_ constants 80, 90

Constants 102

Coupling mode 103

DData acquisition 15

Data buffers, setting 69, 70, 71, 72, 73

Disk space 2

Driver 3, 103

status codes 102

EEnumerated types 102

Enumerating oscilloscopes 24

ETS 103

overview (API) 14

setting time buffers 75, 76

setting up 74

using (API) 15

FFilter, bandwidth-limiting 66

Function calls 19

Functions

ps4000BlockReady 21

ps4000CloseUnit 22

ps4000DataReady 23

ps4000EnumerateUnits 24

ps4000FlashLed 25

ps4000GetChannelInformation 26

ps4000GetMaxDownSampleRatio 27

ps4000GetNoOfCaptures 28

ps4000GetStreamingLatestValues 29

ps4000GetTimebase 30

ps4000GetTimebase2 31

ps4000GetTriggerChannelTimeOffset 32

ps4000GetTriggerChannelTimeOffset64 34

ps4000GetTriggerTimeOffset 35

ps4000GetTriggerTimeOffset64 37

ps4000GetUnitInfo 38

ps4000GetValues 39

ps4000GetValuesAsync 41

ps4000GetValuesBulk 42

ps4000GetValuesTriggerChannelTimeOffsetBulk 43

ps4000GetValuesTriggerTimeOffsetBulk 45

ps4000GetValuesTriggerTimeOffsetBulk64 44, 47

ps4000HoldOff 48

ps4000IsLedFlashing 49

ps4000IsReady 50

ps4000IsTriggerOrPulseWidthQualifierEnabled 51

ps4000MemorySegments 52

ps4000NoOfStreamingValues 53

ps4000OpenUnit 54

ps4000OpenUnitAsync 55

ps4000OpenUnitAsyncEx 56

ps4000OpenUnitEx 57

ps4000OpenUnitProgress 58

ps4000PingUnit 59

ps4000RunBlock 60

ps4000RunStreaming 62

ps4000RunStreamingEx 64

ps4000SetBwFilter 66

Index106


Functions

ps4000SetChannel 67

ps4000SetDataBuffer 69

ps4000SetDataBufferBulk 70

ps4000SetDataBuffers 71

ps4000SetDataBuffersWithMode 72

ps4000SetDataBufferWithMode 73

ps4000SetEts 74

ps4000SetEtsTimeBuffer 75

ps4000SetEtsTimeBuffers 76

ps4000SetExtTriggerRange 77

ps4000SetNoOfCaptures 78

ps4000SetPulseWidthQualifier 79

ps4000SetSigGenArbitrary 81

ps4000SetSigGenBuiltIn 86

ps4000SetSimpleTrigger 88

ps4000SetTriggerChannelConditions 89

ps4000SetTriggerChannelDirections 91

ps4000SetTriggerChannelProperties 92

ps4000SetTriggerDelay 94

ps4000SigGenArbitraryMinMaxValues 95

ps4000SigGenFrequencyToPhase 96

ps4000SigGenSoftwareControl 97

ps4000Stop 98

ps4000StreamingReady 99

HHold-off 48

Hysteresis 93

IIEPE 103

IEPE mode 67

LLED

programming 25, 49

LEVEL constant 93

MMaximum sampling rate 104

Memory in scope 8

Memory segments 52

Multi-unit operation 18

OOne-shot signals 14

Opening a unit 54, 55, 56, 57, 58

Operating system 2

Oversampling 6, 104

PPC Oscilloscope 104

PICO_STATUS enum type 102

picopp.inf 3

picopp.sys 3

PicoScope 4000 Series 1, 104

PicoScope software 3

Processor 2

PS4000_CHANNEL_A 67

PS4000_CHANNEL_B 67

PS4000_LOST_DATA 4

PS4000_MAX_VALUE 4

PS4000_MIN_VALUE 4

PS4262_MAX_VALUE 4

PS4262_MIN_VALUE 4

Pulse width trigger 79

PWQ_CONDITIONS structure 80

RRapid block mode 10, 10

Resolution, vertical 6

Retrieving data 39, 41

stored (API) 17

streaming mode 29

SSampling rate

maximum 8

Scaling 4

Serial numbers 24

Signal generator 9

arbitrary waveforms 81

built-in waveforms 86

software trigger 97

Skew, timing 32, 34, 43, 44

Software license conditions 1

Status codes 102

Stopping sampling 98

Streaming mode 8, 15, 104

getting number of values 53

retrieving data 29

starting 62, 64

using (API) 16

Synchronising units 18

System memory 2

System requirements 2



TThreshold voltage 5

Time buffers

setting for ETS 75, 76

Timebase 7, 104

setting 30, 31

Trademarks 2

Trigger 5

conditions 89, 90

delay 94

directions 91

external 4

pulse width qualifier 51, 79

pulse width qualifier conditions 80

setting up 88

time offset 32, 34, 35, 37

Trigger bandwidth 104

TRIGGER_CHANNEL_PROPERTIES structure 93

TRIGGER_CONDITIONS structure 90

UUSB 2

hub 18

VVertical resolution 6, 104

Voltage range 104

Voltage ranges 4

WWINDOW constant 93

Windows, Microsoft 2

United Kingdom headquarters

Pico TechnologyJames HouseColmworth Business ParkSt. NeotsCambridgeshirePE19 8YPUnited Kingdom

Tel: +44 (0) 1480 396 395Fax: +44 (0) 1480 396 296

[email protected]@picotech.com

www.picotech.com

Copyright © 2008–2016 Pico Technology Ltd. All rights reserved.

ps4000pg.en r9 2016-06-29

United States headquarters

Pico Technology320 N Glenwood BlvdTylerTexas 75702United States of America

Tel: +1 800 591 2796Fax: +1 620 272 0981

Documents

PC Oscilloscopes Programmer's Guide - Pico … application will communicate with a PicoScope 4000 API driver called ps4000.dll, which is supplied in 32-bit and 64-bit versions. The