Data Structures
struct	zb_zcl_door_lock_read_lock_door_res_payload_s

struct	zb_zcl_door_lock_read_unlock_door_res_payload_s

Door Lock cluster attributes
enum	zb_zcl_door_lock_attr_e { ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_ID = 0x0000, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_ID = 0x0001, ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ID = 0x0002, ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ID = 0x0003, ZB_ZCL_ATTR_DOOR_LOCK_NUM_OF_DOOR_OPEN_EVENTS_ID = 0x0004, ZB_ZCL_ATTR_DOOR_LOCK_NUM_OF_DOOR_CLOSED_EVENTS_ID = 0x0005, ZB_ZCL_ATTR_DOOR_LOCK_OPEN_PERIOD_ID = 0x0006, ZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED_ID = 0x0010, ZB_ZCL_ATTR_DOOR_LOCK_NUM_TOTAL_USERS_ID = 0x0011, ZB_ZCL_ATTR_DOOR_LOCK_NUM_PIN_USERS_ID = 0x0012, ZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED_ID = 0x0013, ZB_ZCL_ATTR_DOOR_LOCK_NUM_WEEK_DAY_SCHEDULE_PER_USER_ID = 0x0014, ZB_ZCL_ATTR_DOOR_LOCK_NUM_YEAR_DAY_SCHEDULE_PER_USER_ID = 0x0015, ZB_ZCL_ATTR_DOOR_LOCK_NUM_HOLIDAY_SCHEDULE_ID = 0x0016, ZB_ZCL_ATTR_DOOR_LOCK_MAX_PIN_LEN_ID = 0x0017, ZB_ZCL_ATTR_DOOR_LOCK_MIN_PIN_LEN_ID = 0x0018, ZB_ZCL_ATTR_DOOR_LOCK_MAX_RFID_CODE_LENGTH_ID = 0x0019, ZB_ZCL_ATTR_DOOR_LOCK_MIN_RFID_CODE_LENGTH_ID = 0x001A, ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOGGING_ID = 0x0020, ZB_ZCL_ATTR_DOOR_LOCK_LANGUAGE_ID = 0x0021, ZB_ZCL_ATTR_DOOR_LOCK_LED_SETTINGS_ID = 0x0022, ZB_ZCL_ATTR_DOOR_LOCK_AUTO_RELOCK_TIME_ID = 0x0023, ZB_ZCL_ATTR_DOOR_LOCK_SOUND_VOLUME_ID = 0x0024, ZB_ZCL_ATTR_DOOR_LOCK_OPERATING_MODE_ID = 0x0025, ZB_ZCL_ATTR_DOOR_LOCK_OPERATION_MODES_SUPPORTED_ID = 0x0026, ZB_ZCL_ATTR_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_ID = 0x0027, ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING_ID = 0x0028, ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_ONE_TOUCH_LOCKING_ID = 0x0029, ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_INSIDE_STATUS_LED_ID = 0x002A, ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON_ID = 0x002B, ZB_ZCL_ATTR_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT_ID = 0x0030, ZB_ZCL_ATTR_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME_ID = 0x0031, ZB_ZCL_ATTR_DOOR_LOCK_SEND_PIN_OVER_THE_AIR_ID = 0x0032, ZB_ZCL_ATTR_DOOR_LOCK_REQUIRE_PIN_RF_ID = 0x0033, ZB_ZCL_ATTR_DOOR_LOCK_SECURITY_LEVEL_ID = 0x0034, ZB_ZCL_ATTR_DOOR_LOCK_ALARM_MASK_ID = 0x0040, ZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_ID = 0x0041, ZB_ZCL_ATTR_DOOR_LOCK_RF_OPERATION_EVENT_MASK_ID = 0x0042, ZB_ZCL_ATTR_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_ID = 0x0043, ZB_ZCL_ATTR_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_ID = 0x0044, ZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_ID = 0x0045, ZB_ZCL_ATTR_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_ID = 0x0046, ZB_ZCL_ATTR_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_ID = 0x0047 }
	Door Lock cluster attribute identifiers. More...

enum	zb_zcl_door_lock_lock_state_e { ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_NOT_FULLY_LOCKED = 0x00, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_LOCKED = 0x01, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_UNLOCKED = 0x02, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_UNDEFINED = 0xff }
	Values for LockState attribute. More...

enum	zb_zcl_door_lock_lock_type_e { ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_DEADBOLT = 0x00, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_MAGNETIC = 0x01, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_OTHER = 0x02, ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_UNDEFINED = 0xff }
	Values for LockType attribute. More...

enum	zb_zcl_door_lock_actuator_enabled_e { ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_DISABLED = 0x0b0, ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ENABLED = 0x0b1 }
	Values for ActuatorEnabled attribute. More...

