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
emberAfDeviceManagementServerPrint(void)

Device management server print.

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

Update device site ID.

bool
emberAfPluginDeviceManagementSetProviderId(uint32_t providerId)

Set device provider ID.

bool
emberAfPluginDeviceManagementSetIssuerEventId(uint32_t issuerEventId)

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
N/Atenancy

Ver.: always

N/AvalidateOptionalFields

Ver.: always

Returns

  • bool true is success


Definition at line 48 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementGetTenancy#

bool emberAfPluginDeviceManagementGetTenancy (EmberAfDeviceManagementTenancy *tenancy)

Get tenancy.

Parameters
N/Atenancy

tenancy Ver.: always

Returns

  • bool true is success


Definition at line 58 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetSupplier#

bool emberAfPluginDeviceManagementSetSupplier (uint8_t endpoint, EmberAfDeviceManagementSupplier *supplier)

Set supplier for the device.

Parameters
N/Aendpoint

Ver.: always

N/Asupplier

Ver.: always

Returns

  • bool true is success


Definition at line 68 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementGetSupplier#

bool emberAfPluginDeviceManagementGetSupplier (EmberAfDeviceManagementSupplier *supplier)

Get supplier for the device.

Parameters
N/Asupplier

Ver.: always

Returns

  • bool true is success


Definition at line 77 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetInfoGlobalData#

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

Set global data device information.

Parameters
N/AproviderId

Ver.: always

N/AissuerEventId

Ver.: always

N/AtariffType

Ver.: always

Returns

  • bool true is success


Definition at line 88 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetSiteId#

bool emberAfPluginDeviceManagementSetSiteId (EmberAfDeviceManagementSiteId *siteId)

Set device site ID.

Parameters
N/AsiteId

Ver.: always

Returns

  • bool true is success


Definition at line 99 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementGetSiteId#

bool emberAfPluginDeviceManagementGetSiteId (EmberAfDeviceManagementSiteId *siteId)

Get device site ID.

Parameters
N/AsiteId

Ver.: always

Returns

  • bool true is success


Definition at line 108 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetCIN#

bool emberAfPluginDeviceManagementSetCIN (EmberAfDeviceManagementCIN *cin)

Set device CIN.

Parameters
N/Acin

Ver.: always

Returns

  • bool true is success


Definition at line 117 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementGetCIN#

bool emberAfPluginDeviceManagementGetCIN (EmberAfDeviceManagementCIN *cin)

Get device CIN.

Parameters
N/Acin

Ver.: always

Returns

  • bool true is success


Definition at line 126 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetPassword#

bool emberAfPluginDeviceManagementSetPassword (EmberAfDeviceManagementPassword *password)

Set device password.

Parameters
N/Apassword

Ver.: always

Returns

  • bool true is success


Definition at line 135 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementGetPassword#

bool emberAfPluginDeviceManagementGetPassword (EmberAfDeviceManagementPassword *password, uint8_t passwordType)

Get device password.

Parameters
N/Apassword

Ver.: always

N/ApasswordType

Returns

  • bool true is success


Definition at line 144 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementServerPrint#

void emberAfDeviceManagementServerPrint (void)

Device management server print.

Parameters
N/A

Definition at line 150 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterUpdateSiteId#

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

Update device site ID.

Parameters
N/AdstAddr

Ver.: always

N/AsrcEndpoint

Ver.: always

N/AdstEndpoint

Ver.: always

Returns

  • bool true is success


Definition at line 161 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetProviderId#

bool emberAfPluginDeviceManagementSetProviderId (uint32_t providerId)

Set device provider ID.

Parameters
N/AproviderId

Ver.: always

Returns

  • bool true is success


Definition at line 172 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetIssuerEventId#

bool emberAfPluginDeviceManagementSetIssuerEventId (uint32_t issuerEventId)

Set device issuer event ID.

Parameters
N/AissuerEventId

Returns

  • bool true is success


Definition at line 181 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfPluginDeviceManagementSetTariffType#

bool emberAfPluginDeviceManagementSetTariffType (EmberAfTariffType tariffType)

Set device tariff type.

Parameters
N/AtariffType

Ver.: always

Returns

  • bool true is success


Definition at line 190 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterPublishChangeOfTenancy#

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

Publish the change of tenancy.

Parameters
N/AdstAddr

Ver.: always

N/AsrcEndpoint

Ver.: always

N/AdstEndpoint

Ver.: always

Returns

  • bool true is success


Definition at line 201 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterPublishChangeOfSupplier#

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

Publish the change of supplier.

Parameters
N/AdstAddr

Ver.: always

N/AsrcEndpoint

Ver.: always

N/AdstEndpoint

Ver.: always

Returns

  • bool true is success


Definition at line 214 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterSetPendingUpdates#

void emberAfDeviceManagementClusterSetPendingUpdates (EmberAfDeviceManagementChangePendingFlags pendingUpdatesMask)

Set device pending updates.

Parameters
N/ApendingUpdatesMask

Ver.: always


Definition at line 223 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterGetPendingUpdates#

void emberAfDeviceManagementClusterGetPendingUpdates (EmberAfDeviceManagementChangePendingFlags *pendingUpdatesMask)

Get device pending updates.

Parameters
N/ApendingUpdatesMask

Ver.: always


Definition at line 230 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterUpdateCIN#

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

Update CIN for the device.

Parameters
N/AdstAddr

Ver.: always

N/AsrcEndpoint

Ver.: always

N/AdstEndpoint

Ver.: always

Returns

  • bool true is success


Definition at line 241 of file app/framework/plugin/device-management-server/device-management-server.h

emberAfDeviceManagementClusterSendRequestNewPasswordResponse#

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

Send the request new password response.

Parameters
N/ApasswordType

Ver.: always

N/AdstAddr

Ver.: always

N/AsrcEndpoint

Ver.: always

N/AdstEndpoint

Ver.: always

Returns

  • bool true is success


Definition at line 255 of file app/framework/plugin/device-management-server/device-management-server.h