_data_param_info_t Struct Reference

Contains the set of definitions required by a specific data parameter.

Public Attributes
base_data_type_t	type
data_units_t	unit
uint8_t	index
uint16_t	arg
const char *	name
device_err_t(*	Setter_FromText )(struct _data_param_info_t *paramInfo, const char *value)
	Callback that gets the value of a parameter in string format.
device_err_t(*	Getter )(struct _data_param_info_t *paramInfo, data_union_t *value)
	Callback that sets the value of a parameter in string format.
device_err_t(*	Setter )(struct _data_param_info_t *paramInfo, data_union_t value)
	Callback that gets the value of a parameter.

Member Data Documentation

arg

uint16_t _data_param_info_t::arg

Custom argument used by the data parameter

Getter

device_err_t(* _data_param_info_t::Getter) (struct _data_param_info_t *paramInfo, data_union_t *value)

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.

index

uint8_t _data_param_info_t::index

–TODO–

name

const char* _data_param_info_t::name

Name of the parameter

Setter

device_err_t(* _data_param_info_t::Setter) (struct _data_param_info_t *paramInfo, data_union_t value)

Parameters

paramInfo	Information regarding the data parameter.
value	Location where parameter value is to be updated.

Returns

device_err_t If successful ERR_OK else some other error.

Setter_FromText

device_err_t(* _data_param_info_t::Setter_FromText) (struct _data_param_info_t *paramInfo, const char *value)

Parameters

paramInfo	Information regarding the data parameter.
value	text representation of the value acquired.
addUnit	If true append the unit of the parameter at the end of the string result.

Returns

device_err_t If successful ERR_OK else some other error.

type

base_data_type_t _data_param_info_t::type

Type of data

unit

data_units_t _data_param_info_t::unit

Unit of data