ZCL Basic cluster

Data Structures
struct	zb_zcl_basic_disable_local_conf_s
	Value structure for "Disable local config" attribute. More...
struct	zb_zcl_basic_attrs_s
	Basic cluster attributes. More...

Basic cluster attributes
enum	zb_zcl_basic_info_attr_e {   ZB_ZCL_ATTR_BASIC_ZCL_VERSION_ID = 0x0000, ZB_ZCL_ATTR_BASIC_APPLICATION_VERSION_ID = 0x0001, ZB_ZCL_ATTR_BASIC_STACK_VERSION_ID = 0x0002, ZB_ZCL_ATTR_BASIC_HW_VERSION_ID = 0x0003,   ZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID = 0x0004, ZB_ZCL_ATTR_BASIC_MODEL_IDENTIFIER_ID = 0x0005, ZB_ZCL_ATTR_BASIC_DATE_CODE_ID = 0x0006, ZB_ZCL_ATTR_BASIC_POWER_SOURCE_ID = 0x0007 }
	Basic cluster information attribute set identifiers. More...
enum	zb_zcl_basic_settings_attr_e {   ZB_ZCL_ATTR_BASIC_LOCATION_DESCRIPTION_ID = 0x0010, ZB_ZCL_ATTR_BASIC_PHYSICAL_ENVIRONMENT_ID = 0x0011, ZB_ZCL_ATTR_BASIC_DEVICE_ENABLED_ID = 0x0012, ZB_ZCL_ATTR_BASIC_ALARM_MASK_ID = 0x0013,   ZB_ZCL_ATTR_BASIC_DISABLE_LOCAL_CONFIG_ID = 0x0014 }
	Basic cluster settings attribute set identifiers. More...
enum	zb_zcl_basic_power_source_e {   ZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN = 0x00, ZB_ZCL_BASIC_POWER_SOURCE_MAINS_SINGLE_PHASE = 0x01, ZB_ZCL_BASIC_POWER_SOURCE_MAINS_THREE_PHASE = 0x02, ZB_ZCL_BASIC_POWER_SOURCE_BATTERY = 0x03,   ZB_ZCL_BASIC_POWER_SOURCE_DC_SOURCE = 0x04, ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_CONST = 0x05, ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_TRANSF = 0x06 }
	Permitted values for "Power source" attribute. More...
enum	zb_zcl_basic_physical_env_e { ZB_ZCL_BASIC_ENV_UNSPECIFIED = 0, ZB_ZCL_BASIC_ENV_UNKNOWN = 0xff }
	Basic permitted values for "Physical environment" attribute. More...
enum	zb_zcl_basic_alarm_mask_e { ZB_ZCL_BASIC_ALARM_MASK_HW_FAULT = 0, ZB_ZCL_BASIC_ALARM_MASK_SW_FAULT = 1 }
	Permitted bits for "Alarm mask" attribute. More...
typedef struct zb_zcl_basic_disable_local_conf_s	zb_zcl_basic_disable_local_conf_t
	Value structure for "Disable local config" attribute. More...
typedef struct zb_zcl_basic_attrs_s	zb_zcl_basic_attrs_t
	Basic cluster attributes.

Alarms cluster commands
enum	zb_zcl_basic_cmd_e { ZB_ZCL_CMD_BASIC_RESET_ID = 0x00 }
	Basic cluster command identifiers. More...

Detailed Description

According to ZCL spec, clause 3.2, Basic cluster contains attributes only. These attributes could be queried with general ZCL commands.

Typedef Documentation

typedef struct zb_zcl_basic_disable_local_conf_s zb_zcl_basic_disable_local_conf_t

Value structure for "Disable local config" attribute.

See Also

ZCL spec, subclause 3.2.2.2.15

Enumeration Type Documentation

enum zb_zcl_basic_alarm_mask_e

Permitted bits for "Alarm mask" attribute.

See Also

ZCL spec, subclause 3.2.2.2.14

Enumerator
ZB_ZCL_BASIC_ALARM_MASK_HW_FAULT	General hardware fault
ZB_ZCL_BASIC_ALARM_MASK_SW_FAULT	General software fault

enum zb_zcl_basic_cmd_e

Basic cluster command identifiers.

See Also

ZCL spec, subclause 3.2.2.3

Enumerator
ZB_ZCL_CMD_BASIC_RESET_ID	"Reset to Factory Defaults" command.

enum zb_zcl_basic_info_attr_e

Basic cluster information attribute set identifiers.

See Also

ZCL spec, subclauses 3.2.2.2.1 to 3.2.2.2.9

Enumerator
ZB_ZCL_ATTR_BASIC_ZCL_VERSION_ID	ZCL version attribute
ZB_ZCL_ATTR_BASIC_APPLICATION_VERSION_ID	Application version attribute
ZB_ZCL_ATTR_BASIC_STACK_VERSION_ID	Stack version attribute
ZB_ZCL_ATTR_BASIC_HW_VERSION_ID	Hardware version attribute
ZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID	Manufacturer name attribute
ZB_ZCL_ATTR_BASIC_MODEL_IDENTIFIER_ID	Model identifier attribute
ZB_ZCL_ATTR_BASIC_DATE_CODE_ID	Date code attribute
ZB_ZCL_ATTR_BASIC_POWER_SOURCE_ID	Power source attribute

enum zb_zcl_basic_physical_env_e

Basic permitted values for "Physical environment" attribute.

Note

most of values are profile-specific.

See Also

ZCL spec, subclause 3.2.2.2.12

Enumerator
ZB_ZCL_BASIC_ENV_UNSPECIFIED	Environment unspecified
ZB_ZCL_BASIC_ENV_UNKNOWN	Environment unknown

enum zb_zcl_basic_power_source_e

Permitted values for "Power source" attribute.

See Also

ZCL spec, subclauses 3.2.2.2.9.

Enumerator
ZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN	Power source unknown.
ZB_ZCL_BASIC_POWER_SOURCE_MAINS_SINGLE_PHASE	Single-phase mains.
ZB_ZCL_BASIC_POWER_SOURCE_MAINS_THREE_PHASE	3-phase mains.
ZB_ZCL_BASIC_POWER_SOURCE_BATTERY	Battery source.
ZB_ZCL_BASIC_POWER_SOURCE_DC_SOURCE	DC source.
ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_CONST	Emergency mains constantly powered.
ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_TRANSF	Emergency mains and transfer switch.

enum zb_zcl_basic_settings_attr_e

Basic cluster settings attribute set identifiers.

See Also

ZCL spec, subclauses 3.2.2.2.10 to 3.2.2.2.15

Enumerator
ZB_ZCL_ATTR_BASIC_LOCATION_DESCRIPTION_ID	Location description attribute
ZB_ZCL_ATTR_BASIC_PHYSICAL_ENVIRONMENT_ID	Physical environment attribute
ZB_ZCL_ATTR_BASIC_DEVICE_ENABLED_ID	Device enabled attribute
ZB_ZCL_ATTR_BASIC_ALARM_MASK_ID	Alarm mask attribute
ZB_ZCL_ATTR_BASIC_DISABLE_LOCAL_CONFIG_ID	Disable local config attribute