Interface Cluster

This cluster provides an interface to flow measurement functionality, including configuration and provision of notifications of flow measurements.

See

MatterSpecification.v13.Cluster § 2.5

interface Cluster {
    attributes: Merge<{
        maxMeasuredValue: Attribute<null | number, any>;
        measuredValue: Attribute<null | number, any>;
        minMeasuredValue: Attribute<null | number, any>;
        tolerance: OptionalAttribute<number, any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<1028, "ClusterId">;
    name: "FlowMeasurement";
    revision: 3;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    maxMeasuredValue: Attribute<null | number, any>;
    measuredValue: Attribute<null | number, any>;
    minMeasuredValue: Attribute<null | number, any>;
    tolerance: OptionalAttribute<number, any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlymaxMeasuredValue: Attribute<null | number, any>

    The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue that can be measured. See Measured Value for more details.

    The null value indicates that the value is not available.

    See

    MatterSpecification.v13.Cluster § 2.5.4.3

  • ReadonlymeasuredValue: Attribute<null | number, any>

    MeasuredValue represents the flow in m/h as follows:

    MeasuredValue = 10 x Flow

    The null value indicates that the flow measurement is unknown, otherwise the range shall be as described in Measured Value.

    See

    MatterSpecification.v13.Cluster § 2.5.4.1

  • ReadonlyminMeasuredValue: Attribute<null | number, any>

    The MinMeasuredValue attribute indicates the minimum value of MeasuredValue that can be measured. See Measured Value for more details.

    The null value indicates that the value is not available.

    See

    MatterSpecification.v13.Cluster § 2.5.4.2

  • Readonlytolerance: OptionalAttribute<number, any>

    See Measured Value.

    See

    MatterSpecification.v13.Cluster § 2.5.4.4

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<1028, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          attributes: {
              maxMeasuredValue: Attribute<null | number, any>;
              measuredValue: Attribute<null | number, any>;
              minMeasuredValue: Attribute<null | number, any>;
              tolerance: OptionalAttribute<number, any>;
          };
          id: 1028;
          name: "FlowMeasurement";
          revision: 3;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              maxMeasuredValue: Attribute<null | number, any>;
              measuredValue: Attribute<null | number, any>;
              minMeasuredValue: Attribute<null | number, any>;
              tolerance: OptionalAttribute<number, any>;
          };
          id: 1028;
          name: "FlowMeasurement";
          revision: 3;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          maxMeasuredValue: null | number;
          measuredValue: null | number;
          minMeasuredValue: null | number;
          tolerance?: number;
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              maxMeasuredValue: Attribute<null | number, any>;
              measuredValue: Attribute<null | number, any>;
              minMeasuredValue: Attribute<null | number, any>;
              tolerance: OptionalAttribute<number, any>;
          };
          id: 1028;
          name: "FlowMeasurement";
          revision: 3;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1028;
        name: "FlowMeasurement";
        revision: 3;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods