Sub GHz Server#

emberAfPluginSubGhzServerSendSuspendZclMessagesCommand#

EmberStatus emberAfPluginSubGhzServerSendSuspendZclMessagesCommand (EmberNodeId nodeId, uint8_t endpoint, uint8_t period)

Send the 'Suspend ZCL Messages' command.

This is a server command. The server sends it to temporarily suspend ZCL messages from clients it identifies as causing too much traffic. It is also sent in response to the 'Get Suspend ZCL Messages Status' command.

Note: If endpoint == 0, the framework will choose the suitable endpoint based on the past communication with the given node. If GetSuspendZclMessagesStatus has never been received by the server, the server will not know which endpoint implements the Sub-GHz Client and will default to endpoint 1. The application can "teach" the server the client endpoint by discovering the Sub-GHz clients and call this function for each of them with period == 0.

emberAfPluginSubGhzServerSuspendZclMessagesStatus#

uint16_t emberAfPluginSubGhzServerSuspendZclMessagesStatus (EmberNodeId nodeId)

Get the current suspend status for a given client.

Returns

• The number of seconds remaining; 0 = not suspended.

emAfSubGhzServerIncomingMessage#

bool emAfSubGhzServerIncomingMessage (EmberIncomingMessageType type, EmberApsFrame * apsFrame, EmberNodeId sender, uint16_t messageLength, uint8_t * messageContents)

An incoming message handler.

Used to handle any incoming message from clients. Based on the Duty Cycle state, client's ID (has the client been suspended?) and the message type, determines the right action, which could be one of:

• let the message through to allow the framework to process it further

• respond with 'Suspend ZCL Messages' and suppress this message

• suppress the message silently.

Returns

• True if the message has been processed by the Sub-GHz plugin and should be suppressed, false to allow the message through.