Configuration

Collaboration diagram for Configuration:

Data Structures
union	cc_config_parameter_value_t
struct	_cc_config_parameter_attributes_t
struct	cc_config_parameter_metadata_t
struct	cc_config_parameter_buffer_t
struct	cc_configuration_t
struct	cc_configuration_io_interface_t

Typedefs
typedef struct _cc_config_parameter_attributes_t	cc_config_parameter_attributes_t
typedef struct cc_config_parameter_buffer_t	cc_config_parameter_buffer_t
typedef void *	cc_configuration_handle_t

Enumerations
enum	cc_config_parameter_size_t {   CC_CONFIG_PARAMETER_SIZE_8_BIT = 1 ,   CC_CONFIG_PARAMETER_SIZE_16_BIT = 2 ,   CC_CONFIG_PARAMETER_SIZE_32_BIT = 4 ,   CC_CONFIG_PARAMETER_SIZE_NOT_SPECIFIED = 0xFF }
enum	cc_config_parameter_format_t {   CC_CONFIG_PARAMETER_FORMAT_SIGNED_INTEGER = CONFIGURATION_PROPERTIES_REPORT_FORMAT_SIGNED_INTEGER_V3 ,   CC_CONFIG_PARAMETER_FORMAT_UNSIGNED_INTEGER = CONFIGURATION_PROPERTIES_REPORT_FORMAT_UNSIGNED_INTEGER_V3 ,   CC_CONFIG_PARAMETER_FORMAT_ENUMERATED = CONFIGURATION_PROPERTIES_REPORT_FORMAT_ENUMERATED_V3 ,   CC_CONFIG_PARAMETER_FORMAT_BIT_FIELD = CONFIGURATION_PROPERTIES_REPORT_FORMAT_BIT_FIELD_V3 }
enum	cc_config_configuration_set_return_value {   CC_CONFIG_RETURN_CODE_NOT_SUPPORTED ,   CC_CONFIG_RETURN_CODE_IO_FAIL ,   CC_CONFIG_RETURN_CODE_OK }

Functions
bool	CC_Configuration_SetValue (cc_configuration_handle_t handle, uint16_t number, cc_config_parameter_value_t value)
bool	cc_configuration_get (uint16_t parameter_number, cc_config_parameter_buffer_t *parameter_buffer)
void	cc_configuration_set_interface (cc_configuration_io_interface_t const *interface)
void	cc_configuration_set_default_configuration (cc_configuration_t const *configuration)
bool	cc_configuration_limit_value (cc_config_parameter_buffer_t const *parameter_buffer, cc_config_parameter_value_t *pNewValue)
const cc_configuration_t *	cc_configuration_get_configuration (void)
bool	cc_configuration_io_write (zpal_nvm_object_key_t file_id, uint8_t const *data, size_t size)
bool	cc_configuration_io_read (zpal_nvm_object_key_t file_id, uint8_t *data, size_t size)

Detailed Description

Typedef Documentation

cc_config_parameter_attributes_t

typedef struct _cc_config_parameter_attributes_t cc_config_parameter_attributes_t

cc_config_parameter_buffer_t

typedef struct cc_config_parameter_buffer_t cc_config_parameter_buffer_t

cc_configuration_handle_t

typedef void* cc_configuration_handle_t

Defines a handle type for the Configuration CC.

Enumeration Type Documentation

cc_config_configuration_set_return_value

enum cc_config_configuration_set_return_value

Return value of the configuration set process

Enumerator
CC_CONFIG_RETURN_CODE_NOT_SUPPORTED
CC_CONFIG_RETURN_CODE_IO_FAIL
CC_CONFIG_RETURN_CODE_OK

cc_config_parameter_format_t

enum cc_config_parameter_format_t

Defines the format options of a value.

