DoorLockTrait.Attributes

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

val acceptedCommandList: List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

val actuatorEnabled: Boolean?

Indicates whether the lock is able to process remote Lock, Unlock, or Unlock with Timeout commands.

Access type: Read

val attributeList: List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

val autoRelockTime: UInt?

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

Access type: Write

val clusterRevision: UShort

The revision of the server cluster specification supported by the cluster instance.

val credentialRulesSupport: DoorLockTrait.DlCredentialRuleMask?

Bitmap which indicates which credential rules are supported by the door lock. Valid values are defined by DlCredentialRuleMask.

Access type: Read

val defaultConfigurationRegister: DoorLockTrait.DlDefaultConfigurationRegister?

The default settings for the door lock device. Valid values are defined by DlDefaultConfigurationRegister.

Access type: Read

val doorClosedEvents: UInt?

The number of door closed events that have occurred since it was last zeroed.

Access type: Write

val doorOpenEvents: UInt?

The number of door opened events that have occurred since it was last zeroed.

Access type: Write

val doorState: DoorLockTrait.DoorStateEnum?

The current door state as defined in DoorStateEnum.

Access type: Read

val enableInsideStatusLed: Boolean?

Enables or disables an inside LED that allows the user to see at a glance if the door is locked.

Access type: Write

val enableLocalProgramming: Boolean?

Enable or disable local programming of certain features, as enumerated in the localProgrammingFeatures attribute. When set to true, local programming is enabled on the door lock for all features. Otherwise, local programming is disabled for those features whose bit is set to 0 in the localProgrammingFeatures attribute.

Access type: Write

val enableOneTouchLocking: Boolean?

Enables or disables the ability to lock the door lock with a single touch on the door lock.

Access type: Write

val enablePrivacyModeButton: Boolean?

Enable or 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.

Access type: Write

val expiringUserTimeout: UShort?

The number of minutes a PIN, RFID, fingerprint, or other credential associated with a user of type ExpiringUser remains valid after its first use before expiring.

Access type: Write

val featureMap: DoorLockTrait.Feature

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

val generatedCommandList: List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

val language: String?

The language used for the user interface.

Access type: Write

val ledSettings: UByte?

The settings for the LED support three different modes.

• 0 - Never use LED for signalling events.
• 1 - Use LED to signal all but access-allowed events.
• 2 - Use LED to signal all events.

Access type: Write

val localProgrammingFeatures: DoorLockTrait.DlLocalProgrammingFeatures?

The local programming features that are disabled when the enableLocalProgramming attribute is set to false. Valid values are defined by DlLocalProgrammingFeatures.

Access type: Write

val lockState: DoorLockTrait.DlLockState?

Indicates the current state of the lock. Valid values are defined by DlLockState.

Access type: Read

val lockType: DoorLockTrait.DlLockType?

The type of lock. Valid values are defined by DlLockType.

Access type: Read

val maxPinCodeLength: UByte?

The maximum length in bytes of a PIN Code on this device.

Access type: Read

val maxRfidCodeLength: UByte?

The maximum length in bytes of a RFID Code on this device.

Access type: Read

val minPinCodeLength: UByte?

The minimum length in bytes of a PIN Code on this device.

Access type: Read

val minRfidCodeLength: UByte?

The minimum length in bytes of a RFID Code on this device.

Access type: Read

val numberOfCredentialsSupportedPerUser: UByte?

The number of credentials that could be assigned for each user.

Access type: Read

val numberOfHolidaySchedulesSupported: UByte?

The number of holiday schedules supported for the door lock device.

Access type: Read

val numberOfPinUsersSupported: UShort?

The number of PIN users supported.

Access type: Read

val numberOfRfidUsersSupported: UShort?

The number of RFID users supported.

Access type: Read

val numberOfTotalUsersSupported: UShort?

Number of total users supported by the lock.

Access type: Read

val numberOfWeekDaySchedulesSupportedPerUser: UByte?

The number of configurable week day schedules supported per user. Week day schedules are used to restrict access to a specified time window on certain days of the week. The schedule is repeated each week.

Access type: Read

val numberOfYearDaySchedulesSupportedPerUser: UByte?

The number of configurable year day schedules supported per user. Year day schedules are used to restrict access to a specified date and time window.

Access type: Read

val openPeriod: UShort?

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

Access type: Write

val operatingMode: DoorLockTrait.OperatingModeEnum?

The current operating mode of the lock. Valid values are defined by OperatingModeEnum.

Access type: Write

val requirePinforRemoteOperation: Boolean?

true if the door lock server requires that an optional PINs be included in the payload of remote lock operation events like Lock, Unlock, Unlock with Timeout and Toggle in order to function.

Access type: Write

val sendPinOverTheAir: Boolean?

true if it is ok for the door lock to send PINs over the air.

Access type: Write

val soundVolume: UByte?

Has one of four possible settings:

• 0 - Silent Mode
• 1 - Low Volume
• 2 - High Volume
• 3 - Medium Volume

Access type: Write

val supportedOperatingModes: DoorLockTrait.DlSupportedOperatingModes?

Indicates which operating modes are supported by the lock. Valid values are defined by DlSupportedOperatingModes.

Access type: Read

val userCodeTemporaryDisableTime: UByte?

The number of seconds that the lock shuts down following wrong code entry. The valid range is 1-255.

Access type: Write

val wrongCodeEntryLimit: UByte?

The number of incorrect credential attempts allowed before the lock enters the lockout state. The valid range is 1-255.

Access type: Write