Functions

Functions
device_err_t	Default_GetDataParameter_InText (data_param_info_t *_paramInfo, char *value, bool addUnit)
	Default function to get the data parameters in textual format, according to the parameter info.
device_err_t	Default_SetDataParameter_FromText (data_param_info_t *_paramInfo, const char *value)
	Default function to set the data parameters from textual value, according to the parameter info.
device_err_t	Default_GetDataParameter (data_param_info_t *_paramInfo, data_union_t *value)
	Default function to get the value of a parameter in string format.
device_err_t	Default_SetDataParameter (data_param_info_t *_paramInfo, data_union_t value)
	Default function to set the value of a parameter from string format.
static device_err_t	GetDataParameter_InText (data_param_info_t *_paramInfo, char *value, bool addUnit)
	Gets the data parameters in textual format, according to the parameter info. If appropriate function not found, calls the default function.
static device_err_t	SetDataParameter_FromText (data_param_info_t *_paramInfo, const char *value)
	Sets the data parameters from textual value, according to the parameter info. If appropriate function not found, calls the default function.
static device_err_t	GetDataParameter (data_param_info_t *_paramInfo, data_union_t *value)
	Gets the data parameters according to the parameter info. If appropriate function not found, calls the default function.
static device_err_t	SetDataParameter (data_param_info_t *_paramInfo, data_union_t value)
	Sets the data parameters according to the parameter info. If appropriate function not found, calls the default function.

Detailed Description

Function Documentation

Default_GetDataParameter()

device_err_t Default_GetDataParameter ( data_param_info_t *  _paramInfo, data_union_t *  value  )

extern

Note

This function is used whenever the data_param_info_t::Getter function is not defined and GetDataParameter() is called.

A weak implementation of this function is provided. User can create a custom implementation if needed.

Parameters

_paramInfo	Information regarding the data parameter.
value	text representation of the value acquired.

Returns

device_err_t If successful ERR_OK else some other error.

Default_GetDataParameter_InText()

device_err_t Default_GetDataParameter_InText ( data_param_info_t *  _paramInfo, char *  value, bool  addUnit  )

extern

Note

A weak implementation of this function is provided. User can create a custom implementation if needed.

Parameters

_paramInfo	Structure defining the parameter.
value	Pointer to the location to be updated with the value
addUnit	true if unit needs to be added with the text else false.

Returns

ERR_OK if no error else appropriate error thrown

Default_SetDataParameter()

device_err_t Default_SetDataParameter ( data_param_info_t *  _paramInfo, data_union_t  value  )

extern

Note

This function is used whenever the data_param_info_t::Setter function is not defined and SetDataParameter() is called.

A weak implementation of this function is provided. User can create a custom implementation if needed.

Parameters

_paramInfo	Information regarding the data parameter.
value	text representation of the parameter value.

Returns

device_err_t If successful ERR_OK else some other error.

Default_SetDataParameter_FromText()

device_err_t Default_SetDataParameter_FromText ( data_param_info_t *  _paramInfo, const char *  value  )

extern

Note

A weak implementation of this function is provided. User can create a custom implementation if needed.

Parameters

_paramInfo	Structure defining the parameter.
value	Value to be set as string

Returns

ERR_OK if no error else appropriate error thrown

GetDataParameter()

static device_err_t GetDataParameter ( data_param_info_t *  _paramInfo, data_union_t *  value  )

static

Parameters

_paramInfo	Structure defining the parameter.
value	Pointer to the location to be updated with the value

Returns

ERR_OK if no error else appropriate error thrown

GetDataParameter_InText()

static device_err_t GetDataParameter_InText ( data_param_info_t *  _paramInfo, char *  value, bool  addUnit  )

static

Parameters

_paramInfo	Structure defining the parameter.
value	Pointer to the location to be updated with the value
addUnit	true if unit needs to be added with the text else false.

Returns

ERR_OK if no error else appropriate error thrown

SetDataParameter()

static device_err_t SetDataParameter ( data_param_info_t *  _paramInfo, data_union_t  value  )

static

Parameters

_paramInfo	Structure defining the parameter.
value	Value to be set

Returns

ERR_OK if no error else appropriate error thrown

SetDataParameter_FromText()

static device_err_t SetDataParameter_FromText ( data_param_info_t *  _paramInfo, const char *  value  )

static

Parameters

_paramInfo	Structure defining the parameter.
value	Value to be set as string

Returns

ERR_OK if no error else appropriate error thrown