Plugin Commands: Device Management Server

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_CIN
plugin device-management-server cin [cin:-1] [implementationDateTime:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_ISSUER_EVENT_ID
plugin device-management-server issuer-event-id [issuerEventId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PASSWORD
plugin device-management-server password [password:-1] [implementationDateTime:4] [durationInMinutes:2] [passwordType:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PENDING_UPDATES
plugin device-management-server pending-updates [pendingUpdatesMask:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PRINT
plugin device-management-server print
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PROVIDER_ID
plugin device-management-server provider-id [providerId:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PUB_CHG_OF_SUPPLIER
plugin device-management-server pub-chg-of-supplier [server:2] [clientEndpoint:1] [serverEndpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PUB_CHG_OF_TENANCY
plugin device-management-server pub-chg-of-tenancy [server:2] [clientEndpoint:1] [serverEndpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_SEND_REQ_NEW_PASS_RESP
plugin device-management-server send-req-new-pass-resp [passwordType:1] [server:2] [clientEndpoint:1] [serverEndpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_SITE_ID
plugin device-management-server site-id [siteId:-1] [implementationDateTime:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_SUPPLIER
plugin device-management-server supplier [endpoint:1] [proposedProviderId:4] [implementationDateTime:4] [providerChangeControl:4] [proposedProviderName:-1] [proposedProviderContactDetails:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_TARIFF_TYPE
plugin device-management-server tariff-type [tariffType:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_TENANCY
plugin device-management-server tenancy [implementationDateTime:4] [tenancy:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_UPDATE_CIN
plugin device-management-server update-cin [server:2] [clientEndpoint:1] [serverEndpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_UPDATE_SITE_ID
plugin device-management-server update-site-id [server:2] [clientEndpoint:1] [serverEndpoint:1]

Detailed Description

The device management server plugin contributes CLI commands to the application framework to be used for getting, setting, and displaying information relevant to the Smart Energy 1.2 Device Management Cluster.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_CIN

plugin device-management-server cin [cin:-1] [implementationDateTime:4]

  • Set the customer id number information.
    • cin - OCTET_STRING
    • implementationDateTime - UTC_TIME
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_ISSUER_EVENT_ID

plugin device-management-server issuer-event-id [issuerEventId:4]

  • Set the issuer event id.
    • issuerEventId - INT32U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PASSWORD

plugin device-management-server password [password:-1] [implementationDateTime:4] [durationInMinutes:2] [passwordType:1]

  • Set the specified password.
    • password - OCTET_STRING
    • implementationDateTime - UTC_TIME
    • durationInMinutes - INT16U
    • passwordType - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PENDING_UPDATES

plugin device-management-server pending-updates [pendingUpdatesMask:1]

  • Set appropriate flag for pending updates. Details for each pending flag can be found via definition of EmberAfDeviceManagementChangePendingFlags.
    • pendingUpdatesMask - INT8U - A bitmask that determines if there's a valid pending update for different actions
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PRINT

plugin device-management-server print

  • Print the info relevant to device management.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PROVIDER_ID

plugin device-management-server provider-id [providerId:4]

  • Set the provider id.
    • providerId - INT32U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PUB_CHG_OF_SUPPLIER

plugin device-management-server pub-chg-of-supplier [server:2] [clientEndpoint:1] [serverEndpoint:1]

  • Send PublishChangeOfSupplier command
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_PUB_CHG_OF_TENANCY

plugin device-management-server pub-chg-of-tenancy [server:2] [clientEndpoint:1] [serverEndpoint:1]

  • Send PublishChangeOfTenancy command
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_SEND_REQ_NEW_PASS_RESP

plugin device-management-server send-req-new-pass-resp [passwordType:1] [server:2] [clientEndpoint:1] [serverEndpoint:1]

  • Send unsolicited request new password response.
    • passwordType - INT8U - Service Producer or Consumer.
    • server - INT16U - The network address of the server to which the response will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_SITE_ID

plugin device-management-server site-id [siteId:-1] [implementationDateTime:4]

  • Set the site id information.
    • siteId - OCTET_STRING
    • implementationDateTime - UTC_TIME
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_SUPPLIER

plugin device-management-server supplier [endpoint:1] [proposedProviderId:4] [implementationDateTime:4] [providerChangeControl:4] [proposedProviderName:-1] [proposedProviderContactDetails:-1]

  • Set the supplier information.
    • endpoint - INT8U
    • proposedProviderId - INT32U
    • implementationDateTime - UTC_TIME
    • providerChangeControl - BITMAP32
    • proposedProviderName - OCTET_STRING
    • proposedProviderContactDetails - OCTET_STRING
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_TARIFF_TYPE

plugin device-management-server tariff-type [tariffType:1]

  • Set the tariff type.
    • tariffType - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_TENANCY

plugin device-management-server tenancy [implementationDateTime:4] [tenancy:4]

  • Set the tenancy information.
    • implementationDateTime - UTC_TIME
    • tenancy - INT32U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_UPDATE_CIN

plugin device-management-server update-cin [server:2] [clientEndpoint:1] [serverEndpoint:1]

  • Send UpdateCIN command
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DEVICE_MANAGEMENT_SERVER_PLUGIN_DEVICE_MANAGEMENT_SERVER_UPDATE_SITE_ID

plugin device-management-server update-site-id [server:2] [clientEndpoint:1] [serverEndpoint:1]

  • Send UpdateSiteId command
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.