ZCL Basic

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

Header File

• components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_basic.h

Macros

ESP_ZB_ZCL_BASIC_SECONDARY_POWER_SOURCE(power)

The secondary backup power source, power is listed in esp_zb_zcl_basic_power_source_t

ESP_ZB_ZCL_BASIC_ZCL_VERSION_DEFAULT_VALUE

Default value for ZCL version attribute.

ESP_ZB_ZCL_BASIC_APPLICATION_VERSION_DEFAULT_VALUE

Default value for Application version attribute.

ESP_ZB_ZCL_BASIC_STACK_VERSION_DEFAULT_VALUE

Default value for Stack version attribute.

ESP_ZB_ZCL_BASIC_HW_VERSION_DEFAULT_VALUE

Default value for Hardware version attribute.

ESP_ZB_ZCL_BASIC_MANUFACTURER_NAME_DEFAULT_VALUE

Default value for Manufacturer name attribute.

ESP_ZB_ZCL_BASIC_MODEL_IDENTIFIER_DEFAULT_VALUE

Default value for Model identifier attribute.

ESP_ZB_ZCL_BASIC_DATE_CODE_DEFAULT_VALUE

Default value for Date code attribute.

ESP_ZB_ZCL_BASIC_POWER_SOURCE_DEFAULT_VALUE

Default value for Power source attribute.

ESP_ZB_ZCL_BASIC_GENERIC_DEVICE_CLASS_DEFAULT_VALUE

Default value for GenericDeviceClass attribute.

ESP_ZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_DEFAULT_VALUE

Default value for GenericDeviceType attribute.

ESP_ZB_ZCL_BASIC_PRODUCT_CODE_DEFAULT_VALUE

Default value for ProductCode attribute.

ESP_ZB_ZCL_BASIC_PRODUCT_URL_DEFAULT_VALUE

Default value for ProductURL attribute.

ESP_ZB_ZCL_BASIC_MANUFACTURER_VERSION_DETAILS_DEFAULT_VALUE

Default value for ManufacturerVersionDetails attribute.

ESP_ZB_ZCL_BASIC_SERIAL_NUMBER_DEFAULT_VALUE

Default value for SerialNumber attribute.

ESP_ZB_ZCL_BASIC_PRODUCT_LABEL_DEFAULT_VALUE

Default value for ProductLabel attribute.

ESP_ZB_ZCL_BASIC_LOCATION_DESCRIPTION_DEFAULT_VALUE

Default value for location description attribute.

ESP_ZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DEFAULT_VALUE

Default value for Physical environment attribute.

ESP_ZB_ZCL_BASIC_DEVICE_ENABLED_DEFAULT_VALUE

Default value for Device enabled attribute.

ESP_ZB_ZCL_BASIC_ALARM_MASK_DEFAULT_VALUE

Default value for Alarm mask attribute.

ESP_ZB_ZCL_BASIC_DISABLE_LOCAL_CONFIG_DEFAULT_VALUE

Default value for Disable local config attribute.

ESP_ZB_ZCL_BASIC_SW_BUILD_ID_DEFAULT_VALUE

Default value for SWBuildId attribute.

Note

Default value supposes that attribute will be stored as Pascal-style string (i. e. length-byte, then content).

Type Definitions

typedef enum esp_zb_zcl_basic_power_source_e esp_zb_zcl_basic_power_source_t

Permitted values for “Power source” attribute.

Enumerations

enum esp_zb_zcl_basic_attr_t

Basic cluster information attribute set identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_BASIC_ZCL_VERSION_ID

ZCL version attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_APPLICATION_VERSION_ID

Application version attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_STACK_VERSION_ID

Stack version attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_HW_VERSION_ID

Hardware version attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID

Manufacturer name attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_MODEL_IDENTIFIER_ID

Model identifier attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_DATE_CODE_ID

Date code attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_POWER_SOURCE_ID

Power source attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_GENERIC_DEVICE_CLASS_ID

The GenericDeviceClass attribute defines the field of application of the GenericDeviceType attribute.

enumerator ESP_ZB_ZCL_ATTR_BASIC_GENERIC_DEVICE_TYPE_ID

The GenericDeviceType attribute allows an application to show an icon on a rich user interface (e.g. smartphone app).

enumerator ESP_ZB_ZCL_ATTR_BASIC_PRODUCT_CODE_ID

The ProductCode attribute allows an application to specify a code for the product.

enumerator ESP_ZB_ZCL_ATTR_BASIC_PRODUCT_URL_ID

The ProductURL attribute specifies a link to a web page containing specific product information.

enumerator ESP_ZB_ZCL_ATTR_BASIC_MANUFACTURER_VERSION_DETAILS_ID

Vendor specific human readable (displayable) string representing the versions of one of more program images supported on the device.

enumerator ESP_ZB_ZCL_ATTR_BASIC_SERIAL_NUMBER_ID

Vendor specific human readable (displayable) serial number.

enumerator ESP_ZB_ZCL_ATTR_BASIC_PRODUCT_LABEL_ID

Vendor specific human readable (displayable) product label.

enumerator ESP_ZB_ZCL_ATTR_BASIC_LOCATION_DESCRIPTION_ID

Location description attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_PHYSICAL_ENVIRONMENT_ID

Physical environment attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_DEVICE_ENABLED_ID

Device enabled attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_ALARM_MASK_ID

Alarm mask attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_DISABLE_LOCAL_CONFIG_ID

Disable local config attribute

enumerator ESP_ZB_ZCL_ATTR_BASIC_SW_BUILD_ID

Manufacturer-specific reference to the version of the software.

enum esp_zb_zcl_basic_power_source_e

Permitted values for “Power source” attribute.

Values:

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN

Unknown power source

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_MAINS_SINGLE_PHASE

Single-phase mains.

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_MAINS_THREE_PHASE

3-phase mains.

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_BATTERY

Battery source.

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_DC_SOURCE

DC source.

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_CONST

Emergency mains constantly powered.

enumerator ESP_ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_TRANSF

Emergency mains and transfer switch.

enum esp_zb_zcl_basic_cmd_id_t

Basic cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_BASIC_RESET_ID

“Reset to Factory Defaults” command.