This group provides ZCL Closure Doorlock Cluster macros defined in the ZCL v7 specification. More...

Macros
#define	ATTRID_DOOR_LOCK_LOCK_STATE 0x0000
	Enum for lock state.

#define	ATTRID_DOOR_LOCK_LOCK_TYPE 0x0001
	Enum for lock type.

#define	ATTRID_DOOR_LOCK_ACTUATOR_ENABLED 0x0002
	Actuator enabled of set.

#define	ATTRID_DOOR_LOCK_DOOR_STATE 0x0003
	Enum for door state.

#define	ATTRID_DOOR_LOCK_DOOR_OPEN_EVENTS 0x0004

#define	ATTRID_DOOR_LOCK_DOOR_CLOSED_EVENTS 0x0005

#define	ATTRID_DOOR_LOCK_OPEN_PERIOD 0x0006

#define	ATTRID_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED 0x0010
	The number of available log records.

#define	ATTRID_DOOR_LOCK_NUMBER_OF_TOTAL_USERS_SUPPORTED 0x0011
	Number of total users supported by the lock.

#define	ATTRID_DOOR_LOCK_NUMBER_OF_PIN_USERS_SUPPORTED 0x0012
	The number of PIN users supported.

#define	ATTRID_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED 0x0013
	The number of RFID users supported.

#define	ATTRID_DOOR_LOCK_NUMBER_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER 0x0014
	number of configurable week day schedule supported per user.

#define	ATTRID_DOOR_LOCK_NUMBER_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER 0x0015
	The number of configurable year day schedule supported per user.

#define	ATTRID_DOOR_LOCK_NUMBER_OF_HOLIDAY_SCHEDULES_SUPPORTED 0x0016
	The number of holiday schedules supported for the entire door lock device.

#define	ATTRID_DOOR_LOCK_MAX_PIN_CODE_LENGTH 0x0017
	An 8 bit value indicates the maximum length in bytes of a PIN Code on this device.

#define	ATTRID_DOOR_LOCK_MIN_PIN_CODE_LENGTH 0x0018
	An 8 bit value indicates the minimum length in bytes of a PIN Code on this device.

#define	ATTRID_DOOR_LOCK_MAX_RFID_CODE_LENGTH 0x0019
	An 8 bit value indicates the maximum length in bytes of a RFID Code on this device.

#define	ATTRID_DOOR_LOCK_MIN_RFID_CODE_LENGTH 0x001A
	An 8 bit value indicates the minimum length in bytes of a RFID Code on this device.

#define	ATTRID_DOOR_LOCK_ENABLE_LOGGING 0x0020
	Enable/disable event logging.

#define	ATTRID_DOOR_LOCK_LANGUAGE 0x0021
	Modifies the language for the on-screen or audible user interface using three bytes from ISO-639-1.

#define	ATTRID_DOOR_LOCK_LED_SETTINGS 0x0022
	Configuration for LED events.

#define	ATTRID_DOOR_LOCK_AUTO_RELOCK_TIME 0x0023

#define	ATTRID_DOOR_LOCK_SOUND_VOLUME 0x0024

#define	ATTRID_DOOR_LOCK_OPERATING_MODE 0x0025

#define	ATTRID_DOOR_LOCK_SUPPORTED_OPERATING_MODES 0x0026

#define	ATTRID_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER 0x0027

#define	ATTRID_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING 0x0028
	Enable/disable local programming on the door lock.

#define	ATTRID_DOOR_LOCK_ENABLE_ONE_TOUCH_LOCKING 0x0029
	Enable/disable the ability to lock the door lock with a single touch on the door lock.

#define	ATTRID_DOOR_LOCK_ENABLE_INSIDE_STATUS_LED 0x002A
	Enable/disable an inside LED that allows the user to see at a glance if the door is locked.

#define	ATTRID_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON 0x002B

#define	ATTRID_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT 0x0030

#define	ATTRID_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME 0x0031
	The number of seconds that the lock shuts down following wrong code entry.

