Interface ExtractorHoodDevice

An Extractor Hood is a device that is generally installed above a cooking surface in residential kitchens. An Extractor Hood’s primary purpose is to reduce odors that arise during the cooking process by either extracting the air above the cooking surface or by recirculating and filtering it. It may also contain a light for illuminating the cooking surface.

Extractor Hoods may also be known by the following names:

• Hoods

• Extractor Fans

• Extractors

• Range Hoods

• Telescoping Hoods

• Telescoping Extractors

See

MatterSpecification.v13.Device § 13.10

interface ExtractorHoodDevice {
    behaviors: {
        fanControl: typeof FanControlServer;
    };
    defaults: StateOf<{
        fanControl: typeof FanControlServer;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
    set(defaults: InputStateOf<{
        fanControl: typeof FanControlServer;
    }>): With<For<{
        behaviors: {
            fanControl: typeof FanControlServer;
        };
        deviceRevision: 1;
        deviceType: 122;
        name: "ExtractorHood";
        requirements: typeof ExtractorHoodRequirements;
    }>, {
        fanControl: typeof FanControlServer;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            fanControl: typeof FanControlServer;
        };
        deviceRevision: 1;
        deviceType: 122;
        name: "ExtractorHood";
        requirements: typeof ExtractorHoodRequirements;
    }>, With<{
        fanControl: typeof FanControlServer;
    }, BL>>;
}

Hierarchy (view full)

Identity<typeof ExtractorHoodDeviceDefinition>
- ExtractorHoodDevice

Index

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
fanControl: typeof FanControlServer;
}

defaults

defaults: StateOf<{
fanControl: typeof FanControlServer;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

requirements

requirements: typeof ExtractorHoodRequirements

Methods

set

set(defaults): With<For<{
    behaviors: {
        fanControl: typeof FanControlServer;
    };
    deviceRevision: 1;
    deviceType: 122;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
}>, {
    fanControl: typeof FanControlServer;
}>
Define an endpoint like this one with different defaults. Only updates values present in the input object.
Parameters
- defaults: InputStateOf<{
  fanControl: typeof FanControlServer;
  }>
Returns With<For<{
    behaviors: {
        fanControl: typeof FanControlServer;
    };
    deviceRevision: 1;
    deviceType: 122;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
}>, {
    fanControl: typeof FanControlServer;
}>
Inherited from Identity.set
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:94

with

with<const BL>(...behaviors): With<For<{
    behaviors: {
        fanControl: typeof FanControlServer;
    };
    deviceRevision: 1;
    deviceType: 122;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
}>, With<{
    fanControl: typeof FanControlServer;
}, 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: {
        fanControl: typeof FanControlServer;
    };
    deviceRevision: 1;
    deviceType: 122;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
}>, With<{
    fanControl: typeof FanControlServer;
}, BL>>
Inherited from Identity.with
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:99

Interface ExtractorHoodDevice

See

Hierarchy (view full)

Index

Properties

Methods

Properties

behaviors

defaults

deviceClass

deviceRevision

deviceType

name

requirements

Methods

set

Parameters

Returns With<For<{
    behaviors: {
        fanControl: typeof FanControlServer;
    };
    deviceRevision: 1;
    deviceType: 122;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
}>, {
    fanControl: typeof FanControlServer;
}>

with

Type Parameters

Parameters

Returns With<For<{
    behaviors: {
        fanControl: typeof FanControlServer;
    };
    deviceRevision: 1;
    deviceType: 122;
    name: "ExtractorHood";
    requirements: typeof ExtractorHoodRequirements;
}>, With<{
    fanControl: typeof FanControlServer;
}, BL>>

Settings

On This Page

Interface ExtractorHoodDevice

See

Hierarchy (view full)

Index

Properties

Methods

Properties

behaviors

defaults

deviceClass

deviceRevision

deviceType

name

requirements

Methods

set

Parameters

Returns With<For<{ behaviors: { fanControl: typeof FanControlServer; }; deviceRevision: 1; deviceType: 122; name: "ExtractorHood"; requirements: typeof ExtractorHoodRequirements; }>, { fanControl: typeof FanControlServer; }>

with

Type Parameters

Parameters

Returns With<For<{ behaviors: { fanControl: typeof FanControlServer; }; deviceRevision: 1; deviceType: 122; name: "ExtractorHood"; requirements: typeof ExtractorHoodRequirements; }>, With<{ fanControl: typeof FanControlServer; }, BL>>

Settings

On This Page

Returns With<For<{
behaviors: {
fanControl: typeof FanControlServer;
};
deviceRevision: 1;
deviceType: 122;
name: "ExtractorHood";
requirements: typeof ExtractorHoodRequirements;
}>, {
fanControl: typeof FanControlServer;
}>

Returns With<For<{
behaviors: {
fanControl: typeof FanControlServer;
};
deviceRevision: 1;
deviceType: 122;
name: "ExtractorHood";
requirements: typeof ExtractorHoodRequirements;
}>, With<{
fanControl: typeof FanControlServer;
}, BL>>