|
DS_STATUS
|
DS1M12_StartDeviceChannelScan
|
(DS_HANDLE dsHandle, BOOL bTestMode, DWORD dwMaxNumSamples, DWORD dwTriggerChannel, PDS_TRIGGER_DATA pTriggerData, DWORD dwSampleInterval, PDS_CHANNEL_CONTROL_DATA pChannelAControlData, PDS_CHANNEL_CONTROL_DATA pChannelBControlData)
|
Parameters
|
dsHandle
|
Handle of a DS1M12.
|
|
bTestMode
|
Sets the DS1M12 into test mode. Test mode generates a 244.1Hz sawtooth waveform.
|
|
dwMaxNumSamples
|
Specifies the maximum number of data values that can be read from both channels of a DS1M12 and returned in the channel data buffers. A DS1M12 is configured to return a maximum number of data values using a FPGA configuration file. Valid Maximum Number Samples:
MAXIMUM_NUMBER_SAMPLES_1K MAXIMUM_NUMBER_SAMPLES_2K MAXIMUM_NUMBER_SAMPLES_4K MAXIMUM_NUMBER_SAMPLES_8K |
|
dwTriggerChannel
|
Specifies the input i.e. channel A or channel B or external trigger, to be used as the trigger source. The trigger conditions that must be satisfied before a scan cycle can return data are specified in the pTriggerData parameter. Valid values:
CHANNEL_A CHANNEL_B EXTERNAL_TRIGGER |
|
pTriggerData
|
Pointer to the structure that contains the data, that will be used to configure the trigger conditions for the specified channel of a DS1M12. A scan cycle will only return data after all the trigger conditions have been satisfied.
|
|
dwSampleInterval
|
Specifies the sample interval i.e. the time in microseconds between each value read from both channels of a DS1M12 and returned in the channel data buffers. Valid Sample Rates:
SAMPLE_INTERVAL_1US - 1 microsecond sample interval SAMPLE_INTERVAL_2US - 2 microsecond sample interval SAMPLE_INTERVAL_4US - 4 microsecond sample interval SAMPLE_INTERVAL_10US - 10 microsecond sample interval SAMPLE_INTERVAL_20US - 20 microsecond sample interval SAMPLE_INTERVAL_40US - 40 microsecond sample interval SAMPLE_INTERVAL_100US - 100 microsecond sample interval SAMPLE_INTERVAL_200US - 200 microsecond sample interval SAMPLE_INTERVAL_400US - 400 microsecond sample interval SAMPLE_INTERVAL_1MS - 1 millisecond sample interval SAMPLE_INTERVAL_2MS - 2 millisecond sample interval SAMPLE_INTERVAL_4MS - 4 milliseconds sample interval SAMPLE_INTERVAL_10MS - 10 millisecond sample interval SAMPLE_INTERVAL_20MS - 20 millisecond sample interval SAMPLE_INTERVAL_40MS - 40 millisecond sample interval |
|
pChannelAControlData
|
Pointer to the structure that contains the data that will be used to control the data values read back from channel A of a DS1M12.
|
|
pChannelBControData
|
Pointer to the structure that contains the data that will be used to control the data values read back from channel B of a DS1M12.
|
PDS_TRIGGER_DATA Structure
|
BOOL
|
bAutoTriggerMode
|
Auto trigger set (TRUE), auto trigger not set (FALSE). If auto trigger is set to TRUE, the application programmer has no control of the trigger conditions.
|
|
BOOL
|
bEdgePulseTrigger
|
Edge (FALSE) or pulse (TRUE) width triggering.
|
|
BOOL
|
bEdgeTriggerPositiveNegative
|
If channel A or channel B is to be used as the trigger source then edge triggering, positive (FALSE) or negative (TRUE). If the external trigger is to be used as the trigger source then level triggering (iTriggerLevelmVolts), above trigger level (FALSE) or below trigger level(TRUE).
|
|
INT
|
iTriggerLevelmVolts
|
If channel A or channel B is to be used as the trigger source then the trigger level in mV, can be a positive or a negative value. Valid range is -500000mV to 500000mV. If the external trigger is to be used as the trigger input then the trigger level in mV can be a positive or a negative value. Valid range is -3500mVolts to +3500mV.
|
|
BOOL
|
bPulseWidthTriggerPositiveNegative
|
Positive (FALSE) or negative (TRUE) pulse width triggering.
|
|
BOOL
|
bPulseWidthTriggerLessThanGreaterThan
|
Less than (FALSE) or greater than (TRUE) pulse width triggering.
|
|
DWORD
|
dwTriggerPulseWidth
|
Specifies the pulse width in the number of timebase sample periods. The timebase sample period is the value specified in the dwSampleRate parameter. Valid range is 3 to 1023.
|
|
DWORD
|
dwDelayScanAfterTriggerNumSampleRateIntervals
|
Delays the returned data from the trigger point by the specified number of timebase sample periods. The timebase sample period is the value specified in the dwSampleRate parameter. Valid range 0 to 65535.
|
PDS_CHANNEL_CONTROL_DATA Structure
|
BOOL
|
bGainTimesTen
|
Controls the times ten gain of a DS1M12 channel. If set to TRUE, the gain in mV/Bit, specified in the dwGainuVBit parameter, is increased by a factor of ten i.e. 200mV/Bit becomes 2mV/bit. This allows for compensating for x10 probes.
|
|
DWORD
|
dwGainuVBit
|
Specifies the gain i.e. the number of mVolts per bit on a DS1M12 channel. Valid Gain Values(mV/Bit):
GAIN_100UV_PER_BIT GAIN_200UV_PER_BIT GAIN_500UV_PER_BIT GAIN_1MV_PER_BIT GAIN_2MV_PER_BIT GAIN_5MV_PER_BIT GAIN_10MV_PER_BIT GAIN_20MV_PER_BIT GAIN_50MV_PER_BIT |
|
BOOL
|
bCouplingState
|
Controls whether a DS1M12 channel should be AC (TRUE) or DC (FALSE) coupled.
|
|
BOOL
|
bActiveState
|
Controls the state of a DS1M12 channel. The state of a channel is indicated by its LED, switched on (TRUE) or off (FALSE). Switched on indicates that a channel is in the active state i.e. the data read from a channel is currently being returned to the application. Switched off indicates that a channel is in the inactive state i.e. the data read from a channel is not being displayed.
|
Return Value
Returns DS_SUCCESS if successful, otherwise the return value will be one of the following error codes:
DS_INVALID_HANDLE
DS_INVALID_CHANNEL
DS_INVALID_MAX_NUMBER_SAMPLES
DS_NULL_TRIGGER_DATA_POINTER
DS_NULL_CHANNEL_CONTROL_DATA_POINTER
DS_CHANNEL_TRIGGER_LEVEL_OUT_OF_RANGE
DS_EXTERNAL_TRIGGER_LEVEL_OUT_OF_RANGE
DS_PULSE_WIDTH_OUT_OF_RANGE
DS_MAX_DELAY_SCAN_EXCEEDED
DS_INVALID_SAMPLE_RATE
DS_INVALID_GAIN
DS_FAILED_TO_COMPLETE_COMMAND
DS_FAILED_TO_SYNCHRONIZE_DEVICE
DS_CHANNEL_A_FUSE_FAILED
DS_CHANNEL_B_FUSE_FAILED
DS_EXTERNAL_TRIGGER_FUSE_FAILED
DS_IO_ERROR
Remarks
The DS1M12 FPGA must be programmed prior to calling this function. To program the DS1M12, call DS1M12_ProgramDevice.