The channel trigger hysteresis property is used to control the sensitivity of the trigger system. More...

Collaboration diagram for Hysteresis:

Functions
TIEPIE_HW_API uint32_t	tiepie_hw_oscilloscope_channel_trigger_get_hysteresis_count (tiepie_hw_handle handle, uint16_t ch)
	Get the number of trigger hystereses for a specified channel with the currently selected trigger kind.

TIEPIE_HW_API double	tiepie_hw_oscilloscope_channel_trigger_get_hysteresis (tiepie_hw_handle handle, uint16_t ch, uint32_t index)
	Get the currently set channel trigger hysteresis value for a specified channel and trigger hysteresis.

TIEPIE_HW_API double	tiepie_hw_oscilloscope_channel_trigger_set_hysteresis (tiepie_hw_handle handle, uint16_t ch, uint32_t index, double value)
	Set the channel trigger hysteresis value for a specified channel and trigger hysteresis.

Detailed Description

The channel trigger hysteresis property is used to control the sensitivity of the trigger system.

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

The trigger hysteresis is set as a floating point value between 0 and 1, corresponding to a percentage of the full scale input range:

By default the trigger hysteresis is set to 0.05 (5%) of the full-scale range.

Function Documentation

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_trigger_get_hysteresis_count	(	tiepie_hw_handle	handle,
		uint16_t	ch
	)

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

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	ch	The channel number identifying the channel, `0` to `tiepie_hw_oscilloscope_get_channel_count() - 1`.

Returns: The number of available trigger hystereses 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_hysteresis; tiepie_hw_oscilloscope_channel_trigger_set_hysteresis

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

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

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	ch	The channel number identifying the channel, `0` to `tiepie_hw_oscilloscope_get_channel_count() - 1`.
[in]	index	The trigger hysteresis index, `0` to `tiepie_hw_oscilloscope_channel_trigger_get_hysteresis_count() - 1`.

Returns: The currently set trigger hysteresis value, a number between 0 and 1.

Status values

TIEPIE_HW_STATUS_NOT_SUPPORTED	The indicated channel does not support trigger (hysteresis) with the current settings.
TIEPIE_HW_STATUS_INVALID_INDEX	The trigger hysteresis 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_hysteresis_count; tiepie_hw_oscilloscope_channel_trigger_set_hysteresis

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

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

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	ch	The channel number identifying the channel, `0` to `tiepie_hw_oscilloscope_get_channel_count() - 1`.
[in]	index	The trigger hysteresis index, `0` to `tiepie_hw_oscilloscope_channel_trigger_get_hysteresis_count() - 1`.
[in]	value	The required trigger hysteresis value, a number between `0` and `1`.

Returns: The actually set trigger hysteresis value, a number between 0 and 1.

Status values

TIEPIE_HW_STATUS_VALUE_CLIPPED	The requested trigger hysteresis is outside the valid range and clipped to the closest limit.
TIEPIE_HW_STATUS_NOT_SUPPORTED	The indicated channel does not support trigger (hysteresis) with the current settings.
TIEPIE_HW_STATUS_INVALID_INDEX	The trigger hysteresis 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_hysteresis_count; tiepie_hw_oscilloscope_channel_trigger_get_hysteresis