Interface MicrowaveOvenDevice

This defines conformance to the Microwave Oven device type.

A Microwave Oven is a device with the primary function of heating foods and beverages using a magnetron.

MicrowaveOvenDevice requires MicrowaveOvenControl cluster but MicrowaveOvenControl is not added by default because you must select the features your device supports. You can add manually using MicrowaveOvenDevice.with().

See

MatterSpecification.v13.Device § 13.11

interface MicrowaveOvenDevice {
    behaviors: {
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    };
    defaults: StateOf<{
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "MicrowaveOven";
    requirements: typeof MicrowaveOvenRequirements;
    set(defaults: InputStateOf<{
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    }>): With<For<{
        behaviors: {
            operationalState: Type<WithAlterations<OperationalState.Cluster, {
                attributes: {
                    countdownTime: {
                        optional: false;
                    };
                };
            }>, typeof OperationalStateServer, OperationalStateInterface>;
        } & {
            microwaveOvenMode: typeof MicrowaveOvenModeServer;
        };
        deviceRevision: 1;
        deviceType: 121;
        name: "MicrowaveOven";
        requirements: typeof MicrowaveOvenRequirements;
    }>, {
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            operationalState: Type<WithAlterations<OperationalState.Cluster, {
                attributes: {
                    countdownTime: {
                        optional: false;
                    };
                };
            }>, typeof OperationalStateServer, OperationalStateInterface>;
        } & {
            microwaveOvenMode: typeof MicrowaveOvenModeServer;
        };
        deviceRevision: 1;
        deviceType: 121;
        name: "MicrowaveOven";
        requirements: typeof MicrowaveOvenRequirements;
    }>, With<{
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    }, BL>>;
}

Hierarchy (view full)

Identity<typeof MicrowaveOvenDeviceDefinition>
- MicrowaveOvenDevice

Index

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    operationalState: Type<WithAlterations<OperationalState.Cluster, {
        attributes: {
            countdownTime: {
                optional: false;
            };
        };
    }>, typeof OperationalStateServer, OperationalStateInterface>;
} & {
    microwaveOvenMode: typeof MicrowaveOvenModeServer;
}

defaults

defaults: StateOf<{
    operationalState: Type<WithAlterations<OperationalState.Cluster, {
        attributes: {
            countdownTime: {
                optional: false;
            };
        };
    }>, typeof OperationalStateServer, OperationalStateInterface>;
} & {
    microwaveOvenMode: typeof MicrowaveOvenModeServer;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

requirements

requirements: typeof MicrowaveOvenRequirements

Methods

set

set(defaults): With<For<{
    behaviors: {
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    };
    deviceRevision: 1;
    deviceType: 121;
    name: "MicrowaveOven";
    requirements: typeof MicrowaveOvenRequirements;
}>, {
    operationalState: Type<WithAlterations<OperationalState.Cluster, {
        attributes: {
            countdownTime: {
                optional: false;
            };
        };
    }>, typeof OperationalStateServer, OperationalStateInterface>;
} & {
    microwaveOvenMode: typeof MicrowaveOvenModeServer;
}>
Define an endpoint like this one with different defaults. Only updates values present in the input object.
Parameters
- defaults: InputStateOf<{
      operationalState: Type<WithAlterations<OperationalState.Cluster, {
          attributes: {
              countdownTime: {
                  optional: false;
              };
          };
      }>, typeof OperationalStateServer, OperationalStateInterface>;
  } & {
      microwaveOvenMode: typeof MicrowaveOvenModeServer;
  }>
Returns With<For<{
    behaviors: {
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    };
    deviceRevision: 1;
    deviceType: 121;
    name: "MicrowaveOven";
    requirements: typeof MicrowaveOvenRequirements;
}>, {
    operationalState: Type<WithAlterations<OperationalState.Cluster, {
        attributes: {
            countdownTime: {
                optional: false;
            };
        };
    }>, typeof OperationalStateServer, OperationalStateInterface>;
} & {
    microwaveOvenMode: typeof MicrowaveOvenModeServer;
}>
Inherited from Identity.set
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:94

with

with<const BL>(...behaviors): With<For<{
    behaviors: {
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    };
    deviceRevision: 1;
    deviceType: 121;
    name: "MicrowaveOven";
    requirements: typeof MicrowaveOvenRequirements;
}>, With<{
    operationalState: Type<WithAlterations<OperationalState.Cluster, {
        attributes: {
            countdownTime: {
                optional: false;
            };
        };
    }>, typeof OperationalStateServer, OperationalStateInterface>;
} & {
    microwaveOvenMode: typeof MicrowaveOvenModeServer;
}, BL>>
Define an endpoint like this one with additional and/or replacement server behaviors.
Type Parameters
- const BL extends List
Parameters
- Rest...behaviors: BL
Returns With<For<{
    behaviors: {
        operationalState: Type<WithAlterations<OperationalState.Cluster, {
            attributes: {
                countdownTime: {
                    optional: false;
                };
            };
        }>, typeof OperationalStateServer, OperationalStateInterface>;
    } & {
        microwaveOvenMode: typeof MicrowaveOvenModeServer;
    };
    deviceRevision: 1;
    deviceType: 121;
    name: "MicrowaveOven";
    requirements: typeof MicrowaveOvenRequirements;
}>, With<{
    operationalState: Type<WithAlterations<OperationalState.Cluster, {
        attributes: {
            countdownTime: {
                optional: false;
            };
        };
    }>, typeof OperationalStateServer, OperationalStateInterface>;
} & {
    microwaveOvenMode: typeof MicrowaveOvenModeServer;
}, BL>>
Inherited from Identity.with
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:99

Interface MicrowaveOvenDevice

See

Hierarchy (view full)

Index

Properties

Methods

Properties

behaviors

defaults

deviceClass

deviceRevision

deviceType

name

requirements

Methods

set

Parameters

with

Type Parameters

Parameters

Settings

On This Page