API functions

Enumerations
enum	fedev_completion_e {   FEDEV_RC_OK = 0, FEDEV_RC_FAILURE, FEDEV_RC_INVALID_PARAM, FEDEV_RC_DEVICE_UNKNOWN,   FEDEV_RC_QUEUE_FULL, FEDEV_RC_I_ERROR_000 = 100, FEDEV_RC_I_ERROR_001, FEDEV_RC_I_ERROR_002,   FEDEV_RC_I_ERROR_003, FEDEV_RC_I_ERROR_004, FEDEV_RC_I_ERROR_005, FEDEV_RC_I_ERROR_006,   FEDEV_RC_I_ERROR_007, FEDEV_RC_I_ERROR_008, FEDEV_RC_I_ERROR_009, FEDEV_RC_I_ERROR_010,   FEDEV_RC_I_ERROR_011, FEDEV_RC_I_ERROR_012, FEDEV_RC_I_ERROR_013, FEDEV_RC_I_ERROR_014,   FEDEV_RC_I_ERROR_015, FEDEV_RC_I_ERROR_016, FEDEV_RC_I_ERROR_017, FEDEV_RC_I_ERROR_018,   FEDEV_RC_I_ERROR_019, FEDEV_RC_MAX = 0xFFFFFFFF }
Functions
int	fedev_setDeviceInfoSynch (const char *deviceName, const char *deviceModel, const char *devManName, char *errMsg, unsigned int errLen)
int	fedev_setDeviceInfo (const char *deviceName, const char *deviceModel, const char *devManName, char *errMsg, unsigned int errLen)
int	fedev_getDump (char *dumpBuf, int bufLen)
int	fedev_getDeviceInfo (char *deviceName, char *deviceModel, int deviceModelLen, char *devManName, int devManNameLen, char *seName, int seNameLen, char *errMsg, int errLen)

---

Enumeration Type Documentation

enum fedev_completion_e

completion codes of API functions

---

Function Documentation

int fedev_getDeviceInfo	(	char *	deviceName,
		char *	deviceModel,
		int	deviceModelLen,
		char *	devManName,
		int	devManNameLen,
		char *	seName,
		int	seNameLen,
		char *	errMsg,
		int	errLen
	)

Get device info from database

Parameters:

	deviceName	name of device (max 16 bytes)
	deviceModel	model type of device
	deviceModelLen	length of buffer (at least 16bytes)
	devManName	name of the devicemanager (max 16 bytes)
	devManNameLen	lenth of buffer (at least 16bytes)
	seName	name of the control unit
	seNameLen	lenth of buffer (at least 16bytes)
	errMsg	if supplied, an error message is returned in case of FEDEV_RC_FAILURE
	errLen	length of the supplied error message buffer

Returns:

• FEDEV_RC_OK success
• FEDEV_RC_FAILURE error, you may get more info from errMsg
• FEDEV_RC_INVALID_PARAM error, check input parameter

int fedev_getDump	(	char *	dumpBuf,
		int	bufLen
	)

Dump status info of hidden implementation: Only for debug purpose.

Parameters:

	dumpBuf	Buffer to store dump
	bufLen	Length of supplied buffer

Returns:

• length of dump written to buffer

int fedev_setDeviceInfo	(	const char *	deviceName,
		const char *	deviceModel,
		const char *	devManName,
		char *	errMsg,
		unsigned int	errLen
	)

Set up asynchronously device info of an online device, i.e. device infos are pushed to a hidden message queue which is processed asynchronously. Use this method to ensure complete decoupling from hidden implementation.

Parameters:

	deviceName	name of device (max 16 bytes)
	deviceModel	model type of device (max 16 bytes)
	devManName	name of the devicemanager (max 16 bytes)
	errMsg	if not NULL, an informational error message is copied to this buffer
	errLen	length of the supplied error message buffer

Returns:

• FEDEV_RC_OK success, info put to queue, but not yet processed.
• FEDEV_RC_QUEUE_FULL message queue overrun
• FEDEV_RC_INVALID_PARAM invalid parameter, check input parameter
• else internal error

int fedev_setDeviceInfoSynch	(	const char *	deviceName,
		const char *	deviceModel,
		const char *	devManName,
		char *	errMsg,
		unsigned int	errLen
	)

Set up device info of an online device (synchronously).

Parameters:

	deviceName	name of device (max 16 bytes)
	deviceModel	model type of device (max 16 bytes)
	devManName	name of the devicemanager (max 16 bytes)
	errMsg	if not NULL, an error message is copied to this buffer in case of FEDEV_RC_FAILURE
	errLen	length of the supplied error message buffer

Returns:

• FEDEV_RC_OK success
• FEDEV_RC_FAILURE error, you may get more info from errMsg
• FEDEV_RC_INVALID_PARAM error, check input parameter

---