Messaging Server#

API and Callbacks for the friendly-name Component.

Silicon Labs implementation of the Messaging server cluster. This component serves up messages in its table to clients that request them. This component requires extending to populate the message table with messages.

Modules#

sl_zigbee_af_plugin_messaging_server_message_t

API#

bool

sl_zigbee_af_messaging_server_get_message(uint8_t endpoint, sl_zigbee_af_plugin_messaging_server_message_t *message)

Get the message used by the messaging server plugin.

void

sl_zigbee_af_messaging_server_set_message(uint8_t endpoint, const sl_zigbee_af_plugin_messaging_server_message_t *message)

Set the message used by the Messaging server plugin.

void

sl_zigbee_af_messaging_server_display_message(sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Get the message used by the messaging server plugin.

void

sl_zigbee_af_messaging_server_cancel_message(sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Get the message used by the messaging server plugin.

Macros#

#define

ZCL_MESSAGING_CLUSTER_TRANSMISSION_MASK (BIT(1) | BIT(0))

#define

ZCL_MESSAGING_CLUSTER_IMPORTANCE_MASK (BIT(3) | BIT(2))

#define

ZCL_MESSAGING_CLUSTER_RESERVED_MASK (BIT(6) | BIT(5) | BIT(4))

#define

ZCL_MESSAGING_CLUSTER_CONFIRMATION_MASK BIT(7)

#define

ZCL_MESSAGING_CLUSTER_START_TIME_NOW 0x00000000UL

#define

ZCL_MESSAGING_CLUSTER_END_TIME_NEVER 0xFFFFFFFFUL

#define

ZCL_MESSAGING_CLUSTER_DURATION_UNTIL_CHANGED 0xFFFF

API Documentation#

sl_zigbee_af_messaging_server_get_message#

bool sl_zigbee_af_messaging_server_get_message (uint8_t endpoint, sl_zigbee_af_plugin_messaging_server_message_t * message)

Get the message used by the messaging server plugin.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	endpoint	The relevant endpoint.
sl_zigbee_af_plugin_messaging_server_message_t *	N/A	message	The sl_zigbee_af_plugin_messaging_server_message_t structure describing the message.

This function gets the message and metadata that the plugin sends to clients. For "start now" messages that are current or scheduled, the duration is adjusted to reflect how many minutes remain for the message. Otherwise, the start time and duration of "start now" messages reflect the actual start and the original duration.

Returns

True if the message is valid or false is the message does not exist or is expired.

sl_zigbee_af_messaging_server_set_message#

void sl_zigbee_af_messaging_server_set_message (uint8_t endpoint, const sl_zigbee_af_plugin_messaging_server_message_t * message)

Set the message used by the Messaging server plugin.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	endpoint	The relevant endpoint.
const sl_zigbee_af_plugin_messaging_server_message_t *	N/A	message	The sl_zigbee_af_plugin_messaging_server_message_t structure describing the message. If NULL, the message is removed from the server.

This function sets the message and metadata that the plugin will send to clients. Setting the start time to zero instructs clients to start the message now. For "start now" messages, the plugin will automatically adjust the duration reported to clients based on the original start time of the message.

sl_zigbee_af_messaging_server_display_message#

void sl_zigbee_af_messaging_server_display_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Get the message used by the messaging server plugin.

Parameters

Type	Direction	Argument Name	Description
sl_802154_short_addr_t	N/A	nodeId	The relevant endpoint.
uint8_t	N/A	srcEndpoint	The sl_zigbee_af_plugin_messaging_server_message_t structure describing the message.
uint8_t	N/A	dstEndpoint

Returns

True if the message is valid or false is the message does not exist or is expired.

sl_zigbee_af_messaging_server_cancel_message#

void sl_zigbee_af_messaging_server_cancel_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint)

Get the message used by the messaging server plugin.

Parameters

Type	Direction	Argument Name	Description
sl_802154_short_addr_t	N/A	nodeId	The relevant endpoint.
uint8_t	N/A	srcEndpoint	The sl_zigbee_af_plugin_messaging_server_message_t structure describing the message.
uint8_t	N/A	dstEndpoint

Returns

True if the message is valid or false is the message does not exist or is expired.

Macro Definition Documentation#

ZCL_MESSAGING_CLUSTER_TRANSMISSION_MASK#

#define ZCL_MESSAGING_CLUSTER_TRANSMISSION_MASK

Value:

(BIT(1) | BIT(0))

ZCL_MESSAGING_CLUSTER_IMPORTANCE_MASK#

#define ZCL_MESSAGING_CLUSTER_IMPORTANCE_MASK

Value:

(BIT(3) | BIT(2))

ZCL_MESSAGING_CLUSTER_RESERVED_MASK#

#define ZCL_MESSAGING_CLUSTER_RESERVED_MASK

Value:

(BIT(6) | BIT(5) | BIT(4))

ZCL_MESSAGING_CLUSTER_CONFIRMATION_MASK#

#define ZCL_MESSAGING_CLUSTER_CONFIRMATION_MASK

Value:

BIT(7)

ZCL_MESSAGING_CLUSTER_START_TIME_NOW#

#define ZCL_MESSAGING_CLUSTER_START_TIME_NOW

Value:

0x00000000UL

ZCL_MESSAGING_CLUSTER_END_TIME_NEVER#

#define ZCL_MESSAGING_CLUSTER_END_TIME_NEVER

Value:

0xFFFFFFFFUL

ZCL_MESSAGING_CLUSTER_DURATION_UNTIL_CHANGED#

#define ZCL_MESSAGING_CLUSTER_DURATION_UNTIL_CHANGED

Value:

0xFFFF