# DoorLockTrait.Attributes

# DoorLockTrait.Attributes


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface DoorLockTrait.Attributes : ClusterStruct
```

<br />

Known direct subclasses [DoorLock](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock` | API for the DoorLock trait. |

*** ** * ** ***

Attributes for the DoorLock cluster.

## Summary

| ### Public functions |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#getDescriptor()()` Returns the descriptor for the struct. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#actuatorEnabled()` Indicates whether the lock is able to process remote Lock, Unlock, or Unlock with Timeout commands. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroBleAdvertisingVersion()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroExpeditedTransactionSupportedProtocolVersions()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroGroupResolvingKey()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroReaderGroupIdentifier()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroReaderGroupSubIdentifier()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroReaderVerificationKey()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroSupportedBleUwbProtocolVersions()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#autoRelockTime()` The number of seconds to wait after unlocking a lock before it automatically locks again. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlCredentialRuleMask?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#credentialRulesSupport()` Bitmap which indicates which credential rules are supported by the door lock. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlDefaultConfigurationRegister?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#defaultConfigurationRegister()` The default settings for the door lock device. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#doorClosedEvents()` The number of door closed events that have occurred since it was last zeroed. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#doorOpenEvents()` The number of door opened events that have occurred since it was last zeroed. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorStateEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#doorState()` The current door state as defined in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorStateEnum`. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableInsideStatusLed()` Enables or disables an inside LED that allows the user to see at a glance if the door is locked. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableLocalProgramming()` Enable or disable local programming of certain features, as enumerated in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#localProgrammingFeatures()` attribute. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableOneTouchLocking()` Enables or disables the ability to lock the door lock with a single touch on the door lock. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enablePrivacyModeButton()` Enable or disable a button inside the door that is used to put the lock into privacy mode. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#expiringUserTimeout()` 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. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#language()` The language used for the user interface. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#ledSettings()` The settings for the LED support three different modes. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLocalProgrammingFeatures?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#localProgrammingFeatures()` The local programming features that are disabled when the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableLocalProgramming()` attribute is set to `false`. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLockState?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#lockState()` Indicates the current state of the lock. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLockType?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#lockType()` The type of lock. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#maxPinCodeLength()` The maximum length in bytes of a PIN Code on this device. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#maxRfidCodeLength()` The maximum length in bytes of a RFID Code on this device. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#minPinCodeLength()` The minimum length in bytes of a PIN Code on this device. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#minRfidCodeLength()` The minimum length in bytes of a RFID Code on this device. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfAliroCredentialIssuerKeysSupported()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfAliroEndpointKeysSupported()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfCredentialsSupportedPerUser()` The number of credentials that could be assigned for each user. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfHolidaySchedulesSupported()` The number of holiday schedules supported for the door lock device. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfPinUsersSupported()` The number of PIN users supported. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfRfidUsersSupported()` The number of RFID users supported. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfTotalUsersSupported()` Number of total users supported by the lock. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfWeekDaySchedulesSupportedPerUser()` The number of configurable week day schedules supported per user. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfYearDaySchedulesSupportedPerUser()` The number of configurable year day schedules supported per user. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#openPeriod()` This attribute holds the number of minutes the door has been open since the last time it transitioned from closed to open. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#operatingMode()` The current operating mode of the lock. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#requirePinforRemoteOperation()` `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. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#sendPinOverTheAir()` `true` if it is ok for the door lock to send PINs over the air. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#soundVolume()` Has one of four possible settings: - `0` - Silent Mode - `1` - Low Volume - `2` - High Volume - `3` - Medium Volume <br /> |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlSupportedOperatingModes?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#supportedOperatingModes()` Indicates which operating modes are supported by the lock. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#userCodeTemporaryDisableTime()` The number of seconds that the lock shuts down following wrong code entry. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#wrongCodeEntryLimit()` The number of incorrect credential attempts allowed before the lock enters the lockout state. |

## Public functions

### getDescriptor

```
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
```

Returns the descriptor for the struct.

### getFieldValueById

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

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

## Public properties

### acceptedCommandList

```
val acceptedCommandList: List<UInt>
```

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

### actuatorEnabled

```
val actuatorEnabled: Boolean?
```

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

**Access type:** Read

### aliroBleAdvertisingVersion

```
val aliroBleAdvertisingVersion: UByte?
```

### aliroExpeditedTransactionSupportedProtocolVersions

```
val aliroExpeditedTransactionSupportedProtocolVersions: List<ByteArray>?
```

### aliroGroupResolvingKey

```
val aliroGroupResolvingKey: ByteArray?
```

### aliroReaderGroupIdentifier

```
val aliroReaderGroupIdentifier: ByteArray?
```

### aliroReaderGroupSubIdentifier

```
val aliroReaderGroupSubIdentifier: ByteArray?
```

### aliroReaderVerificationKey

