Variable ClusterInstanceConst

ClusterInstance: MutableCluster<{
    attributes: {
        currentMode: Attribute<number, any>;
        description: FixedAttribute<string, any>;
        standardNamespace: FixedAttribute<number | null, any>;
        startUpMode: OptionalWritableAttribute<number | null, any>;
        supportedModes: FixedAttribute<TypeFromFields[], any>;
    };
    commands: {
        changeToMode: Command<TypeFromFields, void, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                onMode: WritableAttribute<number | null, any>;
            };
        };
        flags: {
            onOff: true;
        };
    }];
    features: {
        onOff: BitFlag;
    };
    id: 80;
    name: "ModeSelect";
    revision: 2;
}, []>

Type declaration

  • Readonlyattributes: {
        currentMode: Attribute<number, any>;
        description: FixedAttribute<string, any>;
        standardNamespace: FixedAttribute<number | null, any>;
        startUpMode: OptionalWritableAttribute<number | null, any>;
        supportedModes: FixedAttribute<TypeFromFields[], any>;
    }
    • ReadonlycurrentMode: Attribute<number, any>

      This attribute represents the current mode of the server.

      The value of this field must match the Mode field of one of the entries in the SupportedModes

      attribute.

      See

      MatterSpecification.v13.Cluster § 1.9.6.5

    • Readonlydescription: FixedAttribute<string, any>

      This attribute describes the purpose of the server, in readable text.

      For example, a coffee machine may have a Mode Select cluster for the amount of milk to add, and another Mode Select cluster for the amount of sugar to add. In this case, the first instance can have the description Milk and the second instance can have the description Sugar. This allows the user to tell the purpose of each of the instances.

      See

      MatterSpecification.v13.Cluster § 1.9.6.2

    • ReadonlystandardNamespace: FixedAttribute<number | null, any>

      This attribute, when not null, shall indicate a single standard namespace for any standard semantic tag value supported in this or any other cluster instance with the same value of this attribute. A

      null value indicates no standard namespace, and therefore, no standard semantic tags are provided in this cluster instance. Each standard namespace and corresponding values and value meanings shall be defined in another document.

      See

      MatterSpecification.v13.Cluster § 1.9.6.3

    • ReadonlystartUpMode: OptionalWritableAttribute<number | null, any>

      The StartUpMode attribute value 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.9.6.6

    • ReadonlysupportedModes: FixedAttribute<TypeFromFields[], any>

      This attribute is 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.

      See

      MatterSpecification.v13.Cluster § 1.9.6.4

  • Readonlycommands: {
        changeToMode: Command<TypeFromFields, void, any>;
    }
    • ReadonlychangeToMode: Command<TypeFromFields, void, any>

      On receipt of this command, if the NewMode field indicates a valid mode transition within the supported list, the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall respond with an INVALID_COMMAND status response.

      See

      MatterSpecification.v13.Cluster § 1.9.7.1

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

    This metadata controls which ModeSelectCluster 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.9.4.1

  • Readonlyid: 80
  • Readonlyname: "ModeSelect"
  • Readonlyrevision: 2

See

Cluster

Settings

Member Visibility