Enumerator
CC_CONFIG_PARAMETER_FORMAT_SIGNED_INTEGER	CC_CONFIG_PARAMETER_FORMAT_SIGNED_INTEGER.
CC_CONFIG_PARAMETER_FORMAT_UNSIGNED_INTEGER	CC_CONFIG_PARAMETER_FORMAT_UNSIGNED_INTEGER.
CC_CONFIG_PARAMETER_FORMAT_ENUMERATED	CC_CONFIG_PARAMETER_FORMAT_ENUMERATED.
CC_CONFIG_PARAMETER_FORMAT_BIT_FIELD	CC_CONFIG_PARAMETER_FORMAT_BIT_FIELD.

cc_config_parameter_size_t

enum cc_config_parameter_size_t

Defines the size options of a value.

Enumerator
CC_CONFIG_PARAMETER_SIZE_8_BIT	CC_CONFIG_PARAMETER_SIZE_8_BIT.
CC_CONFIG_PARAMETER_SIZE_16_BIT	CC_CONFIG_PARAMETER_SIZE_16_BIT.
CC_CONFIG_PARAMETER_SIZE_32_BIT	CC_CONFIG_PARAMETER_SIZE_32_BIT.
CC_CONFIG_PARAMETER_SIZE_NOT_SPECIFIED	CC_CONFIG_PARAMETER_SIZE_NOT_SPECIFIED.

Function Documentation

cc_configuration_get()

bool cc_configuration_get	(	uint16_t	parameter_number,
		cc_config_parameter_buffer_t *	parameter_buffer )

Initialize the configuration Command Class

Parameters

[in]	parameter_number	number of the parameter.
[out]	parameter_buffer	pointer to a parameter buffer which will holds the metadata and current value of a parameter

Returns

Returns true if successfuly found and filled parameter buffer, false otherwise

cc_configuration_get_configuration()

const cc_configuration_t * cc_configuration_get_configuration

(

void

)

cc_configuration_io_read()

bool cc_configuration_io_read	(	zpal_nvm_object_key_t	file_id,
		uint8_t *	data,
		size_t	size )

Read a specific amount data to nvm

Parameters

[in]	file_id	Object key
[in]	data	pointer to the buffer where the data will be read into
[in]	size	wanted amount of data in byte dimension

Returns

Returns true if successfully read from nvm, else false

cc_configuration_io_write()

bool cc_configuration_io_write	(	zpal_nvm_object_key_t	file_id,
		uint8_t const *	data,
		size_t	size )

Write a specific amount data to nvm

Parameters

[in]	file_id	Object key
[in]	data	pointer to the data to be written
[in]	size	amount of data in byte dimension

Returns

Returns true if successfully wrote to nvm, else false

cc_configuration_limit_value()

bool cc_configuration_limit_value	(	cc_config_parameter_buffer_t const *	parameter_buffer,
		cc_config_parameter_value_t *	pNewValue )

Limit a value by the parameter's limits

Parameters

[in]	parameter_buffer	pointer to the parameter buffer which holds the limit values
[out]	pNewValue	the new value to be limited

Returns

Returns true if successfuly limiterd, false otherwise

cc_configuration_set_default_configuration()

void cc_configuration_set_default_configuration

(

cc_configuration_t const *

configuration

)

Sets default configuration in the Command Class

Parameters

[in]

configuration

pointer to a configuration set

cc_configuration_set_interface()

void cc_configuration_set_interface

(

cc_configuration_io_interface_t const *

interface

)

Sets new interface set to manipulate non volatile memory to store and read configuration values

Parameters

[in]

interface

pointer to the new interface set

CC_Configuration_SetValue()

bool CC_Configuration_SetValue	(	cc_configuration_handle_t	handle,
		uint16_t	number,
		cc_config_parameter_value_t	value )

Sets a configuration parameter with the given number to the given value.

• Upon invocation CC_Configuration_Set_handler will be called given that the number and value is valid.

  Parameters

  [in]	handle	CC Configuration handle.
  [in]	number	The number of the parameter to be set.
  [in]	value	The value that the parameter must be set to.

  Returns

  Returns true if the value was set, false otherwise.