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
sl_zigbee_af_device_management_set_tenancy(sl_zigbee_af_device_management_tenancy_t *tenancy, bool validateOptionalFields)

Set tenancy.

bool
sl_zigbee_af_device_management_get_tenancy(sl_zigbee_af_device_management_tenancy_t *tenancy)

Get tenancy.

bool
sl_zigbee_af_device_management_set_supplier(uint8_t endpoint, sl_zigbee_af_device_management_supplier_t *supplier)

Set supplier for the device.

bool
sl_zigbee_af_device_management_get_supplier(sl_zigbee_af_device_management_supplier_t *supplier)

Get supplier for the device.

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

Set global data device information.

bool
sl_zigbee_af_device_management_set_site_id(sl_zigbee_af_device_management_site_id_t *siteId)

Set device site ID.

bool
sl_zigbee_af_device_management_get_site_id(sl_zigbee_af_device_management_site_id_t *siteId)

Get device site ID.

bool
sl_zigbee_af_device_management_set_cin(sl_zigbee_af_device_management_c_i_n_t *cin)

Set device CIN.

bool
sl_zigbee_af_device_management_get_cin(sl_zigbee_af_device_management_c_i_n_t *cin)

Get device CIN.

bool
sl_zigbee_af_device_management_set_password(sl_zigbee_af_device_management_password_t *password)

Set device password.

bool
sl_zigbee_af_device_management_get_password(sl_zigbee_af_device_management_password_t *password, uint8_t passwordType)

Get device password.

void
sl_zigbee_af_device_management_server_print(void)

Device management server print.

bool
sl_zigbee_af_device_management_cluster_update_site_id(sl_802154_short_addr_t dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Update device site ID.

bool
sl_zigbee_af_device_management_set_provider_id(uint32_t providerId)

Set device provider ID.

bool
sl_zigbee_af_device_management_set_issuer_event_id(uint32_t issuerEventId)

Set device issuer event ID.

bool
sl_zigbee_af_device_management_set_tariff_type(sl_zigbee_af_tariff_type_t tariffType)

Set device tariff type.

bool
sl_zigbee_af_device_management_cluster_publish_change_of_tenancy(sl_802154_short_addr_t dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Publish the change of tenancy.

bool
sl_zigbee_af_device_management_cluster_publish_change_of_supplier(sl_802154_short_addr_t dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Publish the change of supplier.

void
sl_zigbee_af_device_management_cluster_set_pending_updates(sl_zigbee_af_device_management_change_pending_flags_t pendingUpdatesMask)

Set device pending updates.

void
sl_zigbee_af_device_management_cluster_get_pending_updates(sl_zigbee_af_device_management_change_pending_flags_t *pendingUpdatesMask)

Get device pending updates.

bool
sl_zigbee_af_device_management_cluster_update_cin(sl_802154_short_addr_t dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Update CIN for the device.

bool
sl_zigbee_af_device_management_cluster_send_request_new_password_response(uint8_t passwordType, sl_802154_short_addr_t dstAddr, uint8_t srcEndpoint, uint8_t dstEndpoint)

Send the request new password response.

API Documentation#

sl_zigbee_af_device_management_set_tenancy#

bool sl_zigbee_af_device_management_set_tenancy (sl_zigbee_af_device_management_tenancy_t * 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

sl_zigbee_af_device_management_get_tenancy#

bool sl_zigbee_af_device_management_get_tenancy (sl_zigbee_af_device_management_tenancy_t * 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

sl_zigbee_af_device_management_set_supplier#

bool sl_zigbee_af_device_management_set_supplier (uint8_t endpoint, sl_zigbee_af_device_management_supplier_t * 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

sl_zigbee_af_device_management_get_supplier#

bool sl_zigbee_af_device_management_get_supplier (sl_zigbee_af_device_management_supplier_t * 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

sl_zigbee_af_device_management_set_info_global_data#

bool sl_zigbee_af_device_management_set_info_global_data (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

sl_zigbee_af_device_management_set_site_id#

bool sl_zigbee_af_device_management_set_site_id (sl_zigbee_af_device_management_site_id_t * 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

sl_zigbee_af_device_management_get_site_id#

bool sl_zigbee_af_device_management_get_site_id (sl_zigbee_af_device_management_site_id_t * 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

sl_zigbee_af_device_management_set_cin#

bool sl_zigbee_af_device_management_set_cin (sl_zigbee_af_device_management_c_i_n_t * 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

sl_zigbee_af_device_management_get_cin#

bool sl_zigbee_af_device_management_get_cin (sl_zigbee_af_device_management_c_i_n_t * 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

sl_zigbee_af_device_management_set_password#

bool sl_zigbee_af_device_management_set_password (sl_zigbee_af_device_management_password_t * 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

sl_zigbee_af_device_management_get_password#

bool sl_zigbee_af_device_management_get_password (sl_zigbee_af_device_management_password_t * 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

sl_zigbee_af_device_management_server_print#

void sl_zigbee_af_device_management_server_print (void )

Device management server print.

Parameters
N/A

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

sl_zigbee_af_device_management_cluster_update_site_id#

bool sl_zigbee_af_device_management_cluster_update_site_id (sl_802154_short_addr_t 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

sl_zigbee_af_device_management_set_provider_id#

bool sl_zigbee_af_device_management_set_provider_id (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

sl_zigbee_af_device_management_set_issuer_event_id#

bool sl_zigbee_af_device_management_set_issuer_event_id (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

sl_zigbee_af_device_management_set_tariff_type#

bool sl_zigbee_af_device_management_set_tariff_type (sl_zigbee_af_tariff_type_t 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

sl_zigbee_af_device_management_cluster_publish_change_of_tenancy#

bool sl_zigbee_af_device_management_cluster_publish_change_of_tenancy (sl_802154_short_addr_t 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

sl_zigbee_af_device_management_cluster_publish_change_of_supplier#

bool sl_zigbee_af_device_management_cluster_publish_change_of_supplier (sl_802154_short_addr_t 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

sl_zigbee_af_device_management_cluster_set_pending_updates#

void sl_zigbee_af_device_management_cluster_set_pending_updates (sl_zigbee_af_device_management_change_pending_flags_t 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

sl_zigbee_af_device_management_cluster_get_pending_updates#

void sl_zigbee_af_device_management_cluster_get_pending_updates (sl_zigbee_af_device_management_change_pending_flags_t * 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

sl_zigbee_af_device_management_cluster_update_cin#

bool sl_zigbee_af_device_management_cluster_update_cin (sl_802154_short_addr_t 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

sl_zigbee_af_device_management_cluster_send_request_new_password_response#

bool sl_zigbee_af_device_management_cluster_send_request_new_password_response (uint8_t passwordType, sl_802154_short_addr_t 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