libtiepie  0.3.0
 All Files Functions Typedefs Groups
Device

Modules

 Events

Functions

void DevClose (TpDeviceHandle_t hDevice)
bool8_t DevIsRemoved (TpDeviceHandle_t hDevice)
TpVersion_t DevGetDriverVersion (TpDeviceHandle_t hDevice)
TpVersion_t DevGetFirmwareVersion (TpDeviceHandle_t hDevice)
TpDate_t DevGetCalibrationDate (TpDeviceHandle_t hDevice)
uint32_t DevGetSerialNumber (TpDeviceHandle_t hDevice)
uint32_t DevGetProductId (TpDeviceHandle_t hDevice)
uint32_t DevGetVendorId (TpDeviceHandle_t hDevice)
uint32_t DevGetName (TpDeviceHandle_t hDevice, char *pBuffer, uint32_t dwBufferLength)
uint32_t DevGetNameShort (TpDeviceHandle_t hDevice, char *pBuffer, uint32_t dwBufferLength)

Detailed Description


Function Documentation

void DevClose ( TpDeviceHandle_t  hDevice)

Close a device handle

Parameters:
hDevicethe handle to close
TpDate_t DevGetCalibrationDate ( TpDeviceHandle_t  hDevice)

Read the calibration date of the instrument

TpDate_t Date = GetCalibrationDate( hDevice ); uint16_t wYear = TPDATE_YEAR( Date );
uint8_t byMonth = TPDATE_MONTH( Date );
uint8_t byDay = TPDATE_DAY( Date );

Parameters:
hDevicea device handle
Returns:
instruments calibration date
TpVersion_t DevGetDriverVersion ( TpDeviceHandle_t  hDevice)

Get version number of the driver

TpVersion_t Version = DevGetDriverVersion( hDevice );
uint16_t wMajor = TPVERSION_MAJOR( Version );
uint16_t wMinor = TPVERSION_MINOR( Version );
uint16_t wRelease = TPVERSION_RELEASE( Version );
uint16_t wBuild = TPVERSION_BUILD( Version );

Parameters:
hDevicea device handle
Returns:
Library version number
TpVersion_t DevGetFirmwareVersion ( TpDeviceHandle_t  hDevice)

Get version number of the driver

TpVersion_t Version = DevGetFirmwareVersion( hDevice );
uint16_t wMajor = TPVERSION_MAJOR( Version );
uint16_t wMinor = TPVERSION_MINOR( Version );
uint16_t wRelease = TPVERSION_RELEASE( Version );
uint16_t wBuild = TPVERSION_BUILD( Version );

Parameters:
hDevicea device handle
Returns:
Library version number
uint32_t DevGetName ( TpDeviceHandle_t  hDevice,
char *  pBuffer,
uint32_t  dwBufferLength 
)
Parameters:
hDevicea device handle
uint32_t DevGetNameShort ( TpDeviceHandle_t  hDevice,
char *  pBuffer,
uint32_t  dwBufferLength 
)
Parameters:
hDevicea device handle
uint32_t DevGetProductId ( TpDeviceHandle_t  hDevice)
Parameters:
hDevicea device handle
uint32_t DevGetSerialNumber ( TpDeviceHandle_t  hDevice)

Read the serial number of the instrument

Parameters:
hDevicea device handle
Returns:
instruments serial number
uint32_t DevGetVendorId ( TpDeviceHandle_t  hDevice)
Parameters:
hDevicea device handle
bool8_t DevIsRemoved ( TpDeviceHandle_t  hDevice)

Check if a device is removed

Parameters:
hDevicea device handle
Returns:
1 if removed else 0