enum	zb_zcl_door_lock_door_state_e { ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_OPEN = 0x00, ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_CLOSED = 0x01, ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ERROR_JAMMED = 0x02, ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ERROR_FORCED_OPEN = 0x03, ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ERROR_UNSPECIFIED = 0x04 }
	Values for DoorState attribute. More...

#define	ZB_ZCL_DOOR_LOCK_CLUSTER_REVISION_DEFAULT ((zb_uint16_t)0x0003u)
	Default value for Door Lock cluster revision global attribute.

#define	ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_DEFAULT_VALUE ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_UNDEFINED
	Default value for Lock State attribute.

#define	ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_DEFAULT_VALUE ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_UNDEFINED
	Default value for Lock Type attribute.

#define	ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_DEFAULT_VALUE ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ENABLED
	Default value for Actuator Enabled attribute.

#define	ZB_ZCL_DECLARE_DOOR_LOCK_ATTRIB_LIST(attr_list, lock_state, lock_type, actuator_enabled)
	Declare attribute list for Door Lock cluster. More...

Door Lock cluster commands
enum	zb_zcl_door_lock_cmd_e { ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR = 0x00, ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR = 0x01, ZB_ZCL_CMD_DOOR_LOCK_TOGGLE = 0x02, ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT = 0x03, ZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD = 0x04, ZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE = 0x05, ZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE = 0x06, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE = 0x07, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES = 0x08, ZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS = 0x09, ZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS = 0x0A, ZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE = 0x0B, ZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE = 0x0C, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE = 0x0D, ZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE = 0x0E, ZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE = 0x0F, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE = 0x10, ZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE = 0x11, ZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE = 0x12, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE = 0x13, ZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE = 0x14, ZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE = 0x15, ZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE = 0x16, ZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE = 0x17, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE = 0x18, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES = 0x19 }
	Door Lock cluster commands. More...

enum	zb_zcl_door_lock_cmd_resp_e { ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_RES = 0x00, ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_RES = 0x01, ZB_ZCL_CMD_DOOR_LOCK_TOGGLE_RESPONSE = 0x02, ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE = 0x03, ZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD_RESPONSE = 0x04, ZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE_RESPONSE = 0x05, ZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE_RESPONSE = 0x06, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE_RESPONSE = 0x07, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES_RESPONSE = 0x08, ZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS_RESPONSE = 0x09, ZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS_RESPONSE = 0x0A, ZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE_RESPONSE = 0x0B, ZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE_RESPONSE = 0x0C, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE_RESPONSE = 0x0D, ZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE_RESPONSE = 0x0E, ZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE_RESPONSE = 0x0F, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE_RESPONSE = 0x10, ZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE_RESPONSE = 0x11, ZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE_RESPONSE = 0x12, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE_RESPONSE = 0x13, ZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE_RESPONSE = 0x14, ZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE_RESPONSE = 0x15, ZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE_RESPONSE = 0x16, ZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE_RESPONSE = 0x17, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE_RESPONSE = 0x18, ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES_RESPONSE = 0x19, ZB_ZCL_CMD_DOOR_LOCK_OPERATION_EVENT_NOTIFICATION_ID = 0x20, ZB_ZCL_CMD_DOOR_LOCK_PROGRAMMING_EVENT_NOTIFICATION = 0x21 }
	Door Lock cluster commands response. More...

enum	zb_zcl_door_lock_operation_event_source_e { ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_SOURCE_KEYPAD = 0x00, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_SOURCE_RF = 0x01, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_SOURCE_MANUAL = 0x02, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_SOURCE_RFID = 0x03, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_SOURCE_INDETERMINATE = 0xFF }

enum	zb_zcl_door_lock_operation_event_code_e { ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_UNKNOWN = 0x00, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_LOCK = 0x01, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_UNLOCK = 0x02, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_KEY_LOCK = 0x08, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_KEY_UNLOCK = 0x09, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_MANUAL_LOCK = 0x0D, ZB_ZCL_DOOR_LOCK_OPERATION_EVENT_CODE_MANUAL_UNLOCK = 0x0E }

enum	zb_zcl_door_lock_keypad_operation_event_mask_e { ZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_UNKNOWN = (1l << 0), ZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_LOCK = (1l << 1), ZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_UNLOCK = (1l << 2) }

enum	zb_zcl_door_lock_rf_operation_event_mask_e { ZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_UNKNOWN = (1l << 0), ZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_LOCK = (1l << 1), ZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_UNLOCK = (1l << 2) }

enum	zb_zcl_door_lock_manual_operation_event_mask_e { ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_UNKNOWN = (1l << 0), ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_THUMBTURN_LOCK = (1l << 1), ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_THUMBTURN_UNLOCK = (1l << 2), ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_KEY_LOCK = (1l << 4), ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_KEY_UNLOCK = (1l << 5), ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_LOCK = (1l << 9), ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_MANUAL_UNLOCK = (1l << 10) }

typedef struct zb_zcl_door_lock_read_lock_door_res_payload_s	zb_zcl_door_lock_read_lock_door_res_payload_t

typedef struct zb_zcl_door_lock_read_unlock_door_res_payload_s	zb_zcl_door_lock_read_unlock_door_res_payload_t

#define	ZB_ZCL_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED_DEFAULT_VALUE ((zb_uint16_t)0)
	Default value for NumberOfLogRecordsSupported attribute.

#define	ZB_ZCL_DOOR_LOCK_NUM_TOTAL_USERS_DEFAULT_VALUE ((zb_uint16_t)0)
	Default value for NumTotalUsers attribute.

#define	ZB_ZCL_DOOR_LOCK_NUM_PIN_USERS_DEFAULT_VALUE ((zb_uint16_t)0)
	Default value for NumPINUsers attribute.

#define	ZB_ZCL_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED_DEFAULT_VALUE ((zb_uint16_t)0)
	Default value for NumberOfRFIDUsersSupported attribute.

#define	ZB_ZCL_DOOR_LOCK_NUM_WEEK_DAY_SCHEDULE_PER_USER_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for NumWeekDaySchedulePerUser attribute.

#define	ZB_ZCL_DOOR_LOCK_NUM_YEAR_DAY_SCHEDULE_PER_USER_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for NumYearDaySchedulePerUser attribute.

#define	ZB_ZCL_DOOR_LOCK_NUM_HOLIDAY_SCHEDULE_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for NumHolidaySchedule attribute.

#define	ZB_ZCL_DOOR_LOCK_MAX_PIN_LEN_DEFAULT_VALUE ((zb_uint8_t)0x08)
	Default value for MaxPINLen attribute.

#define	ZB_ZCL_DOOR_LOCK_MIN_PIN_LEN_DEFAULT_VALUE ((zb_uint8_t)0x04)
	Default value for MinPINLen attribute.

#define	ZB_ZCL_DOOR_LOCK_MAX_RFID_CODE_LENGTH_DEFAULT_VALUE ((zb_uint8_t)0x14)
	Default value for MaxRFIDCodeLength attribute.

#define	ZB_ZCL_DOOR_LOCK_MIN_RFID_CODE_LENGTH_DEFAULT_VALUE ((zb_uint8_t)0x08)
	Default value for MinRFIDCodeLength attribute.

#define	ZB_ZCL_DOOR_LOCK_ENABLE_LOGGING_DEFAULT_VALUE ((zb_bool_t)0)
	Default value for EnableLogging attribute.

#define	ZB_ZCL_DOOR_LOCK_LANGUAGE_DEFAULT_VALUE {0}
	Default value for Language attribute.

#define	ZB_ZCL_DOOR_LOCK_LED_SETTINGS_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for LEDSettings attribute.

#define	ZB_ZCL_DOOR_LOCK_AUTO_RELOCK_TIME_DEFAULT_VALUE ((zb_uint32_t)0)
	Default value for AutoRelockTime attribute.

#define	ZB_ZCL_DOOR_LOCK_SOUND_VOLUME_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for SoundVolume attribute.

#define	ZB_ZCL_DOOR_LOCK_OPERATING_MODE_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for OperatingMode attribute.

#define	ZB_ZCL_DOOR_LOCK_OPERATION_MODES_SUPPORTED_DEFAULT_VALUE ((zb_uint16_t)0x0001)
	Default value for OperationModesSupported attribute.

#define	ZB_ZCL_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for DefaultConfigurationRegister attribute.

#define	ZB_ZCL_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING_DEFAULT_VALUE ((zb_bool_t)0x01)
	Default value for EnableLocalProgramming attribute.

#define	ZB_ZCL_DOOR_LOCK_ENABLE_ONE_TOUCH_LOCKING_DEFAULT_VALUE ((zb_bool_t)0)
	Default value for EnableOneTouchLocking attribute.

#define	ZB_ZCL_DOOR_LOCK_ENABLE_INSIDE_STATUS_LED_DEFAULT_VALUE ((zb_bool_t)0)
	Default value for EnableInsideStatusLED attribute.

#define	ZB_ZCL_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON_DEFAULT_VALUE ((zb_bool_t)0)
	Default value for EnablePrivacyModeButton attribute.

#define	ZB_ZCL_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for WrongCodeEntryLimit attribute.

#define	ZB_ZCL_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for UserCodeTemporaryDisableTime attribute.

#define	ZB_ZCL_DOOR_LOCK_SEND_PIN_OVER_THE_AIR_DEFAULT_VALUE ((zb_bool_t)0)
	Default value for SendPINOverTheAir attribute.

#define	ZB_ZCL_DOOR_LOCK_REQUIRE_PIN_RF_ID_DEFAULT_VALUE ((zb_bool_t)0)
	Default value for RequirePIN_RF_ID attribute.

#define	ZB_ZCL_DOOR_LOCK_SECURITY_LEVEL_DEFAULT_VALUE ((zb_uint8_t)0)
	Default value for SecurityLevel attribute.

#define	ZB_ZCL_DOOR_LOCK_ALARM_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for AlarmMask attribute.

#define	ZB_ZCL_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for KeypadOperationEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_RF_OPERATION_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for RFOperationEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for ManualOperationEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for RFIDOperationEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for KeypadProgrammingEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for RFProgrammingEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_DEFAULT_VALUE ((zb_uint16_t)0x0000)
	Default value for RFIDProgrammingEventMask attribute.

#define	ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_REQ(buffer, dst_addr, dst_addr_mode, dst_ep, ep, dis_default_resp, cb)
	General macro for sending a "Door Lock" cluster command. More...

#define	ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_REQ(buffer, dst_addr, dst_addr_mode, dst_ep, ep, dis_default_resp, cb)
	General macro for sending a "Door Unlock" cluster command. More...

#define	ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq_num, status, aps_secured)
	Door Lock command send response macro. More...

#define	ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, seq_num, status, aps_secured)
	Door Unlock command send response macro. More...

#define	ZB_ZCL_DOOR_LOCK_READ_LOCK_DOOR_RES(buffer)
	Door Lock response structured reading. More...

#define	ZB_ZCL_DOOR_LOCK_READ_UNLOCK_DOOR_RES(buffer)
	Door unLock response structured reading. More...

Detailed Description

Door Lock cluster defined in ZCL spec, clause 7.3.

The cluster contains 2 command sets:

Lock Door request and response;
Unlock Door request and response.

Both requests have no payload and could be scheduled for sending with corresponding macros. Both responses have simple payload, and their sending and parsing with corresponding macros is almost trivial.

Examples:

Send Door Lock command:

      ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_REQ(buffer, DST_ADDR, DST_ADDR_MODE, ENDPOINT_C, ENDPOINT_ED, ZB_ZCL_ENABLE_DEFAULT_RESPONSE, NULL);

Send Door Unlock command:

      ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_REQ(buffer, DST_ADDR, DST_ADDR_MODE, ENDPOINT_C, ENDPOINT_ED, ZB_ZCL_ENABLE_DEFAULT_RESPONSE, NULL);

Macro Definition Documentation

◆ ZB_ZCL_DECLARE_DOOR_LOCK_ATTRIB_LIST

#define ZB_ZCL_DECLARE_DOOR_LOCK_ATTRIB_LIST	(	attr_list,
		lock_state,
		lock_type,
		actuator_enabled
	)

Value:

ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_DOOR_LOCK)      \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_ID, (lock_state))             \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_ID, (lock_type))               \
  ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ID, (actuator_enabled)) \
  ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_ID
LockType attribute. 
Definition: zb_zcl_door_lock.h:87
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_ID
LockState attribute. 
Definition: zb_zcl_door_lock.h:85
ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ID
ActuatorEnabled attribute. 
Definition: zb_zcl_door_lock.h:89

Declare attribute list for Door Lock cluster.

Parameters

attr_list	- attribute list name
lock_state
lock_type
actuator_enabled

◆ ZB_ZCL_DOOR_LOCK_READ_LOCK_DOOR_RES

#define ZB_ZCL_DOOR_LOCK_READ_LOCK_DOOR_RES ( buffer )

Value:

(   (zb_buf_len((buffer)) < sizeof(zb_zcl_door_lock_read_lock_door_res_payload_t))  \
   ?  NULL                                                                            \
   : (zb_zcl_door_lock_read_lock_door_res_payload_t*)zb_buf_begin((buffer)))
zb_zcl_door_lock_read_lock_door_res_payload_s
Definition: zb_zcl_door_lock.h:709
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_zcl_door_lock_read_lock_door_res_payload_t
struct zb_zcl_door_lock_read_lock_door_res_payload_s zb_zcl_door_lock_read_lock_door_res_payload_t
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380

Door Lock response structured reading.

Parameters

buffer - ID of the message buffer (of type zb_bufid_t) containing payload

Returns: pointer to zb_zcl_door_lock_read_lock_door_res_payload_s structure

Attention: returned pointer will point to the same data in the buffer thus being valid until buffer data will be overwritten.

◆ ZB_ZCL_DOOR_LOCK_READ_UNLOCK_DOOR_RES

#define ZB_ZCL_DOOR_LOCK_READ_UNLOCK_DOOR_RES ( buffer )

Value:

(   (zb_buf_len((buffer)) < sizeof(zb_zcl_door_lock_read_unlock_door_res_payload_t))  \
   ?  NULL                                                                              \
   : (zb_zcl_door_lock_read_unlock_door_res_payload_t*)zb_buf_begin((buffer)))
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:362
zb_zcl_door_lock_read_unlock_door_res_payload_t
struct zb_zcl_door_lock_read_unlock_door_res_payload_s zb_zcl_door_lock_read_unlock_door_res_payload_t
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:380
zb_zcl_door_lock_read_unlock_door_res_payload_s
Definition: zb_zcl_door_lock.h:726

Door unLock response structured reading.

Parameters

buffer - ID of the message buffer (of type zb_buf_t) containing payload

Returns: pointer to zb_zcl_door_lock_read_unlock_door_res_payload_s structure

Attention: returned pointer will point to the same data in the buffer thus being valid until buffer data will be overwritten.

◆ ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_REQ

#define ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_REQ	(	buffer,
		dst_addr,
		dst_addr_mode,
		dst_ep,
		ep,
		dis_default_resp,
		cb
	)

Value:

ZB_ZCL_SEND_CMD(  buffer,                                   \
                    dst_addr,                                 \
                    dst_addr_mode,                            \
                    dst_ep,                                   \
                    ep,                                       \
                    ZB_AF_HA_PROFILE_ID,                      \
                    dis_default_resp,                         \
                    ZB_ZCL_CLUSTER_ID_DOOR_LOCK,              \
                    ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR,           \
                    cb)
ZB_AF_HA_PROFILE_ID
#define ZB_AF_HA_PROFILE_ID
Definition: zboss_api_af.h:286
ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR
Definition: zb_zcl_door_lock.h:287
ZB_ZCL_SEND_CMD
#define ZB_ZCL_SEND_CMD( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cluster_id, command_id, cb)
General macro for sending a command with empty payload. 
Definition: zb_zcl_common.h:1488
ZB_ZCL_CLUSTER_ID_DOOR_LOCK
#define ZB_ZCL_CLUSTER_ID_DOOR_LOCK
Definition: zb_zcl_common.h:257

General macro for sending a "Door Lock" cluster command.

Parameters

buffer	to put command payload and headers to
dst_addr	address to send to
dst_addr_mode	destination address mode
dst_ep	destination endpoint
ep	source endpoint
dis_default_resp	"Disable default response" flag
cb	command send status callback

◆ ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_RES

#define ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_RES	(	buffer,
		addr,
		dst_addr_mode,
		dst_ep,
		ep,
		prfl_id,
		seq_num,
		status,
		aps_secured
	)

Value:

{                                                                                    \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                                     \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);                          \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq_num, ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_RES); \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, status);                                              \
  ZB_ZCL_FINISH_N_SEND_PACKET_NEW(buffer,                                            \
                                  ptr,                                               \
                                  addr,                                              \
                                  dst_addr_mode,                                     \
                                  dst_ep,                                            \
                                  ep,                                                \
                                  prfl_id,                                           \
                                  ZB_ZCL_CLUSTER_ID_DOOR_LOCK,                       \
                                  NULL,                                              \
                                  aps_secured,                                       \
                                  ZB_FALSE,                                          \
                                  0);                                                \
}
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_DOOR_LOCK
#define ZB_ZCL_CLUSTER_ID_DOOR_LOCK
Definition: zb_zcl_common.h:257
ZB_FALSE
#define ZB_FALSE
Definition: zb_types.h:356
ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_RES
Definition: zb_zcl_door_lock.h:347

Door Lock command send response macro.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq_num	- sequence number
status	- result of command execute
aps_secured	- APS security mode

◆ ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_REQ

#define ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_REQ	(	buffer,
		dst_addr,
		dst_addr_mode,
		dst_ep,
		ep,
		dis_default_resp,
		cb
	)

Value:

ZB_ZCL_SEND_CMD(buffer,                                         \
                  dst_addr,                                       \
                  dst_addr_mode,                                  \
                  dst_ep,                                         \
                  ep,                                             \
                  ZB_AF_HA_PROFILE_ID,                            \
                  dis_default_resp,                               \
                  ZB_ZCL_CLUSTER_ID_DOOR_LOCK,                    \
                  ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR, cb)
ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR
Definition: zb_zcl_door_lock.h:289
ZB_AF_HA_PROFILE_ID
#define ZB_AF_HA_PROFILE_ID
Definition: zboss_api_af.h:286
ZB_ZCL_SEND_CMD
#define ZB_ZCL_SEND_CMD( buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, cluster_id, command_id, cb)
General macro for sending a command with empty payload. 
Definition: zb_zcl_common.h:1488
ZB_ZCL_CLUSTER_ID_DOOR_LOCK
#define ZB_ZCL_CLUSTER_ID_DOOR_LOCK
Definition: zb_zcl_common.h:257

