ZCL door_lock

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

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_door_lock.h

Macros

ESP_ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_DEFAULT_VALUE: Default value for Lock State attribute.

ESP_ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_DEFAULT_VALUE: Default value for Lock Type attribute.

ESP_ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_DEFAULT_VALUE: Default value for Actuator Enabled attribute.

Enumerations

enum esp_zb_zcl_door_lock_attr_t

Door Lock cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_LOCK_STATE_ID: brief LockState attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_LOCK_TYPE_ID: brief LockType attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_ACTUATOR_ENABLED_ID: brief ActuatorEnabled attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_DOOR_STATE_ID: brief DoorState attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_OF_DOOR_OPEN_EVENTS_ID: brief DoorOpenEvents attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_OF_DOOR_CLOSED_EVENTS_ID: brief DoorClosedEvents attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_OPEN_PERIOD_ID: brief OpenPeriod attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_LOG_RECORDS_SUPPORTED_ID: The number of available log records.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_TOTAL_USERS_ID: brief NumberOfTotalUsersSupported attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_PIN_USERS_ID: brief NumberOfPINUsersSupported attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUMBER_OF_RFID_USERS_SUPPORTED_ID: he number of RFID users supported.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_WEEK_DAY_SCHEDULE_PER_USER_ID: brief NumberOfWeekDaySchedulesSupportedPerUser attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_YEAR_DAY_SCHEDULE_PER_USER_ID: brief NumberOfYearDaySchedulesSupportedPerUser attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_NUM_HOLIDAY_SCHEDULE_ID: brief NumberOfHolidaySchedulesSupported attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_MAX_PIN_LEN_ID: brief Max PIN code length attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_MIN_PIN_LEN_ID: brief Min PIN code length attribute

enumerator ESP_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.

enumerator ESP_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.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOGGING_ID: Enable/disable event logging.

enumerator ESP_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.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_LED_SETTINGS_ID: The settings for the LED support three different modes.

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

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

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_OPERATING_MODE_ID: OperatingMode attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_OPERATION_MODES_SUPPORTED_ID: SupportedOperatingModes attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_DEFAULT_CONFIGURATION_REGISTER_ID: This attribute represents the default configurations as they are physically set on the device

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_ENABLE_LOCAL_PROGRAMMING_ID: EnableLocalProgramming attribute

enumerator ESP_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.

enumerator ESP_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.

enumerator ESP_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.

enumerator ESP_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.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_USER_CODE_TEMPORARY_DISABLE_TIME_ID: The number of seconds that the lock shuts down following wrong code entry.

enumerator ESP_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.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_REQUIRE_PIN_RF_ID: Require PIN for RF operation attribute

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_SECURITY_LEVEL_ID: It allows the door lock manufacturer to indicate what level of security the door lock requires.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_ALARM_MASK_ID: The alarm mask is used to turn on/off alarms for particular functions

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_OPERATION_EVENT_MASK_ID: Event mask used to turn on and off the transmission of keypad operation events.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_RF_OPERATION_EVENT_MASK_ID: Event mask used to turn on and off the transmission of RF operation events.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_MANUAL_OPERATION_EVENT_MASK_ID: Event mask used to turn on and off manual operation events.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_RFID_OPERATION_EVENT_MASK_ID: Event mask used to turn on and off RFID operation events.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_KEYPAD_PROGRAMMING_EVENT_MASK_ID: Event mask used to turn on and off keypad programming events.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_RF_PROGRAMMING_EVENT_MASK_ID: Event mask used to turn on and off RF programming events.

enumerator ESP_ZB_ZCL_ATTR_DOOR_LOCK_RFID_PROGRAMMING_EVENT_MASK_ID: Event mask used to turn on and off RFID programming events.

enum esp_zb_zcl_door_lock_cmd_id_t

Door Lock cluster commands.

Values:

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR: This command causes the lock device to lock the door.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR: This command causes the lock device to unlock the door.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_TOGGLE: Request the status of the lock.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT: This command causes the lock device to unlock the door with a timeout parameter.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD: Request a log record.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE: Set a PIN into the lock.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE: Retrieve a PIN Code.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE: Delete a PIN.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES: Clear out all PINs on the lock.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS: Set the status of a user ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS: Get the status of a user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE: Set a weekly repeating schedule for a specified user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE: Retrieve the specific weekly schedule for the specific user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE: Clear the specific weekly schedule for the specific user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE: Set a time-specific schedule ID for a specified user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE: Retrieve the specific year day schedule for the specific user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE: Clears the specific year day schedule for the specific user.

enumerator ESP_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.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE: Get the holiday Schedule by specifying Holiday ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE: Clear the holiday Schedule by specifying Holiday ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE: Set the type byte for a specified user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE: Retrieve the type byte for a specific user.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE: Set an ID for RFID access into the lock.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE: Retrieve an ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE: Delete an ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES: Clear out all RFIDs on the lock.

enum esp_zb_zcl_door_lock_cmd_resp_t

Door Lock cluster response commands.

Values:

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR_RES: This command is sent in response to a Lock command

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_DOOR_RES: This command is sent in response to a Unlock command

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_TOGGLE_RESPONSE: This command is sent in response to a Toggle command

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_UNLOCK_WITH_TIMEOUT_RESPONSE: This command is sent in response to an Unlock

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_LOG_RECORD_RESPONSE: Returns the specified log record.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_PIN_CODE_RESPONSE: Returns status of the PIN set command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_PIN_CODE_RESPONSE: Returns the PIN for the specified user ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_PIN_CODE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_PIN_CODES_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_USER_STATUS_RESPONSE: Returns the pass or fail value for the setting of the user status.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_USER_STATUS_RESPONSE: Returns the user status for the specified user ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_WEEKDAY_SCHEDULE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_WEEKDAY_SCHEDULE_RESPONSE: Returns the weekly repeating schedule data for the specified schedule ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_YEAR_DAY_SCHEDULE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_YEAR_DAY_SCHEDULE_RESPONSE: Returns the weekly repeating schedule data for the specified schedule ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_YEAR_DAY_SCHEDULE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_HOLIDAY_SCHEDULE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_HOLIDAY_SCHEDULE_RESPONSE: Returns the Holiday Schedule Entry for the specified Holiday ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_USER_TYPE_RESPONSE: Returns the pass or fail value for the setting of the user type.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_USER_TYPE_RESPONSE: Returns the user type for the specified user ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_SET_RFID_CODE_RESPONSE: Returns status of the Set RFID Code command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_GET_RFID_CODE_RESPONSE: Returns the RFID code for the specified user ID.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_RFID_CODE_RESPONSE: Returns pass/fail of the command.

enumerator ESP_ZB_ZCL_CMD_DOOR_LOCK_CLEAR_ALL_RFID_CODES_RESPONSE: Returns pass/fail of the command.

enumerator ESP_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.

enumerator ESP_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.