libtiepie-hw  1.1.3

Functions to control the input coupling of an oscilloscope channel. More...

Collaboration diagram for Coupling:

Functions

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_get_couplings (tiepie_hw_handle handle, uint16_t ch)
 Get the supported coupling kinds of a specified channel. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_get_coupling (tiepie_hw_handle handle, uint16_t ch)
 Get the currently set coupling of a specified channel. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_set_coupling (tiepie_hw_handle handle, uint16_t ch, uint64_t coupling)
 Set the coupling of a specified channel. More...
 

Detailed Description

Functions to control the input coupling of an oscilloscope channel.

By default the input coupling of a channel is set to: Volt DC (TIEPIE_HW_CK_DCV).

Function Documentation

◆ tiepie_hw_oscilloscope_channel_get_couplings()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_get_couplings ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the supported coupling kinds of 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 supported coupling kinds, a set of OR-ed TIEPIE_HW_CK_* values.
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
See also
tiepie_hw_oscilloscope_channel_get_coupling
tiepie_hw_oscilloscope_channel_set_coupling
Since
1.0

◆ tiepie_hw_oscilloscope_channel_get_coupling()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_get_coupling ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the currently set coupling of 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
Coupling, a TIEPIE_HW_CK_* value.
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
See also
tiepie_hw_oscilloscope_channel_get_couplings
tiepie_hw_oscilloscope_channel_set_coupling
Since
1.0

◆ tiepie_hw_oscilloscope_channel_set_coupling()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_channel_set_coupling ( tiepie_hw_handle  handle,
uint16_t  ch,
uint64_t  coupling 
)

Set the coupling of 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]couplingThe required coupling, a TIEPIE_HW_CK_* value.
Returns
The actually set coupling, a TIEPIE_HW_CK_* value.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE The requested coupling kind is invalid.
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 input coupling can affect the input range.
See also
tiepie_hw_oscilloscope_channel_get_couplings
tiepie_hw_oscilloscope_channel_get_coupling
Since
1.0