Device Management Server#

API and Callbacks for the Device Management Cluster Server Component.

This component implements the server-side functionality of the Smart Energy 1.2 Device Management cluster.

API#

bool
emberAfPluginDeviceManagementSetTenancy(EmberAfDeviceManagementTenancy *tenancy, bool validateOptionalFields)

Set tenancy.

bool
emberAfPluginDeviceManagementGetTenancy(EmberAfDeviceManagementTenancy *tenancy)

Get tenancy.

bool
emberAfPluginDeviceManagementSetSupplier(uint8_t endpoint, EmberAfDeviceManagementSupplier *supplier)

Set supplier for the device.

bool
emberAfPluginDeviceManagementGetSupplier(EmberAfDeviceManagementSupplier *supplier)

Get supplier for the device.

bool
emberAfPluginDeviceManagementSetInfoGlobalData(uint32_t providerId, uint32_t issuerEventId, uint8_t tariffType)

Set global data device information.

bool
emberAfPluginDeviceManagementSetSiteId(EmberAfDeviceManagementSiteId *siteId)

Set device site ID.

bool
emberAfPluginDeviceManagementGetSiteId(EmberAfDeviceManagementSiteId *siteId)

Get device site ID.

bool
emberAfPluginDeviceManagementSetCIN(EmberAfDeviceManagementCIN *cin)

Set device CIN.

bool
emberAfPluginDeviceManagementGetCIN(EmberAfDeviceManagementCIN *cin)

Get device CIN.

bool
emberAfPluginDeviceManagementSetPassword(EmberAfDeviceManagementPassword *password)

Set device password.

bool
emberAfPluginDeviceManagementGetPassword(EmberAfDeviceManagementPassword *password, uint8_t passwordType)

Get device password.

void

Device management server print.

