nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Device Management cluster commands

Data Structures

struct  zb_zcl_device_management_request_new_password_cmd_payload_s
 RequestNewPassword Command Payload Format More...
 
struct  zb_zcl_device_management_report_event_cfg_payload_s
 ReportEventConfiguration Payload Format More...
 
struct  zb_zcl_device_management_report_event_cfg_cmd_payload_s
 ReportEventConfigurationCommandPayloadFormat More...
 
struct  zb_zcl_device_management_publish_change_of_tenancy_cmd_payload_s
 PublishChangeOfTenancy Command Payload Format More...
 
struct  zb_zcl_device_management_publish_change_of_supplier_cmd_payload_s
 PublishChangeOfSupplier Command Payload Format More...
 
struct  zb_zcl_device_management_request_new_password_resp_cmd_payload_s
 RequestNewPasswordResponse Command Payload Format More...
 
struct  zb_zcl_device_management_update_site_id_cmd_payload_s
 UpdateSiteID Command Payload Format More...
 
union  zb_zcl_device_management_set_event_cfg_payload_s
 SetEventConfiguration Payload Format More...
 
struct  zb_zcl_device_management_set_event_cfg_cmd_payload_s
 SetEventConfiguration Command Payload Format More...
 
struct  zb_zcl_device_management_get_event_cfg_cmd_payload_s
 GetEventConfigurationCommand Payload Format More...
 
struct  zb_zcl_device_management_update_cin_cmd_payload_s
 UpdateCIN Command Payload Format More...
 

Macros

#define ZB_ZCL_DEVICE_MANAGEMENT_PROP_PROVIDER_NAME_MAX_SIZE   17
 The Proposed Provider Name field should be capable of storing a 16 character string (the first octet indicates length) encoded in the UTF-8 format.
 
#define ZB_ZCL_DEVICE_MANAGEMENT_PROP_PROVIDER_CONTACT_DET_MAX_SIZE   20
 The Proposed Provider Contact Details field should be capable of storing a 19 character string (the first octet indicates length) encoded in the UTF-8 format.
 
#define ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_NAME_MAX_SIZE   11
 The Password field should be capable of storing a 11 character string (the first octet indicates length).
 
#define ZB_ZCL_DEVICE_MANAGEMENT_SITE_ID_MAX_SIZE   33
 The Site ID field should be capable of storing a 32 character string (the first Octet indicates length) encoded in UTF-8 format.
 
#define ZB_ZCL_DEVICE_MANAGEMENT_CUSTOMER_ID_MAX_SIZE   25
 The Customer ID field should be capable of storing a 24 character string (the first Octet indicates length) encoded in UTF-8 format.
 

Typedefs

typedef enum
zb_zcl_device_management_cli_cmd_e 
zb_zcl_device_management_cli_cmd_t
 Commands are generated by Device Management Client. More...
 
typedef enum
zb_zcl_device_management_cfg_control_e 
zb_zcl_device_management_cfg_control_t
 Configuration Control Enumeration. More...
 
typedef enum
zb_zcl_device_management_password_type_e 
zb_zcl_device_management_password_type_t
 Password Type Enumeration. More...
 
typedef struct
zb_zcl_device_management_request_new_password_cmd_payload_s 
zb_zcl_device_management_request_new_password_cmd_payload_t
 RequestNewPassword Command Payload Format More...
 
typedef struct
zb_zcl_device_management_report_event_cfg_payload_s 
zb_zcl_device_management_report_event_cfg_payload_t
 ReportEventConfiguration Payload Format More...
 
typedef struct
zb_zcl_device_management_report_event_cfg_cmd_payload_s 
zb_zcl_device_management_report_event_cfg_cmd_payload_t
 ReportEventConfigurationCommandPayloadFormat More...
 
typedef enum
zb_zcl_device_management_srv_cmd_e 
zb_zcl_device_management_srv_cmd_t
 Commands are generated by Device Management Server. More...
 
