Plugin Commands: Messaging Server#

The messaging-server plugin contributes CLI commands to the application framework to be used for manipulating messages in a server context.

Macros#

#define

plugin messaging-server cancel [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

#define

plugin messaging-server display [nodeId:2] [srcEndpoint:1] [dstEndpoint:1]

#define

plugin messaging-server relative-time [time:4] [duration:4]

#define

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_APPEND#

#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


Definition at line 4072 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CANCEL#

#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.


Definition at line 4080 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_NOT#

#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.


Definition at line 4085 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_REQ#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_CONFIRM_REQ

plugin messaging-server confirm req

  • Set message confirmation to required.


Definition at line 4090 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_DISPLAY#

#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.


Definition at line 4098 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_ID#

#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


Definition at line 4104 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_CRITICAL#

#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.


Definition at line 4109 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_HIGH#

#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.


Definition at line 4114 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_LOW#

#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.


Definition at line 4119 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_IMPORTANCE_MEDIUM#

#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.


Definition at line 4124 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_INVALID#

#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.


Definition at line 4130 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_MESSAGE#

#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


Definition at line 4136 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_PRINT#

#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.


Definition at line 4142 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_RELATIVE_TIME#

#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


Definition at line 4149 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TIME#

#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


Definition at line 4156 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_BOTH#

#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.


Definition at line 4161 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_IPAN#

#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.


Definition at line 4166 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_TRANSMISSION_NORMAL#

#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.


Definition at line 4171 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_MESSAGING_SERVER_PLUGIN_MESSAGING_SERVER_VALID#

#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.


Definition at line 4177 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc