ZCL Commissioning

Zigbee Cluster Library (ZCL) commissioning cluster usage definition for ESP Zigbee SDK.

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_commissioning.h

Functions

void esp_zb_zcl_commissioning_init_server(void)

void esp_zb_zcl_commissioning_init_client(void)

Unions

union esp_zb_zcl_commissioning_restart_device_options_t

#include <esp_zigbee_zcl_commissioning.h>

“options” field of “esp_zb_zcl_commissioning_restart_device_payload_t”

Public Members

uint8_t u8: Restart device options

uint8_t startup_mode: startup mode: bit 0 - 2

uint8_t immediate: immediate: bit 3

uint8_t __pad0__: reserved: bit 4 - 7

struct esp_zb_zcl_commissioning_restart_device_options_t::[anonymous] [anonymous]

union esp_zb_zcl_commissioning_reset_startup_param_options_t

#include <esp_zigbee_zcl_commissioning.h>

“options” field of “esp_zb_zcl_commissioning_reset_startup_parameters_payload_t”

Public Members

uint8_t u8: Reset startup options

uint8_t reset_current: reset current: bit 0

uint8_t reset_all: reset all: bit 1

uint8_t erase_index: erase index: bit 2

uint8_t __pad0__: reserved: bit 3 - 7

struct esp_zb_zcl_commissioning_reset_startup_param_options_t::[anonymous] [anonymous]

Structures

struct esp_zb_zcl_commissioning_restart_device_payload_s

“Restart Device Response” Command Payload Format

Public Members

esp_zb_zcl_commissioning_restart_device_options_t options: Options for restart device

uint8_t delay: Startup procedure is to be invoked, in seconds

uint8_t jitter: Specifies a random jitter range, in millisecond

struct esp_zb_zcl_commissioning_save_startup_parameters_payload_s

ESP_ZB_ZCL_CMD_COMMISSIONING_SAVE_STARTUP_PARAMETERS_ID “Save Startup Parameters” Command Payload Format.

Public Members

uint8_t options: Reserved field

uint8_t index: The current startup parameter attribute set is to be saved

struct esp_zb_zcl_commissioning_restore_startup_parameters_payload_s

ESP_ZB_ZCL_CMD_COMMISSIONING_RESTORE_STARTUP_PARAMETERS_ID “Restore Startup Parameters” Command Payload Format.

Public Members

uint8_t options: Reserved field

uint8_t index: Index of the saved startup parameter attribute set to be restored to current status

struct esp_zb_zcl_commissioning_reset_startup_parameters_payload_s

“Reset Startup Parameters” Command Payload Format

Public Members

esp_zb_zcl_commissioning_reset_startup_param_options_t options: The options of reset startup parameter

uint8_t index: Index of a saved startup parameter attribute set

Macros

ESP_ZB_ZCL_COMMISSIONING_SHORT_ADDRESS_MIN_VALUE: Minimum value for ShortAddress attribute.

ESP_ZB_ZCL_COMMISSIONING_SHORT_ADDRESS_MAX_VALUE: Maximum value for ShortAddress attribute.

ESP_ZB_ZCL_COMMISSIONING_PROTOCOL_VERSION_MIN_VALUE: Minimum value for ProtocolVersion attribute.

ESP_ZB_ZCL_COMMISSIONING_PROTOCOL_VERSION_MAX_VALUE: Maximum value for ProtocolVersion attribute.

ESP_ZB_ZCL_COMMISSIONING_STACK_PROFILE_MIN_VALUE: Minimum value for StackProfile attribute.

ESP_ZB_ZCL_COMMISSIONING_STACK_PROFILE_MAX_VALUE: Maximum value for StackProfile attribute.

ESP_ZB_ZCL_COMMISSIONING_STARTUP_CONTROL_MIN_VALUE: Minimum value for StartupControl attribute.

ESP_ZB_ZCL_COMMISSIONING_STARTUP_CONTROL_MAX_VALUE: Maximum value for StartupControl attribute.

ESP_ZB_ZCL_COMMISSIONING_EXTENDED_PANID_DEFAULT_VALUE: Default value for ExtendedPANId attribute.

ESP_ZB_ZCL_COMMISSIONING_PROTOCOL_VERSION_DEFAULT_VALUE: Default value for ProtocolVersion attribute.

ESP_ZB_ZCL_COMMISSIONING_STACK_PROFILE_DEFAULT_VALUE: Default value for StackProfile attribute.

ESP_ZB_ZCL_COMMISSIONING_STARTUP_CONTROL_DEFAULT_VALUE: Default value for ProtocolVersion attribute.

ESP_ZB_ZCL_COMMISSIONING_USE_INSECURE_JOIN_DEFAULT_VALUE: Default value for UseInsecureJoin attribute.

ESP_ZB_ZCL_CLUSTER_ID_COMMISSIONING_SERVER_ROLE_INIT

ESP_ZB_ZCL_CLUSTER_ID_COMMISSIONING_CLIENT_ROLE_INIT

Type Definitions

typedef struct esp_zb_zcl_commissioning_restart_device_payload_s esp_zb_zcl_commissioning_restart_device_payload_t: “Restart Device Response” Command Payload Format

typedef struct esp_zb_zcl_commissioning_save_startup_parameters_payload_s esp_zb_zcl_commissioning_save_startup_parameters_payload_t: ESP_ZB_ZCL_CMD_COMMISSIONING_SAVE_STARTUP_PARAMETERS_ID “Save Startup Parameters” Command Payload Format.

typedef struct esp_zb_zcl_commissioning_restore_startup_parameters_payload_s esp_zb_zcl_commissioning_restore_startup_parameters_payload_t: ESP_ZB_ZCL_CMD_COMMISSIONING_RESTORE_STARTUP_PARAMETERS_ID “Restore Startup Parameters” Command Payload Format.

typedef struct esp_zb_zcl_commissioning_reset_startup_parameters_payload_s esp_zb_zcl_commissioning_reset_startup_parameters_payload_t: “Reset Startup Parameters” Command Payload Format

Enumerations

enum esp_zb_zcl_commissioning_srv_attr_t

Commissioning Cluster server attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_SHORT_ADDRESS_ID: ShortAddress Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_EXTENDED_PANID_ID: ExtendedPANId Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_PANID_ID: PANId Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_CHANNEL_MASK_ID: ChannelMask Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_PROTOCOL_VERSION_ID: ProtocolVersion Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_STACK_PROFILE_ID: StackProfile Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_STARTUP_CONTROL_ID: StartupControl Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_TRUST_CENTER_ADDRESS_ID: TrustCenterAddress Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_TRUST_CENTER_MASTER_KEY_ID: TrustCenterMasterKey Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_NETWORK_KEY_ID: NetworkKey Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_USE_INSECURE_JOIN_ID: UseInsecureJoin Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_PRECONFIGURED_LINK_KEY_ID: PreconfiguredLinkKey Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_NETWORK_KEY_SEQ_NUM_ID: NetworkKeySeqNum Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_NETWORK_KEY_TYPE_ID: NetworkKeyType Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_NETWORK_MANAGER_ADDRESS_ID: NetworkManagerAddress Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_SCAN_ATTEMPTS_ID: ScanAttempts Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_TIME_BETWEEN_SCANS_ID: TimeBetweenScans Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_REJOIN_INTERVAL_ID: RejoinInterval Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_MAX_REJOIN_INTERVAL_ID: MaxRejoinInterval Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_INDIRECT_POLL_RATE_ID: IndirectPollRate Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_PARENT_RETRY_THRESHOLD_ID: ParentRetryThreshold Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_CONCENTRATOR_FLAG_ID: ConcentratorFlag Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_CONCENTRATOR_RADIUS_ID: ConcentratorRadius Attribute

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_CONCENTRATOR_DISCOVERY_TIME_ID: ConcentratorDiscoveryTime Attribute

enum esp_zb_zcl_commissioning_startup_type_t

Values for valid Startup Control attribute.

Values:

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_STARTUP_TYPE_JOINED

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_STARTUP_TYPE_FORM

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_STARTUP_TYPE_REJOIN

enumerator ESP_ZB_ZCL_ATTR_COMMISSIONING_STARTUP_TYPE_SCRATCH

enum esp_zb_zcl_commissioning_srv_cmd_id_t

Commissioning Cluster server command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_RESTART_DEVICE_RESPONSE_ID: “Restart Device Response” command.

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_SAVE_STARTUP_PARAMETERS_RESPONSE_ID: “Save Startup Parameters Response” command.

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_RESTORE_STARTUP_PARAMETERS_RESPONSE_ID: “Restore Startup Parameters Response” command.

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_RESET_STARTUP_PARAMETERS_RESPONSE_ID: “Reset Startup Parameters Response” command.

enum esp_zb_zcl_commissioning_cli_cmd_id_t

Commissioning Cluster client command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_RESTART_DEVICE_ID: “Restart Device” command.

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_SAVE_STARTUP_PARAMETERS_ID: “Save Startup Parameters” command.

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_RESTORE_STARTUP_PARAMETERS_ID: “Restore Startup Parameters” command.

enumerator ESP_ZB_ZCL_CMD_COMMISSIONING_RESET_STARTUP_PARAMETERS_ID: “Reset Startup Parameters” command.

enum esp_zb_zcl_commissioning_startup_mode_t

The values of “startup_mode” bitfield in “options” field of “esp_zb_zcl_commissioning_restart_device_payload_t”.

Values:

enumerator ESP_ZB_ZCL_COMMISSIONING_STARTUP_MODE_USE_PARAMETER_SET

enumerator ESP_ZB_ZCL_COMMISSIONING_STARTUP_MODE_USE_CURRENT_STACK