LibTiePie  0.6.1
Library for interfacing TiePie engineering instruments

Description

Functions to control the input coupling of an oscilloscope channel.

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

Functions

uint64_t ScpChGetCouplings (LibTiePieHandle_t hDevice, uint16_t wCh)
 Get the supported coupling kinds of a specified channel. More...
 
uint64_t ScpChGetCoupling (LibTiePieHandle_t hDevice, uint16_t wCh)
 Get the currently set coupling of a specified channel. More...
 
uint64_t ScpChSetCoupling (LibTiePieHandle_t hDevice, uint16_t wCh, uint64_t qwCoupling)
 Set the coupling of a specified channel. More...
 

Function Documentation

uint64_t ScpChGetCouplings ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Get the supported coupling kinds of a specified channel.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
The supported coupling kinds, a set of OR-ed CK_* values.
Status values
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChGetCoupling
ScpChSetCoupling
Since
0.4.0
uint64_t ScpChGetCoupling ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Get the currently set coupling of a specified channel.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
Coupling, a CK_* value.
Status values
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChGetCouplings
ScpChSetCoupling
Since
0.4.0
uint64_t ScpChSetCoupling ( LibTiePieHandle_t  hDevice,
uint16_t  wCh,
uint64_t  qwCoupling 
)

Set the coupling of a specified channel.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]qwCouplingThe required coupling, a CK_* value.
Returns
The actually set coupling, a CK_* value.
Status values
INVALID_VALUE The requested coupling kind is invalid.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Remarks
Changing the input coupling can affect the input range.
See also
ScpChGetCouplings
ScpChGetCoupling
Since
0.4.0