Identify Server#

API and Callbacks for the Identify Cluster Server Component.

Silicon Labs implementation of the Identify cluster. It requires extending to integrate the code with the hardware, for example to make a light blink during identify.

This group describes the CLI commands for the Identify cluster. Listed below is a description of the cluster: Attributes and commands for putting a device into Identification mode (e.g. flashing a light).

Modules#

Identify

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ZCL_IDENTIFY_OFF

zcl identify off [endpoint:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ZCL_IDENTIFY_ON

zcl identify on [endpoint:1] [time:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ID

zcl identify id [identifyTime:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_EZ_MODE

zcl identify ez-mode [action:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_TRIGGER

zcl identify trigger [effectId:1] [effectVariant:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ZCL_IDENTIFY_OFF#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ZCL_IDENTIFY_OFF

zcl identify off [endpoint:1]

  • Writes the IdentifyTime attribute

    • endpoint - INT8U - The endpoint on which to stop identifying


Definition at line 239 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ZCL_IDENTIFY_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ZCL_IDENTIFY_ON

zcl identify on [endpoint:1] [time:2]

  • Writes the IdentifyTime attribute

    • endpoint - INT8U - The endpoint on the device which should begin identifying

    • time - INT16U - The number of seconds to spend identifying


Definition at line 246 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ID#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_ID

zcl identify id [identifyTime:2]

  • Command description for Identify

    • identifyTime - INT16U


Definition at line 1246 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_QUERY#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_QUERY

zcl identify query

  • Command description for IdentifyQuery


Definition at line 1251 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_EZ_MODE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_EZ_MODE

zcl identify ez-mode [action:1]

  • Invoke EZMode on an Identify Server

    • action - BITMAP8


Definition at line 1257 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_TRIGGER#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_IDENTIFY_TRIGGER

zcl identify trigger [effectId:1] [effectVariant:1]


Definition at line 1267 of file app/framework/test/headers/cli.doc