A device can have one or more device trigger inputs, usually available as pins on an extension connector on the instrument. More...
Collaboration diagram for Input(s):
Modules | |
| Status | |
| Enabled | |
| The enabled state of a device trigger input determines whether an input is selected as trigger source. | |
| Kind | |
| The device trigger kind determines how the device trigger responds to the device trigger input signal. | |
| Info | |
| Obtain information of a device trigger input. | |
Functions | |
| TIEPIE_HW_API uint16_t | tiepie_hw_device_trigger_get_input_count (tiepie_hw_handle handle) |
| Get the number of trigger inputs. More... | |
| TIEPIE_HW_API uint16_t | tiepie_hw_device_trigger_get_input_index_by_id (tiepie_hw_handle handle, uint32_t id) |
| Get the index of a trigger input identified by its ID. More... | |
Detailed Description
A device can have one or more device trigger inputs, usually available as pins on an extension connector on the instrument.
Use the function tiepie_hw_device_trigger_get_input_count() to determine the amount of available device trigger inputs. To use a device trigger input as trigger source, use the function tiepie_hw_device_trigger_input_set_enabled() to enable it.
Function Documentation
◆ tiepie_hw_device_trigger_get_input_count()
| TIEPIE_HW_API uint16_t tiepie_hw_device_trigger_get_input_count | ( | tiepie_hw_handle | handle | ) |
Get the number of trigger inputs.
- Parameters
-
[in] handle A device handle identifying the device.
- Returns
- The number of trigger inputs.
- Status values
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
- Since
- 1.0
◆ tiepie_hw_device_trigger_get_input_index_by_id()
| TIEPIE_HW_API uint16_t tiepie_hw_device_trigger_get_input_index_by_id | ( | tiepie_hw_handle | handle, |
| uint32_t | id | ||
| ) |
Get the index of a trigger input identified by its ID.
The index is used in the other trigger input functions to identify the trigger input.
- Parameters
-
[in] handle A device handle identifying the device. [in] id The trigger input ID, a TIEPIE_HW_TIID_* value, identifying the trigger input.
- Returns
- The trigger input index or TIEPIE_HW_TRIGGERIO_INDEX_INVALID.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The device has no trigger inputs. 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
- Since
- 1.0
