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

Description

Functions

bool8_t ScpHasConnectionTest (TpDeviceHandle_t hDevice)
 Check whether the instrument supports connection testing. More...
 
bool8_t ScpChHasConnectionTest (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether this channel supports connection testing. More...
 
bool8_t ScpStartConnectionTest (TpDeviceHandle_t hDevice, uint64_t qwChannelMask)
 Perform a connection test. More...
 
bool8_t ScpIsConnectionTestCompleted (TpDeviceHandle_t hDevice)
 Check whether the connection test is completed. More...
 
uint16_t ScpGetConnectionTestData (TpDeviceHandle_t hDevice, LibTiePieTriState_t *pBuffer, uint16_t wChannelCount)
 Get the connection test result data. More...
 

Function Documentation

bool8_t ScpHasConnectionTest ( TpDeviceHandle_t  hDevice)

Check whether the instrument supports connection testing.

Parameters
hDeviceA device handle.
Returns
Returns BOOL8_TRUE when at least one channel supports connection testing, BOOL8_FALSE otherwise.
Since
0.4.0
bool8_t ScpChHasConnectionTest ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether this channel supports connection testing.

Parameters
hDeviceA device handle.
wChChannel number, 0 to ScpGetChannelCount() - 1.
Returns
Returns BOOL8_TRUE if the channel supports connection test, BOOL8_FALSE otherwise.
Since
0.4.0
bool8_t ScpStartConnectionTest ( TpDeviceHandle_t  hDevice,
uint64_t  qwChannelMask 
)

Perform a connection test.

Parameters
hDeviceA device handle.
qwChannelMaskBit mask with channels to be used for the connection test, when zero the current active channels are used.
Returns
Returns BOOL8_TRUE if started successfully, BOOL8_FALSE otherwise.
Since
0.4.0
bool8_t ScpIsConnectionTestCompleted ( TpDeviceHandle_t  hDevice)

Check whether the connection test is completed.

Parameters
hDeviceA device handle.
Returns
Returns BOOL8_TRUE if completed, BOOL8_FALSE otherwise.
Since
0.4.0
uint16_t ScpGetConnectionTestData ( TpDeviceHandle_t  hDevice,
LibTiePieTriState_t pBuffer,
uint16_t  wChannelCount 
)

Get the connection test result data.

Parameters
hDeviceA device handle.
pBufferPointer to LibTiePieTriState_t array.
wChannelCountLength of LibTiePieTriState_t array.
Returns
Number of elements written in LibTiePieTriState_t array.
Since
0.4.0