LibTiePie  0.4.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages

Description

Functions to retrieve information from an oscilloscope channel.

Functions

uint32_t ScpChGetConnectorType (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the channel connector type. More...
 
bool8_t ScpChIsDifferential (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the channel has a differential input. More...
 
double ScpChGetImpedance (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the channel input impedance. More...
 

Function Documentation

uint32_t ScpChGetConnectorType ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get the channel connector type.

Parameters
hDeviceA device handle identifying the oscilloscope.
wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
Channel connector type.
Status values
NOT_SUPPORTED The channel does not support reading the connector type.
INVALID_CHANNELThe 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.
SUCCESS The function executed successfully.
Since
0.4.0
bool8_t ScpChIsDifferential ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether the channel has a differential input.

Parameters
hDeviceA device handle identifying the oscilloscope.
wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
BOOL8_TRUE if differential, BOOL8_FALSE otherwise.
Status values
INVALID_CHANNELThe 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.
SUCCESS The function executed successfully.
Since
0.4.0
double ScpChGetImpedance ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get the channel input impedance.

Parameters
hDeviceA device handle identifying the oscilloscope.
wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
Channel input impedance in Ohm.
Status values
NOT_SUPPORTED The channel does not support reading the input impedance.
INVALID_CHANNELThe 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.
SUCCESS The function executed successfully.
Since
0.4.5