Configuration#

Modules#

cc_config_parameter_value_t

_cc_config_parameter_attributes_t

cc_config_parameter_metadata_t

cc_config_parameter_buffer_t

cc_configuration_t

cc_configuration_io_interface_t

_cc_config_parameter_attributes_t.flags

Enumerations#

enum
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
}

Defines the size options of a value.

enum
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
}

Defines the format options of a value.

enum
CC_CONFIG_RETURN_CODE_NOT_SUPPORTED
CC_CONFIG_RETURN_CODE_IO_FAIL
CC_CONFIG_RETURN_CODE_OK
}

Return value of the configuration set process.

Typedefs#

typedef void *

Defines a handle type for the Configuration CC.

Functions#

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.

bool
cc_configuration_get(uint16_t parameter_number, cc_config_parameter_buffer_t *parameter_buffer)

Initialize the configuration Command Class.

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.

void
cc_configuration_set_default_configuration(cc_configuration_t const *configuration)

Sets default configuration in the Command Class.

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.

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.

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.

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.


Definition at line 39 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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.


Definition at line 51 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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

Definition at line 111 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

Typedef Documentation#

cc_config_parameter_attributes_t#

typedef struct _cc_config_parameter_attributes_t cc_config_parameter_attributes_t

Definition at line 91 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

cc_config_parameter_buffer_t#

typedef struct cc_config_parameter_buffer_t cc_config_parameter_buffer_t

Definition at line 93 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

cc_configuration_handle_t#

typedef void* cc_configuration_handle_t

Defines a handle type for the Configuration CC.


Definition at line 140 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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.

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.

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

    • Returns true if the value was set, false otherwise.


Definition at line 151 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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


Definition at line 163 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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


Definition at line 171 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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


Definition at line 179 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Configuration/inc/CC_Configuration.h

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