bool
emberAfDeviceManagementClusterUpdateSiteId(EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Update device site ID.

bool

Set device provider ID.

bool

Set device issuer event ID.

bool
emberAfPluginDeviceManagementSetTariffType(EmberAfTariffType tariffType)

Set device tariff type.

bool
emberAfDeviceManagementClusterPublishChangeOfTenancy(EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Publish the change of tenancy.

bool
emberAfDeviceManagementClusterPublishChangeOfSupplier(EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Publish the change of supplier.

void
emberAfDeviceManagementClusterSetPendingUpdates(EmberAfDeviceManagementChangePendingFlags pendingUpdatesMask)

Set device pending updates.

void
emberAfDeviceManagementClusterGetPendingUpdates(EmberAfDeviceManagementChangePendingFlags *pendingUpdatesMask)

Get device pending updates.

bool
emberAfDeviceManagementClusterUpdateCIN(EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Update CIN for the device.

bool
emberAfDeviceManagementClusterSendRequestNewPasswordResponse(uint8_t passwordType, EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send the request new password response.

API Documentation#

emberAfPluginDeviceManagementSetTenancy#

bool emberAfPluginDeviceManagementSetTenancy (EmberAfDeviceManagementTenancy * tenancy, bool validateOptionalFields)

Set tenancy.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementTenancy *N/Atenancy

Ver.: always

boolN/AvalidateOptionalFields

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementGetTenancy#

bool emberAfPluginDeviceManagementGetTenancy (EmberAfDeviceManagementTenancy * tenancy)

Get tenancy.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementTenancy *N/Atenancy

tenancy Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetSupplier#

bool emberAfPluginDeviceManagementSetSupplier (uint8_t endpoint, EmberAfDeviceManagementSupplier * supplier)

Set supplier for the device.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

Ver.: always

EmberAfDeviceManagementSupplier *N/Asupplier

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementGetSupplier#

bool emberAfPluginDeviceManagementGetSupplier (EmberAfDeviceManagementSupplier * supplier)

Get supplier for the device.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementSupplier *N/Asupplier

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetInfoGlobalData#

bool emberAfPluginDeviceManagementSetInfoGlobalData (uint32_t providerId, uint32_t issuerEventId, uint8_t tariffType)

Set global data device information.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/AproviderId

Ver.: always

uint32_tN/AissuerEventId

Ver.: always

uint8_tN/AtariffType

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetSiteId#

bool emberAfPluginDeviceManagementSetSiteId (EmberAfDeviceManagementSiteId * siteId)

Set device site ID.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementSiteId *N/AsiteId

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementGetSiteId#

bool emberAfPluginDeviceManagementGetSiteId (EmberAfDeviceManagementSiteId * siteId)

Get device site ID.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementSiteId *N/AsiteId

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetCIN#

bool emberAfPluginDeviceManagementSetCIN (EmberAfDeviceManagementCIN * cin)

Set device CIN.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementCIN *N/Acin

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementGetCIN#

bool emberAfPluginDeviceManagementGetCIN (EmberAfDeviceManagementCIN * cin)

Get device CIN.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementCIN *N/Acin

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetPassword#

bool emberAfPluginDeviceManagementSetPassword (EmberAfDeviceManagementPassword * password)

Set device password.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementPassword *N/Apassword

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementGetPassword#

bool emberAfPluginDeviceManagementGetPassword (EmberAfDeviceManagementPassword * password, uint8_t passwordType)

Get device password.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementPassword *N/Apassword

Ver.: always

uint8_tN/ApasswordType

Returns

  • bool true is success


emberAfDeviceManagementServerPrint#

void emberAfDeviceManagementServerPrint (void )

Device management server print.

Parameters
TypeDirectionArgument NameDescription
voidN/A

emberAfDeviceManagementClusterUpdateSiteId#

bool emberAfDeviceManagementClusterUpdateSiteId (EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Update device site ID.

Parameters
TypeDirectionArgument NameDescription
EmberNodeIdN/AdstAddr

Ver.: always

uint8_tN/AsrcEndpoint

Ver.: always

uint8_tN/AdstEndpoint

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetProviderId#

bool emberAfPluginDeviceManagementSetProviderId (uint32_t providerId)

Set device provider ID.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/AproviderId

Ver.: always

Returns

  • bool true is success


emberAfPluginDeviceManagementSetIssuerEventId#

bool emberAfPluginDeviceManagementSetIssuerEventId (uint32_t issuerEventId)

Set device issuer event ID.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/AissuerEventId

Returns

  • bool true is success


emberAfPluginDeviceManagementSetTariffType#

bool emberAfPluginDeviceManagementSetTariffType (EmberAfTariffType tariffType)

Set device tariff type.

Parameters
TypeDirectionArgument NameDescription
EmberAfTariffTypeN/AtariffType

Ver.: always

Returns

  • bool true is success


emberAfDeviceManagementClusterPublishChangeOfTenancy#

bool emberAfDeviceManagementClusterPublishChangeOfTenancy (EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Publish the change of tenancy.

Parameters
TypeDirectionArgument NameDescription
EmberNodeIdN/AdstAddr

Ver.: always

uint8_tN/AsrcEndpoint

Ver.: always

uint8_tN/AdstEndpoint

Ver.: always

Returns

  • bool true is success


emberAfDeviceManagementClusterPublishChangeOfSupplier#

bool emberAfDeviceManagementClusterPublishChangeOfSupplier (EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Publish the change of supplier.

Parameters
TypeDirectionArgument NameDescription
EmberNodeIdN/AdstAddr

Ver.: always

uint8_tN/AsrcEndpoint

Ver.: always

uint8_tN/AdstEndpoint

Ver.: always

Returns

  • bool true is success


emberAfDeviceManagementClusterSetPendingUpdates#

void emberAfDeviceManagementClusterSetPendingUpdates (EmberAfDeviceManagementChangePendingFlags pendingUpdatesMask)

Set device pending updates.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementChangePendingFlagsN/ApendingUpdatesMask

Ver.: always


emberAfDeviceManagementClusterGetPendingUpdates#

void emberAfDeviceManagementClusterGetPendingUpdates (EmberAfDeviceManagementChangePendingFlags * pendingUpdatesMask)

Get device pending updates.

Parameters
TypeDirectionArgument NameDescription
EmberAfDeviceManagementChangePendingFlags *N/ApendingUpdatesMask

Ver.: always


emberAfDeviceManagementClusterUpdateCIN#

bool emberAfDeviceManagementClusterUpdateCIN (EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Update CIN for the device.

Parameters
TypeDirectionArgument NameDescription
EmberNodeIdN/AdstAddr

Ver.: always

uint8_tN/AsrcEndpoint

Ver.: always

uint8_tN/AdstEndpoint

Ver.: always

Returns

  • bool true is success


emberAfDeviceManagementClusterSendRequestNewPasswordResponse#

bool emberAfDeviceManagementClusterSendRequestNewPasswordResponse (uint8_t passwordType, EmberNodeId dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send the request new password response.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/ApasswordType

Ver.: always

EmberNodeIdN/AdstAddr

Ver.: always

uint8_tN/AsrcEndpoint

Ver.: always

uint8_tN/AdstEndpoint

Ver.: always

Returns

  • bool true is success