#define	ATTRID_DOOR_LOCK_SEND_PIN_OVER_THE_AIR 0x0032
	Boolean set to True if it is ok for the door lock server to send PINs over the air.

#define	ATTRID_DOORLOCK_REQUIRE_PIN_FOR_RF_OPERATION 0x0033

#define	ATTRID_DOOR_LOCK_REQUIRE_PI_NFOR_RF_OPERATION 0x0033

#define	ATTRID_DOOR_LOCK_SECURITY_LEVEL 0x0034

#define	ATTRID_DOOR_LOCK_ALARM_MASK 0x0040
	The alarm mask is used to turn on/off alarms for particular functions.

#define	ATTRID_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK 0x0041
	Event mask used to turn on and off the transmission of keypad operation events.

#define	ATTRID_DOOR_LOCK_RF_OPERATION_EVENT_MASK 0x0042
	Event mask used to turn on and off the transmission of RF operation events.

#define	ATTRID_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK 0x0043
	Event mask used to turn on and off manual operation events.

#define	ATTRID_DOOR_LOCK_RFID_OPERATION_EVENT_MASK 0x0044
	Event mask used to turn on and off RFID operation events.

#define	ATTRID_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK 0x0045
	Event mask used to turn on and off keypad programming events.

#define	ATTRID_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK 0x0046
	Event mask used to turn on and off RF programming events.

#define	ATTRID_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK 0x0047
	Event mask used to turn on and off RFID programming events.

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_LOCK_RECORDS_SUPPORTED 0
	User, PIN, Schedule, Log Information Attribute Set default values.

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_TOTAL_USERS_SUPPORTED 0

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_PIN_USERS_SUPPORTED 0

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_RFID_USERS_SUPPORTED 0

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_WEEK_DAY_SCHEDULES_SUPPORTED_PER_USER 0

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_YEAR_DAY_SCHEDULES_SUPPORTED_PER_USER 0

#define	ATTR_DEFAULT_DOORLOCK_NUM_OF_HOLIDAY_SCHEDULEDS_SUPPORTED 0

#define	ATTR_DEFAULT_DOORLOCK_MAX_PIN_LENGTH 0x08

#define	ATTR_DEFAULT_DOORLOCK_MIN_PIN_LENGTH 0x04

#define	ATTR_DEFAULT_DOORLOCK_MAX_RFID_LENGTH 0x14

#define	ATTR_DEFAULT_DOORLOCK_MIN_RFID_LENGTH 0x08

#define	ATTR_DEFAULT_DOORLOCK_ENABLE_LOGGING 0
	Operational Settings Attribute Set default values.

#define	ATTR_DEFAULT_DOORLOCK_LANGUAGE {0,0,0}

#define	ATTR_DEFAULT_DOORLOCK_LED_SETTINGS 0

#define	ATTR_DEFAULT_DOORLOCK_AUTO_RELOCK_TIME 0

#define	ATTR_DEFAULT_DOORLOCK_SOUND_VOLUME 0

#define	ATTR_DEFAULT_DOORLOCK_OPERATING_MODE 0

#define	ATTR_DEFAULT_DOORLOCK_SUPPORTED_OPERATING_MODES 0x0001

#define	ATTR_DEFAULT_DOORLOCK_DEFAULT_CONFIGURATION_REGISTER 0

#define	ATTR_DEFAULT_DOORLOCK_ENABLE_LOCAL_PROGRAMMING 0

#define	ATTR_DEFAULT_DOORLOCK_ENABLE_ONE_TOUCH_LOCKING 0

#define	ATTR_DEFAULT_DOORLOCK_ENABLE_INSIDE_STATUS_LED 0

#define	ATTR_DEFAULT_DOORLOCK_ENABLE_PRIVACY_MODE_BUTTON 0

#define	ATTR_DEFAULT_DOORLOCK_WRONG_CODE_ENTRY_LIMIT 0
	Security Settings Attribute Set default values.

