Plugin Commands: Sleepy Message Queue
Detailed Description
The sleepy-message-queue plugin provides a means to store packets up to a specified period of time.
Macro Definition Documentation
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_GET_NUM_MSG |
plugin sleepy-message-queue getNumMsg [dstEui64:-1]
-
Get the number of pending messages for a given destination EUI64.
- dstEui64 - OCTET_STRING - The EUI64 of the device for which the number of pending messages is being queried
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_GET_PENDING_MSG |
plugin sleepy-message-queue getPendingMsg [msgId:1]
-
Get the first pending message ID for a given destination EUI64.
- msgId - INT8U - The messageID of the message to be retrieved.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_GET_PENDING_MSG_ID |
plugin sleepy-message-queue getPendingMsgId [dstEui64:-1]
-
Get the first pending message ID for a given destination EUI64.
- dstEui64 - OCTET_STRING - The EUI64 of the device for which the first pending message ID is being queried
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_INIT |
plugin sleepy-message-queue init
- Initialize the sleepy message queue.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_REMAIN_TIME |
plugin sleepy-message-queue remainTime [msgId:1]
-
Report the remaining timeout on the message specified by the message ID.
- msgId - INT8U - The messageID of the message whose remaining time will be reported.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_REMOVE |
plugin sleepy-message-queue remove [msgId:1]
-
Remove the message from the queue with the given messageID.
- msgId - INT8U - The messageID of the message to be removed.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_REMOVE_ALL |
plugin sleepy-message-queue removeAll [dstEui64:-1]
-
Remove all messages from the queue with the given EUI64.
- dstEui64 - OCTET_STRING - The EUI64 of the device whose messages should be removed.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_STORE |
plugin sleepy-message-queue store [timeoutSec:4] [payloadPtr:4] [payloadLength:2] [payloadId:2] [dstEui64:-1]
-
Store a message into the sleepy message queue.
- timeoutSec - INT32U - Message timeout, in seconds
- payloadPtr - INT32U - Pointer to (address of) the message payload
- payloadLength - INT16U - The length of the message payload
- payloadId - INT16U - The payload ID of this message
- dstEui64 - OCTET_STRING - The EUI64 of the device to which the message is being sent
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_TIMESTAMP |
plugin sleepy-message-queue timestamp
- Retrieve the current value of halCommonGetInt32uMillisecondTick().
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SLEEPY_MESSAGE_QUEUE_PLUGIN_SLEEPY_MESSAGE_QUEUE_UNUSED_CNT |
plugin sleepy-message-queue unusedCnt
- Reads the number of unused queue entries.