Component: PicoScope (PS2000) (Test Equipment)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Test Equipment |
Contents
PicoScope component
A set of functions designed for interacting with a 2000 series Pico scope via simulation.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_PS2000.fcsx
Please click here to view the component source code (Beta): FC_Comp_Source_PS2000.fcsx
Detailed description
No detailed description exists yet for this component
Examples
An example project showing the capabilities of the Velleman K8055D board combined with a Pico Technology series 2 scope.
Macro reference
|
ps2000_get_timebase |
| Returns details associated with the selected timebase index | |
 - INT
|
Handle |
| the handle of the required device. | |
| - INT
|
timebase |
| The ps2000a API allows you to select any of 2 32 different timebases based on a maximum sampling rate of 1 GS/s. | |
 - LONG
|
no_of_samples |
| number of samples required | |
| - LONG
|
time_interval |
| time interval between readings at the selected timebase. Use NULL if not required. | |
| - INT
|
time_units |
| - INT
|
oversample |
| not used. | |
| - LONG
|
max_samples |
| on exit, the maximum number of samples available. | |
| - INT
|
Return |
|
|
ps2000_open_unit_progress |
| This function checks on the progress of a request made to ps2000aOpenUnitAsync to open a scope. | |
| - INT
|
handle |
| - INT
|
Progress |
| - INT
|
Return |
|
|
ps2000_flash_led |
| This function flashes the LED on the front of the scope without blocking the calling thread. | |
| - INT
|
handle |
| handle of the scope device | |
| - INT
|
Return |
|
|
ps2000_stop |
| This function stops the scope device from sampling data. If this function is called before a trigger event occurs, the oscilloscope may not contain valid data. | |
| - INT
|
Handle |
| - INT
|
Return |
|
|
ps2000_get_unit_info |
| This function retrieves information about the specified oscilloscope. | |
| - INT
|
Handle |
| the handle of the device | |
 - STRING
|
info_string |
| unit information string | |
| - INT
|
string_length |
| the maximum number of chars in the string | |
| - INT
|
info_line |
| a number specifying what information is required. 0=DriverVersion / 1=USBVersion / 2=HardwareVersion / 3=VariantInfo / 4=BatchAndSerial / 5=CalDate / 6=KernelVersion / 7=DigHardwareVersion / 8=AnHardwareVersion | |
| - INT
|
Return |
|
|
ps2000_set_channel |
| This function specifies whether an input channel is to be enabled, its input coupling type, voltage range, analog offset and bandwidth limit. | |
| - INT
|
handle |
| Handle of the device | |
| - INT
|
channel |
| the channel to be configured. The values are: 0=ChanA / 1=ChanB | |
| - INT
|
enabled |
| whether or not to enable the channel. The values are: 0=Disable / 1=Enable | |
| - INT
|
dc |
| the impedance and coupling type. Values: 0=AC / 1=DC | |
| - INT
|
range |
| the input voltage range: 0=50mV / 1=100mV / 2=200mV / 3=500mV / 4=1V / 5=2V / 6=5V / 7=10V / 8=20V | |
| - INT
|
Return |
|
|
ps2000_get_times_and_values |
| - INT
|
Handle |
| - LONG
|
times |
| - INT
|
buffer_a |
| - INT
|
buffer_b |
| - INT
|
buffer_c |
| - INT
|
buffer_d |
| - INT
|
overflow |
| - INT
|
time_units |
| - LONG
|
no_of_samples |
| - LONG
|
Return |
|
|
ps2000_set_trigger |
| - INT
|
handle |
| - INT
|
source |
| - INT
|
threshold |
| - INT
|
direction |
| - INT
|
delay |
| - INT
|
auto_trigger_ms |
| - INT
|
Return |
|
|
ps2000_set_sig_gen_built_in |
| sets up the signal generator to produce a signal from a list of built-in waveforms | |
| - INT
|
Handle |
| Handle to the device | |
| - LONG
|
Offset_uV |
| the voltage offset, in microvolts, to be applied to the waveform | |
 - ULONG
|
pk2pk_uV |
| the peak-to-peak voltage, in microvolts, of the waveform | |
| - INT
|
waveType |
| the type of waveform to be generated. 0=Sine / 1=Square / 2=Triangle / 3=RampUp / 4=RampDown / 5=Sinc / 6=Gaus / 7=HalfSine / 8=DC | |
 - FLOAT