#define	ATTR_DEFAULT_DOORLOCK_USER_CODE_TEMPORARY_DISABLE_TIME 0

#define	ATTR_DEFAULT_DOORLOCK_SEND_PIN_OTA 0

#define	ATTR_DEFAULT_DOORLOCK_REQUIRE_PIN_FOR_RF_OPERATION 0

#define	ATTR_DEFAULT_DOORLOCK_ZIGBEE_SECURITY_LEVEL 0

#define	ATTR_DEFAULT_DOORLOCK_ALARM_MASK 0x0000
	The alarm mask is used to turn on/off alarms for particular functions.

#define	ATTR_DEFAULT_DOORLOCK_KEYPAD_OPERATION_EVENT_MASK 0x0000
	Event mask used to turn on and off the transmission of keypad operation events.

#define	ATTR_DEFAULT_DOORLOCK_RF_OPERATION_EVENT_MASK 0x0000
	Event mask used to turn on and off the transmission of RF operation events.

#define	ATTR_DEFAULT_DOORLOCK_MANUAL_OPERATION_EVENT_MASK 0x0000
	Event mask used to turn on and off manual operation events.

#define	ATTR_DEFAULT_DOORLOCK_RFID_OPERATION_EVENT_MASK 0x0000
	Event mask used to turn on and off RFID operation events.

#define	ATTR_DEFAULT_DOORLOCK_KEYPAD_PROGRAMMING_EVENT_MASK 0x0000
	Event mask used to turn on and off keypad programming events.

#define	ATTR_DEFAULT_DOORLOCK_RF_PROGRAMMING_EVENT_MASK 0x0000
	Event mask used to turn on and off RF programming events.

#define	ATTR_DEFAULT_DOORLOCK_RFID_PROGRAMMING_EVENT_MASK 0x0000
	Event mask used to turn on and off RFID programming events.

#define	DOORLOCK_OP_MODE_NORMAL 0x00
	Normal Mode: The lock operates normally. All interfaces are enabled.

#define	DOORLOCK_OP_MODE_VACATION 0x01
	Vacation Mode: Only RF interaction is enabled. The keypad cannot be operated.

#define	DOORLOCK_OP_MODE_PRIVACY 0x02
	Privacy Mode: All external interaction with the door lock is disabled.

#define	DOORLOCK_OP_MODE_NO_RF_LOCK_UNLOCK 0x03
	No RF Lock or Unlock: This mode only disables RF interaction with the lock.

#define	DOORLOCK_OP_MODE_PASSAGE 0x04

#define	CLOSURES_LOCK_STATE_NOT_FULLY_LOCKED 0x00
	Lock state values.

#define	CLOSURES_LOCK_STATE_LOCKED 0x01

#define	CLOSURES_LOCK_STATE_UNLOCKED 0x02

#define	CLOSURES_LOCK_TYPE_DEADBOLT 0x00
	Lock type values.

#define	CLOSURES_LOCK_TYPE_MAGNETIC 0x01

#define	CLOSURES_LOCK_TYPE_OTHER 0x02

#define	CLOSURES_LOCK_TYPE_MORTISE 0x03

#define	CLOSURES_LOCK_TYPE_RIM 0x04

#define	CLOSURES_LOCK_TYPE_LATCH_BOLT 0x05

#define	CLOSURES_LOCK_TYPE_CYLINDRICAL_LOCK 0x06

#define	CLOSURES_LOCK_TYPE_TUBULAR_LOCK 0x07

#define	CLOSURES_LOCK_TYPE_INTERCONNECTED_LOCK 0x08

#define	CLOSURES_LOCK_TYPE_DEAD_LATCH 0x09

#define	CLOSURES_LOCK_TYPE_DOOR_FURNITURE 0x0A

#define	CLOSURES_DOOR_STATE_OPEN 0x00
	Door State values.

#define	CLOSURES_DOOR_STATE_CLOSED 0x01

#define	CLOSURES_DOOR_STATE_ERROR_JAMMED 0x02

