libtiepie-hw  1.1.3

Functions to control the trigger settings of an oscilloscope channel. More...

Collaboration diagram for Trigger:

Modules

 Enabled
 The enabled state of a channel trigger determines whether a channel is selected as trigger source.
 
 Kind
 The channel trigger kind property is used to control how the channel trigger responds to the channel input signal.
 
 Level mode
 Functions for controlling the trigger level mode.
 
 Level
 The channel trigger level property is used to control at which level(s) the channel trigger responds to the channel input signal.
 
 Hysteresis
 The channel trigger hysteresis property is used to control the sensitivity of the trigger system.
 
 Condition
 Some trigger kinds require an additional condition to indicate how the channel trigger must respond to the input signal.
 
 Time
 The Time property determines how long a specific condition must last for the channel trigger to respond.
 

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_has_trigger (tiepie_hw_handle handle, uint16_t ch)
 Check whether the specified channel has trigger support with the currently selected measure mode. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_is_available (tiepie_hw_handle handle, uint16_t ch)
 Check whether the channel trigger for the specified channel is available, with the current oscilloscope settings. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_is_triggered (tiepie_hw_handle handle, uint16_t ch)
 Check whether the channel trigger caused a trigger. More...
 

Detailed Description

Functions to control the trigger settings of an oscilloscope channel.

Depending on the settings of the oscilloscope, a channel trigger may not be supported or temporarily unavailable. In streaming measure mode, channel trigger is not supported, use tiepie_hw_oscilloscope_channel_has_trigger() to check if triggering is supported in the currently set measure mode. When channel trigger is supported, it can be temporarily unavailable due to other settings like e.g. sample rate, resolution and/or the number of enabled channels, use tiepie_hw_oscilloscope_channel_trigger_is_available() to check if the trigger is available.

To use a channel as trigger source, the channel must be enabled.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_has_trigger()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_has_trigger ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the specified channel has trigger support with the currently selected measure mode.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
TIEPIE_HW_BOOL_TRUE if the channel has trigger support, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_CHANNEL
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
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_is_available()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_is_available ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the channel trigger for the specified channel is available, with the current oscilloscope settings.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
TIEPIE_HW_BOOL_TRUE if available, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_CHANNEL
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
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_is_triggered()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_is_triggered ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the channel trigger caused a trigger.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
TIEPIE_HW_BOOL_TRUE if the channel trigger caused a trigger, TIEPIE_HW_BOOL_FALSE otherwise.
See also
tiepie_hw_oscilloscope_is_triggered
tiepie_hw_oscilloscope_is_timeout_triggered
tiepie_hw_oscilloscope_is_force_triggered
tiepie_hw_oscilloscope_trigger_input_is_triggered
Since
1.0