General
[Functions]

Functions

void UpdateDeviceLists ()
TpDeviceHandle_t OpenGenerator (uint32_t dwId)
uint32_t GetGeneratorCount ()
TpDeviceHandle_t OpenOscilloscope (uint32_t dwId)
uint32_t GetOscilloscopeCount ()
void CloseDevice (TpDeviceHandle_t hDevice)
TpVersion_t GetVersion ()
LibTiePieStatus_t GetLastStatus ()
TpDate_t GetCalibrationDate (TpDeviceHandle_t hDevice)
uint32_t GetSerialNumber (TpDeviceHandle_t hDevice)

Function Documentation

void CloseDevice ( TpDeviceHandle_t  hDevice  ) 

Close a device handle

Parameters:
hDevice the handle to close
TpDate_t GetCalibrationDate ( TpDeviceHandle_t  hDevice  ) 

Read the calibration date of the instrument

uint16_t wYear = GetCalibrationDate( hDevice ) >> 16;
uint8_t byMonth = ( GetCalibrationDate( hDevice ) >> 8 ) & 0xff;
uint8_t byDay = GetCalibrationDate( hDevice ) & 0xff;

Parameters:
hDevice a device handle
Returns:
instruments calibration date
uint32_t GetGeneratorCount (  ) 

Get number of generators available

Returns:
number of generators available
LibTiePieStatus_t GetLastStatus (  ) 

On each function call GetLastStatus() is set

See also:
Status return codes
Returns:
status code
uint32_t GetOscilloscopeCount (  ) 

Get number of oscilloscopes available

Returns:
number of oscilloscopes available
uint32_t GetSerialNumber ( TpDeviceHandle_t  hDevice  ) 

Read the serial number of the instrument

Parameters:
hDevice a device handle
Returns:
instruments serial number
TpVersion_t GetVersion (  ) 

Get version number of the library

uint16_t wMajor = GetVersion() >> 48;
uint16_t wMinor = ( GetVersion() >> 32 ) & 0xffff;
uint16_t wRelease = ( GetVersion() >> 16 ) & 0xffff;
uint16_t wBuild = GetVersion() & 0xffff;

Returns:
Version number
TpDeviceHandle_t OpenGenerator ( uint32_t  dwId  ) 

Get handle to generator, for each index the handle is only assigend once.

Parameters:
dwId generator index or a Device ID or a serial number
Returns:
a device handle, or TPDEVICEHANDLE_INVALID on error
TpDeviceHandle_t OpenOscilloscope ( uint32_t  dwId  ) 

Get handle to oscilloscope, for each index the handle is only assigend once.

Parameters:
dwId oscilloscope index or a Device ID or a serial number
Returns:
a device handle, or TPDEVICEHANDLE_INVALID on error
void UpdateDeviceLists (  ) 

Search for new devices


Generated on Fri Apr 9 16:07:51 2010 for libtiepie by  doxygen 1.6.1