LibTiePie  0.4.3
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Groups Pages
Combined instrument

Functions

uint32_t LstDevGetContainedSerialNumbers (uint32_t dwIdKind, uint32_t dwId, uint32_t *pBuffer, uint32_t dwBufferLength)
 Get serial numbers of the instruments contained in a combined instrument.
 
uint32_t LstCbDevGetProductId (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the product id of an instrument contained in a combined instrument.
 
uint32_t LstCbDevGetVendorId (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the vendor id of an instrument contained in a combined instrument.
 
uint32_t LstCbDevGetName (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength)
 Get the name of an instrument contained in a combined instrument.
 
uint32_t LstCbDevGetNameShort (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength)
 Get the short name of an instrument contained in a combined instrument.
 
TpVersion_t LstCbDevGetDriverVersion (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the driver version of an instrument contained in a combined instrument.
 
TpVersion_t LstCbDevGetFirmwareVersion (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the firmware version of an instrument contained in a combined instrument.
 
TpDate_t LstCbDevGetCalibrationDate (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the calibration date of an instrument contained in a combined instrument.
 
uint16_t LstCbScpGetChannelCount (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the channel count of an oscilloscope contained in a combined oscilloscope.
 

Detailed Description

Function Documentation

uint32_t LstDevGetContainedSerialNumbers ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t *  pBuffer,
uint32_t  dwBufferLength 
)

Get serial numbers of the instruments contained in a combined instrument.

Example:

uint32_t dwLength = LstDevGetContainedSerialNumbers( dwIdKind , dwId , NULL , 0 );
uint32_t* pSerialNumbers = malloc( sizeof( uint32_t ) * dwLength );
dwLength = LstDevGetContainedSerialNumbers( dwIdKind , dwId , pSerialNumbers , dwLength );
for( i = 0 ; i < dwLength ; i++ )
printf( "%u\n" , pSerialNumbers[ i ] );
free( pSerialNumbers );
Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
pBufferPointer to buffer for serial numbers.
dwBufferLengthLength of the buffer.
Returns
Number of instruments in the combined instrument, or zero if the instrument isn't a combined instrument.
uint32_t LstCbDevGetProductId ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber 
)

Get the product id of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
Returns
Contained instruments product id.
uint32_t LstCbDevGetVendorId ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber 
)

Get the vendor id of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
Returns
Contained instruments vendor id.
uint32_t LstCbDevGetName ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber,
char *  pBuffer,
uint32_t  dwBufferLength 
)

Get the name of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
pBufferPointer to buffer to write to.
dwBufferLengthLength of the buffer.
Returns
Name length excluding excluding terminating zero.
uint32_t LstCbDevGetNameShort ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber,
char *  pBuffer,
uint32_t  dwBufferLength 
)

Get the short name of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
pBufferPointer to buffer to write to.
dwBufferLengthLength of the buffer.
Returns
Short name length excluding excluding terminating zero.
TpVersion_t LstCbDevGetDriverVersion ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber 
)

Get the driver version of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
Returns
Contained instruments driver version, or zero if no driver version is available.
TpVersion_t LstCbDevGetFirmwareVersion ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber 
)

Get the firmware version of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
Returns
Contained instruments firmware version, or zero if no firmware version is available.
TpDate_t LstCbDevGetCalibrationDate ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber 
)

Get the calibration date of an instrument contained in a combined instrument.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
Returns
Contained instruments calibration date, or zero if no calibration date is available.
uint16_t LstCbScpGetChannelCount ( uint32_t  dwIdKind,
uint32_t  dwId,
uint32_t  dwContainedDeviceSerialNumber 
)

Get the channel count of an oscilloscope contained in a combined oscilloscope.

Parameters
dwIdKindAn id kind.
dwIdDevice index, Device ID or serial number as specified by dwIdKind.
dwContainedDeviceSerialNumberSerial number of the contained instrument.
Returns
Contained oscilloscope channel count.