#define	CLOSURES_DOOR_STATE_ERROR_FORCED_OPEN 0x03

#define	CLOSURES_DOOR_STATE_ERROR_UNSPECIFIED 0x04

#define	COMMAND_DOOR_LOCK_LOCK_DOOR 0x00
	This command causes the lock device to lock the door.

#define	COMMAND_DOOR_LOCK_UNLOCK_DOOR 0x01
	This command causes the lock device to unlock the door.

#define	COMMAND_DOOR_LOCK_TOGGLE 0x02
	Request the status of the lock.

#define	COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT 0x03
	This command causes the lock device to unlock the door with a timeout parameter.

#define	COMMAND_DOOR_LOCK_GET_LOG_RECORD 0x04
	Request a log record.

#define	COMMAND_DOOR_LOCK_SET_PIN_CODE 0x05
	Set a PIN into the lock.

#define	COMMAND_DOOR_LOCK_GET_PIN_CODE 0x06
	Retrieve a PIN Code.

#define	COMMAND_DOOR_LOCK_CLEAR_PIN_CODE 0x07
	Delete a PIN.

#define	COMMAND_DOOR_LOCK_CLEAR_ALL_PIN_CODES 0x08
	Clear out all PINs on the lock.

#define	COMMAND_DOOR_LOCK_SET_USER_STATUS 0x09
	Set the status of a user ID.

#define	COMMAND_DOOR_LOCK_GET_USER_STATUS 0x0A
	Get the status of a user.

#define	COMMAND_DOOR_LOCK_SET_WEEKDAY_SCHEDULE 0x0B
	Set a weekly repeating schedule for a specified user.

#define	COMMAND_DOOR_LOCK_GET_WEEKDAY_SCHEDULE 0x0C
	Retrieve the specific weekly schedule for the specific user.

#define	COMMAND_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE 0x0D
	Clear the specific weekly schedule for the specific user.

#define	COMMAND_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE 0x0E
	Set a time-specific schedule ID for a specified user.

#define	COMMAND_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE 0x0F
	Retrieve the specific year day schedule for the specific user.

#define	COMMAND_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE 0x10
	Clears the specific year day schedule for the specific user.

#define	COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE 0x11

#define	COMMAND_DOOR_LOCK_GET_HOLIDAY_SCHEDULE 0x12
	Get the holiday Schedule by specifying Holiday ID.

#define	COMMAND_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE 0x13
	Clear the holiday Schedule by specifying Holiday ID.

#define	COMMAND_DOOR_LOCK_SET_USER_TYPE 0x14
	Set the type byte for a specified user.

#define	COMMAND_DOOR_LOCK_GET_USER_TYPE 0x15
	Retrieve the type byte for a specific user.

#define	COMMAND_DOOR_LOCK_SET_RFID_CODE 0x16
	Set an ID for RFID access into the lock.

#define	COMMAND_DOOR_LOCK_GET_RFID_CODE 0x17
	Retrieve an ID.

#define	COMMAND_DOOR_LOCK_CLEAR_RFID_CODE 0x18
	Delete an ID.

#define	COMMAND_DOOR_LOCK_CLEAR_ALL_RFID_CODES 0x19
	Clear out all RFIDs on the lock.

#define	COMMAND_DOOR_LOCK_LOCK_DOOR_RESPONSE 0x00
	This command is sent in response to a Lock command with one status byte payload.

#define	COMMAND_DOOR_LOCK_UNLOCK_DOOR_RESPONSE 0x01
	This command is sent in response to a Toggle command with one status byte payload.

#define	COMMAND_DOOR_LOCK_TOGGLE_RESPONSE 0x02
	This command is sent in response to a Toggle command with one status byte payload.

#define	COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE 0x03

#define	COMMAND_DOOR_LOCK_GET_LOG_RECORD_RESPONSE 0x04
	Returns the specified log record.

#define	COMMAND_DOOR_LOCK_SET_PIN_CODE_RESPONSE 0x05
	Returns status of the PIN set command.

