libtiepie-hw  1.1.6
Output(s)

A device can have one or more device trigger outputs, usually available as pins on an extension connector on the instrument. More...

Collaboration diagram for Output(s):

Modules

 Enabled
 The enabled state of a device trigger output determines whether an output is used.
 
 Event
 Select the event that controls the trigger output.
 
 Info
 Obtain information of a device trigger output.
 

Functions

TIEPIE_HW_API uint16_t tiepie_hw_device_trigger_get_output_count (tiepie_hw_handle handle)
 Get the number of trigger outputs. More...
 
TIEPIE_HW_API uint16_t tiepie_hw_device_trigger_get_output_index_by_id (tiepie_hw_handle handle, uint32_t id)
 Get the index of trigger output identified by its ID. More...
 

Detailed Description

A device can have one or more device trigger outputs, usually available as pins on an extension connector on the instrument.

The trigger outputs are controlled by events that occur in the instrument.

Use the function tiepie_hw_device_trigger_get_output_count() to determine the amount of available device trigger outputs. To use a device trigger output, use the function tiepie_hw_device_trigger_output_set_enabled() to enable it.

Function Documentation

◆ tiepie_hw_device_trigger_get_output_count()

TIEPIE_HW_API uint16_t tiepie_hw_device_trigger_get_output_count ( tiepie_hw_handle  handle)

Get the number of trigger outputs.

Parameters
[in]handleA device handle identifying the device.
Returns
The number of trigger outputs.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
TIEPIE_HW_STATUS_INVALID_HANDLE
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_device_trigger_get_output_index_by_id()

TIEPIE_HW_API uint16_t tiepie_hw_device_trigger_get_output_index_by_id ( tiepie_hw_handle  handle,
uint32_t  id 
)

Get the index of trigger output identified by its ID.

Parameters
[in]handleA device handle identifying the device.
[in]idThe trigger output ID, a TIEPIE_HW_TOID_* value, identifying the trigger output.
Returns
The trigger output index or TIEPIE_HW_TRIGGERIO_INDEX_INVALID.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger outputs.
TIEPIE_HW_STATUS_INVALID_VALUE The requested ID is invalid.
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_output_get_id()
Since
1.0