DoorLock Cluster

Cluster ID: 0x0101  |  Endpoint: Typically on Endpoint 1 (application endpoint)

DoorLock is the core Cluster for Matter door lock devices, defining all capabilities including lock state queries, lock/unlock operations, user management, and credential (PIN code/fingerprint/NFC) management. Day-to-day development of door lock devices revolves around this Cluster.

Commands

Commands are operations sent to the door lock for execution. Most write operations require a Timed Interaction, which is a Matter security requirement for safety-critical devices like door locks. Click on a command ID in the table below to jump to its detailed description.

LockDoor — Lock (0x00)

Sends a lock command to the door lock. On successful execution, the LockState attribute changes from its current value to Locked (1). This is one of the most essential and frequently used commands for door locks.

↑ Back to Commands

UnlockDoor — Unlock (0x01)

Sends an unlock command to the door lock. On successful execution, the LockState attribute changes to Unlocked (2). Symmetric to LockDoor, this is also one of the most frequently used commands.

↑ Back to Commands

UnlockWithTimeout — Timed Unlock (0x03)

Unlocks the door lock and automatically re-locks after a specified duration. Functionally equivalent to issuing UnlockDoor followed by waiting for AutoRelockTime, but the timeout is specified by the command parameter and is not affected by the AutoRelockTime attribute.

↑ Back to Commands

SetCredential — Set Credential (0x22)

Adds or modifies a credential for a user. Credentials are the "keys" users use to unlock the door — they can be PIN codes, fingerprints, RFID cards, etc. Each credential must be bound to an existing user (created via SetUser).

↑ Back to Commands

GetCredentialStatus — Query Credential Status (0x24)

Queries whether a specific credential slot is occupied and which user it is bound to. Does not require a Timed Interaction; this is a read-only query operation.

↑ Back to Commands

ClearCredential — Delete Credential (0x26)

Deletes a specified credential. If a specific CredentialType and CredentialIndex are provided, the exact credential is removed; it can also batch-clear all credentials of a given type or all credentials entirely.

↑ Back to Commands

SetAliroReaderConfig — Configure Aliro Reader (0x28)

Configures the Aliro NFC reader's signing key, group key, supported protocol versions, and other parameters. Aliro is a new NFC tap-to-unlock standard introduced by Matter for door locks.

↑ Back to Commands

ClearAliroReaderConfig — Clear Aliro Config (0x29)

Resets all Aliro NFC reader configuration, restoring the device to an unconfigured state.

↑ Back to Commands

SetUser — Set User (0x1A)

Creates or modifies a user on the door lock. Users are "containers" for credentials — each user can have multiple bound credentials (passwords, fingerprints, etc.), and can be assigned a permission level and validity period. User management and credential management are the two most complex operations for door locks.

↑ Back to Commands

GetUser — Query User (0x1B)

Queries detailed user information by UserIndex, including name, status, type, bound credentials list, etc. Does not require a Timed Interaction.

↑ Back to Commands

ClearUser — Delete User (0x1D)

Deletes the specified user along with all associated credentials. This is a "cascading delete" operation — no additional ClearCredential calls are needed.

↑ Back to Commands

Timed Interaction Example

When sending a lock command, the request structure looks roughly like this:

{
  "timedRequest": {
    "timeoutMs": 5000       // Timeout: 5 seconds
  },
  "invokeRequests": [{
    "commandPath": {
      "endpointId": 1,       // Application endpoint
      "clusterId": "0x0101", // DoorLock
      "commandId": "0x00"    // LockDoor
    },
    "commandFields": {}      // LockDoor has no additional parameters
  }]
}

↑ Back to Commands

Attributes

The DoorLock Cluster attributes are organized into five functional groups. Click on an attribute ID in the summary table below to jump to its detailed description.

Lock Core State (0x00-0x06)

The most fundamental status information of the door lock, including lock state, lock type, actuator, and door position sensor data.

LockState Enum Values

LockType Enum Values

DoorState Enum Values

↑ Back to Attributes

Users & Credentials (0x11-0x1C)

Describes the number of users supported by the door lock, credential type capacities, and schedule capabilities.

CredentialRulesSupport Bitmap

↑ Back to Attributes

Operation & Display (0x21-0x2C)

Controls the door lock's operating behavior, display settings, and local programming features.

LEDSettings Enum Values

SoundVolume Enum Values

OperatingMode Enum Values

↑ Back to Attributes

Remote Operation (0x30-0x33)

Attributes related to remote (network/wireless) operation security policies.

↑ Back to Attributes

Aliro NFC Access (0x80-0x88)

Aliro is a new NFC tap-to-unlock standard introduced by Matter for door locks. It supports automatic unlocking when a phone is brought near the door lock, similar to the Apple digital car key experience. Managed via SetAliroReaderConfig / ClearAliroReaderConfig commands.

↑ Back to Attributes

Standard Example

Below is a typical attribute data example for a Matter door lock (JSON format), with field-by-field annotations:

{
  // --- Lock Core State ---
  "0x00": 1,           // LockState = Locked
  "0x01": 0,           // LockType = DeadBolt
  "0x02": true,        // ActuatorEnabled = true (actuator enabled)
  "0x03": 1,           // DoorState = Closed

  // --- Users & Credentials ---
  "0x11": 10,          // NumberOfTotalUsersSupported = 10
  "0x12": 10,          // NumberOfPINUsersSupported = 10
  "0x17": 8,           // MaxPINCodeLength = 8 digits
  "0x18": 4,           // MinPINCodeLength = 4 digits
  "0x1C": 5,           // NumberOfCredentialsSupportedPerUser = 5

  // --- Operation & Display ---
  "0x23": 30,          // AutoRelockTime = 30 seconds
  "0x24": 2,           // SoundVolume = High
  "0x25": 0,           // OperatingMode = Normal
  "0x26": 65535,       // SupportedOperatingModes (all modes supported)

  // --- Remote Operation ---
  "0x30": 5,           // WrongCodeEntryLimit = 5 attempts
  "0x33": false        // RequirePINforRemoteOperation = false
}

Common Scenarios

Scenario 1: Remote Lock / Unlock

1. Read ActuatorEnabled (0x02) to confirm the actuator is enabled
2. Read RequirePINforRemoteOperation (0x33) to determine if user PIN input is required
3. Send LockDoor (0x00) or UnlockDoor (0x01) command (must use Timed Interaction)
4. Subscribe to LockState (0x00) changes to confirm the operation result

Scenario 2: Add New User and PIN Code

1. Read NumberOfTotalUsersSupported (0x11) to check user capacity
2. Send SetUser (0x1A) to create the user
3. Read MinPINCodeLength (0x18) and MaxPINCodeLength (0x17) to verify PIN length requirements
4. Send SetCredential (0x22) to bind a PIN code to that user
5. Optionally use GetCredentialStatus (0x24) to verify the credential was set successfully

Scenario 3: Display Lock Status on Home Screen

1. Read LockState (0x00) — handle the null value properly
2. Read OperatingMode (0x25) — if not Normal, the UI may need to show a notice
3. Read battery level from the PowerSource Cluster alongside lock status