#define	COMMAND_DOOR_LOCK_GET_PIN_CODE_RESPONSE 0x06
	Returns the PIN for the specified user ID.

#define	COMMAND_DOOR_LOCK_CLEAR_PIN_CODE_RESPONSE 0x07
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_CLEAR_ALL_PIN_CODES_RESPONSE 0x08
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_SET_USER_STATUS_RESPONSE 0x09
	Returns the pass or fail value for the setting of the user status.

#define	COMMAND_DOOR_LOCK_GET_USER_STATUS_RESPONSE 0x0A
	Returns the user status for the specified user ID.

#define	COMMAND_DOOR_LOCK_SET_WEEKDAY_SCHEDULE_RESPONSE 0x0B
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_GET_WEEKDAY_SCHEDULE_RESPONSE 0x0C
	Returns the weekly repeating schedule data for the specified schedule ID.

#define	COMMAND_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE_RESPONSE 0x0D
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE_RESPONSE 0x0E
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE_RESPONSE 0x0F
	Returns the weekly repeating schedule data for the specified schedule ID.

#define	COMMAND_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE_RESPONSE 0x10
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE_RESPONSE 0x11
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_GET_HOLIDAY_SCHEDULE_RESPONSE 0x12
	Returns the Holiday Schedule Entry for the specified Holiday ID.

#define	COMMAND_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE_RESPONSE 0x13
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_SET_USER_TYPE_RESPONSE 0x14
	Returns the pass or fail value for the setting of the user type.

#define	COMMAND_DOOR_LOCK_GET_USER_TYPE_RESPONSE 0x15
	Returns the user type for the specified user ID.

#define	COMMAND_DOOR_LOCK_SET_RFID_CODE_RESPONSE 0x16
	Returns status of the Set RFID Code command.

#define	COMMAND_DOOR_LOCK_GET_RFID_CODE_RESPONSE 0x17
	Returns the RFID code for the specified user ID.

#define	COMMAND_DOOR_LOCK_CLEAR_RFID_CODE_RESPONSE 0x18
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_CLEAR_ALL_RFID_CODES_RESPONSE 0x19
	Returns pass/fail of the command.

#define	COMMAND_DOOR_LOCK_OPERATING_EVENT_NOTIFICATION 0x20

#define	COMMAND_DOOR_LOCK_PROGRAMMING_EVENT_NOTIFICATION 0x21

#define	USER_STATUS_AVAILABLE 0x00

#define	USER_STATUS_OCCUPIED_ENABLED 0x01

#define	USER_STATUS_RESERVED 0x02

#define	USER_STATUS_OCCUPIED_DISABLED 0x03

#define	USER_TYPE_UNRESTRICTED_USER 0x00
	Used to indicate what the type is for a specific user ID.

#define	USER_TYPE_YEAR_DAY_SCHEDULE_USER 0x01

#define	USER_TYPE_WEEK_DAY_SCHEDULE_USER 0x02

#define	USER_TYPE_MASTER_USER 0x03

#define	OPERATION_EVENT_SOURCE_KEYPAD 0x00
	A source value where available sources are.

#define	OPERATION_EVENT_SOURCE_RF 0x01

#define	OPERATION_EVENT_SOURCE_MANUAL 0x02

#define	OPERATION_EVENT_SOURCE_RFID 0x03

#define	OPERATION_EVENT_SOURCE_INDETERMINATE 0xFF

#define	OPERATION_EVENT_CODE_UNKNOWN_OR_MFG_SPECIFIC 0x00
	Operation Event Code Value enum.

#define	OPERATION_EVENT_CODE_LOCK 0x01

#define	OPERATION_EVENT_CODE_UNLOCK 0x02

#define	OPERATION_EVENT_CODE_LOCK_FAILURE_INVALID_PIN_OR_ID 0x03

#define	OPERATION_EVENT_CODE_LOCK_FAILURE_INVALID_SCHEDULE 0x04

