Configuration#
Modules#
_cc_config_parameter_attributes_t
cc_config_parameter_metadata_t
cc_configuration_io_interface_t
_cc_config_parameter_attributes_t.flags
Enumerations#
Defines the size options of a value.
Defines the format options of a value.
Return value of the configuration set process.
Typedefs#
Defines a handle type for the Configuration CC.
Functions#
Sets a configuration parameter with the given number to the given value.
Initialize the configuration Command Class.
Limit a value by the parameter's limits.
Write a specific amount data to nvm.
Read a specific amount data to nvm.
Enumeration Documentation#
cc_config_parameter_size_t#
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. |
cc_config_parameter_format_t#
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_configuration_set_return_value#
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 | |
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.
Function Documentation#
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| cc_configuration_handle_t | [in] | handle | [deprecated] CC Configuration handle. (Not used) |
| uint16_t | [in] | number | The number of the parameter to be set. |
| cc_config_parameter_value_t | [in] | value | The value that the parameter must be set to. |
Upon invocation CC_Configuration_Set_handler will be called given that the number and value is valid. If the value was successfully changed, a Configuration Report will be sent to the lifeline. Returns
Returns true if the value was set, false otherwise.
cc_configuration_get#
bool cc_configuration_get (uint16_t parameter_number, cc_config_parameter_buffer_t * parameter_buffer)
Initialize the configuration Command Class.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | parameter_number | number of the parameter. |
| cc_config_parameter_buffer_t * | [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_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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| cc_config_parameter_buffer_t const * | [in] | parameter_buffer | pointer to the parameter buffer which holds the limit values |
| cc_config_parameter_value_t * | [out] | pNewValue | the new value to be limited |
Returns
Returns true if successfuly limiterd, false otherwise
cc_configuration_get_configuration#
const cc_configuration_t * cc_configuration_get_configuration (void )
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| zpal_nvm_object_key_t | [in] | file_id | Object key |
| uint8_t const * | [in] | data | pointer to the data to be written |
| size_t | [in] | size | amount of data in byte dimension |
Returns
Returns true if successfully wrote to nvm, else false
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| zpal_nvm_object_key_t | [in] | file_id | Object key |
| uint8_t * | [in] | data | pointer to the buffer where the data will be read into |
| size_t | [in] | size | wanted amount of data in byte dimension |
Returns
Returns true if successfully read from nvm, else false