nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
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.
 
#define ZB_ZCL_BASIC_ZCL_VERSION_DEFAULT_VALUE   ((zb_uint8_t)0x02)
 Default value for ZCL version attribute.
 
#define ZB_ZCL_BASIC_APPLICATION_VERSION_DEFAULT_VALUE   ((zb_uint8_t)0x00)
 Default value for Application version attribute.
 
#define ZB_ZCL_BASIC_STACK_VERSION_DEFAULT_VALUE   ((zb_uint8_t)0x00)
 Default value for Stack version attribute.
 
#define ZB_ZCL_BASIC_HW_VERSION_DEFAULT_VALUE   ((zb_uint8_t)0x00)
 Default value for Hardware version attribute.
 
#define ZB_ZCL_BASIC_MANUFACTURER_NAME_DEFAULT_VALUE   {0}
 Default value for Manufacturer name attribute.
 
#define ZB_ZCL_BASIC_MODEL_IDENTIFIER_DEFAULT_VALUE   {0}
 Default value for Model identifier attribute.
 
#define ZB_ZCL_BASIC_DATE_CODE_DEFAULT_VALUE   {0}
 Default value for Date code attribute.
 
#define ZB_ZCL_BASIC_POWER_SOURCE_DEFAULT_VALUE   (ZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN)
 Default value for Power source attribute.
 
#define ZB_ZCL_BASIC_LOCATION_DESCRIPTION_DEFAULT_VALUE   {0}
 Default value for location description attribute.
 
#define ZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DEFAULT_VALUE   (ZB_ZCL_BASIC_ENV_UNSPECIFIED)
 Default value for Physical environment attribute.
 
#define ZB_ZCL_BASIC_DEVICE_ENABLED_DEFAULT_VALUE   ((zb_uint8_t)0x01)
 Default value for Device enabled attribute.
 
#define ZB_ZCL_BASIC_ALARM_MASK_DEFAULT_VALUE   (ZB_ZCL_BASIC_ALARM_MASK_HW_FAULT)
 Default value for Alarm mask attribute.
 
#define ZB_ZCL_BASIC_DISABLE_LOCAL_CONFIG_DEFAULT_VALUE   ((zb_zcl_basic_disable_local_conf_t)0x00)
 Default value for Disable local config attribute.
 
#define ZB_ZCL_DECLARE_BASIC_ATTR_LIST(attr_list, attrs)   ZB_ZCL_DECLARE_BASIC_ATTRIB_LIST(attr_list, &attrs.zcl_version, &attrs.power_source)
 Declare attribute list for Basic cluster cluster. More...
 

Alarms cluster commands

enum  zb_zcl_basic_cmd_e { ZB_ZCL_CMD_BASIC_RESET_ID = 0x00 }
 Basic cluster command identifiers. More...
 
#define ZB_ZCL_BASIC_SEND_RESET_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cb)
 Send Reset to Factory Defaults command. More...
 
#define ZB_ZCL_RESET_TO_FACTORY_DEFAULTS_USER_APP(buffer, ep, result)
 

Detailed Description

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

Macro Definition Documentation

#define ZB_ZCL_BASIC_SEND_RESET_REQ (   buffer,
  addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prof_id,
  dis_default_resp,
  cb 
)
Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer) \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, dis_default_resp) \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_BASIC_RESET_ID); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, ZB_ZCL_CLUSTER_ID_BASIC, cb); \
}
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1170
Definition: zb_zcl_common.h:137
#define ZB_ZCL_FINISH_PACKET(zbbuf, ptr)
Definition: zb_zcl_common.h:1538
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:115
Definition: zb_zcl_basic.h:345

Send Reset to Factory Defaults command.

Parameters
bufferto put data to
addr- address of the device to send command to
dst_addr_mode- addressing mode
dst_epdestination endpoint
ep- current endpoint
prof_id- profile identifier
dis_default_resp- "Disable default response" flag
cb- callback to call to report send status
#define ZB_ZCL_DECLARE_BASIC_ATTR_LIST (   attr_list,
  attrs 
)    ZB_ZCL_DECLARE_BASIC_ATTRIB_LIST(attr_list, &attrs.zcl_version, &attrs.power_source)

Declare attribute list for Basic cluster cluster.

Parameters
[in]attr_list- attribute list variable name
[in]attrs- pointer to zb_zcl_basic_attrs_s structure
#define ZB_ZCL_RESET_TO_FACTORY_DEFAULTS_USER_APP (   buffer,
  ep,
  result 
)
Value:
{ \
TRACE_MSG(TRACE_ZCL1, "ZB_ZCL_RESET_TO_FACTORY_DEFAULTS_USER_APP", (FMT__0)); \
if (ZCL_CTX().device_cb) \
{ \
user_app_data->device_cb_id = ZB_ZCL_BASIC_RESET_CB_ID; \
user_app_data->endpoint = (ep); \
user_app_data->status = RET_OK; \
(ZCL_CTX().device_cb)(param); \
result = user_app_data->status; \
} \
}
Definition: zboss_api_zcl.h:324
Data for Device user application callback. This structure has receive to User application callback (s...
Definition: zboss_api_zcl.h:597
#define ZB_GET_BUF_PARAM(zbbuf, type)
Definition: zboss_api_core.h:920
struct zb_zcl_device_callback_param_s zb_zcl_device_callback_param_t
Data for Device user application callback. This structure has receive to User application callback (s...
#define TRACE_MSG(lm, fmts, args)
Put trace output.
Definition: zb_trace.h:150
#define ZCL_CTX()
Definition: zboss_api_zcl.h:1142

Call device callback in user application to reset application settings to defaults.

Parameters
[in]buffer- pointer to buffer for callback
[in]ep- current endpoint
[out]result- callback status

Typedef Documentation

Value structure for "Disable local config" attribute.

See also
ZCL spec, subclause 3.2.2.2.15

Enumeration Type Documentation

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

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.

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

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

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.

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