libtiepie-hw  1.2.5

The enabled state of a channel trigger determines whether a channel is selected as trigger source. More...

Collaboration diagram for Enabled:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_get_enabled (tiepie_hw_handle handle, uint16_t ch)
 Check whether channel trigger for a specified channel is enabled. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_set_enabled (tiepie_hw_handle handle, uint16_t ch, tiepie_hw_bool value)
 To select a channel as trigger source, set channel trigger enable. More...
 

Detailed Description

The enabled state of a channel trigger determines whether a channel is selected as trigger source.

Channel triggers of multiple channels can be enabled, in that case they will be OR'ed.

The enabled state can be affected by changing the channel enable, sample rate and/or resolution.

By default channel 1 is enabled, all other channels are disabled.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_trigger_get_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_get_enabled ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether channel trigger for a specified channel is enabled.

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 enabled, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger with the current settings.
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
See also
tiepie_hw_oscilloscope_channel_trigger_set_enabled
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_set_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_trigger_set_enabled ( tiepie_hw_handle  handle,
uint16_t  ch,
tiepie_hw_bool  value 
)

To select a channel as trigger source, set channel trigger enable.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
[in]valueTIEPIE_HW_BOOL_TRUE or TIEPIE_HW_BOOL_FALSE.
Returns
TIEPIE_HW_BOOL_TRUE if enabled, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_NOT_AVAILABLE
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger with the current settings.
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
Remarks
Enabling the channel trigger may change the input range if trigger level mode is TIEPIE_HW_TLM_ABSOLUTE and auto ranging is enabled.
See also
tiepie_hw_oscilloscope_channel_trigger_get_enabled
Since
1.0