typedef enum
zb_zcl_device_management_tariff_type_e 
zb_zcl_device_management_tariff_type_t
 Tariff Type Enumeration. More...
 
typedef struct
zb_zcl_device_management_publish_change_of_tenancy_cmd_payload_s 
zb_zcl_device_management_publish_change_of_tenancy_cmd_payload_t
 PublishChangeOfTenancy Command Payload Format More...
 
typedef struct
zb_zcl_device_management_publish_change_of_supplier_cmd_payload_s 
zb_zcl_device_management_publish_change_of_supplier_cmd_payload_t
 PublishChangeOfSupplier Command Payload Format More...
 
typedef struct
zb_zcl_device_management_request_new_password_resp_cmd_payload_s 
zb_zcl_device_management_request_new_password_resp_cmd_payload_t
 RequestNewPasswordResponse Command Payload Format More...
 
typedef struct
zb_zcl_device_management_update_site_id_cmd_payload_s 
zb_zcl_device_management_update_site_id_cmd_payload_t
 UpdateSiteID Command Payload Format More...
 
typedef union
zb_zcl_device_management_set_event_cfg_payload_s 
zb_zcl_device_management_set_event_cfg_payload_t
 SetEventConfiguration Payload Format More...
 
typedef struct
zb_zcl_device_management_set_event_cfg_cmd_payload_s 
zb_zcl_device_management_set_event_cfg_cmd_payload_t
 SetEventConfiguration Command Payload Format More...
 
typedef struct
zb_zcl_device_management_get_event_cfg_cmd_payload_s 
zb_zcl_device_management_get_event_cfg_cmd_payload_t
 GetEventConfigurationCommand Payload Format More...
 
typedef struct
zb_zcl_device_management_update_cin_cmd_payload_s 
zb_zcl_device_management_update_cin_cmd_payload_t
 UpdateCIN Command Payload Format More...
 

Enumerations

enum  zb_zcl_device_management_cli_cmd_e {
  ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_CHANGE_OF_TENANCY = 0x00, ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_CHANGE_OF_SUPPLIER, ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_REQUEST_NEW_PASSWORD, ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_SITE_ID,
  ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_REPORT_EVENT_CONFIGURATION, ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_CIN
}
 Commands are generated by Device Management Client. More...
 
enum  zb_zcl_device_management_cfg_control_e { ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_LIST = 0x00, ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_EVENT_GROUP = 0x01, ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_LOG_TYPE = 0x02, ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_CONFIG_MATCH = 0x03 }
 Configuration Control Enumeration. More...
 
enum  zb_zcl_device_management_password_type_e { ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_1 = 0x01, ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_2 = 0x02, ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_3 = 0x03, ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_4 = 0x04 }
 Password Type Enumeration. More...
 
enum  zb_zcl_device_management_srv_cmd_e {
  ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_PUBLISH_CHANGE_OF_TENANCY = 0x00, ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_PUBLISH_CHANGE_OF_SUPPLIER, ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_REQUEST_NEW_PASSWORD_RESPONSE, ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_UPDATE_SITE_ID,
  ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_SET_EVENT_CONFIGURATION, ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_GET_EVENT_CONFIGURATION, ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_UPDATE_CIN
}
 Commands are generated by Device Management Server. More...
 
enum  zb_zcl_device_management_tariff_type_e { ZB_ZCL_DEVICE_MANAGEMENT_TARIFF_TYPE_DELIVERED = 0x00, ZB_ZCL_DEVICE_MANAGEMENT_TARIFF_TYPE_RECEIVED = 0x01, ZB_ZCL_DEVICE_MANAGEMENT_TARIFF_TYPE_DELIVERED_AND_RECEIVED = 0x02 }
 Tariff Type Enumeration. More...
 

Detailed Description

Typedef Documentation

Commands are generated by Device Management Client.

See also
SE spec, subclause 10.2.3

Password Type Enumeration.

See also
SE spec, Table D-172

SetEventConfiguration Payload Format

