DoorLockTrait

object DoorLockTrait

Attributes for DoorLockTrait.

Summary

Nested types
`enum DoorLockTrait.AlarmCodeEnum : Enum, ClusterEnum` Alarm codes.
`interface DoorLockTrait.Attributes` Attributes for the DoorLock cluster.
`object DoorLockTrait.ClearAliroReaderConfigCommand : CommandDescriptor`
`class DoorLockTrait.ClearAliroReaderConfigCommand.Request`
`object DoorLockTrait.ClearCredentialCommand : CommandDescriptor` Clear a single credential, one type of credential, or all credentials except `ProgrammingPIN` credentials.
`class DoorLockTrait.ClearCredentialCommand.Request` The request payload for the ClearCredential command.
`object DoorLockTrait.ClearHolidayScheduleCommand : CommandDescriptor` Clear the specified holiday schedule, or all holiday schedules.
`class DoorLockTrait.ClearHolidayScheduleCommand.Request` The request payload for the ClearHolidaySchedule command.
`object DoorLockTrait.ClearUserCommand : CommandDescriptor` Clear the specified user.
`class DoorLockTrait.ClearUserCommand.Request` The request payload for the ClearUser command.
`object DoorLockTrait.ClearWeekDayScheduleCommand : CommandDescriptor` Clear the specified week day schedule or all week day schedules for the specific user.
`class DoorLockTrait.ClearWeekDayScheduleCommand.Request` The request payload for the ClearWeekDaySchedule command.
`object DoorLockTrait.ClearYearDayScheduleCommand : CommandDescriptor` Clear the specified year day schedule, or all year day schedules for the specific user.
`class DoorLockTrait.ClearYearDayScheduleCommand.Request` The request payload for the ClearYearDaySchedule command.
`enum DoorLockTrait.CredentialRuleEnum : Enum, ClusterEnum` Indicates the credential rule that can be applied to a particular user.
`class DoorLockTrait.CredentialStruct` A set of credentials used when operating the door lock.
`enum DoorLockTrait.CredentialTypeEnum : Enum, ClusterEnum` Indicates the credential type.
`enum DoorLockTrait.DataOperationTypeEnum : Enum, ClusterEnum` Indicates the data operation performed.
`data class DoorLockTrait.DaysMaskMap : ClusterBitmap` The days of the week.
`data class DoorLockTrait.DlCredentialRuleMask : ClusterBitmap` Credential rules.
`data class DoorLockTrait.DlCredentialRulesSupport : ClusterBitmap` Credential rules.
`data class DoorLockTrait.DlDefaultConfigurationRegister : ClusterBitmap` The default configurations as they are physically set on the device.
`data class DoorLockTrait.DlKeypadOperationEventMask : ClusterBitmap` Event mask used to enable and disable the transmission of keypad operation events.
`data class DoorLockTrait.DlKeypadProgrammingEventMask : ClusterBitmap` Event mask used to enable and disable keypad programming events.
`data class DoorLockTrait.DlLocalProgrammingFeatures : ClusterBitmap` The local programming features that are disabled when the `enableLocalProgramming` attribute is set to `false`.
`enum DoorLockTrait.DlLockState : Enum, ClusterEnum` Door lock states.
`enum DoorLockTrait.DlLockType : Enum, ClusterEnum` Lock types.
`data class DoorLockTrait.DlManualOperationEventMask : ClusterBitmap` Manual operation events.
`data class DoorLockTrait.DlRemoteOperationEventMask : ClusterBitmap` Event mask used to enable and disable the transmission of remote operation events.
`data class DoorLockTrait.DlRemoteProgrammingEventMask : ClusterBitmap` Event mask used to enable and disable remote programming events.
`data class DoorLockTrait.DlRfidOperationEventMask : ClusterBitmap` Event mask used to enable and disable the transmission of RFID events.
`data class DoorLockTrait.DlRfidProgrammingEventMask : ClusterBitmap` Event mask used to enable and disable RFID programming events.
`enum DoorLockTrait.DlStatus : Enum, ClusterEnum` Door lock statuses.
`data class DoorLockTrait.DlSupportedOperatingModes : ClusterBitmap` This bitmap contains all operating bits of the Operating Mode Attribute supported by the lock.
`interface DoorLockTrait.DoorLockAlarm` Indicates that there is a critical state on the door lock.
`data class DoorLockTrait.DoorLockDayOfWeek : ClusterBitmap` Days of the week.
`enum DoorLockTrait.DoorLockOperationEventCode : Enum, ClusterEnum` Door lock operation event codes.
`enum DoorLockTrait.DoorLockProgrammingEventCode : Enum, ClusterEnum` Door lock programming event codes.
`enum DoorLockTrait.DoorLockSetPinOrIdStatus : Enum, ClusterEnum` Door lock credential status.
`enum DoorLockTrait.DoorLockUserStatus : Enum, ClusterEnum` The status for a specific user.
`enum DoorLockTrait.DoorLockUserType : Enum, ClusterEnum` The type for a specific user.
`interface DoorLockTrait.DoorStateChange` Indicates that the state of the door has changed.
`enum DoorLockTrait.DoorStateEnum : Enum, ClusterEnum` Door states.
`data class DoorLockTrait.Feature : ClusterBitmap` DoorLock cluster FeatureMap.
`object DoorLockTrait.GetCredentialStatusCommand : CommandDescriptor` Retrieve the status of the specified credential.
`class DoorLockTrait.GetCredentialStatusCommand.Request` The request payload for the GetCredentialStatus command.
`class DoorLockTrait.GetCredentialStatusCommand.Response` Returns the status for the specified credential.
`object DoorLockTrait.GetHolidayScheduleCommand : CommandDescriptor` Get the holiday schedule for the specified holiday index.
`class DoorLockTrait.GetHolidayScheduleCommand.Request` The request payload for the GetHolidaySchedule command.
`class DoorLockTrait.GetHolidayScheduleCommand.Response` Returns the holiday schedule entry for the specified holiday ID.
`object DoorLockTrait.GetUserCommand : CommandDescriptor` Retrieve the user type for a specific user.
`class DoorLockTrait.GetUserCommand.Request` The request payload for the GetUser command.
`class DoorLockTrait.GetUserCommand.Response` Returns the user for the specified `userIndex`.
`object DoorLockTrait.GetWeekDayScheduleCommand : CommandDescriptor` Retrieve the weekly schedule for the specified user.
`class DoorLockTrait.GetWeekDayScheduleCommand.Request` The request payload for the GetWeekDaySchedule command.
`class DoorLockTrait.GetWeekDayScheduleCommand.Response` Returns the weekly repeating schedule data for the specified schedule index.
`object DoorLockTrait.GetYearDayScheduleCommand : CommandDescriptor` Retrieve the specified year day schedule for the specified user.
`class DoorLockTrait.GetYearDayScheduleCommand.Request` The request payload for the GetYearDaySchedule command.
`class DoorLockTrait.GetYearDayScheduleCommand.Response` Returns the year day schedule data for the specified schedule and user indexes.
`enum DoorLockTrait.LockDataTypeEnum : Enum, ClusterEnum` Data types associated with door locks.
`object DoorLockTrait.LockDoorCommand : CommandDescriptor` Lock the door.
`interface DoorLockTrait.LockDoorCommand.OptionalArgs` Optional arguments for the command LockDoorCommand Request
`class DoorLockTrait.LockDoorCommand.Request` The request payload for the LockDoor command.
`interface DoorLockTrait.LockOperation` Indicates that a lock operation has taken place.
`interface DoorLockTrait.LockOperationError` Indicates that a lock operation failed.
`enum DoorLockTrait.LockOperationTypeEnum : Enum, ClusterEnum` The type of Lock operation performed.
`interface DoorLockTrait.LockUserChange` Indicates that a lock user, schedule, or credential has changed.
`enum DoorLockTrait.OperatingModeEnum : Enum, ClusterEnum` Operating modes.
`enum DoorLockTrait.OperationErrorEnum : Enum, ClusterEnum` Indicates the cause of the Lock or Unlock operation failure.
`enum DoorLockTrait.OperationSourceEnum : Enum, ClusterEnum` Indicates the source of the Lock or Unlock operation.
`object DoorLockTrait.SetAliroReaderConfigCommand : CommandDescriptor`
`interface DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs` Optional arguments for the command SetAliroReaderConfigCommand Request
`class DoorLockTrait.SetAliroReaderConfigCommand.Request`
`object DoorLockTrait.SetCredentialCommand : CommandDescriptor` Set a credential into the lock for a new or existing user, or for a programming user.
`class DoorLockTrait.SetCredentialCommand.Request` The request payload for the SetCredential command.
`class DoorLockTrait.SetCredentialCommand.Response` The status for setting the specified credential.
`object DoorLockTrait.SetHolidayScheduleCommand : CommandDescriptor` Set the holiday schedule by specifying the local start and end time with respect to a specific lock operating mode.
`class DoorLockTrait.SetHolidayScheduleCommand.Request` The request payload for the SetHolidaySchedule command.
`object DoorLockTrait.SetUserCommand : CommandDescriptor` Set the user on the lock.
`class DoorLockTrait.SetUserCommand.Request` The request payload for the SetUser command.
`object DoorLockTrait.SetWeekDayScheduleCommand : CommandDescriptor` Set a weekly repeating schedule for the specified user.
`class DoorLockTrait.SetWeekDayScheduleCommand.Request` The request payload for the SetWeekDaySchedule command.
`object DoorLockTrait.SetYearDayScheduleCommand : CommandDescriptor` Set a time-specific schedule ID for a specified user.
`class DoorLockTrait.SetYearDayScheduleCommand.Request` The request payload for the SetYearDaySchedule command.
`object DoorLockTrait.UnboltDoorCommand : CommandDescriptor` Disengage the deadbolt.
`interface DoorLockTrait.UnboltDoorCommand.OptionalArgs` Optional arguments for the command UnboltDoorCommand Request
`class DoorLockTrait.UnboltDoorCommand.Request` The request payload for the UnboltDoor command.
`object DoorLockTrait.UnlockDoorCommand : CommandDescriptor` Unlock the door.
`interface DoorLockTrait.UnlockDoorCommand.OptionalArgs` Optional arguments for the command UnlockDoorCommand Request
`class DoorLockTrait.UnlockDoorCommand.Request` The request payload for the UnlockDoor command.
`object DoorLockTrait.UnlockWithTimeoutCommand : CommandDescriptor` Unlock the door with a timeout parameter.
`interface DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs` Optional arguments for the command UnlockWithTimeoutCommand Request
`class DoorLockTrait.UnlockWithTimeoutCommand.Request` The request payload for the UnlockWithTimeout command.
`enum DoorLockTrait.UserStatusEnum : Enum, ClusterEnum` The status for a specific user.
`enum DoorLockTrait.UserTypeEnum : Enum, ClusterEnum` The type of a specific user.

Public properties
`ClusterId`	`Id`

Public properties

Id

val Id: ClusterId

DoorLockTrait

Summary

Nested types

Public properties

Public properties

Id