User manual

PicoScope 6000 Series Programmer's Guide 21
Copyright © 2009-2013 Pico Technology Ltd. All rights reserved. ps6000pg.en r9
3.9
API functions
The PicoScope 6000 Series API exports the following functions for you to use in your
own applications. All functions are C functions using the standard call naming
convention (__stdcall). They are all exported with both decorated and undecorated
names.
ps6000BlockReady
indicate when block-mode data ready
ps6000CloseUnit
close a scope device
ps6000DataReady
indicate when post-collection data ready
ps6000EnumerateUnits
find all connected oscilloscopes
ps6000FlashLed
flash the front-panel LED
ps6000GetAnalogueOffset
get min/max allowable analogue offset
ps6000GetMaxDownSampleRatio
find out aggregation ratio for data
ps6000GetStreamingLatestValues
get streaming data while scope is running
ps6000GetTimebase
find out what timebases are available
ps6000GetTimebase2
find out what timebases are available
ps6000GetTriggerTimeOffset
find out when trigger occurred (32-bit)
ps6000GetTriggerTimeOffset64
find out when trigger occurred (64-bit)
ps6000GetUnitInfo
read information about scope device
ps6000GetValues
get block-mode data with callback
ps6000GetValuesAsync
get streaming data with callback
ps6000GetValuesBulk
get data in rapid block mode
ps6000GetValuesBulkAsync
get data in rapid block mode using callback
ps6000GetValuesOverlapped
set up data collection ahead of capture
ps6000GetValuesOverlappedBulk
set up data collection in rapid block mode
ps6000GetValuesTriggerTimeOffsetBulk
get rapid-block waveform timings (32-bit)
ps6000GetValuesTriggerTimeOffsetBulk64
get rapid-block waveform timings (64-bit)
ps6000IsReady
poll driver in block mode
ps6000IsTriggerOrPulseWidthQualifierEnabled
find out whether trigger is enabled
ps6000MemorySegments
divide scope memory into segments
ps6000NoOfStreamingValues
get number of samples in streaming mode
ps6000OpenUnit
open a scope device
ps6000OpenUnitAsync
open a scope device without waiting
ps6000OpenUnitProgress
check progress of OpenUnit call
ps6000RunBlock
start block mode
ps6000RunStreaming
start streaming mode
ps6000SetChannel
set up input channels
ps6000SetDataBuffer
register data buffer with driver
ps6000SetDataBufferBulk
set the buffers for each waveform
ps6000SetDataBuffers
register aggregated data buffers with driver
ps6000SetDataBuffersBulk
register data buffers for rapid block mode
ps6000SetEts
set up equivalent-time sampling
ps6000SetEtsTimeBuffer
set up buffer for ETS timings (64-bit)
ps6000SetEtsTimeBuffers
set up buffer for ETS timings (32-bit)
ps6000SetExternalClock
set AUX input to receive external clock
ps6000SetNoOfCaptures
set number of captures to collect in one run
ps6000SetPulseWidthQualifier
set up pulse width triggering
ps6000SetSigGenArbitrary
set up arbitrary waveform generator
ps6000SetSigGenBuiltIn
set up standard signal generator
ps6000SetSimpleTrigger
set up level triggers only
ps6000SetTriggerChannelConditions
specify which channels to trigger on
ps6000SetTriggerChannelDirections
set up signal polarities for triggering
ps6000SetTriggerChannelProperties
set up trigger thresholds
ps6000SetTriggerDelay
set up post-trigger delay
ps6000SigGenSoftwareControl
trigger the signal generator
ps6000Stop
stop data capture
ps6000StreamingReady
indicate when streaming-mode data ready