Variable ClusterInstanceConst

ClusterInstance: MutableCluster<{
    attributes: {
        currentMode: Attribute<number, any>;
        startUpMode: OptionalWritableAttribute<number | null, any>;
        supportedModes: FixedAttribute<.[], any>;
    };
    commands: {
        changeToMode: Command<., void, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                onMode: WritableAttribute<number | null, any>;
            };
        };
        flags: {
            onOff: true;
        };
    }];
    features: {
        onOff: BitFlag;
    };
    id: 73;
    name: "OvenMode";
    revision: 1;
}, []>

Type declaration

  • Readonlyattributes: {
        currentMode: Attribute<number, any>;
        startUpMode: OptionalWritableAttribute<number | null, any>;
        supportedModes: FixedAttribute<.[], any>;
    }
    • 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

    • ReadonlystartUpMode: OptionalWritableAttribute<number | null, 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<.[], 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<., void, any>;
    }
    • ReadonlychangeToMode: Command<., 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

  • Readonlyextensions: readonly [{
        component: {
            attributes: {
                onMode: WritableAttribute<number | null, any>;
            };
        };
        flags: {
            onOff: true;
        };
    }]

    This metadata controls which OvenModeCluster elements matter.js activates for specific feature combinations.

  • 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: 73
  • Readonlyname: "OvenMode"
  • Readonlyrevision: 1

See

Cluster

Settings

Member Visibility