Global ZCL
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DIRECTION
zcl global direction [direction:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISC_COM_GEN
zcl global disc-com-gen [clusterId:2] [startCommandId:1] [maxCommandId:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISC_COM_REC
zcl global disc-com-rec [clusterId:2] [startCommandId:1] [maxCommandId:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISCOVER
zcl global discover [cluster:2] [attributeId:2] [max:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_EXPECT_REPORT_FROM_ME
zcl global expect-report-from-me [cluster:2] [attributeId:2] [timeout:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_NWRITE
zcl global nwrite [cluster:2] [attributeId:2] [type:1] [data:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_READ
zcl global read [cluster:2] [attributeId:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_REPORT
zcl global report [endpoint:1] [clusterId:2] [attributeId:2] [mask:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_REPORT_READ
zcl global report-read [cluster:2] [attributeId:2] [direction:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_SEND_ME_A_REPORT
zcl global send-me-a-report [cluster:2] [attributeId:2] [dataType:1] [minReportTime:2] [maxReportTime:2] [reportableChange:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_UWRITE
zcl global uwrite [cluster:2] [attributeId:2] [type:1] [data:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_WRITE
zcl global write [cluster:2] [attributeId:2] [type:4] [data:-1]

Detailed Description

All the ZCL global commands defined in the ZigBee Cluster Library Specification. These command line commands can be used to send messages over the air to, for instance, read and write attributes to devices on the network.

Macro Definition Documentation

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DIRECTION

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DIRECTION

zcl global direction [direction:1]

  • Sets the direction for global commands, either client to server or server to client.
    • direction - INT8U - The direction for global commands, 0 = client to server, 1 = server to client.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISC_COM_GEN

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISC_COM_GEN

zcl global disc-com-gen [clusterId:2] [startCommandId:1] [maxCommandId:1]

  • Create a Discover Commands Generated command with associated values.
    • clusterId - INT16U - The cluster to find commands on.
    • startCommandId - INT8U - The command id to start the command search on.
    • maxCommandId - INT8U - Max command ids to search for.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISC_COM_REC

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISC_COM_REC

zcl global disc-com-rec [clusterId:2] [startCommandId:1] [maxCommandId:1]

  • Create a Discover Commands Received command with associated values.
    • clusterId - INT16U - The cluster to find commands on.
    • startCommandId - INT8U - The command id to start the command search on.
    • maxCommandId - INT8U - Max command ids to search for.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISCOVER

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_DISCOVER

zcl global discover [cluster:2] [attributeId:2] [max:1]

  • Creates discovery message for devices with the associated cluster and attribute specified.
    • cluster - INT16U - The cluster id of the cluster to discover.
    • attributeId - INT16U - The attribute id of the attribute to read during discovery.
    • max - INT8U - Max number of discovery responses.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_EXPECT_REPORT_FROM_ME

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_EXPECT_REPORT_FROM_ME

zcl global expect-report-from-me [cluster:2] [attributeId:2] [timeout:2]

  • Create a expect-report-from-me message with associated values.
    • cluster - INT16U - The cluster id for the requested report.
    • attributeId - INT16U - The attribute id for the requested report.
    • timeout - INT16U - Maximum amount of time between reports.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_NWRITE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_NWRITE

zcl global nwrite [cluster:2] [attributeId:2] [type:1] [data:-1]

  • Creates a global write command message to write to the cluster and attribute specified
    • cluster - INT16U - The cluster id of the cluster to read from.
    • attributeId - INT16U - The attribute id of the attribute to read.
    • type - INT8U - The type of the attribute to write.
    • data - OCTET_STRING - The data to be written.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_READ

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_READ

zcl global read [cluster:2] [attributeId:2]

  • Creates a global read command message to read from the cluster and attribute specified
    • cluster - INT16U - The cluster id of the cluster to read from.
    • attributeId - INT16U - The attribute id of the attribute to read.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_REPORT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_REPORT

zcl global report [endpoint:1] [clusterId:2] [attributeId:2] [mask:1]

    • endpoint - INT8U - The desired endpoint.
    • clusterId - INT16U - The cluster id.
    • attributeId - INT16U - The attribute id.
    • mask - INT8U - The mask.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_REPORT_READ

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_REPORT_READ

zcl global report-read [cluster:2] [attributeId:2] [direction:1]

  • Creates a global read reporting command for the associated cluster, attribute and server/client direction.
    • cluster - INT16U - The cluster id to read from.
    • attributeId - INT16U - The attribute id to read from.
    • direction - INT8U - 0 for client-to-server, 1 for server-to-client.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_SEND_ME_A_REPORT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_SEND_ME_A_REPORT

zcl global send-me-a-report [cluster:2] [attributeId:2] [dataType:1] [minReportTime:2] [maxReportTime:2] [reportableChange:-1]

  • Creates a global send me a report command for the associated values.
    • cluster - INT16U - The cluster id of the requested report.
    • attributeId - INT16U - The attribute id for requested report.
    • dataType - INT8U - The two byte ZigBee type value for the requested report.
    • minReportTime - INT16U - Minimum number of seconds between reports.
    • maxReportTime - INT16U - Maximum number of seconds between reports.
    • reportableChange - OCTET_STRING - Amount of change to trigger a report.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_UWRITE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_UWRITE

zcl global uwrite [cluster:2] [attributeId:2] [type:1] [data:-1]

  • Creates a global write undivided command message to write to the cluster and attribute specified
    • cluster - INT16U - The cluster id of the cluster to write to.
    • attributeId - INT16U - The attribute id of the attribute to write.
    • type - INT8U - The type of the attribute to write.
    • data - OCTET_STRING - The data to be written.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_WRITE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ZCL_GLOBAL_ZCL_GLOBAL_WRITE

zcl global write [cluster:2] [attributeId:2] [type:4] [data:-1]

  • Creates a global write command message to write to the cluster and attribute specified
    • cluster - INT16U - The cluster id of the cluster to write to.
    • attributeId - INT16U - The attribute id of the attribute to write.
    • type - INT32U - The type of the attribute to write.
    • data - OCTET_STRING - The data to be written.