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

Type	Direction	Argument Name	Description
EmberAfDeviceManagementTenancy *	N/A	tenancy	Ver.: always
bool	N/A	validateOptionalFields	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementGetTenancy#

bool emberAfPluginDeviceManagementGetTenancy (EmberAfDeviceManagementTenancy * tenancy)

Get tenancy.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementTenancy *	N/A	tenancy	tenancy Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementSetSupplier#

bool emberAfPluginDeviceManagementSetSupplier (uint8_t endpoint, EmberAfDeviceManagementSupplier * supplier)

Set supplier for the device.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	endpoint	Ver.: always
EmberAfDeviceManagementSupplier *	N/A	supplier	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementGetSupplier#

bool emberAfPluginDeviceManagementGetSupplier (EmberAfDeviceManagementSupplier * supplier)

Get supplier for the device.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementSupplier *	N/A	supplier	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

Type	Direction	Argument Name	Description
uint32_t	N/A	providerId	Ver.: always
uint32_t	N/A	issuerEventId	Ver.: always
uint8_t	N/A	tariffType	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementSetSiteId#

bool emberAfPluginDeviceManagementSetSiteId (EmberAfDeviceManagementSiteId * siteId)

Set device site ID.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementSiteId *	N/A	siteId	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementGetSiteId#

bool emberAfPluginDeviceManagementGetSiteId (EmberAfDeviceManagementSiteId * siteId)

Get device site ID.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementSiteId *	N/A	siteId	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementSetCIN#

bool emberAfPluginDeviceManagementSetCIN (EmberAfDeviceManagementCIN * cin)

Set device CIN.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementCIN *	N/A	cin	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementGetCIN#

bool emberAfPluginDeviceManagementGetCIN (EmberAfDeviceManagementCIN * cin)

Get device CIN.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementCIN *	N/A	cin	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementSetPassword#

bool emberAfPluginDeviceManagementSetPassword (EmberAfDeviceManagementPassword * password)

Set device password.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementPassword *	N/A	password	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementGetPassword#

bool emberAfPluginDeviceManagementGetPassword (EmberAfDeviceManagementPassword * password, uint8_t passwordType)

Get device password.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementPassword *	N/A	password	Ver.: always
uint8_t	N/A	passwordType

Returns

bool true is success

emberAfDeviceManagementServerPrint#

void emberAfDeviceManagementServerPrint (void )

Device management server print.

Parameters

Type	Direction	Argument Name	Description
void	N/A

emberAfDeviceManagementClusterUpdateSiteId#

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

Update device site ID.

Parameters

Type	Direction	Argument Name	Description
EmberNodeId	N/A	dstAddr	Ver.: always
uint8_t	N/A	srcEndpoint	Ver.: always
uint8_t	N/A	dstEndpoint	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementSetProviderId#

bool emberAfPluginDeviceManagementSetProviderId (uint32_t providerId)

Set device provider ID.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	providerId	Ver.: always

Returns

bool true is success

emberAfPluginDeviceManagementSetIssuerEventId#

bool emberAfPluginDeviceManagementSetIssuerEventId (uint32_t issuerEventId)

Set device issuer event ID.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	issuerEventId

Returns

bool true is success

emberAfPluginDeviceManagementSetTariffType#

bool emberAfPluginDeviceManagementSetTariffType (EmberAfTariffType tariffType)

Set device tariff type.

Parameters

Type	Direction	Argument Name	Description
EmberAfTariffType	N/A	tariffType	Ver.: always

Returns

bool true is success

emberAfDeviceManagementClusterPublishChangeOfTenancy#

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

Publish the change of tenancy.

Parameters

Type	Direction	Argument Name	Description
EmberNodeId	N/A	dstAddr	Ver.: always
uint8_t	N/A	srcEndpoint	Ver.: always
uint8_t	N/A	dstEndpoint	Ver.: always

Returns

bool true is success

emberAfDeviceManagementClusterPublishChangeOfSupplier#

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

Publish the change of supplier.

Parameters

Type	Direction	Argument Name	Description
EmberNodeId	N/A	dstAddr	Ver.: always
uint8_t	N/A	srcEndpoint	Ver.: always
uint8_t	N/A	dstEndpoint	Ver.: always

Returns

bool true is success

emberAfDeviceManagementClusterSetPendingUpdates#

void emberAfDeviceManagementClusterSetPendingUpdates (EmberAfDeviceManagementChangePendingFlags pendingUpdatesMask)

Set device pending updates.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementChangePendingFlags	N/A	pendingUpdatesMask	Ver.: always

emberAfDeviceManagementClusterGetPendingUpdates#

void emberAfDeviceManagementClusterGetPendingUpdates (EmberAfDeviceManagementChangePendingFlags * pendingUpdatesMask)

Get device pending updates.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceManagementChangePendingFlags *	N/A	pendingUpdatesMask	Ver.: always

emberAfDeviceManagementClusterUpdateCIN#

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

Update CIN for the device.

Parameters

Type	Direction	Argument Name	Description
EmberNodeId	N/A	dstAddr	Ver.: always
uint8_t	N/A	srcEndpoint	Ver.: always
uint8_t	N/A	dstEndpoint	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

Type	Direction	Argument Name	Description
uint8_t	N/A	passwordType	Ver.: always
EmberNodeId	N/A	dstAddr	Ver.: always
uint8_t	N/A	srcEndpoint	Ver.: always
uint8_t	N/A	dstEndpoint	Ver.: always

Returns

bool true is success