Cluster Commands: Messaging#
This group describes the CLI commands for the Messaging cluster. Listed below is a description of the cluster: This cluster provides an interface for passing text messages between SE devices.
Macros#
zcl msg disp [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
zcl msg cancel [messageId:4] [messageControl:1]
zcl msg disp-protd [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
zcl msg x-all [implementationDateTime:4]
zcl msg get
zcl msg confirm [messageId:4] [confirmationTime:4] [messageConfirmationControl:1] [messageResponse:-1]
zcl msg get-msg-x [earliestImplementationTime:4]
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP
zcl msg disp [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
Command description for DisplayMessage
messageId - INT32U
messageControl - MessagingControlMask [BITMAP8]
startTime - UTC_TIME
durationInMinutes - INT16U
message - CHAR_STRING
optionalExtendedMessageControl - MessagingExtendedControlMask [BITMAP8]
9292 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CANCEL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CANCEL
zcl msg cancel [messageId:4] [messageControl:1]
The CancelMessage command provides the ability to cancel the sending or acceptance of previously sent messages.
messageId - INT32U
messageControl - MessagingControlMask [BITMAP8]
9299 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP_PROTD#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP_PROTD
zcl msg disp-protd [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]
The DisplayProtected Message command is for use with messages that are protected by a password or PIN.
messageId - INT32U
messageControl - MessagingControlMask [BITMAP8]
startTime - UTC_TIME
durationInMinutes - INT16U
message - CHAR_STRING
optionalExtendedMessageControl - MessagingExtendedControlMask [BITMAP8]
9310 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_X_ALL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_X_ALL
zcl msg x-all [implementationDateTime:4]
The CancelAllMessages command indicates to a client device that it should cancel all display messages currently held by it.
implementationDateTime - UTC_TIME
9316 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET
zcl msg get
Command description for GetLastMessage
9321 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CONFIRM#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CONFIRM
zcl msg confirm [messageId:4] [confirmationTime:4] [messageConfirmationControl:1] [messageResponse:-1]
The Message Confirmation command provides an indication that a Utility Customer has acknowledged and/or accepted the contents of a previously sent message. Enhanced Message Confirmation commands shall contain an answer of 'NO', 'YES' and/or a message confirmation string.
messageId - INT32U
confirmationTime - UTC_TIME
messageConfirmationControl - BITMAP8
messageResponse - OCTET_STRING
9330 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET_MSG_X#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET_MSG_X
zcl msg get-msg-x [earliestImplementationTime:4]
This command initiates the return of the first (and maybe only) Cancel All Messages command held on the associated server, and which has an implementation time equal to or later than the value indicated in the payload.
earliestImplementationTime - UTC_TIME
9336 of file ./app/framework/test/headers/cli.doc