#define	OPERATION_EVENT_CODE_UNLOCK_FAILURE_INVALID_PIN_OR_ID 0x05

#define	OPERATION_EVENT_CODE_UNLOCK_FAILURE_INVALID_SCHEDULE 0x06

#define	OPERATION_EVENT_CODE_ONE_TOUCH_LOCK 0x07

#define	OPERATION_EVENT_CODE_KEY_LOCK 0x08

#define	OPERATION_EVENT_CODE_KEY_UNLOCK 0x09

#define	OPERATION_EVENT_CODE_AUTO_LOCK 0x0A

#define	OPERATION_EVENT_CODE_SCHEDULE_LOCK 0x0B

#define	OPERATION_EVENT_CODE_SCHEDULE_UNLOCK 0x0C

#define	OPERATION_EVENT_CODE_MANUAL_LOCK 0x0D

#define	OPERATION_EVENT_CODE_MANUAL_UNLOCK 0x0E

#define	PROGRAMMING_EVENT_CODE_UNKNOWN_OR_MFG_SPECIFIC 0x00
	Programming Event Code enums.

#define	PROGRAMMING_EVENT_CODE_MASTER_CODE_CHANGED 0x01

#define	PROGRAMMING_EVENT_CODE_PIN_CODE_ADDED 0x02

#define	PROGRAMMING_EVENT_CODE_PIN_CODE_DELETED 0x03

#define	PROGRAMMING_EVENT_CODE_PIN_CODE_CHANGED 0x04

#define	PROGRAMMING_EVENT_CODE_RFID_CODE_ADDED 0x05

#define	PROGRAMMING_EVENT_CODE_RFID_CODE_DELETED 0x06

#define	DOORLOCK_RES_PAYLOAD_LEN 0x01
	Door Lock cluster commands payload lengths.

#define	PAYLOAD_LEN_UNLOCK_TIMEOUT 2

#define	PAYLOAD_LEN_GET_LOG_RECORD 2

#define	PAYLOAD_LEN_SET_PIN_CODE 4

#define	PAYLOAD_LEN_USER_ID 2

#define	PAYLOAD_LEN_SET_USER_STATUS 3

#define	PAYLOAD_LEN_SET_WEEK_DAY_SCHEDULE 8

#define	PAYLOAD_LEN_SCHEDULE 3

#define	PAYLOAD_LEN_SET_YEAR_DAY_SCHEDULE 11

#define	PAYLOAD_LEN_SET_HOLIDAY_SCHEDULE 10

#define	PAYLOAD_LEN_HOLIDAY_SCHEDULE 1

#define	PAYLOAD_LEN_SET_USER_TYPE 3

#define	PAYLOAD_LEN_SET_RFID_CODE 4

#define	PAYLOAD_LEN_GET_LOG_RECORD_RSP 11

#define	PAYLOAD_LEN_GET_PIN_CODE_RSP 4

#define	PAYLOAD_LEN_GET_USER_STATUS_RSP 3

#define	PAYLOAD_LEN_GET_USER_TYPE_RSP 3

#define	PAYLOAD_LEN_GET_WEEK_DAY_SCHEDULE_RSP 9

#define	PAYLOAD_LEN_GET_YEAR_DAY_SCHEDULE_RSP 12

#define	PAYLOAD_LEN_GET_HOLIDAY_SCHEDULE_RSP 11

#define	PAYLOAD_LEN_GET_RFID_CODE_RSP 4

#define	PAYLOAD_LEN_OPERATION_EVENT_NOTIFICATION 9

#define	PAYLOAD_LEN_PROGRAMMING_EVENT_NOTIFICATION 11

Detailed Description

This group provides ZCL Closure Doorlock Cluster macros defined in the ZCL v7 specification.

Macro Definition Documentation

§ ATTRID_DOOR_LOCK_AUTO_RELOCK_TIME

#define ATTRID_DOOR_LOCK_AUTO_RELOCK_TIME 0x0023

The number of seconds to wait after unlocking a lock before it automatically locks again.

