Interface Cluster

This cluster provides an interface to air quality classification using distinct levels with human-readable labels.

AirQualityCluster supports optional features that you can enable with the AirQualityCluster.with() factory method.

See

MatterSpecification.v13.Cluster § 2.9

interface Cluster {
    attributes: Merge<{
        airQuality: Attribute<AirQuality.AirQualityEnum, any>;
    }, GlobalAttributes<{
        extremelyPoor: BitFlag;
        fair: BitFlag;
        moderate: BitFlag;
        veryPoor: BitFlag;
    }>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: readonly [];
    features: {
        extremelyPoor: BitFlag;
        fair: BitFlag;
        moderate: BitFlag;
        veryPoor: BitFlag;
    };
    id: Branded<91, "ClusterId">;
    name: "AirQuality";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, 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<{
    airQuality: Attribute<AirQuality.AirQualityEnum, any>;
}, GlobalAttributes<{
    extremelyPoor: BitFlag;
    fair: BitFlag;
    moderate: BitFlag;
    veryPoor: BitFlag;
}>>

Type declaration

  • ReadonlyairQuality: Attribute<AirQuality.AirQualityEnum, any>

    Indicates a value from AirQualityEnum that is indicative of the currently measured air quality.

    See

    MatterSpecification.v13.Cluster § 2.9.6.1

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: readonly []

features

features: {
    extremelyPoor: BitFlag;
    fair: BitFlag;
    moderate: BitFlag;
    veryPoor: BitFlag;
}

Type declaration

  • ReadonlyextremelyPoor: BitFlag

    ExtremelyPoor

    Cluster supports the Extremely poor air quality level

  • Readonlyfair: BitFlag

    Fair

    Cluster supports the Fair air quality level

  • Readonlymoderate: BitFlag

    Moderate

    Cluster supports the Moderate air quality level

  • ReadonlyveryPoor: BitFlag

    VeryPoor

    Cluster supports the Very poor air quality level

id

id: Branded<91, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              airQuality: Attribute<AirQuality.AirQualityEnum, any>;
          };
          extensions: readonly [];
          features: {
              extremelyPoor: BitFlag;
              fair: BitFlag;
              moderate: BitFlag;
              veryPoor: BitFlag;
          };
          id: 91;
          name: "AirQuality";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          airQuality: number;
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              airQuality: Attribute<AirQuality.AirQualityEnum, any>;
          };
          extensions: readonly [];
          features: {
              extremelyPoor: BitFlag;
              fair: BitFlag;
              moderate: BitFlag;
              veryPoor: BitFlag;
          };
          id: 91;
          name: "AirQuality";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            airQuality: Attribute<AirQuality.AirQualityEnum, any>;
        };
        extensions: readonly [];
        features: {
            extremelyPoor: BitFlag;
            fair: BitFlag;
            moderate: BitFlag;
            veryPoor: BitFlag;
        };
        id: 91;
        name: "AirQuality";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods