Modules#

On / Off Server#

API and Callbacks for the On/Off Cluster Server Component.

Silicon Labs implementation of the On/Off server cluster. If the ZLL On/Off server cluster component is also enabled, this component uses it for handling ZLL enhancements. Otherwise, all ZLL extensions are disabled. This component requires extending to integrate the software into the hardware that the on/off signals will control.

This group describes the CLI commands for the On/off cluster. Listed below is a description of the cluster: Attributes and commands for switching devices between 'On' and 'Off' states.

Macros#

#define

EMBER_AF_DOXYGEN_CLI_COMMAND_ON /OFF_OFF

zcl on-off off

#define

EMBER_AF_DOXYGEN_CLI_COMMAND_ON /OFF_ON

zcl on-off off

#define

EMBER_AF_DOXYGEN_CLI_COMMAND_ON /OFF_TOGGLE

zcl on-off off

#define

EMBER_AF_DOXYGEN_CLI_COMMAND_ON /OFF_OFFEFFECT

zcl on-off off

#define

EMBER_AF_DOXYGEN_CLI_COMMAND_ON /OFF_ONRECALL

zcl on-off off

#define

EMBER_AF_DOXYGEN_CLI_COMMAND_ON /OFF_ONTIMEDOFF

zcl on-off off

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ON

Value:

/OFF_OFF

zcl on-off off

zcl on-off ontimedoff [onOffControl:1] [onTime:2] [offWaitTime:2]

zcl on-off onrecall

zcl on-off offeffect [effectId:1] [effectVariant:1]

zcl on-off toggle

zcl on-off on

Command description for Off
Command description for On
Command description for Toggle
- Command description for OffWithEffect
  - effectId - OnOffEffectIdentifier [ENUM8]
  - effectVariant - ENUM8 See Also
    - EmberAfOnOffEffectIdentifier
Command description for OnWithRecallGlobalScene
Command description for OnWithTimedOff
- onOffControl - OnOffControl [BITMAP8]
- onTime - INT16U
- offWaitTime - INT16U

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

EMBER_AF_DOXYGEN_CLI_COMMAND_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ON

Value:

/OFF_ON

zcl on-off off

zcl on-off ontimedoff [onOffControl:1] [onTime:2] [offWaitTime:2]

zcl on-off onrecall

zcl on-off offeffect [effectId:1] [effectVariant:1]

zcl on-off toggle

zcl on-off on

Command description for Off
Command description for On
Command description for Toggle
- Command description for OffWithEffect
  - effectId - OnOffEffectIdentifier [ENUM8]
  - effectVariant - ENUM8 See Also
    - EmberAfOnOffEffectIdentifier
Command description for OnWithRecallGlobalScene
Command description for OnWithTimedOff
- onOffControl - OnOffControl [BITMAP8]
- onTime - INT16U
- offWaitTime - INT16U

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

EMBER_AF_DOXYGEN_CLI_COMMAND_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ON

Value:

/OFF_TOGGLE

zcl on-off off

zcl on-off ontimedoff [onOffControl:1] [onTime:2] [offWaitTime:2]

zcl on-off onrecall

zcl on-off offeffect [effectId:1] [effectVariant:1]

zcl on-off toggle

zcl on-off on

Command description for Off
Command description for On
Command description for Toggle
- Command description for OffWithEffect
  - effectId - OnOffEffectIdentifier [ENUM8]
  - effectVariant - ENUM8 See Also
    - EmberAfOnOffEffectIdentifier
Command description for OnWithRecallGlobalScene
Command description for OnWithTimedOff
- onOffControl - OnOffControl [BITMAP8]
- onTime - INT16U
- offWaitTime - INT16U

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

EMBER_AF_DOXYGEN_CLI_COMMAND_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ON

Value:

/OFF_OFFEFFECT

zcl on-off off

zcl on-off ontimedoff [onOffControl:1] [onTime:2] [offWaitTime:2]

zcl on-off onrecall

zcl on-off offeffect [effectId:1] [effectVariant:1]

zcl on-off toggle

zcl on-off on

Command description for Off
Command description for On
Command description for Toggle
- Command description for OffWithEffect
  - effectId - OnOffEffectIdentifier [ENUM8]
  - effectVariant - ENUM8 See Also
    - EmberAfOnOffEffectIdentifier
Command description for OnWithRecallGlobalScene
Command description for OnWithTimedOff
- onOffControl - OnOffControl [BITMAP8]
- onTime - INT16U
- offWaitTime - INT16U

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

EMBER_AF_DOXYGEN_CLI_COMMAND_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ON

Value:

/OFF_ONRECALL

zcl on-off off

zcl on-off ontimedoff [onOffControl:1] [onTime:2] [offWaitTime:2]

zcl on-off onrecall

zcl on-off offeffect [effectId:1] [effectVariant:1]

zcl on-off toggle

zcl on-off on

Command description for Off
Command description for On
Command description for Toggle
- Command description for OffWithEffect
  - effectId - OnOffEffectIdentifier [ENUM8]
  - effectVariant - ENUM8 See Also
    - EmberAfOnOffEffectIdentifier
Command description for OnWithRecallGlobalScene
Command description for OnWithTimedOff
- onOffControl - OnOffControl [BITMAP8]
- onTime - INT16U
- offWaitTime - INT16U

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

EMBER_AF_DOXYGEN_CLI_COMMAND_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_ON

Value:

/OFF_ONTIMEDOFF

zcl on-off off

zcl on-off ontimedoff [onOffControl:1] [onTime:2] [offWaitTime:2]

zcl on-off onrecall

zcl on-off offeffect [effectId:1] [effectVariant:1]

zcl on-off toggle

zcl on-off on

Command description for Off
Command description for On
Command description for Toggle
- Command description for OffWithEffect
  - effectId - OnOffEffectIdentifier [ENUM8]
  - effectVariant - ENUM8 See Also
    - EmberAfOnOffEffectIdentifier
Command description for OnWithRecallGlobalScene
Command description for OnWithTimedOff
- onOffControl - OnOffControl [BITMAP8]
- onTime - INT16U
- offWaitTime - INT16U

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