libtiepie-hw  1.2.0

Functions to retrieve information from an oscilloscope channel. More...

Collaboration diagram for Info:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_get_connector_type (tiepie_hw_handle handle, uint16_t ch)
 Get the channel connector type. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_is_differential (tiepie_hw_handle handle, uint16_t ch)
 Check whether the channel has a differential input. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_is_isolated (tiepie_hw_handle handle, uint16_t ch)
 Check whether the channel has a galvanically isolated input. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_get_impedance (tiepie_hw_handle handle, uint16_t ch)
 Get the channel input impedance. More...
 

Detailed Description

Functions to retrieve information from an oscilloscope channel.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_get_connector_type()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_channel_get_connector_type ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the channel connector type.

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
Channel connector type.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The channel does not support reading the connector type.
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
Since
1.0

◆ tiepie_hw_oscilloscope_channel_is_differential()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_is_differential ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the channel has a differential input.

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
TIEPIE_HW_BOOL_TRUE if differential, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
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
Since
1.0

◆ tiepie_hw_oscilloscope_channel_is_isolated()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_is_isolated ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the channel has a galvanically isolated input.

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
TIEPIE_HW_BOOL_TRUE if galvanically isolated, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
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
Since
1.0

◆ tiepie_hw_oscilloscope_channel_get_impedance()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_get_impedance ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the channel input impedance.

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
Channel input impedance in Ohm.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The channel does not support reading the input impedance.
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
Since
1.0