Interface SetPinCodeRequest

Input to the DoorLock setPinCode command

MatterSpecification.v13.Cluster § 5.2.10.6

interface SetPinCodeRequest {
    pin: Uint8Array;
    userId: number;
    userStatus: null | DoorLock.UserStatus;
    userType: null | DoorLock.UserType;
}

Properties

pin: Uint8Array

userId: number

This field shall indicate the user ID. The value of the UserID field shall be between 0 and the value of the NumberOfPINUsersSupported attribute.

MatterSpecification.v13.Cluster § 5.2.10.6.1

userStatus: null | DoorLock.UserStatus

This field shall indicate the user status. Only the values 1 (Occupied/Enabled) and 3 (Occupied/Disabled) are allowed for UserStatus.

MatterSpecification.v13.Cluster § 5.2.10.6.2

userType: null | DoorLock.UserType