Interface Cluster

This cluster is derived from the Mode Base cluster, defining additional mode tags and namespaced enumerated values for oven devices.

OvenModeCluster supports optional features that you can enable with the OvenModeCluster.with() factory method.

See

MatterSpecification.v13.Cluster § 8.11

interface Cluster {
    attributes: Merge<{
        currentMode: Attribute<number, any>;
        startUpMode: OptionalWritableAttribute<null | number, any>;
        supportedModes: FixedAttribute<TypeFromFields<{
            label: FieldType<string>;
            mode: FieldType<number>;
            modeTags: FieldType<TypeFromFields<{
                mfgCode: OptionalFieldType<(...)>;
                value: FieldType<(...)>;
            }>[]>;
        }>[], any>;
    }, GlobalAttributes<{
        onOff: BitFlag;
    }>>;
    base: undefined;
    commands: {
        changeToMode: Command<TypeFromFields<{
            newMode: FieldType<number>;
        }>, void, any>;
    };
    events: {};
    extensions: readonly [{
        component: {
            attributes: {
                onMode: WritableAttribute<null | number, any>;
            };
        };
        flags: {
            onOff: true;
        };
    }];
    features: {
        onOff: BitFlag;
    };
    id: Branded<73, "ClusterId">;
    name: "OvenMode";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    currentMode: Attribute<number, any>;
    startUpMode: OptionalWritableAttribute<null | number, any>;
    supportedModes: FixedAttribute<TypeFromFields<{
        label: FieldType<string>;
        mode: FieldType<number>;
        modeTags: FieldType<TypeFromFields<{
            mfgCode: OptionalFieldType<(...)>;
            value: FieldType<(...)>;
        }>[]>;
    }>[], any>;
}, GlobalAttributes<{
    onOff: BitFlag;
}>>

Type declaration

  • 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<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: OptionalFieldType<(...)>;
            value: FieldType<(...)>;
        }>[]>;
    }>[], 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

base

base: undefined

commands

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

Type declaration

  • 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

events

events: {}

extensions

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

features

features: {
    onOff: BitFlag;
}

Type declaration

  • 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

id

id: Branded<73, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          attributes: {
              currentMode: Attribute<number, any>;
              startUpMode: OptionalWritableAttribute<null | number, any>;
              supportedModes: FixedAttribute<TypeFromFields<{
                  label: FieldType<string>;
                  mode: FieldType<number>;
                  modeTags: FieldType<TypeFromFields<(...)>[]>;
              }>[], any>;
          };
          commands: {
              changeToMode: Command<TypeFromFields<{
                  newMode: FieldType<number>;
              }>, void, any>;
          };
          extensions: readonly [{
              component: {
                  attributes: {
                      onMode: WritableAttribute<null | number, any>;
                  };
              };
              flags: {
                  onOff: true;
              };
          }];
          features: {
              onOff: BitFlag;
          };
          id: 73;
          name: "OvenMode";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              currentMode: Attribute<number, any>;
              startUpMode: OptionalWritableAttribute<null | number, any>;
              supportedModes: FixedAttribute<TypeFromFields<{
                  label: FieldType<string>;
                  mode: FieldType<number>;
                  modeTags: FieldType<TypeFromFields<(...)>[]>;
              }>[], any>;
          };
          commands: {
              changeToMode: Command<TypeFromFields<{
                  newMode: FieldType<number>;
              }>, void, any>;
          };
          extensions: readonly [{
              component: {
                  attributes: {
                      onMode: WritableAttribute<null | number, any>;
                  };
              };
              flags: {
                  onOff: true;
              };
          }];
          features: {
              onOff: BitFlag;
          };
          id: 73;
          name: "OvenMode";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          currentMode: number;
          startUpMode?: null | number;
          supportedModes: {
              label: string;
              mode: number;
              modeTags: {
                  mfgCode?: number;
                  value: number;
              }[];
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              currentMode: Attribute<number, any>;
              startUpMode: OptionalWritableAttribute<null | number, any>;
              supportedModes: FixedAttribute<TypeFromFields<{
                  label: FieldType<string>;
                  mode: FieldType<number>;
                  modeTags: FieldType<TypeFromFields<(...)>[]>;
              }>[], any>;
          };
          commands: {
              changeToMode: Command<TypeFromFields<{
                  newMode: FieldType<number>;
              }>, void, any>;
          };
          extensions: readonly [{
              component: {
                  attributes: {
                      onMode: WritableAttribute<null | number, any>;
                  };
              };
              flags: {
                  onOff: true;
              };
          }];
          features: {
              onOff: BitFlag;
          };
          id: 73;
          name: "OvenMode";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            currentMode: Attribute<number, any>;
            startUpMode: OptionalWritableAttribute<null | number, any>;
            supportedModes: FixedAttribute<TypeFromFields<{
                label: FieldType<string>;
                mode: FieldType<number>;
                modeTags: FieldType<TypeFromFields<(...)>[]>;
            }>[], any>;
        };
        commands: {
            changeToMode: Command<TypeFromFields<{
                newMode: FieldType<number>;
            }>, void, any>;
        };
        extensions: readonly [{
            component: {
                attributes: {
                    onMode: WritableAttribute<null | number, any>;
                };
            };
            flags: {
                onOff: true;
            };
        }];
        features: {
            onOff: BitFlag;
        };
        id: 73;
        name: "OvenMode";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods