Cluster Commands: Power Profile#

This group describes the CLI commands for the Power Profile cluster. Listed below is a description of the cluster: This cluster provides an interface for transferring power profile information from a device (e.g. Whitegood) to a controller (e.g. the Home Gateway). The Power Profile transferred can be solicited by client side (request command) or can be notified directly from the device (server side).

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_PROFILE undefined

zcl power-profile profile [powerProfileId:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_STATE undefined

zcl power-profile state

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_ENERGY_PHASES_SCHEDULE undefined

zcl power-profile energy-phases-schedule [powerProfileId:1] [numOfScheduledPhases:1] [scheduledPhases:3]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_SCHEDULE_CONSTRAINTS undefined

zcl power-profile schedule-constraints [powerProfileId:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_ENERGY_PHASES_SCHEDULE_STATES undefined

zcl power-profile energy-phases-schedule-states [powerProfileId:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_PROFILE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_PROFILE

zcl power-profile profile [powerProfileId:1]

  • The PowerProfileRequest Command is generated by a device supporting the client side of the Power Profile cluster in order to request the Power Profile of a server device.

    • powerProfileId - INT8U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_STATE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_STATE

zcl power-profile state

  • The PowerProfileStateRequest Command is generated in order to retrieve the identifiers of current Power Profiles.


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

EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_ENERGY_PHASES_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_ENERGY_PHASES_SCHEDULE

zcl power-profile energy-phases-schedule [powerProfileId:1] [numOfScheduledPhases:1] [scheduledPhases:3]

  • The EnergyPhasesScheduleNotification Command is generated by a device supporting the client side of the Power Profile cluster in order to schedule the start of the selected Power Profile and its phases.

    • powerProfileId - INT8U

    • numOfScheduledPhases - INT8U

    • scheduledPhases - struct ScheduledPhase


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

EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_SCHEDULE_CONSTRAINTS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_SCHEDULE_CONSTRAINTS

zcl power-profile schedule-constraints [powerProfileId:1]

  • The PowerProfileScheduleConstraintsRequest Command is generated by a device supporting the client side of the Power Profile cluster in order to request the constraints -if set- of Power Profile of a client device, in order to set the proper boundaries for the scheduling when calculating the schedules.

    • powerProfileId - INT8U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_ENERGY_PHASES_SCHEDULE_STATES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_POWER_PROFILE_ENERGY_PHASES_SCHEDULE_STATES

zcl power-profile energy-phases-schedule-states [powerProfileId:1]

  • The EnergyPhasesScheduleStateRequest Command is generated by a device supporting the client side of the Power Profile cluster to check the states of the scheduling of a power profile, which is supported in the device implementing the server side of Power Profile cluster.

    • powerProfileId - INT8U


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