Channels

Description

Functions to setup and control oscilloscope channels.

An oscilloscope will have one or more input channels. Use ScpGetChannelCount() 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.

Modules
	Info
	Functions to retrieve information from 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.
	Probe
	Functions to control the probe settings of an oscilloscope channel.
	Range
	Functions to control the input range of an oscilloscope channel.
	Trigger
	Functions to control the trigger settings of an input channel.

Functions
uint16_t	ScpGetChannelCount (TpDeviceHandle_t hDevice)
	Get the number of channels. More...
bool8_t	ScpChIsAvailable (TpDeviceHandle_t hDevice, uint16_t wCh)
	Check whether the channel is available. More...

Function Documentation

uint16_t ScpGetChannelCount

(

TpDeviceHandle_t

hDevice

)

Get the number of channels.

Parameters

[in]

hDevice

A device handle identifying the oscilloscope.

Returns

The number of channels.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since

0.4.0

bool8_t ScpChIsAvailable	(	TpDeviceHandle_t	hDevice,
		uint16_t	wCh
	)

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]	hDevice	A device handle identifying the oscilloscope.
[in]	wCh	The channel number identifying the channel, 0 to ScpGetChannelCount() - 1.

Returns

BOOL8_TRUE if available, BOOL8_FALSE otherwise.

Status values

INVALID_CHANNEL	The requested channel number is not valid.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since

0.4.4