Level Control Server#

API and Callbacks for the Level Control Cluster Server Component.

Silicon Labs implementation of the Level Control server cluster. If the ZLL Level Control server cluster component is also enabled, this component uses it to handle ZLL enhancements. Otherwise, all ZLL extensions are disabled. It is not intended for production but provides sample code to show how the cluster could be implemented.

This group describes the CLI commands for the Level Control cluster. Listed below is a description of the cluster: Attributes and commands for controlling devices that can be set to a level between fully 'On' and fully 'Off.'

Modules#

Level Control

Macros#

#define
SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICK_TIME (MILLISECOND_TICKS_PER_SECOND / SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICKS_PER_SECOND)
#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MV_TO_LEVEL

zcl level-control mv-to-level [level:1] [transitionTime:2] [optionMask:1] [optionOverride:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MOVE

zcl level-control move [moveMode:1] [rate:1] [optionMask:1] [optionOverride:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_STEP

zcl level-control step [stepMode:1] [stepSize:1] [transitionTime:2] [optionMask:1] [optionOverride:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_STOP

zcl level-control stop [optionMask:1] [optionOverride:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_MV_TO_LEVEL

zcl level-control o-mv-to-level [level:1] [transitionTime:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_MOVE

zcl level-control o-move [moveMode:1] [rate:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_STEP

zcl level-control o-step [stepMode:1] [stepSize:1] [transitionTime:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_STOP

zcl level-control o-stop

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MV_TO_CLOSEST_FREQ

zcl level-control mv-to-closest-freq [frequency:2]

Macro Definition Documentation#

SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICKS_PER_SECOND#

#define SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICKS_PER_SECOND
Value:
32

Definition at line 45 of file app/framework/plugin/level-control/level-control.h

SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICK_TIME#

#define SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICK_TIME
Value:
  (MILLISECOND_TICKS_PER_SECOND / SL_ZIGBEE_AF_PLUGIN_LEVEL_CONTROL_TICKS_PER_SECOND)

Definition at line 47 of file app/framework/plugin/level-control/level-control.h

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MV_TO_LEVEL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MV_TO_LEVEL

zcl level-control mv-to-level [level:1] [transitionTime:2] [optionMask:1] [optionOverride:1]

  • Command description for MoveToLevel

    • level - INT8U

    • transitionTime - INT16U

    • optionMask - BITMAP8

    • optionOverride - BITMAP8


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MOVE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MOVE

zcl level-control move [moveMode:1] [rate:1] [optionMask:1] [optionOverride:1]

  • Command description for Move


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_STEP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_STEP

zcl level-control step [stepMode:1] [stepSize:1] [transitionTime:2] [optionMask:1] [optionOverride:1]

  • Command description for Step

    • stepMode - StepMode [ENUM8]

    • stepSize - INT8U

    • transitionTime - INT16U

    • optionMask - BITMAP8

    • optionOverride - BITMAP8 See Also


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_STOP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_STOP

zcl level-control stop [optionMask:1] [optionOverride:1]

  • Command description for Stop

    • optionMask - BITMAP8

    • optionOverride - BITMAP8


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_MV_TO_LEVEL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_MV_TO_LEVEL

zcl level-control o-mv-to-level [level:1] [transitionTime:2]

  • Command description for MoveToLevelWithOnOff

    • level - INT8U

    • transitionTime - INT16U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_MOVE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_MOVE

zcl level-control o-move [moveMode:1] [rate:1]


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_STEP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_STEP

zcl level-control o-step [stepMode:1] [stepSize:1] [transitionTime:2]

  • Command description for StepWithOnOff


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_STOP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_O_STOP

zcl level-control o-stop

  • Command description for StopWithOnOff


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

EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MV_TO_CLOSEST_FREQ#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_LEVEL_CONTROL_MV_TO_CLOSEST_FREQ

zcl level-control mv-to-closest-freq [frequency:2]

  • Command description for MoveToClosestFrequency

    • frequency - INT16U


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