libtiepie-hw  1.2.1

The channel trigger kind property is used to control how the channel trigger responds to the channel input signal. More...

Collaboration diagram for Kind:

Functions

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_trigger_get_kinds (tiepie_hw_handle handle, uint16_t ch)
 Get the supported channel trigger kinds for a specified channel with the currently selected measure mode. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_trigger_get_kind (tiepie_hw_handle handle, uint16_t ch)
 Get the currently selected channel trigger kind for a specified channel. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_trigger_set_kind (tiepie_hw_handle handle, uint16_t ch, uint64_t value)
 Set the channel trigger kind for a specified channel. More...
 

Detailed Description

The channel trigger kind property is used to control how the channel trigger responds to the channel input signal.

Use tiepie_hw_oscilloscope_channel_trigger_get_kinds() to find out which trigger kinds are supported by the channel. Depending on the selected trigger kind, other properties like e.g. level(s) and hysteresis are available to configure the channel trigger. Read more on trigger kind.

By default kind is set to rising edge (TIEPIE_HW_TK_RISINGEDGE).

Function Documentation

◆ tiepie_hw_oscilloscope_channel_trigger_get_kinds()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_trigger_get_kinds ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the supported channel trigger kinds for a specified channel 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
The supported trigger kinds, a set of OR-ed TIEPIE_HW_TK_* values or TIEPIE_HW_TKM_NONE if the channel has no trigger support.
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_set_kind
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_get_kind()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_trigger_get_kind ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the currently selected channel trigger kind for a specified channel.

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 current trigger kind, a TIEPIE_HW_TK_* value.
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_kinds
tiepie_hw_oscilloscope_channel_trigger_set_kind
Since
1.0

◆ tiepie_hw_oscilloscope_channel_trigger_set_kind()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_trigger_set_kind ( tiepie_hw_handle  handle,
uint16_t  ch,
uint64_t  value 
)

Set the channel trigger kind for a specified channel.

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]valueThe required trigger kind: a TIEPIE_HW_TK_* value.
Returns
The actually set trigger kind, a TIEPIE_HW_TK_* value.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE The requested trigger kind is invalid.
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
Changing the channel trigger kind 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_kinds
tiepie_hw_oscilloscope_channel_trigger_get_kind
Since
1.0