Zigbee Protocol Controller 1.6.0
Zigpc_binding_mqtt

API and functions for interacting with MQTT for bindings. More...

Functions

sl_status_t zigpc_binding_init_mqtt (zigbee_eui64_uint_t eui64, zigbee_endpoint_id_t endpoint)
 zigpc_binding_init_mqtt - Initialize all the MQTT topics for the binding cluster More...
 
sl_status_t zigpc_publish_binding_table (zigbee_eui64_uint_t eui64, zigbee_endpoint_id_t endpoint)
 zigpc_publish_binding_table - publish the binding table of a node/endpoint combination to MQTT. Fetches the persisted bindings from the datastore and then parses that to MQTT More...
 
sl_status_t zigpc_binding_mqtt_publish_bindable_clusters (zigbee_eui64_uint_t eui64, zigbee_endpoint_id_t endpoint)
 zigpc_binding_mqtt_update_bindable_clusters - update the clusters which the endpoint can bind to on MQTT More...
 
sl_status_t zigpc_binding_mqtt_publish_table_full (zigbee_eui64_uint_t eui64, zigbee_endpoint_id_t endpoint, bool is_reported, bool table_full_value)
 zigpc_binding_mqtt_pub_table_full - publish the "BindingTableFull" attribute to MQTT for a given node/endpoint combination More...
 

Detailed Description

API and functions for interacting with MQTT for bindings.

Function Documentation

◆ zigpc_binding_init_mqtt()

sl_status_t zigpc_binding_init_mqtt ( zigbee_eui64_uint_t  eui64,
zigbee_endpoint_id_t  endpoint 
)

zigpc_binding_init_mqtt - Initialize all the MQTT topics for the binding cluster

Parameters
eui64- the address of the node
endpoint- the endpoint id where the bindings will be initiated
Returns
SL_STATUS_OK if the MQTT topics could be successfully set up

◆ zigpc_binding_mqtt_publish_bindable_clusters()

sl_status_t zigpc_binding_mqtt_publish_bindable_clusters ( zigbee_eui64_uint_t  eui64,
zigbee_endpoint_id_t  endpoint 
)

zigpc_binding_mqtt_update_bindable_clusters - update the clusters which the endpoint can bind to on MQTT

Parameters
eui64- the address of the node
endpoint- the ID of the endpoint that can be bound
Returns
SL_STATUS_OK if MQTT could be properly updated

◆ zigpc_binding_mqtt_publish_table_full()

sl_status_t zigpc_binding_mqtt_publish_table_full ( zigbee_eui64_uint_t  eui64,
zigbee_endpoint_id_t  endpoint,
bool  is_reported,
bool  table_full_value 
)

zigpc_binding_mqtt_pub_table_full - publish the "BindingTableFull" attribute to MQTT for a given node/endpoint combination

Parameters
eui64- the address of the node
endpoint- the endpoint id whose binding table status is being published to MQTT
Returns
SL_STATUS_OK if the "BindingTableFull" attribute could be properly updated

◆ zigpc_publish_binding_table()

sl_status_t zigpc_publish_binding_table ( zigbee_eui64_uint_t  eui64,
zigbee_endpoint_id_t  endpoint 
)

zigpc_publish_binding_table - publish the binding table of a node/endpoint combination to MQTT. Fetches the persisted bindings from the datastore and then parses that to MQTT

Parameters
eui64- address of the node
endpoint- the ID of the endpoint containing the bindings
Returns
SL_STATUS_OK if able to retrieve all information and publish as an MQTT message