See also
SE spec, subclauses 10.2.4.5.2.1 to 10.2.4.5.2.4
zb_zcl_device_management_set_event_cfg_cmd_payload_t::event_cfg_payload

Commands are generated by Device Management Server.

See also
SE spec, subclause 10.2.4

Tariff Type Enumeration.

See also
SE spec, Table D-108

UpdateCIN Command Payload Format

See also
SE spec, subclause 10.2.4.7

Enumeration Type Documentation

Configuration Control Enumeration.

See also
SE spec, Table D-173
zb_zcl_device_management_set_event_cfg_cmd_payload_t::cfg_control
Enumerator
ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_LIST 

Apply by List

ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_EVENT_GROUP 

Apply by Event Group

ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_LOG_TYPE 

Apply by Log Type

ZB_ZCL_DEVICE_MANAGEMENT_APPLY_BY_CONFIG_MATCH 

Apply by Configuration Match

Commands are generated by Device Management Client.

See also
SE spec, subclause 10.2.3
Enumerator
ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_CHANGE_OF_TENANCY 

This command is used to request the ESI to respond with information regarding any available change of tenancy.

Note
There are no payloads for this command
ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_CHANGE_OF_SUPPLIER 

This command is used to request the ESI to respond with information regarding any available change of supplier.

Note
There are no payloads for this command
ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_REQUEST_NEW_PASSWORD 

This command is used to request the current Password from the server.

See also
zb_zcl_device_management_request_new_password_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_SITE_ID 

This command is used to request the ESI to respond with information regarding any pending change of Site ID.

Note
There are no payloads for this command
ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_REPORT_EVENT_CONFIGURATION 

This command is sent in response to a GetEventConfiguration command.

See also
zb_zcl_device_management_report_event_cfg_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_CLI_CMD_GET_CIN 

This command is used to request the ESI to respond with information regarding any pending change of Customer ID Number.

Note
There are no payloads for this command

Password Type Enumeration.

See also
SE spec, Table D-172
Enumerator
ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_1 

Used for access to the Service menu

ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_2 

Used for access to the Consumer menu

ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_3 

TBD

ZB_ZCL_DEVICE_MANAGEMENT_PASSWORD_TYPE_4 

TBD

Commands are generated by Device Management Server.

See also
SE spec, subclause 10.2.4
Enumerator
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_PUBLISH_CHANGE_OF_TENANCY 

This command is used to change the tenancy of a meter.

See also
zb_zcl_device_management_publish_change_of_tenancy_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_PUBLISH_CHANGE_OF_SUPPLIER 

This command is used to change the Supplier (commodity provider) that is supplying the property.

See also
zb_zcl_device_management_publish_change_of_supplier_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_REQUEST_NEW_PASSWORD_RESPONSE 

This command is used to send the current password to the client.

See also
zb_zcl_device_management_request_new_password_resp_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_UPDATE_SITE_ID 

This command is used to set the SiteID attribute on a meter.

See also
zb_zcl_device_management_update_site_id_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_SET_EVENT_CONFIGURATION 

This command provides a method to set the event configuration attributes, held in a client device.

See also
zb_zcl_device_management_set_event_cfg_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_GET_EVENT_CONFIGURATION 

This command allows the server to request details of event configurations.

See also
zb_zcl_device_management_get_event_cfg_cmd_payload_t
ZB_ZCL_DEVICE_MANAGEMENT_SRV_CMD_UPDATE_CIN 

This command is used to set the CustomerIDNumber attribute held in the Metering cluster.

See also
zb_zcl_device_management_update_cin_cmd_payload_t

Tariff Type Enumeration.

See also
SE spec, Table D-108
Enumerator
ZB_ZCL_DEVICE_MANAGEMENT_TARIFF_TYPE_DELIVERED 

Delivered Tariff

ZB_ZCL_DEVICE_MANAGEMENT_TARIFF_TYPE_RECEIVED 

Received Tariff

ZB_ZCL_DEVICE_MANAGEMENT_TARIFF_TYPE_DELIVERED_AND_RECEIVED 

Delivered and Received Tariff