Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      identifyTime: WritableAttribute<number, any>;
      identifyType: Attribute<Identify.IdentifyType, any>;
  }

  • ReadonlyidentifyTime: WritableAttribute<number, any>

    This attribute specifies the remaining length of time, in seconds, that the endpoint will continue to identify itself.

    If this attribute is set to a value other than 0 then the device shall enter its identification state, in order to indicate to an observer which of several nodes and/or endpoints it is. It is recommended that this state consists of flashing a light with a period of 0.5 seconds. The IdentifyTime attribute shall be decremented every second while in this state.

    If this attribute reaches or is set to the value 0 then the device shall terminate its identification state.

    See

    MatterSpecification.v13.Cluster § 1.2.5.1

  • ReadonlyidentifyType: Attribute<Identify.IdentifyType, any>

    This attribute specifies how the identification state is presented to the user.

    This field shall contain one of the values defined in IdentifyTypeEnum. The value None shall NOT be used if the device is capable of presenting its identification state using one of the other methods defined in IdentifyTypeEnum.

    See

    MatterSpecification.v13.Cluster § 1.2.5.2

• Readonlycommands: {
      identify: Command<TypeFromFields<{
          identifyTime: FieldType<number>;
      }>, void, any>;
      triggerEffect: OptionalCommand<TypeFromFields<{
          effectIdentifier: FieldType<Identify.EffectIdentifier>;
          effectVariant: FieldType<Default>;
      }>, void, any>;
  }

  • Readonlyidentify: Command<TypeFromFields<{
        identifyTime: FieldType<number>;
    }>, void, any>

    This command starts or stops the receiving device identifying itself.

    See

    MatterSpecification.v13.Cluster § 1.2.6.1

  • ReadonlytriggerEffect: OptionalCommand<TypeFromFields<{
        effectIdentifier: FieldType<Identify.EffectIdentifier>;
        effectVariant: FieldType<Default>;
    }>, void, any>

    This command allows the support of feedback to the user, such as a certain light effect. It is used to allow an implementation to provide visual feedback to the user under certain circumstances such as a color light turning green when it has successfully connected to a network. The use of this command and the effects themselves are entirely up to the implementer to use whenever a visual feedback is useful but it is not the same as and does not replace the identify mechanism used during commissioning.

    See

    MatterSpecification.v13.Cluster § 1.2.6.2

• Readonlyid: 3

• Readonlyname: "Identify"

• Readonlyrevision: 4