§ ATTRID_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER

#define ATTRID_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER 0x0027

This attribute represents the default configurations as they are physically set on the device.

§ ATTRID_DOOR_LOCK_DOOR_CLOSED_EVENTS

#define ATTRID_DOOR_LOCK_DOOR_CLOSED_EVENTS 0x0005

This attribute holds the number of door closed events that have occurred since it was last zeroed.

§ ATTRID_DOOR_LOCK_DOOR_OPEN_EVENTS

#define ATTRID_DOOR_LOCK_DOOR_OPEN_EVENTS 0x0004

This attribute holds the number of door open events that have occurred since it was last zeroed.

§ ATTRID_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON

#define ATTRID_DOOR_LOCK_ENABLE_PRIVACY_MODE_BUTTON 0x002B

Enable/disable a button inside the door that is used to put the lock into privacy mode. When the lock is in privacy mode it cannot be manipulated from the outside.

§ ATTRID_DOOR_LOCK_OPEN_PERIOD

#define ATTRID_DOOR_LOCK_OPEN_PERIOD 0x0006

This attribute holds the number of minutes the door has been open since the last time it transitioned from closed to open.

§ ATTRID_DOOR_LOCK_OPERATING_MODE

#define ATTRID_DOOR_LOCK_OPERATING_MODE 0x0025

shows the current operating mode and which interfaces are enabled during each of the operating mode.

§ ATTRID_DOOR_LOCK_SECURITY_LEVEL

#define ATTRID_DOOR_LOCK_SECURITY_LEVEL 0x0034

Door locks MAY sometimes wish to implement a higher level of security within the application protocol in addition to the default network security.

§ ATTRID_DOOR_LOCK_SOUND_VOLUME

#define ATTRID_DOOR_LOCK_SOUND_VOLUME 0x0024

The sound volume on a door lock has three possible settings: silent, low and high volumes.

§ ATTRID_DOOR_LOCK_SUPPORTED_OPERATING_MODES

#define ATTRID_DOOR_LOCK_SUPPORTED_OPERATING_MODES 0x0026

This bitmap contains all operating bits of the Operating Mode Attribute supported by the lock.

§ ATTRID_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT

#define ATTRID_DOOR_LOCK_WRONG_CODE_ENTRY_LIMIT 0x0030

The number of incorrect codes or RFID presentment attempts a user is allowed to enter before the door will enter a lockout state.

§ ATTRID_DOORLOCK_REQUIRE_PIN_FOR_RF_OPERATION

#define ATTRID_DOORLOCK_REQUIRE_PIN_FOR_RF_OPERATION 0x0033

Boolean set to True if the door lock server requires that an optional PINs be included in the payload of RF lock operation events like Lock, Unlock and Toggle in order to function.

§ COMMAND_DOOR_LOCK_OPERATING_EVENT_NOTIFICATION

#define COMMAND_DOOR_LOCK_OPERATING_EVENT_NOTIFICATION 0x20

The door lock server sends out operation event notification when the event is triggered by the various event sources.

§ COMMAND_DOOR_LOCK_PROGRAMMING_EVENT_NOTIFICATION

#define COMMAND_DOOR_LOCK_PROGRAMMING_EVENT_NOTIFICATION 0x21

The door lock optionally sends out notifications (if they are enabled) whenever there is a significant operational event on the lock.

§ COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE

#define COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE 0x11

Set the holiday Schedule by specifying local start time and local end time with respect to any Lock Operating Mode.

§ COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE

#define COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE 0x03

This command is sent in response to an Unlock with Timeout command with one status byte payload.

§ DOORLOCK_OP_MODE_PASSAGE

#define DOORLOCK_OP_MODE_PASSAGE 0x04

Passage Mode: The lock is open or can be open or closed at will without the use of a Keypad or other means of user validation.

§ USER_STATUS_AVAILABLE

#define USER_STATUS_AVAILABLE 0x00

The following User Status and User Type values are used in the payload of multiple commands.

Macros