```
val aliroReaderVerificationKey: ByteArray?
```

### aliroSupportedBleUwbProtocolVersions

```
val aliroSupportedBleUwbProtocolVersions: List<ByteArray>?
```

### attributeList

```
val attributeList: List<UInt>
```

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

### autoRelockTime

```
val autoRelockTime: UInt?
```

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

**Access type:** Write

### clusterRevision

```
val clusterRevision: UShort
```

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

### credentialRulesSupport

```
val credentialRulesSupport: DoorLockTrait.DlCredentialRuleMask?
```

Bitmap which indicates which credential rules are supported by the door lock. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlCredentialRuleMask`.

**Access type:** Read

### defaultConfigurationRegister

```
val defaultConfigurationRegister: DoorLockTrait.DlDefaultConfigurationRegister?
```

The default settings for the door lock device. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlDefaultConfigurationRegister`.

**Access type:** Read

### doorClosedEvents

```
val doorClosedEvents: UInt?
```

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

**Access type:** Write

### doorOpenEvents

```
val doorOpenEvents: UInt?
```

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

**Access type:** Write

### doorState

```
val doorState: DoorLockTrait.DoorStateEnum?
```

The current door state as defined in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorStateEnum`.

**Access type:** Read

### enableInsideStatusLed

```
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

### enableLocalProgramming

```
val enableLocalProgramming: Boolean?
```

Enable or disable local programming of certain features, as enumerated in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#localProgrammingFeatures()` attribute.

**Access type:** Write

### enableOneTouchLocking

```
val enableOneTouchLocking: Boolean?
```

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

**Access type:** Write

### enablePrivacyModeButton

```
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

### expiringUserTimeout

```
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

### featureMap

```
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).

### generatedCommandList

```
val generatedCommandList: List<UInt>
```

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

### language

```
val language: String?
```

The language used for the user interface.

**Access type:** Write

### ledSettings

```
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.

<br />

**Access type:** Write

### localProgrammingFeatures

```
val localProgrammingFeatures: DoorLockTrait.DlLocalProgrammingFeatures?
```

The local programming features that are disabled when the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableLocalProgramming()` attribute is set to `false`. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLocalProgrammingFeatures`.

**Access type:** Write

### lockState

```
val lockState: DoorLockTrait.DlLockState?
```

Indicates the current state of the lock. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLockState`.

**Access type:** Read

### lockType

```
val lockType: DoorLockTrait.DlLockType?
```

The type of lock. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLockType`.

**Access type:** Read

### maxPinCodeLength

```
val maxPinCodeLength: UByte?
```

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

**Access type:** Read

### maxRfidCodeLength

```
val maxRfidCodeLength: UByte?
```

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

**Access type:** Read

### minPinCodeLength

```
val minPinCodeLength: UByte?
```

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

**Access type:** Read

### minRfidCodeLength

```
val minRfidCodeLength: UByte?
```

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

**Access type:** Read

### numberOfAliroCredentialIssuerKeysSupported

```
val numberOfAliroCredentialIssuerKeysSupported: UShort?
```

### numberOfAliroEndpointKeysSupported

```
val numberOfAliroEndpointKeysSupported: UShort?
```

### numberOfCredentialsSupportedPerUser

```
val numberOfCredentialsSupportedPerUser: UByte?
```

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

**Access type:** Read

### numberOfHolidaySchedulesSupported

```
val numberOfHolidaySchedulesSupported: UByte?
```

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

**Access type:** Read

### numberOfPinUsersSupported

```
val numberOfPinUsersSupported: UShort?
```

The number of PIN users supported.

**Access type:** Read

### numberOfRfidUsersSupported

```
val numberOfRfidUsersSupported: UShort?
```

The number of RFID users supported.

**Access type:** Read

### numberOfTotalUsersSupported

```
val numberOfTotalUsersSupported: UShort?
```

Number of total users supported by the lock.

**Access type:** Read

### numberOfWeekDaySchedulesSupportedPerUser

```
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

### numberOfYearDaySchedulesSupportedPerUser

```
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

### openPeriod

```
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

### operatingMode

```
val operatingMode: DoorLockTrait.OperatingModeEnum?
```

The current operating mode of the lock. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum`.

**Access type:** Write

### requirePinforRemoteOperation

```
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

### sendPinOverTheAir

```
val sendPinOverTheAir: Boolean?
```

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

**Access type:** Write

### soundVolume

```
val soundVolume: UByte?
```

Has one of four possible settings:

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

<br />

**Access type:** Write

### supportedOperatingModes

```
val supportedOperatingModes: DoorLockTrait.DlSupportedOperatingModes?
```

Indicates which operating modes are supported by the lock. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlSupportedOperatingModes`.

**Access type:** Read

### userCodeTemporaryDisableTime

```
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

### wrongCodeEntryLimit

```
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