Door Lock 0x0101
Controls door locks including lock/unlock operations, user management, and access schedules.
Attributes 44
Commands 26
Features 15
| Code | Name | Type | Flags |
|---|---|---|---|
| 0x0001 | LockType | DlLockType | |
| 0x0002 | ActuatorEnabled | boolean | |
| 0x0003 | DoorState | DoorStateEnum | Optional |
| 0x0004 | DoorOpenEvents | int32u | Writable Optional |
| 0x0005 | DoorClosedEvents | int32u | Writable Optional |
| 0x0006 | OpenPeriod | int16u | Writable Optional |
| 0x0011 | NumberOfTotalUsersSupported | int16u | Optional |
| 0x0012 | NumberOfPINUsersSupported | int16u | Optional |
| 0x0013 | NumberOfRFIDUsersSupported | int16u | Optional |
| 0x0014 | NumberOfWeekDaySchedulesSupportedPerUser | int8u | Optional |
| 0x0015 | NumberOfYearDaySchedulesSupportedPerUser | int8u | Optional |
| 0x0016 | NumberOfHolidaySchedulesSupported | int8u | Optional |
| 0x0017 | MaxPINCodeLength | int8u | Optional |
| 0x0018 | MinPINCodeLength | int8u | Optional |
| 0x0019 | MaxRFIDCodeLength | int8u | Optional |
| 0x001A | MinRFIDCodeLength | int8u | Optional |
| 0x001B | CredentialRulesSupport | DlCredentialRuleMask | Optional |
| 0x001C | NumberOfCredentialsSupportedPerUser | int8u | Optional |
| 0x0021 | Language | char_string | Writable Optional |
| 0x0022 | LEDSettings | int8u | Writable Optional |
| 0x0023 | AutoRelockTime | int32u | Writable Optional |
| 0x0024 | SoundVolume | int8u | Writable Optional |
| 0x0025 | OperatingMode | OperatingModeEnum | Writable |
| 0x0026 | SupportedOperatingModes | DlSupportedOperatingModes | |
| 0x0027 | DefaultConfigurationRegister | DlDefaultConfigurationRegister | Optional |
| 0x0028 | EnableLocalProgramming | boolean | Writable Optional |
| 0x0029 | EnableOneTouchLocking | boolean | Writable Optional |
| 0x002A | EnableInsideStatusLED | boolean | Writable Optional |
| 0x002B | EnablePrivacyModeButton | boolean | Writable Optional |
| 0x002C | LocalProgrammingFeatures | DlLocalProgrammingFeatures | Writable Optional |
| 0x0030 | WrongCodeEntryLimit | int8u | Writable Optional |
| 0x0031 | UserCodeTemporaryDisableTime | int8u | Writable Optional |
| 0x0032 | SendPINOverTheAir | boolean | Writable Optional |
| 0x0033 | RequirePINforRemoteOperation | boolean | Writable Optional |
| 0x0035 | ExpiringUserTimeout | int16u | Writable Optional |
| 0x0080 | AliroReaderVerificationKey | octet_string | Optional |
| 0x0081 | AliroReaderGroupIdentifier | octet_string | Optional |
| 0x0082 | AliroReaderGroupSubIdentifier | octet_string | Optional |
| 0x0083 | AliroExpeditedTransactionSupportedProtocolVersions | array | Optional |
| 0x0084 | AliroGroupResolvingKey | octet_string | Optional |
| 0x0085 | AliroSupportedBLEUWBProtocolVersions | array | Optional |
| 0x0086 | AliroBLEAdvertisingVersion | int8u | Optional |
| 0x0087 | NumberOfAliroCredentialIssuerKeysSupported | int16u | Optional |
| 0x0088 | NumberOfAliroEndpointKeysSupported | int16u | Optional |
| Code | Name | Direction | Parameters |
|---|---|---|---|
| 0x01 | UnlockDoor | client→server |
PINCode: octet_string |
| 0x03 | UnlockWithTimeout Optional | client→server |
Timeout: int16u, PINCode: octet_string |
| 0x0B | SetWeekDaySchedule Optional | client→server |
WeekDayIndex: int8u, UserIndex: int16u, DaysMask: DaysMaskMap, StartHour: int8u, StartMinute: int8u, EndHour: int8u, EndMinute: int8u |
| 0x0C | GetWeekDaySchedule Optional | client→server |
WeekDayIndex: int8u, UserIndex: int16u |
| 0x0C | GetWeekDayScheduleResponse Optional | server→client |
WeekDayIndex: int8u, UserIndex: int16u, Status: DlStatus, DaysMask: DaysMaskMap, StartHour: int8u, StartMinute: int8u, EndHour: int8u, EndMinute: int8u |
| 0x0D | ClearWeekDaySchedule Optional | client→server |
WeekDayIndex: int8u, UserIndex: int16u |
| 0x0E | SetYearDaySchedule Optional | client→server |
YearDayIndex: int8u, UserIndex: int16u, LocalStartTime: epoch_s, LocalEndTime: epoch_s |
| 0x0F | GetYearDaySchedule Optional | client→server |
YearDayIndex: int8u, UserIndex: int16u |
| 0x0F | GetYearDayScheduleResponse Optional | server→client |
YearDayIndex: int8u, UserIndex: int16u, Status: DlStatus, LocalStartTime: epoch_s, LocalEndTime: epoch_s |
| 0x10 | ClearYearDaySchedule Optional | client→server |
YearDayIndex: int8u, UserIndex: int16u |
| 0x11 | SetHolidaySchedule Optional | client→server |
HolidayIndex: int8u, LocalStartTime: epoch_s, LocalEndTime: epoch_s, OperatingMode: OperatingModeEnum |
| 0x12 | GetHolidaySchedule Optional | client→server |
HolidayIndex: int8u |
| 0x12 | GetHolidayScheduleResponse Optional | server→client |
HolidayIndex: int8u, Status: DlStatus, LocalStartTime: epoch_s, LocalEndTime: epoch_s, OperatingMode: OperatingModeEnum |
| 0x13 | ClearHolidaySchedule Optional | client→server |
HolidayIndex: int8u |
| 0x1A | SetUser Optional | client→server |
OperationType: DataOperationTypeEnum, UserIndex: int16u, UserName: char_string, UserUniqueID: int32u, UserStatus: UserStatusEnum, UserType: UserTypeEnum, CredentialRule: CredentialRuleEnum |
| 0x1B | GetUser Optional | client→server |
UserIndex: int16u |
| 0x1C | GetUserResponse Optional | server→client |
UserIndex: int16u, UserName: char_string, UserUniqueID: int32u, UserStatus: UserStatusEnum, UserType: UserTypeEnum, CredentialRule: CredentialRuleEnum, Credentials: CredentialStruct, CreatorFabricIndex: fabric_idx, LastModifiedFabricIndex: fabric_idx, NextUserIndex: int16u |
| 0x1D | ClearUser Optional | client→server |
UserIndex: int16u |
| 0x22 | SetCredential Optional | client→server |
OperationType: DataOperationTypeEnum, Credential: CredentialStruct, CredentialData: long_octet_string, UserIndex: int16u, UserStatus: UserStatusEnum, UserType: UserTypeEnum |
| 0x23 | SetCredentialResponse Optional | server→client |
Status: DlStatus, UserIndex: int16u, NextCredentialIndex: int16u |
| 0x24 | GetCredentialStatus Optional | client→server |
Credential: CredentialStruct |
| 0x25 | GetCredentialStatusResponse Optional | server→client |
CredentialExists: boolean, UserIndex: int16u, CreatorFabricIndex: fabric_idx, LastModifiedFabricIndex: fabric_idx, NextCredentialIndex: int16u, CredentialData: octet_string |
| 0x26 | ClearCredential Optional | client→server |
Credential: CredentialStruct |
| 0x27 | UnboltDoor Optional | client→server |
PINCode: octet_string |
| 0x28 | SetAliroReaderConfig Optional | client→server |
SigningKey: octet_string, VerificationKey: octet_string, GroupIdentifier: octet_string, GroupResolvingKey: octet_string |
| 0x29 | ClearAliroReaderConfig Optional | client→server | None |
PIN Credential
(PIN)
bit 0
Lock supports PIN credentials (via keypad, or over-the-air)
RFID Credential
(RID)
bit 1
Lock supports RFID credentials
FingerCredentials
(FGP)
bit 2
Lock supports finger related credentials (fingerprint, finger vein)
Logging
(LOG)
bit 3
Lock supports local/on-lock logging when Events are not supported
WeekDayAccessSchedules
(WDSCH)
bit 4
Lock supports week day user access schedules
DoorPositionSensor
(DPS)
bit 5
Lock supports a door position sensor that indicates door's state
FaceCredentials
(FACE)
bit 6
Lock supports face related credentials (face, iris, retina)
CredentialsOverTheAirAccess
(COTA)
bit 7
PIN codes over-the-air supported for lock/unlock operations
User
(USR)
bit 8
Lock supports the user commands and database
Notification
(NOT)
bit 9
Operation and Programming Notifications
YearDayAccessSchedules
(YDSCH)
bit 10
Lock supports year day user access schedules
HolidaySchedules
(HDSCH)
bit 11
Lock supports holiday schedules
Unbolt
(UBOLT)
bit 12
Lock supports unbolting
AliroProvisioning
(ALIRO)
bit 13
AliroProvisioning
AliroBLEUWB
(ALBU)
bit 14
AliroBLEUWB
Device Types Using This Cluster
Device types in the Matter spec that reference this cluster
Devices Implementing This Cluster
25 devices in the survey implement this cluster