Interface Base

interface Base {
    lockDoor(request: DoorLock.LockDoorRequest): MaybePromise;
    unlockDoor(request: DoorLock.UnlockDoorRequest): MaybePromise;
    unlockWithTimeout(request: DoorLock.UnlockWithTimeoutRequest): MaybePromise;
}

Methods

lockDoor unlockDoor unlockWithTimeout

Methods

lockDoor

  • lockDoor(request): MaybePromise

  • This command causes the lock device to lock the door. This command includes an optional code for the lock. The door lock may require a PIN depending on the value of the RequirePINForRemoteOperation attribute.

    † The PIN/RFID Code is an obsolete field name, use PINCode instead.

    Parameters

    Returns MaybePromise

    See

    MatterSpecification.v13.Cluster § 5.2.10.1

unlockDoor

  • unlockDoor(request): MaybePromise

  • This command causes the lock device to unlock the door. This command includes an optional code for the lock. The door lock may require a code depending on the value of the RequirePINForRemoteOperation attribute.

    NOTE

    If the attribute AutoRelockTime is supported the lock will transition to the locked state when the auto relock time has expired.

    † The PIN/RFID Code is an obsolete field name, use PINCode instead.

    Parameters

    Returns MaybePromise

    See

    MatterSpecification.v13.Cluster § 5.2.10.2

unlockWithTimeout

  • unlockWithTimeout(request): MaybePromise

  • This command causes the lock device to unlock the door with a timeout parameter. After the time in seconds specified in the timeout field, the lock device will relock itself automatically. This timeout parameter is only temporary for this message transition and overrides the default relock time

    as specified in the AutoRelockTime attribute. If the door lock device is not capable of or does not want to support temporary Relock Timeout, it SHOULD NOT support this optional command.

    † The PIN/RFID Code is an obsolete field name, use PINCode instead.

    Parameters

    Returns MaybePromise

    See

    MatterSpecification.v13.Cluster § 5.2.10.3

Settings

Member Visibility

On This Page

Methods