libtiepie-hw  1.2.5

The channel trigger level property is used to control at which level(s) the channel trigger responds to the channel input signal. More...

Collaboration diagram for Level:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_trigger_get_level_count (tiepie_hw_handle handle, uint16_t ch)
 Get the number of channel trigger levels for a specified channel with the currently selected trigger kind. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_get_level (tiepie_hw_handle handle, uint16_t ch, uint32_t index)
 Get the currently set channel trigger level value for a specified channel and trigger level. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_set_level (tiepie_hw_handle handle, uint16_t ch, uint32_t index, double value)
 Set the channel trigger level value for a specified channel and trigger level. More...
 

Detailed Description

The channel trigger level property is used to control at which level(s) the channel trigger responds to the channel input signal.

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

If the trigger level mode is TIEPIE_HW_TLM_RELATIVE, the trigger level is set as a floating point value between 0 and 1, corresponding to a percentage of the full scale input range:

If the trigger level mode is TIEPIE_HW_TLM_ABSOLUTE, the trigger level is set as a floating point value, clipped by the full scale input range.

By default the trigger level is set to 0.5 (50%) of the full-scale range.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_trigger_get_level_count()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_trigger_get_level_count ( tiepie_hw_handle  handle,
uint16_t  ch 
)

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

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
The number of available trigger levels for the currently set trigger kind.
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_get_kind
tiepie_hw_oscilloscope_channel_trigger_get_level
tiepie_hw_oscilloscope_channel_trigger_set_level
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_get_level()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_get_level ( tiepie_hw_handle  handle,
uint16_t  ch,
uint32_t  index 
)

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

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]indexThe trigger level index, 0 to tiepie_hw_oscilloscope_channel_trigger_get_level_count() - 1.
Returns
The currently set trigger level value.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger (level) with the current settings.
TIEPIE_HW_STATUS_INVALID_INDEX The trigger level index is invalid.
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_get_level_count
tiepie_hw_oscilloscope_channel_trigger_set_level
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_set_level()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_trigger_set_level ( tiepie_hw_handle  handle,
uint16_t  ch,
uint32_t  index,
double  value 
)

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

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]indexThe trigger level index, 0 to tiepie_hw_oscilloscope_channel_trigger_get_level_count() - 1.
[in]valueThe required trigger level.
Returns
The actually set trigger level.
Status values
TIEPIE_HW_STATUS_VALUE_MODIFIED The requested trigger time is within the valid range, but not available. The closest valid value is set.
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested trigger level is outside the valid range and clipped to the closest limit.
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support trigger (level) with the current settings.
TIEPIE_HW_STATUS_INVALID_INDEX The trigger level index is invalid.
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
Changing the channel trigger level may change the input range if the channel trigger is enabled, trigger level mode is TIEPIE_HW_TLM_ABSOLUTE and auto ranging is enabled.
See also
tiepie_hw_oscilloscope_channel_trigger_get_level_count
tiepie_hw_oscilloscope_channel_trigger_get_level
Since
1.0