|
startFrequency |
| the frequency that the signal generator will initially produce | |
| - FLOAT
|
stopFrequency |
| the frequency at which the sweep reverses direction or returns to initial | |
| - FLOAT
|
increment |
| the amount of frequency increase or decrease in sweep mode | |
| - FLOAT
|
dwellTime |
| the time for which the sweep stays at each frequency, in seconds | |
| - INT
|
sweepType |
| whether the frequency will sweep from startFrequency to stopFrequency. 0=Up, 1=Down, 2=UpDown, 3=DownUp | |
| - ULONG
|
sweeps |
| produce number of cycles specified by shots | |
| - INT
|
Return |
|
|
ps2000_close_unit |
| This function shuts down an oscilloscope. | |
| - INT
|
Handle |
| The handle of the scope device to be closed | |
| - INT
|
Return |
|
|
ps2000_run_block |
| This function starts collecting data in block mode. | |
| - INT
|
handle |
| - LONG
|
no_of_samples |
| - INT
|
timebase |
| - INT
|
oversample |
| - LONG
|
time_indisposed_ms |
| - INT
|
Return |
|
|
ps2000_get_values |
| This function returns block-mode data, with or without downsampling. | |
| - INT
|
Handle |
| the handle of the required device. | |
| - INT
|
buffer_a |
| Start point for data collection | |
| - INT
|
buffer_b |
| Number of samples | |
| - INT
|
buffer_c |
| Down sample ratio | |
| - INT
|
buffer_d |
| Down sample mode : 0=None / 1=Aggregate / 2=Decimate / 4=Average | |
| - INT
|
overflow |
| Flags to indicate if an overflow has occurred | |
| - LONG
|
no_of_samples |
| - LONG
|
Return |
|
|
ps2000_ready |
| - INT
|
Handle |
| - INT
|
Return |
|
|
ps2000_open_unit_async |
| This function opens a scope without blocking the calling thread. | |
| - INT
|
Return |
|
|
ps2000_open_unit |
| Returns a handle to the opened unit Returns 0 if no unit found Returns -1 if unit failed to open | |
| - INT
|
Return |
Property reference
|
Properties |
==Macro reference==
|
|
ps2000_get_timebase |
| Returns details associated with the selected timebase index | |
| - INT
|
Handle |
| the handle of the required device. | |
| - INT
|
timebase |
| The ps2000a API allows you to select any of 2 32 different timebases based on a maximum sampling rate of 1 GS/s. | |
| - LONG
|
no_of_samples |
| number of samples required | |
| - LONG
|
time_interval |
| time interval between readings at the selected timebase. Use NULL if not required. | |
| - INT
|
time_units |
| - INT
|
oversample |
| not used. | |
| - LONG
|
max_samples |
| on exit, the maximum number of samples available. | |
| - INT
|
Return |
|
|
ps2000_open_unit_progress |
| This function checks on the progress of a request made to ps2000aOpenUnitAsync to open a scope. | |
| - INT
|
handle |
| - INT
|
Progress |
| - INT
|
Return |
|
|
ps2000_flash_led |
| This function flashes the LED on the front of the scope without blocking the calling thread. | |
| - INT
|
handle |
| handle of the scope device | |
| - INT
|
Return |
|
|
ps2000_stop |
| This function stops the scope device from sampling data. If this function is called before a trigger event occurs, the oscilloscope may not contain valid data. | |
| - INT
|
Handle |
| - INT
|
Return |
|
|
ps2000_get_unit_info |
| This function retrieves information about the specified oscilloscope. | |
| - INT
|
Handle |
| the handle of the device | |
| - STRING
|
info_string |
| unit information string | |
| - INT
|
string_length |
| the maximum number of chars in the string | |
| - INT
|
info_line |
| a number specifying what information is required. 0=DriverVersion / 1=USBVersion / 2=HardwareVersion / 3=VariantInfo / 4=BatchAndSerial / 5=CalDate / 6=KernelVersion / 7=DigHardwareVersion / 8=AnHardwareVersion | |
| - INT
|
Return |
|
|
ps2000_set_channel |
| This function specifies whether an input channel is to be enabled, its input coupling type, voltage range, analog offset and bandwidth limit. | |
| - INT
|
handle |
| Handle of the device | |
| - INT
|
channel |
| the channel to be configured. The values are: 0=ChanA / 1=ChanB | |
| - INT
|
enabled |
| whether or not to enable the channel. The values are: 0=Disable / 1=Enable | |
| - INT
|
dc |
| the impedance and coupling type. Values: 0=AC / 1=DC | |
| - INT
|
range |
| the input voltage range: 0=50mV / 1=100mV / 2=200mV / 3=500mV / 4=1V / 5=2V / 6=5V / 7=10V / 8=20V | |
| - INT
|
Return |
|
|
ps2000_get_times_and_values |
| - INT
|
Handle |
| - LONG
|
times |
| - INT
|
buffer_a |
| - INT
|
buffer_b |
| - INT
|
buffer_c |
| - INT
|
buffer_d |
| - INT
|
overflow |
| - INT
|
time_units |
| - LONG
|
no_of_samples |
| - LONG
|
Return |
|
|
ps2000_set_trigger |
| - INT
|
handle |
| - INT
|
source |
| - INT
|
threshold |
| - INT
|
direction |
| - INT
|
delay |
| - INT
|
auto_trigger_ms |
| - INT
|
Return |
|
|
ps2000_set_sig_gen_built_in |
| sets up the signal generator to produce a signal from a list of built-in waveforms | |
| - INT
|
Handle |
| Handle to the device | |
| - LONG
|
Offset_uV |
| the voltage offset, in microvolts, to be applied to the waveform | |
| - ULONG
|
pk2pk_uV |
| the peak-to-peak voltage, in microvolts, of the waveform | |
| - INT
|
waveType |
| the type of waveform to be generated. 0=Sine / 1=Square / 2=Triangle / 3=RampUp / 4=RampDown / 5=Sinc / 6=Gaus / 7=HalfSine / 8=DC | |
| - FLOAT
|
startFrequency |
| the frequency that the signal generator will initially produce | |
| - FLOAT
|
stopFrequency |
| the frequency at which the sweep reverses direction or returns to initial | |
| - FLOAT
|
increment |
| the amount of frequency increase or decrease in sweep mode | |
| - FLOAT
|
dwellTime |
| the time for which the sweep stays at each frequency, in seconds | |
| - INT
|
sweepType |
| whether the frequency will sweep from startFrequency to stopFrequency. 0=Up, 1=Down, 2=UpDown, 3=DownUp | |
| - ULONG
|
sweeps |
| produce number of cycles specified by shots | |
| - INT
|
Return |
|
|
ps2000_close_unit |
| This function shuts down an oscilloscope. | |
| - INT
|
Handle |
| The handle of the scope device to be closed | |
| - INT
|
Return |
|
|
ps2000_run_block |
| This function starts collecting data in block mode. | |
| - INT
|
handle |
| - LONG
|
no_of_samples |
| - INT
|
timebase |
| - INT
|
oversample |
| - LONG
|
time_indisposed_ms |
| - INT
|
Return |
|
|
ps2000_get_values |
| This function returns block-mode data, with or without downsampling. | |
| - INT
|
Handle |
| the handle of the required device. | |
| - INT
|
buffer_a |
| Start point for data collection | |
| - INT
|
buffer_b |
| Number of samples | |
| - INT
|
buffer_c |
| Down sample ratio | |
| - INT
|
buffer_d |
| Down sample mode : 0=None / 1=Aggregate / 2=Decimate / 4=Average | |
| - INT
|
overflow |
| Flags to indicate if an overflow has occurred | |
| - LONG
|
no_of_samples |
| - LONG
|
Return |
|
|
ps2000_ready |
| - INT
|
Handle |
| - INT
|
Return |
|
|
ps2000_open_unit_async |
| This function opens a scope without blocking the calling thread. | |
| - INT
|
Return |
|
|
ps2000_open_unit |
| Returns a handle to the opened unit Returns 0 if no unit found Returns -1 if unit failed to open | |
| - INT
|
Return |
Property reference
|
|
Properties |
==Macro reference==
|
|
ps2000_get_timebase |
| Returns details associated with the selected timebase index | |
| - INT
|
Handle |
| the handle of the required device. | |
| - INT
|
timebase |
| The ps2000a API allows you to select any of 2 32 different timebases based on a maximum sampling rate of 1 GS/s. | |
| - LONG
|
no_of_samples |
| number of samples required | |
| - LONG
|
time_interval |
| time interval between readings at the selected timebase. Use NULL if not required. | |
| - INT
|
time_units |
| - INT
|
oversample |
| not used. | |
| - LONG
|
max_samples |
| on exit, the maximum number of samples available. | |
| - INT
|
Return |
|
|
ps2000_open_unit_progress |
| This function checks on the progress of a request made to ps2000aOpenUnitAsync to open a scope. | |
| - INT
|
handle |
| - INT
|
Progress |
| - INT
|
Return |
|
|
ps2000_flash_led |
| This function flashes the LED on the front of the scope without blocking the calling thread. | |
| - INT
|
handle |
| handle of the scope device | |
| - INT
|
Return |
|
|
ps2000_stop |
| This function stops the scope device from sampling data. If this function is called before a trigger event occurs, the oscilloscope may not contain valid data. | |
| - INT
|
Handle |
| - INT
|
Return |
|
|
ps2000_get_unit_info |
| This function retrieves information about the specified oscilloscope. | |
| - INT
|
Handle |
| the handle of the device | |
| - STRING
|
info_string |
| unit information string | |
| - INT
|
string_length |
| the maximum number of chars in the string | |
| - INT
|
info_line |
| a number specifying what information is required. 0=DriverVersion / 1=USBVersion / 2=HardwareVersion / 3=VariantInfo / 4=BatchAndSerial / 5=CalDate / 6=KernelVersion / 7=DigHardwareVersion / 8=AnHardwareVersion | |
| - INT
|
Return |
|
|
ps2000_set_channel |
| This function specifies whether an input channel is to be enabled, its input coupling type, voltage range, analog offset and bandwidth limit. | |
| - INT
|
handle |
| Handle of the device | |
| - INT
|
channel |
| the channel to be configured. The values are: 0=ChanA / 1=ChanB | |
| - INT
|
enabled |
| whether or not to enable the channel. The values are: 0=Disable / 1=Enable | |
| - INT
|
dc |
| the impedance and coupling type. Values: 0=AC / 1=DC | |
| - INT
|
range |
| the input voltage range: 0=50mV / 1=100mV / 2=200mV / 3=500mV / 4=1V / 5=2V / 6=5V / 7=10V / 8=20V | |
| - INT
|
Return |
|
|
ps2000_get_times_and_values |
| - INT
|
Handle |
| - LONG
|
times |
| - INT
|
buffer_a |
| - INT
|
buffer_b |
| - INT
|
buffer_c |
| - INT
|
buffer_d |
| - INT
|
overflow |
| - INT
|
time_units |
| - LONG
|
no_of_samples |
| - LONG
|
Return |
|
|
ps2000_set_trigger |
| - INT
|
handle |
| - INT
|
source |
| - INT
|
threshold |
| - INT
|
direction |
| - INT
|
delay |
| - INT
|
auto_trigger_ms |
| - INT
|
Return |
|
|
ps2000_set_sig_gen_built_in |
| sets up the signal generator to produce a signal from a list of built-in waveforms | |
| - INT
|
Handle |
| Handle to the device | |
| - LONG
|
Offset_uV |
| the voltage offset, in microvolts, to be applied to the waveform | |
| - ULONG
|
pk2pk_uV |
| the peak-to-peak voltage, in microvolts, of the waveform | |
| - INT
|
waveType |
| the type of waveform to be generated. 0=Sine / 1=Square / 2=Triangle / 3=RampUp / 4=RampDown / 5=Sinc / 6=Gaus / 7=HalfSine / 8=DC | |
| - FLOAT
|
startFrequency |
| the frequency that the signal generator will initially produce | |
| - FLOAT
|
stopFrequency |
| the frequency at which the sweep reverses direction or returns to initial | |
| - FLOAT
|
increment |
| the amount of frequency increase or decrease in sweep mode | |
| - FLOAT
|
dwellTime |
| the time for which the sweep stays at each frequency, in seconds | |
| - INT
|
sweepType |
| whether the frequency will sweep from startFrequency to stopFrequency. 0=Up, 1=Down, 2=UpDown, 3=DownUp | |
| - ULONG
|
sweeps |
| produce number of cycles specified by shots | |
| - INT
|
Return |
|
|
ps2000_close_unit |
| This function shuts down an oscilloscope. | |
| - INT
|
Handle |
| The handle of the scope device to be closed | |
| - INT
|
Return |
|
|
ps2000_run_block |
| This function starts collecting data in block mode. | |
| - INT
|
handle |
| - LONG
|
no_of_samples |
| - INT
|
timebase |
| - INT
|
oversample |
| - LONG
|
time_indisposed_ms |
| - INT
|
Return |
|
|
ps2000_get_values |
| This function returns block-mode data, with or without downsampling. | |
| - INT
|
Handle |
| the handle of the required device. | |
| - INT
|
buffer_a |
| Start point for data collection | |
| - INT
|
buffer_b |
| Number of samples | |
| - INT
|
buffer_c |
| Down sample ratio | |
| - INT
|
buffer_d |
| Down sample mode : 0=None / 1=Aggregate / 2=Decimate / 4=Average | |
| - INT
|
overflow |
| Flags to indicate if an overflow has occurred | |
| - LONG
|
no_of_samples |
| - LONG
|
Return |
|
|
ps2000_ready |
| - INT
|
Handle |
| - INT
|
Return |
|
|
ps2000_open_unit_async |
| This function opens a scope without blocking the calling thread. | |
| - INT
|
Return |
|
|
ps2000_open_unit |
| Returns a handle to the opened unit Returns 0 if no unit found Returns -1 if unit failed to open | |
| - INT
|
Return |
Property reference
|
|
Properties |
