Interface RoboticVacuumCleanerDevice

This defines conformance for the Robotic Vacuum Cleaner device type.

See

MatterSpecification.v13.Device § 12.1

interface RoboticVacuumCleanerDevice {
    behaviors: {
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    } & {
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    };
    defaults: StateOf<{
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "RoboticVacuumCleaner";
    requirements: typeof RoboticVacuumCleanerRequirements;
    set(defaults: InputStateOf<{
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }>): With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            rvcRunMode: typeof RvcRunModeServer;
        } & {
            rvcOperationalState: typeof RvcOperationalStateServer;
        };
        deviceRevision: 2;
        deviceType: 116;
        name: "RoboticVacuumCleaner";
        requirements: typeof RoboticVacuumCleanerRequirements;
    }>, {
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            rvcRunMode: typeof RvcRunModeServer;
        } & {
            rvcOperationalState: typeof RvcOperationalStateServer;
        };
        deviceRevision: 2;
        deviceType: 116;
        name: "RoboticVacuumCleaner";
        requirements: typeof RoboticVacuumCleanerRequirements;
    }>, With<{
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }, BL>>;
}

Hierarchy (view full)

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    identify: typeof IdentifyServer;
} & {
    rvcRunMode: typeof RvcRunModeServer;
} & {
    rvcOperationalState: typeof RvcOperationalStateServer;
} & {
    identify: typeof IdentifyServer;
} & {
    rvcRunMode: typeof RvcRunModeServer;
} & {
    rvcOperationalState: typeof RvcOperationalStateServer;
}

defaults

defaults: StateOf<{
    identify: typeof IdentifyServer;
} & {
    rvcRunMode: typeof RvcRunModeServer;
} & {
    rvcOperationalState: typeof RvcOperationalStateServer;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

name

requirements

requirements: typeof RoboticVacuumCleanerRequirements

Methods

set

  • set(defaults): With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            rvcRunMode: typeof RvcRunModeServer;
        } & {
            rvcOperationalState: typeof RvcOperationalStateServer;
        };
        deviceRevision: 2;
        deviceType: 116;
        name: "RoboticVacuumCleaner";
        requirements: typeof RoboticVacuumCleanerRequirements;
    }>, {
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }>

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

    Parameters

    Returns With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            rvcRunMode: typeof RvcRunModeServer;
        } & {
            rvcOperationalState: typeof RvcOperationalStateServer;
        };
        deviceRevision: 2;
        deviceType: 116;
        name: "RoboticVacuumCleaner";
        requirements: typeof RoboticVacuumCleanerRequirements;
    }>, {
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }>

with

  • with<const BL>(...behaviors): With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            rvcRunMode: typeof RvcRunModeServer;
        } & {
            rvcOperationalState: typeof RvcOperationalStateServer;
        };
        deviceRevision: 2;
        deviceType: 116;
        name: "RoboticVacuumCleaner";
        requirements: typeof RoboticVacuumCleanerRequirements;
    }>, With<{
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }, 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: {
            identify: typeof IdentifyServer;
        } & {
            rvcRunMode: typeof RvcRunModeServer;
        } & {
            rvcOperationalState: typeof RvcOperationalStateServer;
        };
        deviceRevision: 2;
        deviceType: 116;
        name: "RoboticVacuumCleaner";
        requirements: typeof RoboticVacuumCleanerRequirements;
    }>, With<{
        identify: typeof IdentifyServer;
    } & {
        rvcRunMode: typeof RvcRunModeServer;
    } & {
        rvcOperationalState: typeof RvcOperationalStateServer;
    }, BL>>

Settings

Member Visibility

On This Page

Properties
Methods