SysInfo Class Reference

System information class. More...

#include <SysInfo.h>

List of all members.

Static Public Member Functions

static const char * getSerialNumber ()
 Get device serial number.
static const char * getModelType ()
 Get device model type.
static const char * getHardwareRevision ()
 Get device hardware revision.
static const char * getFirmwareVersion ()
 Get device firmware version.
static time_t getManufTimeStamp ()
 Get device manufacture date.
static SCANNER_INFORMATIONgetScannerInformation ()
 Get scanner information.
static int getCommModule ()
 Get communication module type.
static bool getUbootEnv (const char *varName, char *pBuf, int maxLen)
 Read bootloader environment variable.

Detailed Description

System information class.

System information class provides facilities to retrieve system hardware and software information, and global hardware configuration data. System information class contains static functions and does not require separate initialization.


Member Function Documentation

int SysInfo::getCommModule (  )  [static]

Get communication module type.

Retrieves the data terminal communication module type from the onboard flash memory.

Note:
The first call reads the flash block, subsequent calls reuse cached data.

Defined values are:

  • 0 -- No wireless connectivity
  • 1 -- GPRS module installed
  • 5 -- WLAN module installed
Returns:
Returns the mobile data terminal communication moduele type identifier.
const char * SysInfo::getFirmwareVersion (  )  [static]

Get device firmware version.

Retrieves the version of the data terminal firmware.

Note:
The first call reads the firmware version from file, subsequent calls reuse cached data.
Returns:
Returns the firmware version of the mobile data terminal.
const char * SysInfo::getHardwareRevision (  )  [static]

Get device hardware revision.

Retrieves the unit hardware revision from data terminal onboard flash memory.

Note:
The first call reads the flash block, subsequent calls reuse cached data.
Returns:
Returns the hardware revision of the mobile data terminal.
time_t SysInfo::getManufTimeStamp (  )  [static]

Get device manufacture date.

Retrieves the unit manufacture timestamp from data terminal onboard flash memory.

Note:
The first call reads the flash block, subsequent calls reuse cached data.
Returns:
Returns the manufacture timestamp of the mobile data terminal.
const char * SysInfo::getModelType (  )  [static]

Get device model type.

Retrieves the unit model type from data terminal onboard flash memory.

Note:
The first call reads the flash block, subsequent calls reuse cached data.

Defined values:

  • ts8 -- Artec Triskan TS8 mobile data terminal
Returns:
Returns the model type identifier of the mobile data terminal.
SCANNER_INFORMATION * SysInfo::getScannerInformation (  )  [static]

Get scanner information.

Retrieves information about a scanner module attached to the mobile data terminal.

Note:
The first call reads the data from the scanner module, subsequent calls reuse cached data, since the module is not hot-swappable.
Returns:
Returns scanner module descriptor. Returns NULL if the information is not available or communication to scanner module fails.
const char * SysInfo::getSerialNumber (  )  [static]

Get device serial number.

Retrieves the unit serial number from data terminal onboard flash memory.

Note:
The first call reads the flash block, subsequent calls reuse cached data.

Serial number should contain six decimal numbers.

Returns:
Returns the serial number of the mobile data terminal.
bool SysInfo::getUbootEnv ( const char *  varName,
char *  pBuf,
int  maxLen 
) [static]

Read bootloader environment variable.

Retrieves the value of the U-boot bootloader environment variable. The data is located in the mobile terminal internal flash memory. The bootloader environment variables are intended to store global manufacturing and configuration data which is considered read-only during a normal mobile terminal operation.

Parameters:
varName Specifies the name of the environment variable.
pBuf Contains a pointer to the buffer where the variable value is copied to.
maxLen Specifies the maximum length of the returned data.
Returns:
Returns true if the variable was read successfully. Returns false if the variable was not found, or on a flash memory error.

The documentation for this class was generated from the following files:
Generated on Wed Oct 20 11:13:45 2010 for libspatha by  doxygen 1.6.3