Variable CompleteInstanceConst

Type declaration

• Readonlyattributes: {
      acceptedCommandList: Attribute<CommandId[], never>;
      attributeList: Attribute<AttributeId[], never>;
      clusterRevision: Attribute<number, never>;
      currentMode: Attribute<number, any>;
      featureMap: Attribute<TypeFromPartialBitSchema<{
          onOff: BitFlag;
      }>, never>;
      generatedCommandList: Attribute<CommandId[], never>;
      onMode: WritableAttribute<null | number, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              onOff: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      startUpMode: OptionalWritableAttribute<null | number, any>;
      supportedModes: FixedAttribute<TypeFromFields<{
          label: FieldType<string>;
          mode: FieldType<number>;
          modeTags: FieldType<TypeFromFields<{
              mfgCode: ...;
              value: ...;
          }>[]>;
      }>[], any>;
  }

  • ReadonlyacceptedCommandList: Attribute<CommandId[], never>

    List of client generated commands which are supported by this cluster server instance.

  • ReadonlyattributeList: Attribute<AttributeId[], never>

    List of the attribute IDs of the attributes supported by the cluster instance.

  • ReadonlyclusterRevision: Attribute<number, never>

    Indicates the revision of the server cluster specification supported by the cluster instance.

  • ReadonlycurrentMode: Attribute<number, any>

    Indicates the current mode of the server.

    The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.

    The value of this attribute may change at any time via an out-of-band interaction outside of the server, such as interactions with a user interface, via internal mode changes due to autonomously progressing through a sequence of operations, on system time-outs or idle delays, or via interactions coming from a fabric other than the one which last executed a ChangeToMode.

    See

    MatterSpecification.v13.Cluster § 1.10.6.3

  • ReadonlyfeatureMap: Attribute<TypeFromPartialBitSchema<{
        onOff: BitFlag;
    }>, never>

    Indicates whether the server supports zero or more optional cluster features.

  • ReadonlygeneratedCommandList: Attribute<CommandId[], never>

    List of server generated commands (server to client commands).

  • ReadonlyonMode: WritableAttribute<null | number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            onOff: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlystartUpMode: OptionalWritableAttribute<null | number, any>

    Indicates the desired startup mode for the server when it is supplied with power.

    If this attribute is not null, the CurrentMode attribute shall be set to the StartUpMode value, when the server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute (see OnModeWithPowerUp).

    This behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode attribute shall return to its value prior to the restart.

    The value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.

    If this attribute is not implemented, or is set to the null value, it shall have no effect.

    See

    MatterSpecification.v13.Cluster § 1.10.6.4

  • ReadonlysupportedModes: FixedAttribute<TypeFromFields<{
        label: FieldType<string>;
        mode: FieldType<number>;
        modeTags: FieldType<TypeFromFields<{
            mfgCode: ...;
            value: ...;
        }>[]>;
    }>[], any>

    This attribute shall contain the list of supported modes that may be selected for the CurrentMode attribute. Each item in this list represents a unique mode as indicated by the Mode field of the ModeOptionStruct.

    Each entry in this list shall have a unique value for the Mode field. Each entry in this list shall have a unique value for the Label field.

    See

    MatterSpecification.v13.Cluster § 1.10.6.2

• Readonlycommands: {
      changeToMode: Command<TypeFromFields<{
          newMode: FieldType<number>;
      }>, void, any>;
  }

  • ReadonlychangeToMode: Command<TypeFromFields<{
        newMode: FieldType<number>;
    }>, void, any>

    This command is used to change device modes.

    On receipt of this command the device shall respond with a ChangeToModeResponse command.

    See

    MatterSpecification.v13.Cluster § 1.10.7.1

• Readonlyfeatures: {
      onOff: BitFlag;
  }

  • ReadonlyonOff: BitFlag

    OnOff

    This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same endpoint. See OnMode for more information.

    See

    MatterSpecification.v13.Cluster § 1.10.4.1

• Readonlyid: Branded<157, "ClusterId">

• Readonlyname: "EnergyEvseMode"

• Readonlyrevision: 1