Configuration structure for the Unify DotDot Attribute Store component. More...

#include <unify_dotdot_attribute_store.h>

Public Attributes
endpoint_node_fetching_function_t	get_endpoint_node_function
	endpoint_node_fetching_function_t function that returns the Attribute Store node for an endpoint based on a UNID/Endpoint ID. Set this to NULL if this function is not available More...

unid_fetching_function_t	get_unid_endpoint_function
	unid_fetching_function_t function that outputs UNID/Endpoints based on a Attribute Store node. The attribute Store node may be located at any depth under the endpoint node. More...

unid_only_fetching_function_t	get_unid_function
	unid_only_fetching_function_t function that outputs UNID based on a Attribute Store node. This function will be used on in cases when we do not have any endpoint, but need to read UNIDs. This is used by the node state component. More...

bool	update_attribute_desired_values_on_commands
	Enables or disables the automatic updating of ZCL attribute desired values upon MQTT command reception. More...

bool	clear_reported_on_desired_updates
	Instructs if the component should clear reported values when setting a new desired values. It can e.g. used in combination with the Attribute Resolver to force reading the state of an attribute after issuing a command Note that this has no effect if update_attribute_desired_values_on_commands is set to false. More...

bool	automatic_deduction_of_supported_commands
	Enables or disables the automatic deduction of supported commands for a node based on the ZCL attributes present in the attribute store. When DotDot MQTT performs a UIC_MQTT_DOTDOT_CALLBACK_TYPE_SUPPORT_CHECK call to its command registered callbacks, this component can be configured to return SL_STATUS_OK based on the list of supported attributes. More...

bool	force_read_attributes_enabled
	When enabled, ForceReadAttribute will undefine the reported value of ZCL/DotDot attribute to trigger a re-resolution. More...

bool	write_attributes_enabled
	Enables or disables the automatic publishing of ZCL Attributes values to MQTT. More...

bool	publish_desired_attribute_values_to_mqtt
	Enables or disables the automatic publishing of ZCL Attributes desired values to MQTT. More...

bool	publish_reported_attribute_values_to_mqtt
	Enables or disables the automatic publishing of ZCL Attributes reported values to MQTT. More...

attribute_store_type_t	node_type
	Type of an node attribute. More...

attribute_store_type_t	endpoint_type
	Type of an endpoint attribute. More...

Detailed Description

Configuration structure for the Unify DotDot Attribute Store component.

Member Data Documentation

◆ automatic_deduction_of_supported_commands

bool unify_dotdot_attribute_store_configuration_t::automatic_deduction_of_supported_commands

Enables or disables the automatic deduction of supported commands for a node based on the ZCL attributes present in the attribute store. When DotDot MQTT performs a UIC_MQTT_DOTDOT_CALLBACK_TYPE_SUPPORT_CHECK call to its command registered callbacks, this component can be configured to return SL_STATUS_OK based on the list of supported attributes.

◆ clear_reported_on_desired_updates

bool unify_dotdot_attribute_store_configuration_t::clear_reported_on_desired_updates

Instructs if the component should clear reported values when setting a new desired values. It can e.g. used in combination with the Attribute Resolver to force reading the state of an attribute after issuing a command Note that this has no effect if update_attribute_desired_values_on_commands is set to false.

◆ endpoint_type

attribute_store_type_t unify_dotdot_attribute_store_configuration_t::endpoint_type

Type of an endpoint attribute.

◆ force_read_attributes_enabled

bool unify_dotdot_attribute_store_configuration_t::force_read_attributes_enabled

When enabled, ForceReadAttribute will undefine the reported value of ZCL/DotDot attribute to trigger a re-resolution.

◆ get_endpoint_node_function

endpoint_node_fetching_function_t unify_dotdot_attribute_store_configuration_t::get_endpoint_node_function

endpoint_node_fetching_function_t function that returns the Attribute Store node for an endpoint based on a UNID/Endpoint ID. Set this to NULL if this function is not available

◆ get_unid_endpoint_function

unid_fetching_function_t unify_dotdot_attribute_store_configuration_t::get_unid_endpoint_function

unid_fetching_function_t function that outputs UNID/Endpoints based on a Attribute Store node. The attribute Store node may be located at any depth under the endpoint node.

◆ get_unid_function

unid_only_fetching_function_t unify_dotdot_attribute_store_configuration_t::get_unid_function

unid_only_fetching_function_t function that outputs UNID based on a Attribute Store node. This function will be used on in cases when we do not have any endpoint, but need to read UNIDs. This is used by the node state component.

◆ node_type

attribute_store_type_t unify_dotdot_attribute_store_configuration_t::node_type

Type of an node attribute.

◆ publish_desired_attribute_values_to_mqtt

bool unify_dotdot_attribute_store_configuration_t::publish_desired_attribute_values_to_mqtt

Enables or disables the automatic publishing of ZCL Attributes desired values to MQTT.

◆ publish_reported_attribute_values_to_mqtt

bool unify_dotdot_attribute_store_configuration_t::publish_reported_attribute_values_to_mqtt

Enables or disables the automatic publishing of ZCL Attributes reported values to MQTT.

◆ update_attribute_desired_values_on_commands

bool unify_dotdot_attribute_store_configuration_t::update_attribute_desired_values_on_commands

Enables or disables the automatic updating of ZCL attribute desired values upon MQTT command reception.

◆ write_attributes_enabled

bool unify_dotdot_attribute_store_configuration_t::write_attributes_enabled

Enables or disables the automatic publishing of ZCL Attributes values to MQTT.

The documentation for this struct was generated from the following file:

components/unify_dotdot_attribute_store/include/unify_dotdot_attribute_store.h

Public Attributes