libtiepie-hw  1.1.6

Functions to control the oscilloscope trigger time out. More...

Collaboration diagram for Time out:

Functions

TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_get_timeout (tiepie_hw_handle handle)
 Get the currently selected trigger time out in seconds, for a specified oscilloscope. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_set_timeout (tiepie_hw_handle handle, double value)
 Set the trigger time out in seconds, for a specified oscilloscope. More...
 

Detailed 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 rate.

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

Function Documentation

◆ tiepie_hw_oscilloscope_trigger_get_timeout()

TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_get_timeout ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
Trigger time out in seconds, or TIEPIE_HW_TO_INFINITY.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support trigger.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_trigger_set_timeout
Since
1.0

◆ tiepie_hw_oscilloscope_trigger_set_timeout()

TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_set_timeout ( tiepie_hw_handle  handle,
double  value 
)

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

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]valueThe required trigger time out in seconds, or TIEPIE_HW_TO_INFINITY.
Returns
The actually set trigger time out in seconds, or TIEPIE_HW_TO_INFINITY.
Status values
TIEPIE_HW_STATUS_VALUE_MODIFIED The requested trigger time out is within the valid range but not available. The closest valid value is set.
TIEPIE_HW_STATUS_INVALID_VALUE
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support trigger.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_trigger_get_timeout
Since
1.0