Module door_lock

Module door_lock 

Source
Expand description

Matter TLV encoders and decoders for Door Lock Cluster Cluster ID: 0x0101

This file is automatically generated from DoorLock.xml

Modules§

alarmmask
Constants for AlarmMask
configurationregister
Constants for ConfigurationRegister
credentialrules
Constants for CredentialRules
daysmask
Constants for DaysMask
localprogrammingfeatures
Constants for LocalProgrammingFeatures
operatingmodes
Constants for OperatingModes

Structs§

Credential
DoorLockAlarmEvent
DoorStateChangeEvent
GetCredentialStatusResponse
GetHolidayScheduleResponse
GetUserResponse
GetWeekDayScheduleResponse
GetYearDayScheduleResponse
LockOperationErrorEvent
LockOperationEvent
LockUserChangeEvent
SetCredentialResponse

Enums§

AlarmCode
CredentialRule
CredentialType
DataOperationType
DoorState
EventType
LEDSetting
LockDataType
LockOperationType
LockState
LockType
OperatingMode
OperationError
OperationSource
SoundVolume
StatusCode
UserStatus
UserType

Functions§

decode_actuator_enabled
Decode ActuatorEnabled attribute (0x0002)
decode_aliro_ble_advertising_version
Decode AliroBLEAdvertisingVersion attribute (0x0086)
decode_aliro_expedited_transaction_supported_protocol_versions
Decode AliroExpeditedTransactionSupportedProtocolVersions attribute (0x0083)
decode_aliro_group_resolving_key
Decode AliroGroupResolvingKey attribute (0x0084)
decode_aliro_reader_group_identifier
Decode AliroReaderGroupIdentifier attribute (0x0081)
decode_aliro_reader_group_sub_identifier
Decode AliroReaderGroupSubIdentifier attribute (0x0082)
decode_aliro_reader_verification_key
Decode AliroReaderVerificationKey attribute (0x0080)
decode_aliro_supported_bleuwb_protocol_versions
Decode AliroSupportedBLEUWBProtocolVersions attribute (0x0085)
decode_attribute_json
Decode attribute value and return as JSON string
decode_auto_relock_time
Decode AutoRelockTime attribute (0x0023)
decode_credential_rules_support
Decode CredentialRulesSupport attribute (0x001B)
decode_default_configuration_register
Decode DefaultConfigurationRegister attribute (0x0027)
decode_door_closed_events
Decode DoorClosedEvents attribute (0x0005)
decode_door_lock_alarm_event
Decode DoorLockAlarm event (0x00, priority: critical)
decode_door_open_events
Decode DoorOpenEvents attribute (0x0004)
decode_door_state
Decode DoorState attribute (0x0003)
decode_door_state_change_event
Decode DoorStateChange event (0x01, priority: desc)
decode_enable_inside_status_led
Decode EnableInsideStatusLED attribute (0x002A)
decode_enable_local_programming
Decode EnableLocalProgramming attribute (0x0028)
decode_enable_one_touch_locking
Decode EnableOneTouchLocking attribute (0x0029)
decode_enable_privacy_mode_button
Decode EnablePrivacyModeButton attribute (0x002B)
decode_expiring_user_timeout
Decode ExpiringUserTimeout attribute (0x0035)
decode_get_credential_status_response
Decode GetCredentialStatusResponse command response (25)
decode_get_holiday_schedule_response
Decode GetHolidayScheduleResponse command response (12)
decode_get_user_response
Decode GetUserResponse command response (1C)
decode_get_week_day_schedule_response
Decode GetWeekDayScheduleResponse command response (0C)
decode_get_year_day_schedule_response
Decode GetYearDayScheduleResponse command response (0F)
decode_language
Decode Language attribute (0x0021)
decode_led_settings
Decode LEDSettings attribute (0x0022)
decode_local_programming_features
Decode LocalProgrammingFeatures attribute (0x002C)
decode_lock_operation_error_event
Decode LockOperationError event (0x03, priority: desc)
decode_lock_operation_event
Decode LockOperation event (0x02, priority: desc)
decode_lock_state
Decode LockState attribute (0x0000)
decode_lock_type
Decode LockType attribute (0x0001)
decode_lock_user_change_event
Decode LockUserChange event (0x04, priority: info)
decode_max_pin_code_length
Decode MaxPINCodeLength attribute (0x0017)
decode_max_rfid_code_length
Decode MaxRFIDCodeLength attribute (0x0019)
decode_min_pin_code_length
Decode MinPINCodeLength attribute (0x0018)
decode_min_rfid_code_length
Decode MinRFIDCodeLength attribute (0x001A)
decode_number_of_aliro_credential_issuer_keys_supported
Decode NumberOfAliroCredentialIssuerKeysSupported attribute (0x0087)
decode_number_of_aliro_endpoint_keys_supported
Decode NumberOfAliroEndpointKeysSupported attribute (0x0088)
decode_number_of_credentials_supported_per_user
Decode NumberOfCredentialsSupportedPerUser attribute (0x001C)
decode_number_of_holiday_schedules_supported
Decode NumberOfHolidaySchedulesSupported attribute (0x0016)
decode_number_of_pin_users_supported
Decode NumberOfPINUsersSupported attribute (0x0012)
decode_number_of_rfid_users_supported
Decode NumberOfRFIDUsersSupported attribute (0x0013)
decode_number_of_total_users_supported
Decode NumberOfTotalUsersSupported attribute (0x0011)
decode_number_of_week_day_schedules_supported_per_user
Decode NumberOfWeekDaySchedulesSupportedPerUser attribute (0x0014)
decode_number_of_year_day_schedules_supported_per_user
Decode NumberOfYearDaySchedulesSupportedPerUser attribute (0x0015)
decode_open_period
Decode OpenPeriod attribute (0x0006)
decode_operating_mode
Decode OperatingMode attribute (0x0025)
decode_require_pinfor_remote_operation
Decode RequirePINforRemoteOperation attribute (0x0033)
decode_security_level
Decode SecurityLevel attribute (0x0034)
decode_send_pin_over_the_air
Decode SendPINOverTheAir attribute (0x0032)
decode_set_credential_response
Decode SetCredentialResponse command response (23)
decode_sound_volume
Decode SoundVolume attribute (0x0024)
decode_supported_operating_modes
Decode SupportedOperatingModes attribute (0x0026)
decode_user_code_temporary_disable_time
Decode UserCodeTemporaryDisableTime attribute (0x0031)
decode_wrong_code_entry_limit
Decode WrongCodeEntryLimit attribute (0x0030)
encode_clear_credential
Encode ClearCredential command (0x26)
encode_clear_holiday_schedule
Encode ClearHolidaySchedule command (0x13)
encode_clear_user
Encode ClearUser command (0x1D)
encode_clear_week_day_schedule
Encode ClearWeekDaySchedule command (0x0D)
encode_clear_year_day_schedule
Encode ClearYearDaySchedule command (0x10)
encode_get_credential_status
Encode GetCredentialStatus command (0x24)
encode_get_holiday_schedule
Encode GetHolidaySchedule command (0x12)
encode_get_user
Encode GetUser command (0x1B)
encode_get_week_day_schedule
Encode GetWeekDaySchedule command (0x0C)
encode_get_year_day_schedule
Encode GetYearDaySchedule command (0x0F)
encode_lock_door
Encode LockDoor command (0x00)
encode_set_aliro_reader_config
Encode SetAliroReaderConfig command (0x28)
encode_set_credential
Encode SetCredential command (0x22)
encode_set_holiday_schedule
Encode SetHolidaySchedule command (0x11)
encode_set_user
Encode SetUser command (0x1A)
encode_set_week_day_schedule
Encode SetWeekDaySchedule command (0x0B)
encode_set_year_day_schedule
Encode SetYearDaySchedule command (0x0E)
encode_unbolt_door
Encode UnboltDoor command (0x27)
encode_unlock_door
Encode UnlockDoor command (0x01)
encode_unlock_with_timeout
Encode UnlockWithTimeout command (0x03)
get_attribute_list
Get list of all attributes supported by this cluster

Type Aliases§

AlarmMask
AlarmMask bitmap type
ConfigurationRegister
ConfigurationRegister bitmap type
CredentialRules
CredentialRules bitmap type
DaysMask
DaysMask bitmap type
LocalProgrammingFeatures
LocalProgrammingFeatures bitmap type
OperatingModes
OperatingModes bitmap type