Interface State

interface State {
    accuracy: TypeFromFields<{
        accuracyRanges: FieldType<TypeFromFields<{
            fixedMax: OptionalFieldType<number | bigint>;
            fixedMin: OptionalFieldType<number | bigint>;
            fixedTypical: OptionalFieldType<number | bigint>;
            percentMax: OptionalFieldType<number>;
            percentMin: OptionalFieldType<number>;
            percentTypical: OptionalFieldType<number>;
            rangeMax: FieldType<number | bigint>;
            rangeMin: FieldType<number | bigint>;
        }>[]>;
        maxMeasuredValue: FieldType<number | bigint>;
        measured: FieldType<boolean>;
        measurementType: FieldType<MeasurementType>;
        minMeasuredValue: FieldType<number | bigint>;
    }>[];
    activeCurrent?: null | number | bigint;
    activePower: null | number | bigint;
    numberOfMeasurementTypes: number;
    powerMode: ElectricalPowerMeasurement.PowerMode;
    ranges?: TypeFromFields<{
        endSystime: OptionalFieldType<number | bigint>;
        endTimestamp: OptionalFieldType<number>;
        max: FieldType<number | bigint>;
        maxSystime: OptionalFieldType<number | bigint>;
        maxTimestamp: OptionalFieldType<number>;
        measurementType: FieldType<MeasurementType>;
        min: FieldType<number | bigint>;
        minSystime: OptionalFieldType<number | bigint>;
        minTimestamp: OptionalFieldType<number>;
        startSystime: OptionalFieldType<number | bigint>;
        startTimestamp: OptionalFieldType<number>;
    }>[];
    voltage?: null | number | bigint;
}

Hierarchy

  • StateType
    • State

Properties

accuracy activeCurrent? activePower numberOfMeasurementTypes powerMode ranges? voltage?

Properties

Readonlyaccuracy

accuracy: TypeFromFields<{
    accuracyRanges: FieldType<TypeFromFields<{
        fixedMax: OptionalFieldType<number | bigint>;
        fixedMin: OptionalFieldType<number | bigint>;
        fixedTypical: OptionalFieldType<number | bigint>;
        percentMax: OptionalFieldType<number>;
        percentMin: OptionalFieldType<number>;
        percentTypical: OptionalFieldType<number>;
        rangeMax: FieldType<number | bigint>;
        rangeMin: FieldType<number | bigint>;
    }>[]>;
    maxMeasuredValue: FieldType<number | bigint>;
    measured: FieldType<boolean>;
    measurementType: FieldType<MeasurementType>;
    minMeasuredValue: FieldType<number | bigint>;
}>[]

This shall indicate a list of accuracy specifications for the measurement types supported by the server. There shall be an entry for ActivePower, as well as any other measurement types implemented by this server.

See

MatterSpecification.v13.Cluster § 2.13.6.3

Optional ReadonlyactiveCurrent

activeCurrent?: null | number | bigint

This shall indicate the most recent ActiveCurrent reading in milliamps (mA).

A positive value represents current flowing into the server, while a negative value represents current flowing out of the server.

The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit publication of deltas considered not meaningful.

The server shall NOT mark this attribute ready for report if the last time this was done was more recently than 1 second ago.

The server may delay marking this attribute ready for report for longer periods if needed, however the server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.

If the current cannot be measured, a value of null shall be returned.

See

MatterSpecification.v13.Cluster § 2.13.6.6

ReadonlyactivePower

activePower: null | number | bigint

This shall indicate the most recent ActivePower reading in milliwatts (mW). If the power cannot be measured, a value of null shall be returned.

A positive value represents power imported, while a negative value represents power exported.

The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit publication of deltas considered not meaningful.

The server shall NOT mark this attribute ready for report if the last time this was done was more recently than 1 second ago.

The server may delay marking this attribute ready for report for longer periods if needed, however the server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.

If the Polyphase Power feature is set, this value represents the combined active power imported or exported.

See

MatterSpecification.v13.Cluster § 2.13.6.9

ReadonlynumberOfMeasurementTypes

numberOfMeasurementTypes: number

This shall indicate the maximum number of measurement types the server is capable of reporting.

See

MatterSpecification.v13.Cluster § 2.13.6.2

ReadonlypowerMode

powerMode: ElectricalPowerMeasurement.PowerMode

This shall indicate the current mode of the server. For some servers, such as an EV, this may change depending on the mode of charging or discharging.

See

MatterSpecification.v13.Cluster § 2.13.6.1

Optional Readonlyranges

ranges?: TypeFromFields<{
    endSystime: OptionalFieldType<number | bigint>;
    endTimestamp: OptionalFieldType<number>;
    max: FieldType<number | bigint>;
    maxSystime: OptionalFieldType<number | bigint>;
    maxTimestamp: OptionalFieldType<number>;
    measurementType: FieldType<MeasurementType>;
    min: FieldType<number | bigint>;
    minSystime: OptionalFieldType<number | bigint>;
    minTimestamp: OptionalFieldType<number>;
    startSystime: OptionalFieldType<number | bigint>;
    startTimestamp: OptionalFieldType<number>;
}>[]

This shall indicate a list of measured ranges for different measurement types. Each measurement type shall have at most one entry in this list, representing the range of measurements in the most recent measurement period.

The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit publication of deltas considered not meaningful.

The server shall NOT mark this attribute ready for report if the last time this was done was more recently than 1 second ago.

The server may delay marking this attribute ready for report for longer periods if needed, however the server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.

See

MatterSpecification.v13.Cluster § 2.13.6.4

Optional Readonlyvoltage

voltage?: null | number | bigint

This shall indicate the most recent Voltage reading in millivolts (mV).

The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit publication of deltas considered not meaningful.

The server shall NOT mark this attribute ready for report if the last time this was done was more recently than 1 second ago.

The server may delay marking this attribute ready for report for longer periods if needed, however the server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.

If the voltage cannot be measured, a value of null shall be returned.

See

MatterSpecification.v13.Cluster § 2.13.6.5

Settings

Member Visibility

On This Page

Properties