Variable PinCredentialNotUserComponentConst

Type declaration

• Readonlyattributes: {
      sendPinOverTheAir: OptionalWritableAttribute<boolean, any>;
  }

  • ReadonlysendPinOverTheAir: OptionalWritableAttribute<boolean, any>

    Indicates the door locks ability to send PINs over the air. If the attribute is True it is ok for the door lock server to send PINs over the air. This attribute determines the behavior of the server’s TX operation. If it is false, then it is not ok for the device to send PIN in any messages over the air.

    The PIN field within any door lock cluster message shall keep the first octet unchanged and masks the actual code by replacing with 0xFF. For example (PIN "1234" ): If the attribute value is True, 0x04 0x31 0x32 0x33 0x34 shall be used in the PIN field in any door lock cluster message payload. If the attribute value is False, 0x04 0xFF 0xFF 0xFF 0xFF shall be used.

    See

    MatterSpecification.v13.Cluster § 5.2.9.37

• Readonlycommands: {
      clearAllPinCodes: Command<void, void, any>;
      clearPinCode: Command<TypeFromFields, void, any>;
      getPinCode: Command<TypeFromFields, TypeFromFields, any>;
      setPinCode: Command<TypeFromFields, void, any>;
  }

  • ReadonlyclearAllPinCodes: Command<void, void, any>

    Clear out all PINs on the lock.

    NOTE

    On the server, the clear all PIN codes command SHOULD have the same effect as the ClearPINCode command with respect to the setting of user status, user type and schedules.

    See

    MatterSpecification.v13.Cluster § 5.2.10.10

  • ReadonlyclearPinCode: Command<TypeFromFields, void, any>

    Clear a PIN code or all PIN codes.

    † The User ID is an obsolete field name, use PINSlotIndex instead.

    For each PIN Code cleared whose user doesn’t have a RFID Code or other credential type, then corresponding user record’s UserStatus value shall be set to Available, and UserType value shall be set to UnrestrictedUser and all schedules shall be cleared.

    See

    MatterSpecification.v13.Cluster § 5.2.10.9

  • ReadonlygetPinCode: Command<TypeFromFields, TypeFromFields, any>

    Retrieve a PIN Code.

    See

    MatterSpecification.v13.Cluster § 5.2.10.7

  • ReadonlysetPinCode: Command<TypeFromFields, void, any>

    Set a PIN Code into the lock.

    Return status is a global status code or a cluster-specific status code from the Status Codes table and shall be one of the following values:

    See

    MatterSpecification.v13.Cluster § 5.2.10.6