libtiepie-hw  1.1.4

Functions to setup and control oscilloscope channels. More...

Collaboration diagram for Channels:

Modules

 Info
 Functions to retrieve information from an oscilloscope channel.
 
 Bandwidth
 Functions to control the input bandwidth of an oscilloscope channel.
 
 Coupling
 Functions to control the input coupling of an oscilloscope channel.
 
 Enabled
 Functions to control the enabled state of an oscilloscope channel.
 
 Range
 Functions to control the input range of an oscilloscope channel.
 
 SafeGround
 Functions to control the SafeGround feature of an oscilloscope channel.
 
 Trigger
 Functions to control the trigger settings of an oscilloscope channel.
 
 Demo signals
 Functions to control demo signals of a demo oscilloscope channel.
 

Functions

TIEPIE_HW_API uint16_t tiepie_hw_oscilloscope_get_channel_count (tiepie_hw_handle handle)
 Get the number of channels. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_is_available (tiepie_hw_handle handle, uint16_t ch)
 Check whether the channel is available. More...
 

Detailed Description

Functions to setup and control oscilloscope channels.

An oscilloscope will have one or more input channels. Use tiepie_hw_oscilloscope_get_channel_count() to determine the amount of available channels.

All oscilloscope channel related functions use a channel number parameter to identify the channel. Channel numbers start at 0 for the first channel.

Function Documentation

◆ tiepie_hw_oscilloscope_get_channel_count()

TIEPIE_HW_API uint16_t tiepie_hw_oscilloscope_get_channel_count ( tiepie_hw_handle  handle)

Get the number of channels.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The number of channels.
Status values
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_available()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_is_available ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the channel is available.

Depending on other settings, a channel may currently not be available. It can still be enabled, but that will affect other settings.

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 available, 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