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#
Set tenancy.
Get tenancy.
Set supplier for the device.
Get supplier for the device.
Set global data device information.
Set device site ID.
Get device site ID.
Set device CIN.
Get device CIN.
Set device password.
Get device password.
Device management server print.
Update device site ID.
Set device provider ID.
Set device issuer event ID.
Set device tariff type.
Publish the change of tenancy.
Publish the change of supplier.
Set device pending updates.
Get device pending updates.
Update CIN for the device.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_tenancy_t * | N/A | tenancy | Ver.: always |
| bool | N/A | validateOptionalFields | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_tenancy_t * | N/A | tenancy | tenancy Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Ver.: always |
| sl_zigbee_af_device_management_supplier_t * | N/A | supplier | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_supplier_t * | N/A | supplier | Ver.: always |
Returns
bool true is success
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.
| 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
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_site_id_t * | N/A | siteId | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_site_id_t * | N/A | siteId | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_c_i_n_t * | N/A | cin | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_c_i_n_t * | N/A | cin | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_password_t * | N/A | password | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_password_t * | N/A | password | Ver.: always |
| uint8_t | N/A | passwordType |
Returns
bool true is success
sl_zigbee_af_device_management_server_print#
void sl_zigbee_af_device_management_server_print (void )
Device management server print.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | dstAddr | Ver.: always |
| uint8_t | N/A | srcEndpoint | Ver.: always |
| uint8_t | N/A | dstEndpoint | Ver.: always |
Returns
bool true is success
sl_zigbee_af_device_management_set_provider_id#
bool sl_zigbee_af_device_management_set_provider_id (uint32_t providerId)
Set device provider ID.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | providerId | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | issuerEventId |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_tariff_type_t | N/A | tariffType | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | dstAddr | Ver.: always |
| uint8_t | N/A | srcEndpoint | Ver.: always |
| uint8_t | N/A | dstEndpoint | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | dstAddr | Ver.: always |
| uint8_t | N/A | srcEndpoint | Ver.: always |
| uint8_t | N/A | dstEndpoint | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_change_pending_flags_t | N/A | pendingUpdatesMask | Ver.: always |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_device_management_change_pending_flags_t * | N/A | pendingUpdatesMask | Ver.: always |
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | dstAddr | Ver.: always |
| uint8_t | N/A | srcEndpoint | Ver.: always |
| uint8_t | N/A | dstEndpoint | Ver.: always |
Returns
bool true is success
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | passwordType | Ver.: always |
| sl_802154_short_addr_t | N/A | dstAddr | Ver.: always |
| uint8_t | N/A | srcEndpoint | Ver.: always |
| uint8_t | N/A | dstEndpoint | Ver.: always |
Returns
bool true is success