zigpc_ucl::pc_nwmgmt Namespace Reference

UCL operations manipulating the following topics: More...

Functions
sl_status_t	on_net_init (zigbee_eui64_uint_t pc_eui64)
	Event handler when the network has initialized. This handler will initialized any MQTT subscriptions needed to receieve PC NetworkManagement commands. More...
void	on_write_mqtt (const char *topic, const char *message, const size_t message_length)
	MQTT subscription handler for receiving network management updates. This function will send a dynamically allocated string from the character array passed in as a the MQTT message. More...
sl_status_t	on_net_state_update (zigpc_net_mgmt_on_network_state_update_t &state)
	Event handler when the network state has been updated. This handler will update the NetworkManagement MQTT topic based on the data received. More...

Detailed Description

UCL operations manipulating the following topics:

• ucl/by-unid/+/ProtocolController/NetworkManagement
• ucl/by-unid/+/ProtocolController/NetworkManagement/Write

Function Documentation

on_net_init()

sl_status_t zigpc_ucl::pc_nwmgmt::on_net_init

(

zigbee_eui64_uint_t

pc_eui64

)

Event handler when the network has initialized. This handler will initialized any MQTT subscriptions needed to receieve PC NetworkManagement commands.

Parameters

pc_eui64

ProtocolController device identifier.

Returns

sl_status_t SL_STATUS_OK on success, MQTT API error otherwise.

on_net_state_update()

sl_status_t zigpc_ucl::pc_nwmgmt::on_net_state_update

(

zigpc_net_mgmt_on_network_state_update_t &

state

)

Event handler when the network state has been updated. This handler will update the NetworkManagement MQTT topic based on the data received.

Parameters

state_update

Network status update information.

Returns

sl_status_t SL_STATUS_OK on success, MQTT API error otherwise.

on_write_mqtt()

void zigpc_ucl::pc_nwmgmt::on_write_mqtt	(	const char *	topic,
		const char *	message,
		const size_t	message_length
	)

MQTT subscription handler for receiving network management updates. This function will send a dynamically allocated string from the character array passed in as a the MQTT message.

Parameters

topic	Character array containing MQTT topic triggered
message	Character array containing MQTT payload
message_length	Length of MQTT payload