Modules#

Messaging Client#

API and Callbacks for the Messaging Cluster Client Component.

Silicon Labs implementation of the Messaging client cluster. This component requires extending to display the message on the hardware display.

API#

void

emAfPluginMessagingClientClearMessage(uint8_t endpoint)

Clear the message.

void

emAfPluginMessagingClientPrintInfo(uint8_t endpoint)

Print information about the message.

EmberAfStatus

emberAfPluginMessagingClientConfirmMessage(uint8_t endpoint)

Confirm a message.

API Documentation#

emAfPluginMessagingClientClearMessage#

void emAfPluginMessagingClientClearMessage (uint8_t endpoint)

Clear the message.

Parameters

N/A

endpoint

The relevant endpoint.

This function is used to manually inactivate or clear the message.

Definition at line 59 of file app/framework/plugin/messaging-client/messaging-client.h

emAfPluginMessagingClientPrintInfo#

void emAfPluginMessagingClientPrintInfo (uint8_t endpoint)

Print information about the message.

Parameters

N/A

endpoint

The relevant endpoint.

Definition at line 67 of file app/framework/plugin/messaging-client/messaging-client.h

emberAfPluginMessagingClientConfirmMessage#

EmberAfStatus emberAfPluginMessagingClientConfirmMessage (uint8_t endpoint)

Confirm a message.

Parameters

N/A endpoint

This function is used to confirm a message. The messaging client plugin sends the confirmation command to the endpoint on the node that sent the message.

Returns

EMBER_ZCL_STATUS_SUCCESS if the confirmation was sent, EMBER_ZCL_STATUS_FAILURE if an error occurred, or EMBER_ZCL_STATUS_NOT_FOUND if the message does not exist.

Definition at line 80 of file app/framework/plugin/messaging-client/messaging-client.h