Plugin Commands: Messaging Server
Detailed Description
The messaging-server plugin contributes CLI commands to the application framework to be used for manipulating messages in a server context.
Macro Definition Documentation
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_APPEND |
plugin messaging-server append [message:-1]
-
Append an additional string to the message contained in the message plugin
- message - OCTET_STRING - the string to append to the current message
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CANCEL |
plugin messaging-server cancel [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]
-
Cancel the message.
- nodeId - INT16U - The destination of the message.
- srcEndpoint - INT8U - The source endpoint of the message.
- dstEndpoint - INT8U - The destination endpoint of the message.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_NOT |
plugin messaging-server confirm not
- Set the message confirmation to not used.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_REQ |
plugin messaging-server confirm req
- Set message confirmation to required.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_DISPLAY |
plugin messaging-server display [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]
-
Display the message.
- nodeId - INT16U - The destination of the message.
- srcEndpoint - INT8U - The source endpoint of the message.
- dstEndpoint - INT8U - The destination endpoint of the message.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_ID |
plugin messaging-server id [messageId:4]
-
Set the message id for the message contained in the messaging plugin
- messageId - INT32U - message id
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_CRITICAL |
plugin messaging-server importance critical
- Set the message importance to critical.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_HIGH |
plugin messaging-server importance high
- Set the message importance to high.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_LOW |
plugin messaging-server importance low
- Set the message importance to low.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_MEDIUM |
plugin messaging-server importance medium
- Set the message importance to medium.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_INVALID |
plugin messaging-server invalid [endpoint:1]
-
Set the message validity to invalid.
- endpoint - INT8U - The relevant endpoint.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_MESSAGE |
plugin messaging-server message [message:-1]
-
Set the message used by the message plugin.
- message - OCTET_STRING - The message to set
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_PRINT |
plugin messaging-server print [endpoint:1]
-
Print the message info.
- endpoint - INT8U - The relevant endpoint.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_RELATIVE_TIME |
plugin messaging-server relative-time [time:4] [duration:4]
-
Set the relative time on the message.
- time - INT32U - number of minutes to add to the message time above the current time
- duration - INT32U - duration in minutes for the message to be valid
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TIME |
plugin messaging-server time [time:4] [duration:2]
-
Set the start time and duration for the message used by the message plugin.
- time - INT32U - start time
- duration - INT16U - duration
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_BOTH |
plugin messaging-server transmission both
- Set the message control bit mask in the message to normal and anonymous.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_IPAN |
plugin messaging-server transmission ipan
- Set the message control bit mask in the message to anonymous.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_NORMAL |
plugin messaging-server transmission normal
- Sets the message control bit mask to normal transmission.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_VALID |
plugin messaging-server valid [endpoint:1]
-
Set the message validity to valid.
- endpoint - INT8U - The relevant endpoint.