libtiepie-hw  1.1.6

The device trigger kind determines how the device trigger responds to the device trigger input signal. More...

Collaboration diagram for Kind:

Functions

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_input_get_kinds (tiepie_hw_handle handle, uint16_t input)
 Get the supported trigger kinds for a specified device trigger input. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_input_get_kind (tiepie_hw_handle handle, uint16_t input)
 Get the currently selected trigger kind for a specified device trigger input. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_input_set_kind (tiepie_hw_handle handle, uint16_t input, uint64_t value)
 Set the required trigger kind for a specified device trigger input. More...
 

Detailed Description

The device trigger kind determines how the device trigger responds to the device trigger input signal.

Use tiepie_hw_device_trigger_input_get_kinds() to find out which trigger kinds are supported by the device trigger input. Read more on device trigger kind.

Default value: TIEPIE_HW_TK_RISINGEDGE if supported, else TIEPIE_HW_TK_FALLINGEDGE.

Function Documentation

◆ tiepie_hw_device_trigger_input_get_kinds()

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_input_get_kinds ( tiepie_hw_handle  handle,
uint16_t  input 
)

Get the supported trigger kinds for a specified device trigger input.

Parameters
[in]handleA device handle identifying the device.
[in]inputThe trigger input index identifying the trigger input, 0 to Dev_trIn_get_count() - 1.
Returns
Supported trigger input kinds, a set of OR-ed TIEPIE_HW_TK_* values.
Status values
TIEPIE_HW_STATUS_INVALID_INPUT
TIEPIE_HW_STATUS_NOT_AVAILABLE With the current settings, the trigger input is not available.
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger inputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_trigger_input_get_kind
tiepie_hw_device_trigger_input_set_kind
Since
1.0

◆ tiepie_hw_device_trigger_input_get_kind()

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_input_get_kind ( tiepie_hw_handle  handle,
uint16_t  input 
)

Get the currently selected trigger kind for a specified device trigger input.

Parameters
[in]handleA device handle identifying the device.
[in]inputThe trigger input index identifying the trigger input, 0 to Dev_trIn_get_count() - 1.
Returns
The current trigger kind, a TIEPIE_HW_TK_* value.
Status values
TIEPIE_HW_STATUS_INVALID_INPUT
TIEPIE_HW_STATUS_NOT_AVAILABLE With the current settings, the trigger input is not available.
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger inputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_trigger_input_get_kinds
tiepie_hw_device_trigger_input_set_kind
Since
1.0

◆ tiepie_hw_device_trigger_input_set_kind()

TIEPIE_HW_API uint64_t tiepie_hw_device_trigger_input_set_kind ( tiepie_hw_handle  handle,
uint16_t  input,
uint64_t  value 
)

Set the required trigger kind for a specified device trigger input.

Parameters
[in]handleA device handle identifying the device.
[in]inputThe trigger input index identifying the trigger input, 0 to Dev_trIn_get_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_INPUT
TIEPIE_HW_STATUS_NOT_AVAILABLE With the current settings, the trigger input is not available.
TIEPIE_HW_STATUS_INVALID_VALUE The requested trigger kind is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger inputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_device_trigger_input_get_kinds
tiepie_hw_device_trigger_input_get_kind
Since
1.0