Interface SetCredentialRequest

Input to the DoorLock setCredential command

See

MatterSpecification.v13.Cluster § 5.2.10.40

interface SetCredentialRequest {
    credential: TypeFromFields<{
        credentialIndex: FieldType<number>;
        credentialType: FieldType<DoorLock.CredentialType>;
    }>;
    credentialData: Uint8Array;
    operationType: DoorLock.DataOperationType;
    userIndex: null | number;
    userStatus: null | DoorLock.UserStatus;
    userType: null | DoorLock.UserType;
}

Hierarchy (view full)

Properties

credential credentialData operationType userIndex userStatus userType

Properties

credential

credential: TypeFromFields<{
    credentialIndex: FieldType<number>;
    credentialType: FieldType<DoorLock.CredentialType>;
}>

This field shall contain a credential structure that contains the CredentialTypeEnum and the credential index (if applicable or 0 if not) to set.

Type declaration

  • credentialIndex: FieldType<number>

    This field shall indicate the index of the specific credential used to authorize the lock operation in the list of credentials identified by CredentialType (e.g. PIN, RFID, etc.). This field shall be set to 0 if CredentialType is ProgrammingPIN or does not correspond to a list that can be indexed into.

    See

    MatterSpecification.v13.Cluster § 5.2.6.26.2

  • credentialType: FieldType<DoorLock.CredentialType>

    This field shall indicate the credential field used to authorize the lock operation.

    See

    MatterSpecification.v13.Cluster § 5.2.6.26.1

See

MatterSpecification.v13.Cluster § 5.2.10.40.2

credentialData

credentialData: Uint8Array

This field shall indicate the credential data to set for the credential being added or modified. The length of the credential data shall conform to the limits of the CredentialType specified in the Credential structure otherwise an INVALID_COMMAND status shall be returned in the SetCredentialResponse command.

See

MatterSpecification.v13.Cluster § 5.2.10.40.3

operationType

operationType: DoorLock.DataOperationType

This field shall indicate the set credential operation type requested.

See

MatterSpecification.v13.Cluster § 5.2.10.40.1

userIndex

userIndex: null | number

This field shall indicate the user index to the user record that corresponds to the credential being added or modified. This shall be null if OperationType is add and a new credential and user is being added at the same time.

See

MatterSpecification.v13.Cluster § 5.2.10.40.4

userStatus

userStatus: null | DoorLock.UserStatus

This field shall indicate the user status to use in the new user record if a new user is being created. This shall be null if OperationType is Modify. This may be null when adding a new credential and user.

See

MatterSpecification.v13.Cluster § 5.2.10.40.5

userType

userType: null | DoorLock.UserType

This field shall indicate the user type to use in the new user record if a new user is being created. This shall be null if OperationType is Modify. This may be null when adding a new credential and user.

See

MatterSpecification.v13.Cluster § 5.2.10.40.6

Settings

Member Visibility

On This Page

Properties