General macro for sending a "Door Unlock" cluster command.

Parameters

buffer	to put command payload and headers to
dst_addr	address to send to
dst_addr_mode	destination address mode
dst_ep	destination endpoint
ep	source endpoint
dis_default_resp	"Disable default response" flag
cb	command send status callback

◆ ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_RES

#define ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_RES	(	buffer,
		addr,
		dst_addr_mode,
		dst_ep,
		ep,
		prfl_id,
		seq_num,
		status,
		aps_secured
	)

Value:

{                                                                                      \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer);                                       \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);                            \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, seq_num, ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_RES); \
  ZB_ZCL_PACKET_PUT_DATA8(ptr, status);                                                \
  ZB_ZCL_FINISH_N_SEND_PACKET_NEW(buffer,                                              \
                                  ptr,                                                 \
                                  addr,                                                \
                                  dst_addr_mode,                                       \
                                  dst_ep,                                              \
                                  ep,                                                  \
                                  prfl_id,                                             \
                                  ZB_ZCL_CLUSTER_ID_DOOR_LOCK,                         \
                                  NULL,                                                \
                                  aps_secured,                                         \
                                  ZB_FALSE,                                            \
                                  0);                                                  \
}
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array. 
Definition: zb_zcl_common.h:1523
ZB_ZCL_CLUSTER_ID_DOOR_LOCK
#define ZB_ZCL_CLUSTER_ID_DOOR_LOCK
Definition: zb_zcl_common.h:257
ZB_FALSE
#define ZB_FALSE
Definition: zb_types.h:356
ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_RES
Definition: zb_zcl_door_lock.h:349

Door Unlock command send response macro.

Parameters

buffer	to put packet to
addr	- address to send packet to
dst_addr_mode	- addressing mode
dst_ep	- destination endpoint
ep	- sending endpoint
prfl_id	- profile identifier
seq_num	- sequence number
status	- result of command execute
aps_secured	- APS security mode

Typedef Documentation

◆ zb_zcl_door_lock_read_lock_door_res_payload_t

typedef struct zb_zcl_door_lock_read_lock_door_res_payload_s zb_zcl_door_lock_read_lock_door_res_payload_t

Door lock commands response payload structure

◆ zb_zcl_door_lock_read_unlock_door_res_payload_t

typedef struct zb_zcl_door_lock_read_unlock_door_res_payload_s zb_zcl_door_lock_read_unlock_door_res_payload_t

Door unlock commands response payload structure

Enumeration Type Documentation

◆ zb_zcl_door_lock_actuator_enabled_e

enum zb_zcl_door_lock_actuator_enabled_e

Values for ActuatorEnabled attribute.

See also: ZCL spec, subclause 7.3.2.2.3

Enumerator
ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_DISABLED	"Disabled" value
ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ENABLED	"Enabled" value

◆ zb_zcl_door_lock_attr_e

enum zb_zcl_door_lock_attr_e

Door Lock cluster attribute identifiers.

See also: ZCL spec, subclause 7.3.2.2

