MultilevelSensor#

sensor_name#

sensor_name

Defined possible sensor types.

sensor_read_result_size_t#

sensor_read_result_size_t

Defined possible sensor read size.

sensor_read_result_precision#

sensor_read_result_precision

Defined possible sensor read precision.

sensor_interface_return_value_t#

sensor_interface_return_value_t

Defined sensor interface return values.

cc_multilevel_sensor_return_value#

cc_multilevel_sensor_return_value

Defined Multilevel Sensor return values.

sensor_name_t#

typedef enum sensor_name sensor_name_t

Defined possible sensor types.

sensor_type_t#

typedef struct _sensor_type sensor_type_t

Structure that holds the attributes of a sensor type.

sensor_read_result_t#

typedef struct _sensor_read_result sensor_read_result_t

sensor_interface_t#

typedef struct _sensor_interface sensor_interface_t

Structure that holds a read result from the read interface.

sensor_interface_iterator_t#

typedef struct _sensor_interface sensor_interface_iterator_t

sensor_administration_t#

typedef struct _sensor_administration sensor_administration_t

Structure that administrate all of the registered sensors.

cc_multilevel_sensor_send_sensor_data#

void cc_multilevel_sensor_send_sensor_data (void )

This function will report the registered sensor's measured datas to the Lifeline group.

cc_multilevel_sensor_config_register_instances#

void cc_multilevel_sensor_config_register_instances (void )

cc_multilevel_sensor_init_all_sensor#

void cc_multilevel_sensor_init_all_sensor (void )

Calls the init function for all of the registered sensor interfaces.

cc_multilevel_sensor_check_scale#

uint8_t cc_multilevel_sensor_check_scale (const sensor_interface_t * i_interface, uint8_t i_scale)

Checks if the wanted scale is a legal one for an interface.

If the scale is not set the function will return with the first available scale. The function will iterate from bit 0 to 7 to look for the first scale which is supported. That will be the default scale. Returns

• a usable scale value, if the input i_scale is valid that will be return, else the default one.

cc_multilevel_sensor_check_sensor_type_registered#

cc_multilevel_sensor_return_value cc_multilevel_sensor_check_sensor_type_registered (uint8_t endpoint, uint8_t sensor_type_value)

Checks if the wanted sensor type has a registered interface or not.

Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if interface is registered for a sensor, else CC_MULTILEVEL_SENSOR_RETURN_VALUE_NOT_FOUND.

cc_multilevel_sensor_registration#

cc_multilevel_sensor_return_value cc_multilevel_sensor_registration (sensor_interface_t * i_new_sensor)

Registers an interface to a specific sensor type.

The number of registered sensor types is maximized with REGISTERED_SENSOR_NUMBER_LIMIT Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if interface is registered for a sensor.

cc_multilevel_sensor_get_supported_sensors#

cc_multilevel_sensor_return_value cc_multilevel_sensor_get_supported_sensors (uint8_t * o_supported_sensor_buffer)

Fills an input buffer with flags where each flag represents a supported sensor.

Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if success, else CC_MULTILEVEL_SENSOR_RETURN_VALUE_ERROR.

cc_multilevel_sensor_get_supported_scale#

cc_multilevel_sensor_return_value cc_multilevel_sensor_get_supported_scale (uint8_t sensor_type_value, uint8_t * o_supported_scale)

Fills an input buffer with flags where each flag represents a supported scale.

Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if interface is registered for a sensor.

cc_multilevel_sensor_get_interface#

cc_multilevel_sensor_return_value cc_multilevel_sensor_get_interface (uint8_t endpoint, uint8_t sensor_type_value, sensor_interface_t ** o_interface)

Getter function for a sensor type's interface.

Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if interface is registered for a sensor, else CC_MULTILEVEL_SENSOR_RETURN_VALUE_NOT_FOUND.

cc_multilevel_sensor_get_default_sensor_type#

cc_multilevel_sensor_return_value cc_multilevel_sensor_get_default_sensor_type (uint8_t * o_default_sensor_type)

Gets the default sensor type value.

Basically the first registered sensor interface' type is the default one. Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if there is any registered interface, else CC_MULTILEVEL_SENSOR_RETURN_VALUE_ERROR.

cc_multilevel_sensor_init_iterator#

cc_multilevel_sensor_return_value cc_multilevel_sensor_init_iterator (sensor_interface_iterator_t ** i_iterator)

Initialize an iterator struct for the registered sensor interfaces.

If there is any registered interface the iterator will be NULL. Returns

• CC_MULTILEVEL_SENSOR_RETURN_VALUE_OK if success, else CC_MULTILEVEL_SENSOR_RETURN_VALUE_ERROR..

cc_multilevel_sensor_next_iterator#

void cc_multilevel_sensor_next_iterator (sensor_interface_iterator_t ** i_iterator)

Moves the iterator reference forward to the next registered interface, if the current is the last one then NULL If there is any registered interface the iterator will be NULL.

cc_multilevel_sensor_get_number_of_registered_sensors#

uint8_t cc_multilevel_sensor_get_number_of_registered_sensors (void )

Returns the number of registered sensor interfaces.

Returns

• Number of registered sensor interfaces.

cc_multilevel_sensor_reset_administration#

void cc_multilevel_sensor_reset_administration (void )

Removes all of the registered sensor interfaces from the administration.

cc_multilevel_sensor_get_sensor_type#

const sensor_type_t * cc_multilevel_sensor_get_sensor_type (sensor_name_t i_sensor_name)

Returns a sensor_type_t struct from the sensor_types config table.

Returns

• sensor_type_t struct which includes the type attributes.

cc_multilevel_sensor_init_interface#

sensor_interface_return_value_t cc_multilevel_sensor_init_interface (sensor_interface_t * i_instance, sensor_name_t i_name)

Initialize a sensor interface instance.

Sets the whole struct to zero and sets the reference to the appropiate sensor_type_t struct. Returns

• Status of the initialization.

cc_multilevel_sensor_add_supported_scale_interface#

sensor_interface_return_value_t cc_multilevel_sensor_add_supported_scale_interface (sensor_interface_t * i_instance, uint8_t i_scale)

Adds a new scale to an existing interface.

Supported scales must be set by this function during initialization. Returns

• Status of the new scale value registration.