NXP Reader Library  v17.1.0.2535
Component : Ps6000Usb

BAL-Component for the PicoScope PS6000 USB Oscilloscope. More...

Collaboration diagram for Component : Ps6000Usb:

Data Structures

struct  phbalReg_Ps6000Usb_DataParams_t
 PS6000USB BAL parameter structure. More...
 

Macros

#define PHBAL_REG_PS6000USB_ID   0x04U
 ID for Ps6000Usb BAL component.
 

Functions

phStatus_t phbalReg_Ps6000Usb_Init (phbalReg_Ps6000Usb_DataParams_t *pDataParams, uint16_t wSizeOfDataParams)
 Initialise the PS6000USB BAL component. More...
 

Custom Configs

#define PHBAL_REG_PS6000USB_ADDITIONAL_INFO   (PH_CONFIG_CUSTOM_BEGIN + 0)
 Set / Get additional information .
 

Function pointers

typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_OPEN_UNIT) (int16_t *pwHandle, int8_t *pSerial)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_OPEN_UNIT_ASYNC) (int16_t *pwStatus, int8_t *pSerial)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_OPEN_UNIT_PROGRESS) (int16_t *pwHandle, int16_t *pwProgressPercent, int16_t *pwComplete)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_UNIT_INFO) (int16_t wHandle, int8_t *pString, int16_t wStringLength, int16_t *pwRequiredSize, uint32_t dwInfo)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_FLASH_LED) (int16_t wHandle, int16_t wStart)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_CLOSE_UNIT) (int16_t wHandle)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_MEMORY_SEGMENTS) (int16_t wHandle, uint32_t dwNSegments, uint32_t *pdwNMaxSamples)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_CHANNEL) (int16_t wHandle, uint32_t dwChannel, int16_t wEnabled, uint32_t dwType, uint32_t dwRange, int32_t dwAnalogueOffset, uint32_t dwBandwidth)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_TIMEBASE) (int16_t wHandle, uint32_t dwTimebase, uint32_t dwNoSamples, int32_t *pdwTimeIntervalNanoseconds, int16_t wOversample, uint32_t *pdwMaxSamples, uint32_t dwSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_TIMEBASE2) (int16_t wHandle, uint32_t dwTimebase, uint32_t dwNoSamples, int32_t *pdwTimeIntervalNanoseconds, int16_t wOversample, uint32_t *pdwMaxSamples, uint32_t dwSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_SIG_GEN_ARBITRARY) (int16_t wHandle, int32_t dwOffsetVoltage, uint32_t dwPkToPk, uint32_t dwStartDeltaPhase, uint32_t dwStopDeltaPhase, uint32_t dwDeltaPhaseIncrement, uint32_t dwDwellCount, int16_t *pwArbitraryWaveform, int32_t dwArbitraryWaveformSize, uint32_t dwSweepType, uint32_t dwOperation, uint32_t dwIndexMode, uint32_t dwShots, uint32_t dwSweeps, uint32_t dwTriggerType, uint32_t dwTriggerSource, int16_t wExtInThreshold)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_SIG_GEN_BUILT_IN) (int16_t wHandle, int32_t dwOffsetVoltage, uint32_t dwPkToPk, int16_t wWavetype, int32_t dwStartFrequency, int32_t dwStopFrequency, int32_t dwIncrement, int32_t dwDwellTime, uint32_t dwSweepType, uint32_t dwOperation, uint32_t dwShots, uint32_t dwSweeps, uint32_t dwTriggerType, uint32_t dwTriggerSource, int16_t wExtInThreshold)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SIG_GEN_SOFTWARE_CONTROL) (int16_t wHandle, int16_t wState)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_SIMPLE_TRIGGER) (int16_t wHandle, int16_t wEnable, uint32_t dwSource, int16_t wThreshold, uint32_t dwDirection, uint32_t dwDelay, int16_t wAutoTrigger_ms)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_ETS) (int16_t wHandle, uint32_t dwMode, int16_t wEtsCycles, int16_t wEtsInterleave, int32_t *pdwSampleTimePicoseconds)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_TRIGGER_CHANNEL_PROPERTIES) (int16_t wHandle, uint32_t *pdwChannelProperties, int16_t wNChannelProperties, int16_t wAuxOutputEnable, int32_t dwAutoTriggerMilliseconds)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_TRIGGER_CHANNEL_CONDITIONS) (int16_t wHandle, uint32_t *pdwConditions, uint16_t wNConditions)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_TRIGGER_CHANNEL_DIRECTIONS) (int16_t wHandle, uint32_t dwChannelA, uint32_t dwChannelB, uint32_t dwChannelC, uint32_t dwChannelD, uint32_t dwExt, uint32_t dwAux)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_TRIGGER_DELAY) (int16_t wHandle, uint32_t dwDelay)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_PULSE_WIDTH_QUALIFIER) (int16_t wHandle, uint32_t *pdwConditions, int16_t wNConditions, uint32_t dwDirection, uint32_t dwLower, uint32_t dwUpper, uint32_t dwType)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_IS_TRIGGER_OR_PULSE_WIDTH_QUALIFIER_ENABLED) (int16_t wHandle, int16_t *pwTriggerEnabled, int16_t *pwPulseWidthQualifierEnabled)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_TRIGGER_TIME_OFFSET) (int16_t wHandle, uint32_t *pdwTimeUpper, uint32_t *pdwTimeLower, uint32_t *pdwTimeUnits, uint32_t dwSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_TRIGGER_TIME_OFFSET64) (int16_t wHandle, uint64_t *pqwTime, uint32_t *pdwTimeUnits, uint32_t dwSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_TRIGGER_TIME_OFFSET_BULK) (int16_t wHandle, uint32_t *pdwTimesUpper, uint32_t *pdwTimesLower, uint32_t *pdwTimeUnits, uint32_t dwFromSegmentIndex, uint32_t dwToSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_TRIGGER_TIME_OFFSET_BULK64) (int16_t wHandle, uint64_t *pqwTimes, uint32_t *pdwTimeUnits, uint32_t *pdwFromSegmentIndex, uint32_t *pdwToSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_DATA_BUFFERS) (int16_t wHandle, uint32_t dwChannel, int16_t *pwBufferMax, int16_t *pwBufferMin, uint32_t dwBufferLth, uint32_t dwDownSampleRatioMode)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_DATA_BUFFER) (int16_t wHandle, uint32_t dwChannel, int16_t *pwBuffer, uint32_t dwBufferLth, uint32_t dwDownSampleRatioMode)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_DATA_BUFFER_BULK) (int16_t wHandle, uint32_t dwChannel, int16_t *pwBuffer, uint32_t dwBufferLth, uint32_t dwWaveform, uint32_t dwDownSampleRatioMode)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_DATA_BUFFERS_BULK) (int16_t wHandle, uint32_t dwChannel, int16_t *pwBufferMax, int16_t *pwBufferMin, uint32_t dwBufferLth, uint32_t dwWaveform, uint32_t dwDownSampleRatioMode)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_ETS_TIME_BUFFER) (int16_t wHandle, uint64_t *pqwBuffer, uint32_t dwBufferLth)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_ETS_TIME_BUFFERS) (int16_t wHandle, uint32_t *pdwTimeUpper, uint32_t *pdwTimeLower, uint32_t dwBufferLth)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_RUN_BLOCK) (int16_t wHandle, uint32_t dwNoOfPreTriggerSamples, uint32_t dwNoOfPostTriggerSamples, uint32_t dwTimebase, int16_t wOversample, int32_t *pdwTimeIndisposedMs, uint32_t dwSegmentIndex, uint32_t dwLpReady, void *pParameter)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_IS_READY) (int16_t wHandle, int16_t *pwReady)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_RUN_STREAMING) (int16_t wHandle, uint32_t *pdwSampleInterval, uint32_t dwSampleIntervalTimeUnits, uint32_t dwMaxPreTriggerSamples, uint32_t dwMaxPostTriggerSamples, int16_t wAutoStop, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwOverviewBufferSize)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_STREAMING_LATEST_VALUES) (int16_t wHandle, void *pLpPs6000Ready, void *pParameter)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_NO_OF_STREAMING_VALUES) (int16_t wHandle, uint32_t *pdwNoOfValues)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_MAX_DOWN_SAMPLE_RATIO) (int16_t wHandle, uint32_t dwNoOfUnaggregatedSamples, uint32_t *pdwMaxDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwSegmentIndex)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES) (int16_t wHandle, uint32_t dwStartIndex, uint32_t *pdwNoOfSamples, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwSegmentIndex, int16_t *pwOverflow)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_BULK) (int16_t wHandle, uint32_t *pdwNoOfSamples, uint32_t dwFromSegmentIndex, uint32_t dwToSegmentIndex, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, int16_t *pwOverflow)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_ASYNC) (int16_t wHandle, uint32_t dwStartIndex, uint32_t dwNoOfSamples, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwSegmentIndex, void *pLpDataReady, void *pParameter)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_OVERLAPPED) (int16_t wHandle, uint32_t dwStartIndex, uint32_t *pdwNoOfSamples, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwSegmentIndex, int16_t *pwOverflow)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_OVERLAPPED_BULK) (int16_t wHandle, uint32_t dwStartIndex, uint32_t *pdwNoOfSamples, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwFromSegmentIndex, uint32_t dwToSegmentIndex, int16_t *pwOverflow)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_VALUES_BULK_ASYNC) (int16_t wHandle, uint32_t dwStartIndex, uint32_t *pdwNoOfSamples, uint32_t dwDownSampleRatio, uint32_t dwDownSampleRatioMode, uint32_t dwFromSegmentIndex, uint32_t dwToSegmentIndex, int16_t *pwOverflow)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_GET_NO_OF_CAPTURES) (int16_t wHandle, uint32_t *pdwNCaptures)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_STOP) (int16_t wHandle)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_NO_OF_CAPTURES) (int16_t wHandle, uint32_t dwNCaptures)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_WAVEFORM_LIMITER) (int16_t wHandle, uint32_t dwNWaveformsPerSecond)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_ENUMERATE_UNITS) (int16_t *pwCount, int8_t *pSerials, int16_t *pwSerialLth)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_SET_EXTERNAL_CLOCK) (int16_t wHandle, uint32_t dwFrequency, int16_t wThreshold)
 
typedef uint32_t(__stdcall * PHBAL_REG_PS6000USB_PING_UNIT) (int16_t wHandle)
 

Detailed Description

BAL-Component for the PicoScope PS6000 USB Oscilloscope.

Function Documentation

◆ phbalReg_Ps6000Usb_Init()

phStatus_t phbalReg_Ps6000Usb_Init ( phbalReg_Ps6000Usb_DataParams_t pDataParams,
uint16_t  wSizeOfDataParams 
)

Initialise the PS6000USB BAL component.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSParameter structure size is invalid.
PH_ERR_USE_CONDITIONRequired dependencies not available.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wSizeOfDataParams[In] Specifies the size of the data parameter structure.