Interface Cluster

The Illuminance Measurement cluster provides an interface to illuminance measurement functionality, including configuration and provision of notifications of illuminance measurements.

See

MatterSpecification.v13.Cluster § 2.2

interface Cluster {
    attributes: Merge<{
        lightSensorType: OptionalAttribute<null | number, any>;
        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<1024, "ClusterId">;
    name: "IlluminanceMeasurement";
    revision: 3;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            lightSensorType: OptionalAttribute<null | number, any>;
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1024;
        name: "IlluminanceMeasurement";
        revision: 3;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            lightSensorType: OptionalAttribute<null | number, any>;
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1024;
        name: "IlluminanceMeasurement";
        revision: 3;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            lightSensorType: OptionalAttribute<null | number, any>;
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1024;
        name: "IlluminanceMeasurement";
        revision: 3;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            lightSensorType: OptionalAttribute<null | number, any>;
            maxMeasuredValue: Attribute<null | number, any>;
            measuredValue: Attribute<null | number, any>;
            minMeasuredValue: Attribute<null | number, any>;
            tolerance: OptionalAttribute<number, any>;
        };
        id: 1024;
        name: "IlluminanceMeasurement";
        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<{
    lightSensorType: OptionalAttribute<null | number, any>;
    maxMeasuredValue: Attribute<null | number, any>;
    measuredValue: Attribute<null | number, any>;
    minMeasuredValue: Attribute<null | number, any>;
    tolerance: OptionalAttribute<number, any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlylightSensorType: OptionalAttribute<null | number, any>

    The LightSensorType attribute specifies the electronic type of the light sensor. This attribute shall be set to one of the non-reserved values listed in LightSensorTypeEnum or null in case the sensor type is unknown.

    See

    MatterSpecification.v13.Cluster § 2.2.5.5

  • ReadonlymaxMeasuredValue: Attribute<null | number, any>

    The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue that can be measured. A value of null indicates that this attribute is not defined. See Measured Value for more details.

    See

    MatterSpecification.v13.Cluster § 2.2.5.3

  • ReadonlymeasuredValue: Attribute<null | number, any>

    The MeasuredValue attribute represents the illuminance in Lux (symbol lx) as follows:

    • MeasuredValue = 10,000 x log10(illuminance) + 1,

    where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE. The MeasuredValue attribute can take the following values:

    • 0 indicates a value of illuminance that is too low to be measured,

    • MinMeasuredValue <= MeasuredValue <= MaxMeasuredValue under normal circumstances,

    • null indicates that the illuminance measurement is invalid.

    The MeasuredValue attribute is updated continuously as new measurements are made.

    See

    MatterSpecification.v13.Cluster § 2.2.5.1

  • ReadonlyminMeasuredValue: Attribute<null | number, any>

    The MinMeasuredValue attribute indicates the minimum value of MeasuredValue that can be measured. A value of null indicates that this attribute is not defined. See Measured Value for more details.

    See

    MatterSpecification.v13.Cluster § 2.2.5.2

  • Readonlytolerance: OptionalAttribute<number, any>

    See Measured Value.

    See

    MatterSpecification.v13.Cluster § 2.2.5.4

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<1024, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

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

  • Modify elements using ElementModifier.alter.

    Type Parameters

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

    Parameters

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

enable

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

  • Modify elements using ElementModifier.enable.

    Type Parameters

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

    Parameters

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

set

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

  • Modify elements using ElementModifier.set.

    Type Parameters

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

    Parameters

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

with

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

  • Select features using ClusterComposer.compose.

    Type Parameters

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

    Parameters

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

Settings

Member Visibility

On This Page

Properties
Methods