LibTiePie  0.7.4
Library for interfacing TiePie engineering instruments

Description

Functions to control the oscilloscope trigger time out.

Trigger time out defines the time that the system will wait for a trigger before a trigger is forced.

If the trigger conditions are set in such a way that the input signal(s) will never meet the trigger settings, the instrument will wait forever. When no measurement is performed, no signals will be displayed. To avoid that the system will wait infinitely, a trigger time out is added to the trigger system. When after a user defined amount of time after starting the measurement still no trigger has occurred, the trigger time out will force a trigger. This will ensure a minimum number of measurements per second.

The trigger time out is entered as a number, representing the delay in seconds. There are two special values for the trigger time out setting:

The trigger time out can be affected by changing the sample frequency.

By default the trigger time out is set to: 0.1 s (100 ms).

Functions

double ScpGetTriggerTimeOut (LibTiePieHandle_t hDevice)
 Get the currently selected trigger time out in seconds, for a specified oscilloscope. More...
 
double ScpSetTriggerTimeOut (LibTiePieHandle_t hDevice, double dTimeOut)
 Set the trigger time out in seconds, for a specified oscilloscope. More...
 

Function Documentation

double ScpGetTriggerTimeOut ( LibTiePieHandle_t  hDevice)

Get the currently selected trigger time out in seconds, for a specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
Trigger time out in seconds, or TO_INFINITY.
Status values
NOT_SUPPORTED The oscilloscope does not support trigger.
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
ScpSetTriggerTimeOut
Since
0.4.0
double ScpSetTriggerTimeOut ( LibTiePieHandle_t  hDevice,
double  dTimeOut 
)

Set the trigger time out in seconds, for a specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]dTimeOutThe required trigger time out in seconds, or TO_INFINITY.
Returns
The actually set trigger time out in seconds, or TO_INFINITY.
Status values
VALUE_MODIFIED The requested trigger time out is within the valid range but not available. The closest valid value is set.
INVALID_VALUE The requested value is invalid.
NOT_SUPPORTED The oscilloscope does not support trigger.
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
ScpGetTriggerTimeOut
Since
0.4.0