Cluster Commands: Device Management
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_CHG_OF_TENANCY
zcl dm get-chg-of-tenancy
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_CHG_OF_SUPPLIER
zcl dm get-chg-of-supplier
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_REQ_NEW_PASS
zcl dm req-new-pass [passwordType:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_SITE_ID
zcl dm get-site-id
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_RPT_EVENT_CONFIG
zcl dm rpt-event-config [commandIndex:1] [totalCommands:1] [eventConfigurationPayload:3]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_CIN
zcl dm get-cin
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_PUB_CHG_OF_SUPPLIER
zcl dm pub-chg-of-supplier [currentProviderId:4] [issuerEventId:4] [tariffType:1] [proposedProviderId:4] [providerChangeImplementationTime:4] [providerChangeControl:4] [proposedProviderName:-1] [proposedProviderContactDetails:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_REQ_NEW_PASS_RESP
zcl dm req-new-pass-resp [issuerEventId:4] [implementationDateTime:4] [durationInMinutes:2] [passwordType:1] [password:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_SET_EVENT_CONFIG
zcl dm set-event-config [issuerEventId:4] [startDateTime:4] [eventConfiguration:1] [configurationControl:1] [eventConfigurationPayload:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_EVENT_CONFIG
zcl dm get-event-config [eventId:2]

Detailed Description

This group describes the CLI commands for the Device Management cluster. Listed below is a description of the cluster:

This cluster provides attributes and commands to support device-cognisant application layer protocols.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_CHG_OF_SUPPLIER

zcl dm get-chg-of-supplier

  • This command is used to request the ESI to respond with information regarding any available change of supplier.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_CHG_OF_TENANCY

zcl dm get-chg-of-tenancy

  • This command is used to request the ESI to respond with information regarding any available change of tenancy.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_CIN

zcl dm get-cin

  • This command is used to request the ESI to respond with information regarding any pending change of Customer ID Number.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_EVENT_CONFIG

zcl dm get-event-config [eventId:2]

  • This command allows the server to request details of event configurations.
    • eventId - INT16U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_GET_SITE_ID

zcl dm get-site-id

  • This command is used to request the ESI to respond with information regarding any pending change of Site ID.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_PUB_CHG_OF_SUPPLIER

zcl dm pub-chg-of-supplier [currentProviderId:4] [issuerEventId:4] [tariffType:1] [proposedProviderId:4] [providerChangeImplementationTime:4] [providerChangeControl:4] [proposedProviderName:-1] [proposedProviderContactDetails:-1]

  • This command is used to change the Supplier (energy supplier) that is supplying the meter (s).
    • currentProviderId - INT32U
    • issuerEventId - INT32U
    • tariffType - TariffType [ENUM8]
    • proposedProviderId - INT32U
    • providerChangeImplementationTime - UTC_TIME
    • providerChangeControl - ProposedChangeControl [BITMAP32]
    • proposedProviderName - OCTET_STRING
    • proposedProviderContactDetails - OCTET_STRING
      See also
      EmberAfTariffType
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_REQ_NEW_PASS

zcl dm req-new-pass [passwordType:1]

  • This command is used to request the current password from the server.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_REQ_NEW_PASS_RESP

zcl dm req-new-pass-resp [issuerEventId:4] [implementationDateTime:4] [durationInMinutes:2] [passwordType:1] [password:-1]

  • This command is used to send the current password to the client.
    • issuerEventId - INT32U
    • implementationDateTime - UTC_TIME
    • durationInMinutes - INT16U
    • passwordType - PasswordType [ENUM8]
    • password - OCTET_STRING
      See also
      EmberAfPasswordType
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_RPT_EVENT_CONFIG

zcl dm rpt-event-config [commandIndex:1] [totalCommands:1] [eventConfigurationPayload:3]

  • This command is sent in response to a GetEventConfiguration command.
    • commandIndex - INT8U
    • totalCommands - INT8U
    • eventConfigurationPayload - struct EventConfigurationPayload
#define EMBER_AF_DOXYGEN_CLI_COMMAND_DEVICE_MANAGEMENT_SET_EVENT_CONFIG

zcl dm set-event-config [issuerEventId:4] [startDateTime:4] [eventConfiguration:1] [configurationControl:1] [eventConfigurationPayload:1]

  • This command provides a method to set the event configuration attributes, held in a client device.
    • issuerEventId - INT32U
    • startDateTime - UTC_TIME
    • eventConfiguration - EventConfiguration [BITMAP8]
    • configurationControl - EventConfigurationControl [ENUM8]
    • eventConfigurationPayload - INT8U
      See also
      EmberAfEventConfigurationControl