Interface PumpDevice

A Pump device is a pump that may have variable speed. It may have optional built-in sensors and a regulation mechanism. It is typically used for pumping fluids like water.

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

See

MatterSpecification.v13.Device § 5.3

interface PumpDevice {
    behaviors: {
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    } & {
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    };
    defaults: StateOf<{
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "Pump";
    requirements: typeof PumpRequirements;
    set(defaults: InputStateOf<{
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }>): With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            identify: typeof IdentifyServer;
        };
        deviceRevision: 3;
        deviceType: 771;
        name: "Pump";
        requirements: typeof PumpRequirements;
    }>, {
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            identify: typeof IdentifyServer;
        };
        deviceRevision: 3;
        deviceType: 771;
        name: "Pump";
        requirements: typeof PumpRequirements;
    }>, With<{
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }, BL>>;
}

Hierarchy (view full)

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    onOff: typeof OnOffServer;
} & {
    identify: typeof IdentifyServer;
} & {
    onOff: typeof OnOffServer;
} & {
    identify: typeof IdentifyServer;
}

defaults

defaults: StateOf<{
    onOff: typeof OnOffServer;
} & {
    identify: typeof IdentifyServer;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

name

requirements

requirements: typeof PumpRequirements

Methods

set

  • set(defaults): With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            identify: typeof IdentifyServer;
        };
        deviceRevision: 3;
        deviceType: 771;
        name: "Pump";
        requirements: typeof PumpRequirements;
    }>, {
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }>

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

    Parameters

    • defaults: InputStateOf<{
          onOff: typeof OnOffServer;
      } & {
          identify: typeof IdentifyServer;
      }>

    Returns With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            identify: typeof IdentifyServer;
        };
        deviceRevision: 3;
        deviceType: 771;
        name: "Pump";
        requirements: typeof PumpRequirements;
    }>, {
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }>

with

  • with<const BL>(...behaviors): With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            identify: typeof IdentifyServer;
        };
        deviceRevision: 3;
        deviceType: 771;
        name: "Pump";
        requirements: typeof PumpRequirements;
    }>, With<{
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }, 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: {
            onOff: typeof OnOffServer;
        } & {
            identify: typeof IdentifyServer;
        };
        deviceRevision: 3;
        deviceType: 771;
        name: "Pump";
        requirements: typeof PumpRequirements;
    }>, With<{
        onOff: typeof OnOffServer;
    } & {
        identify: typeof IdentifyServer;
    }, BL>>

Settings

Member Visibility

On This Page

Properties
Methods