Enumerator
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_ID	LockState attribute.
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_ID	LockType attribute.
ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ID	ActuatorEnabled attribute.
ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ID	DoorState attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_OF_DOOR_OPEN_EVENTS_ID	DoorOpenEvents attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_OF_DOOR_CLOSED_EVENTS_ID	DoorClosedEvents attribute.
ZB_ZCL_ATTR_DOOR_LOCK_OPEN_PERIOD_ID	OpenPeriod attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED_ID	The number of available log records.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_TOTAL_USERS_ID	NumberOfTotalUsersSupported attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_PIN_USERS_ID	NumberOfPINUsersSupported attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED_ID	The number of RFID users supported.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_WEEK_DAY_SCHEDULE_PER_USER_ID	NumberOfWeekDaySchedulesSupportedPerUser attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_YEAR_DAY_SCHEDULE_PER_USER_ID	NumberOfYearDaySchedulesSupportedPerUser attribute.
ZB_ZCL_ATTR_DOOR_LOCK_NUM_HOLIDAY_SCHEDULE_ID	NumberOfHolidaySchedulesSupported attribute.
ZB_ZCL_ATTR_DOOR_LOCK_MAX_PIN_LEN_ID	Max PIN code length attribute.
ZB_ZCL_ATTR_DOOR_LOCK_MIN_PIN_LEN_ID	Min PIN code length attribute.
ZB_ZCL_ATTR_DOOR_LOCK_MAX_RFID_CODE_LENGTH_ID	An 8-bit value indicates the maximum length in bytes of a RFID Code on this device.
ZB_ZCL_ATTR_DOOR_LOCK_MIN_RFID_CODE_LENGTH_ID	An 8-bit value indicates the minimum length in bytes of a RFID Code on this device.
ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOGGING_ID	Enable/disable event logging.
ZB_ZCL_ATTR_DOOR_LOCK_LANGUAGE_ID	Modifies the language for the on-screen or audible user interface using three bytes from ISO-639-1.
ZB_ZCL_ATTR_DOOR_LOCK_LED_SETTINGS_ID	The settings for the LED support three different modes.
ZB_ZCL_ATTR_DOOR_LOCK_AUTO_RELOCK_TIME_ID	The number of seconds to wait after unlocking a lock before it automatically locks again.
ZB_ZCL_ATTR_DOOR_LOCK_SOUND_VOLUME_ID	The sound volume on a door lock has three possible settings: silent, low and high volumes.
ZB_ZCL_ATTR_DOOR_LOCK_OPERATING_MODE_ID	OperatingMode attribute.
ZB_ZCL_ATTR_DOOR_LOCK_OPERATION_MODES_SUPPORTED_ID	SupportedOperatingModes attribute.
ZB_ZCL_ATTR_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_ID	This attribute represents the default configurations as they are physically set on the device (example: hardware dip switch setting, etc) and represents the default setting for some of the attributes within this Operational Setting Attribute Set (for example: LED, Auto Lock, Sound Volume, and Operating Mode attributes).
ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING_ID	EnableLocalProgramming attribute.
ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_ONE_TOUCH_LOCKING_ID	Enable/disable the ability to lock the door lock with a single touch on the door lock.
ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_INSIDE_STATUS_LED_ID	Enable/disable an inside LED that allows the user to see at a glance if the door is locked.
ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON_ID	Enable/disable a button inside the door that is used to put the lock into privacy mode.
ZB_ZCL_ATTR_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT_ID	The number of incorrect codes or RFID presentment attempts a user is allowed to enter before the door will enter a lockout state.
ZB_ZCL_ATTR_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME_ID	The number of seconds that the lock shuts down following wrong code entry.
ZB_ZCL_ATTR_DOOR_LOCK_SEND_PIN_OVER_THE_AIR_ID	Boolean set to True if it is ok for the door lock server to send PINs over the air.
ZB_ZCL_ATTR_DOOR_LOCK_REQUIRE_PIN_RF_ID	Require PIN for RF operation attribute.
ZB_ZCL_ATTR_DOOR_LOCK_SECURITY_LEVEL_ID	The Security Level attribute allows the door lock manufacturer to indicate what level of security the door lock requires.
ZB_ZCL_ATTR_DOOR_LOCK_ALARM_MASK_ID	The alarm mask is used to turn on/off alarms for particular functions
ZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_ID	Event mask used to turn on and off the transmission of keypad operation events.
ZB_ZCL_ATTR_DOOR_LOCK_RF_OPERATION_EVENT_MASK_ID	Event mask used to turn on and off the transmission of RF operation events.
ZB_ZCL_ATTR_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_ID	Event mask used to turn on and off manual operation events.
ZB_ZCL_ATTR_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_ID	Event mask used to turn on and off RFID operation events.
ZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_ID	Event mask used to turn on and off keypad programming events.
ZB_ZCL_ATTR_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_ID	Event mask used to turn on and off RF programming events.
ZB_ZCL_ATTR_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_ID	Event mask used to turn on and off RFID programming events.

◆ zb_zcl_door_lock_cmd_e

enum zb_zcl_door_lock_cmd_e

Door Lock cluster commands.

See also: ZCL spec, subclause 7.3.2.3 Commands Received

Enumerator
ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR	This command causes the lock device to lock the door.
ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR	This command causes the lock device to unlock the door.
ZB_ZCL_CMD_DOOR_LOCK_TOGGLE	Request the status of the lock.
ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT	This command causes the lock device to unlock the door with a timeout parameter.
ZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD	Request a log record.
ZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE	Set a PIN into the lock.
ZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE	Retrieve a PIN Code.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE	Delete a PIN.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES	Clear out all PINs on the lock.
ZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS	Set the status of a user ID.
ZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS	Get the status of a user.
ZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE	Set a weekly repeating schedule for a specified user.
ZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE	Retrieve the specific weekly schedule for the specific user.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE	Clear the specific weekly schedule for the specific user.
ZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE	Set a time-specific schedule ID for a specified user.
ZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE	Retrieve the specific year day schedule for the specific user.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE	Clears the specific year day schedule for the specific user.
ZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE	Set the holiday Schedule by specifying local start time and local end time with respect to any Lock Operating Mode.
ZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE	Get the holiday Schedule by specifying Holiday ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE	Clear the holiday Schedule by specifying Holiday ID.
ZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE	Set the type byte for a specified user.
ZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE	Retrieve the type byte for a specific user.
ZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE	Set an ID for RFID access into the lock.
ZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE	Retrieve an ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE	Delete an ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES	Clear out all RFIDs on the lock.

◆ zb_zcl_door_lock_cmd_resp_e

enum zb_zcl_door_lock_cmd_resp_e

Door Lock cluster commands response.

See also: ZCL spec, subclause 7.3.2.4 Commands Generated

Enumerator
ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_RES	This command is sent in response to a Lock command with one status byte payload.
ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_RES	This command is sent in response to a Unlock command with one status byte payload.
ZB_ZCL_CMD_DOOR_LOCK_TOGGLE_RESPONSE	This command is sent in response to a Toggle command with one status byte payload.
ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE	This command is sent in response to an Unlock with Timeout command with one status byte payload.
ZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD_RESPONSE	Returns the specified log record.
ZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE_RESPONSE	Returns status of the PIN set command.
ZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE_RESPONSE	Returns the PIN for the specified user ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS_RESPONSE	Returns the pass or fail value for the setting of the user status.
ZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS_RESPONSE	Returns the user status for the specified user ID.
ZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE_RESPONSE	Returns the weekly repeating schedule data for the specified schedule ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE_RESPONSE	Returns the weekly repeating schedule data for the specified schedule ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE_RESPONSE	Returns the Holiday Schedule Entry for the specified Holiday ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE_RESPONSE	Returns the pass or fail value for the setting of the user type.
ZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE_RESPONSE	Returns the user type for the specified user ID.
ZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE_RESPONSE	Returns status of the Set RFID Code command.
ZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE_RESPONSE	Returns the RFID code for the specified user ID.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES_RESPONSE	Returns pass/fail of the command.
ZB_ZCL_CMD_DOOR_LOCK_OPERATION_EVENT_NOTIFICATION_ID	The door lock server sends out operation event notification when the event is triggered by the various event sources.
ZB_ZCL_CMD_DOOR_LOCK_PROGRAMMING_EVENT_NOTIFICATION	The door lock server sends out a programming event notification whenever a programming event takes place on the door lock.

◆ zb_zcl_door_lock_door_state_e

enum zb_zcl_door_lock_door_state_e

Values for DoorState attribute.

See also: ZCL spec, subclause 7.3.2.2.4

Enumerator
ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_OPEN	"Open" value
ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_CLOSED	"Closed" value
ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ERROR_JAMMED	"Error (jammed)" value
ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ERROR_FORCED_OPEN	"Error (forced open)" value
ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ERROR_UNSPECIFIED	"Error (unspecified)" value

◆ zb_zcl_door_lock_lock_state_e

enum zb_zcl_door_lock_lock_state_e

Values for LockState attribute.

See also: ZCL spec, subclause 7.3.2.2.1

Enumerator
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_NOT_FULLY_LOCKED	"Not fully locked" value
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_LOCKED	"Locked" value
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_UNLOCKED	"Unlocked" value
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_UNDEFINED	"Not Defined" value

◆ zb_zcl_door_lock_lock_type_e

enum zb_zcl_door_lock_lock_type_e

Values for LockType attribute.

See also: ZCL spec, subclause 7.3.2.2.2

Enumerator
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_DEADBOLT	"Deadbolt" value
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_MAGNETIC	"Magnetic" value
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_OTHER	"Other" value
ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_UNDEFINED	"Not Defined" value

ZCL DoorLock cluster

nRF5 SDK for Thread and Zigbee v4.2.0

Data Structures

Door Lock cluster attributes

Door Lock cluster commands

Detailed Description

Macro Definition Documentation

◆ ZB_ZCL_DECLARE_DOOR_LOCK_ATTRIB_LIST

◆ ZB_ZCL_DOOR_LOCK_READ_LOCK_DOOR_RES

◆ ZB_ZCL_DOOR_LOCK_READ_UNLOCK_DOOR_RES

◆ ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_REQ

◆ ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_RES

◆ ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_REQ

◆ ZB_ZCL_DOOR_LOCK_SEND_UNLOCK_DOOR_RES

Typedef Documentation

◆ zb_zcl_door_lock_read_lock_door_res_payload_t

◆ zb_zcl_door_lock_read_unlock_door_res_payload_t

Enumeration Type Documentation

◆ zb_zcl_door_lock_actuator_enabled_e

◆ zb_zcl_door_lock_attr_e

◆ zb_zcl_door_lock_cmd_e

◆ zb_zcl_door_lock_cmd_resp_e

◆ zb_zcl_door_lock_door_state_e

◆ zb_zcl_door_lock_lock_state_e

◆ zb_zcl_door_lock_lock_type_e