Unify Framework Lib 1.6.0
UCL Node State

Handles publishing node state to ucl/by-unid/<node>/State topic. More...

Macros

#define MAX_COMMAND_DELAY_UNKNOWN   0xFFFFFFFF
 This represents with an unknown delay before it can be reached. More...
 
#define MAX_COMMAND_DELAY_INFINITE   0xFFFFFFFE
 

Functions

NodeStateNetworkStatus unify_attribute_store_node_state_get_status (attribute_store_node_t node)
 Reads the UCL network status of a node, starting from any attribute under the NodeID in the attribute store. More...
 
sl_status_t unify_dotdot_attribute_store_node_state_init ()
 

Detailed Description

Handles publishing node state to ucl/by-unid/<node>/State topic.

This component handles publishing the ucl/by-unid/<node>/State topic in MQTT It register callbacks in the Attribute Store for NETWORK_STATUS attribute and acts on these callbacks, when the state of the node changes, and publish the changes to MQTT.

UCL Node State design

Macro Definition Documentation

◆ MAX_COMMAND_DELAY_INFINITE

#define MAX_COMMAND_DELAY_INFINITE   0xFFFFFFFE

This represents with a possibly infinite delay before it can be reached (wakes up only on manual activations)

◆ MAX_COMMAND_DELAY_UNKNOWN

#define MAX_COMMAND_DELAY_UNKNOWN   0xFFFFFFFF

This represents with an unknown delay before it can be reached.

Function Documentation

◆ unify_attribute_store_node_state_get_status()

NodeStateNetworkStatus unify_attribute_store_node_state_get_status ( attribute_store_node_t  node)

Reads the UCL network status of a node, starting from any attribute under the NodeID in the attribute store.

Parameters
nodeAttribute store node under the NodeID for which we want to read the network status.

◆ unify_dotdot_attribute_store_node_state_init()

sl_status_t unify_dotdot_attribute_store_node_state_init ( )