LibTiePie  0.7.4
Library for interfacing TiePie engineering instruments

Description

The channel trigger hysteresis property is used to control the sensitivity of the trigger system.

The number of available trigger hystereses depends on the currently set trigger kind. Use ScpChTrGetHysteresisCount() to determine the number of trigger hystereses for the currently set trigger kind.

The trigger hysteresis is set as a floating point value between 0 and 1, corresponding to a percentage of the full scale input range:

By default the trigger hysteresis is set to 0.05 (5%) of the full-scale range.

Functions

uint32_t ScpChTrGetHysteresisCount (LibTiePieHandle_t hDevice, uint16_t wCh)
 Get the number of trigger hystereses for a specified channel with the currently selected trigger kind. More...
 
double ScpChTrGetHysteresis (LibTiePieHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get the currently set channel trigger hysteresis value for a specified channel and trigger hysteresis. More...
 
double ScpChTrSetHysteresis (LibTiePieHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dHysteresis)
 Set the channel trigger hysteresis value for a specified channel and trigger hysteresis. More...
 

Function Documentation

uint32_t ScpChTrGetHysteresisCount ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Get the number of trigger hystereses for a specified channel with the currently selected trigger kind.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
The number of available trigger hystereses for the currently set trigger kind.
Status values
NOT_SUPPORTED The indicated channel does not support trigger with the current settings.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChTrGetKind
ScpChTrGetHysteresis
ScpChTrSetHysteresis
Since
0.4.1
double ScpChTrGetHysteresis ( LibTiePieHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex 
)

Get the currently set channel trigger hysteresis value for a specified channel and trigger hysteresis.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]dwIndexThe trigger hysteresis index, 0 to ScpChTrGetHysteresisCount() - 1.
Returns
The currently set trigger hysteresis value, a number between 0 and 1.
Status values
NOT_SUPPORTED The indicated channel does not support trigger (hysteresis) with the current settings.
INVALID_INDEX The trigger hysteresis index is invalid.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChTrGetHysteresisCount
ScpChTrSetHysteresis
Since
0.4.1
double ScpChTrSetHysteresis ( LibTiePieHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex,
double  dHysteresis 
)

Set the channel trigger hysteresis value for a specified channel and trigger hysteresis.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]dwIndexThe trigger hysteresis index, 0 to ScpChTrGetHysteresisCount() - 1.
[in]dHysteresisThe required trigger hysteresis value, a number between 0 and 1.
Returns
The actually set trigger hysteresis value, a number between 0 and 1.
Status values
VALUE_CLIPPED The requested trigger hysteresis is outside the valid range and clipped to the closest limit.
NOT_SUPPORTED The indicated channel does not support trigger (hysteresis) with the current settings.
INVALID_INDEX The trigger hysteresis index is invalid.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChTrGetHysteresisCount
ScpChTrGetHysteresis
Since
0.4.1