Interface DishwasherDevice

A dishwasher is a device that is generally installed in residential homes and is capable of washing dishes, cutlery, and other items associate with food preparation and consumption. The device can be permanently installed or portable and can have variety of filling and draining methods.

See

MatterSpecification.v13.Device § 13.5

interface DishwasherDevice {
    behaviors: {
        operationalState: typeof OperationalStateServer;
    } & {
        operationalState: typeof OperationalStateServer;
    };
    defaults: StateOf<{
        operationalState: typeof OperationalStateServer;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "Dishwasher";
    requirements: typeof DishwasherRequirements;
    set(defaults: InputStateOf<{
        operationalState: typeof OperationalStateServer;
    }>): With<For<{
        behaviors: {
            operationalState: typeof OperationalStateServer;
        };
        deviceRevision: 1;
        deviceType: 117;
        name: "Dishwasher";
        requirements: typeof DishwasherRequirements;
    }>, {
        operationalState: typeof OperationalStateServer;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            operationalState: typeof OperationalStateServer;
        };
        deviceRevision: 1;
        deviceType: 117;
        name: "Dishwasher";
        requirements: typeof DishwasherRequirements;
    }>, With<{
        operationalState: typeof OperationalStateServer;
    }, BL>>;
}

Hierarchy (view full)

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    operationalState: typeof OperationalStateServer;
} & {
    operationalState: typeof OperationalStateServer;
}

defaults

defaults: StateOf<{
    operationalState: typeof OperationalStateServer;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

name

requirements

requirements: typeof DishwasherRequirements

Methods

set

  • set(defaults): With<For<{
        behaviors: {
            operationalState: typeof OperationalStateServer;
        };
        deviceRevision: 1;
        deviceType: 117;
        name: "Dishwasher";
        requirements: typeof DishwasherRequirements;
    }>, {
        operationalState: typeof OperationalStateServer;
    }>

  • Define an endpoint like this one with different defaults. Only updates values present in the input object.

    Parameters

    Returns With<For<{
        behaviors: {
            operationalState: typeof OperationalStateServer;
        };
        deviceRevision: 1;
        deviceType: 117;
        name: "Dishwasher";
        requirements: typeof DishwasherRequirements;
    }>, {
        operationalState: typeof OperationalStateServer;
    }>

with

  • with<const BL>(...behaviors): With<For<{
        behaviors: {
            operationalState: typeof OperationalStateServer;
        };
        deviceRevision: 1;
        deviceType: 117;
        name: "Dishwasher";
        requirements: typeof DishwasherRequirements;
    }>, With<{
        operationalState: typeof OperationalStateServer;
    }, 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: typeof OperationalStateServer;
        };
        deviceRevision: 1;
        deviceType: 117;
        name: "Dishwasher";
        requirements: typeof DishwasherRequirements;
    }>, With<{
        operationalState: typeof OperationalStateServer;
    }, BL>>

Settings

Member Visibility

On This Page

Properties
Methods