Interface ElectricalPowerMeasurementBehavior

interface ElectricalPowerMeasurementBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<Events, never> & {
        accuracy$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
            accuracyRanges: FieldType<TypeFromFields<{
                fixedMax: ...;
                fixedMin: ...;
                fixedTypical: ...;
                percentMax: ...;
                percentMin: ...;
                percentTypical: ...;
                rangeMax: ...;
                rangeMin: ...;
            }>[]>;
            maxMeasuredValue: FieldType<number | bigint>;
            measured: FieldType<boolean>;
            measurementType: FieldType<MeasurementType>;
            minMeasuredValue: FieldType<number | bigint>;
        }>[], any>>;
        activePower$Changing: ClusterEvents.AttributeObservable<Attribute<null | number | bigint, any>>;
        numberOfMeasurementTypes$Changing: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>;
        powerMode$Changing: ClusterEvents.AttributeObservable<Attribute<ElectricalPowerMeasurement.PowerMode, any>>;
    } & {
        activeCurrent$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
        ranges$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<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>;
        }>[], any>>;
        voltage$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
    } & {
        accuracy$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
            accuracyRanges: FieldType<TypeFromFields<{
                fixedMax: ...;
                fixedMin: ...;
                fixedTypical: ...;
                percentMax: ...;
                percentMin: ...;
                percentTypical: ...;
                rangeMax: ...;
                rangeMin: ...;
            }>[]>;
            maxMeasuredValue: FieldType<number | bigint>;
            measured: FieldType<boolean>;
            measurementType: FieldType<MeasurementType>;
            minMeasuredValue: FieldType<number | bigint>;
        }>[], any>>;
        activePower$Changed: ClusterEvents.AttributeObservable<Attribute<null | number | bigint, any>>;
        numberOfMeasurementTypes$Changed: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>;
        powerMode$Changed: ClusterEvents.AttributeObservable<Attribute<ElectricalPowerMeasurement.PowerMode, any>>;
    } & {
        activeCurrent$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
        ranges$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<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>;
        }>[], any>>;
        voltage$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
    } & {} & {
        measurementPeriodRanges?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
            ranges: FieldType<TypeFromFields<{
                endSystime: ...;
                endTimestamp: ...;
                max: ...;
                maxSystime: ...;
                maxTimestamp: ...;
                measurementType: ...;
                min: ...;
                minSystime: ...;
                minTimestamp: ...;
                startSystime: ...;
                startTimestamp: ...;
            }>[]>;
        }>, any>>;
    };
    features: TypeFromBitSchema<{
        alternatingCurrent: BitFlag;
        directCurrent: BitFlag;
        harmonics: BitFlag;
        polyphasePower: BitFlag;
        powerQuality: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<{}, never> & {
        activePower: null | number | bigint;
        powerMode: ElectricalPowerMeasurement.PowerMode;
    } & {
        activeCurrent?: null | number | bigint;
        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;
    } & {
        accuracy: TypeFromFields<{
            accuracyRanges: FieldType<TypeFromFields<{
                fixedMax: OptionalFieldType<(...) | (...)>;
                fixedMin: OptionalFieldType<(...) | (...)>;
                fixedTypical: OptionalFieldType<(...) | (...)>;
                percentMax: OptionalFieldType<number>;
                percentMin: OptionalFieldType<number>;
                percentTypical: OptionalFieldType<number>;
                rangeMax: FieldType<(...) | (...)>;
                rangeMin: FieldType<(...) | (...)>;
            }>[]>;
            maxMeasuredValue: FieldType<number | bigint>;
            measured: FieldType<boolean>;
            measurementType: FieldType<MeasurementType>;
            minMeasuredValue: FieldType<number | bigint>;
        }>[];
        numberOfMeasurementTypes: number;
    } & {};
    [asyncDispose](): MaybePromise;
    asAdmin(fn: (() => void)): void;
    assertAttributeEnabled<This, K>(this: This, attributeName: K): void;
    callback<A, R>(reactor: Reactor<A, R>, options?: Reactor.Options): ((...args: A) => undefined | R);
    initialize(_options?: {}): MaybePromise;
    reactTo<O>(observable: O, reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>, options?: Reactor.Options): void;
    requireAttributeEnabled<This, K>(this: This, attributeName: K): Exclude<This["state"][K], undefined>;
    toString(): string;
    State: any;
}

Hierarchy (view full)

Properties

[reference] agent cluster context endpoint env events features session state

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<Events, never> & {
    accuracy$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
        accuracyRanges: FieldType<TypeFromFields<{
            fixedMax: ...;
            fixedMin: ...;
            fixedTypical: ...;
            percentMax: ...;
            percentMin: ...;
            percentTypical: ...;
            rangeMax: ...;
            rangeMin: ...;
        }>[]>;
        maxMeasuredValue: FieldType<number | bigint>;
        measured: FieldType<boolean>;
        measurementType: FieldType<MeasurementType>;
        minMeasuredValue: FieldType<number | bigint>;
    }>[], any>>;
    activePower$Changing: ClusterEvents.AttributeObservable<Attribute<null | number | bigint, any>>;
    numberOfMeasurementTypes$Changing: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>;
    powerMode$Changing: ClusterEvents.AttributeObservable<Attribute<ElectricalPowerMeasurement.PowerMode, any>>;
} & {
    activeCurrent$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
    ranges$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<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>;
    }>[], any>>;
    voltage$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
} & {
    accuracy$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
        accuracyRanges: FieldType<TypeFromFields<{
            fixedMax: ...;
            fixedMin: ...;
            fixedTypical: ...;
            percentMax: ...;
            percentMin: ...;
            percentTypical: ...;
            rangeMax: ...;
            rangeMin: ...;
        }>[]>;
        maxMeasuredValue: FieldType<number | bigint>;
        measured: FieldType<boolean>;
        measurementType: FieldType<MeasurementType>;
        minMeasuredValue: FieldType<number | bigint>;
    }>[], any>>;
    activePower$Changed: ClusterEvents.AttributeObservable<Attribute<null | number | bigint, any>>;
    numberOfMeasurementTypes$Changed: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>;
    powerMode$Changed: ClusterEvents.AttributeObservable<Attribute<ElectricalPowerMeasurement.PowerMode, any>>;
} & {
    activeCurrent$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
    ranges$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<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>;
    }>[], any>>;
    voltage$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number | bigint, any>>;
} & {} & {
    measurementPeriodRanges?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        ranges: FieldType<TypeFromFields<{
            endSystime: ...;
            endTimestamp: ...;
            max: ...;
            maxSystime: ...;
            maxTimestamp: ...;
            measurementType: ...;
            min: ...;
            minSystime: ...;
            minTimestamp: ...;
            startSystime: ...;
            startTimestamp: ...;
        }>[]>;
    }>, any>>;
}

Access the behavior's events.

Type declaration

  • Optional ReadonlymeasurementPeriodRanges?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        ranges: FieldType<TypeFromFields<{
            endSystime: ...;
            endTimestamp: ...;
            max: ...;
            maxSystime: ...;
            maxTimestamp: ...;
            measurementType: ...;
            min: ...;
            minSystime: ...;
            minTimestamp: ...;
            startSystime: ...;
            startTimestamp: ...;
        }>[]>;
    }>, any>>

    If supported, this event shall be generated at the end of a measurement period. The start and end times for measurement periods shall be determined by the server, and may represent overlapping periods.

    See

    MatterSpecification.v13.Cluster § 2.13.7.1

features

features: TypeFromBitSchema<{
    alternatingCurrent: BitFlag;
    directCurrent: BitFlag;
    harmonics: BitFlag;
    polyphasePower: BitFlag;
    powerQuality: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlyalternatingCurrent: BitFlag

    AlternatingCurrent

    This feature indicates the cluster can measure an alternating current.

    See

    MatterSpecification.v13.Cluster § 2.13.4.2

  • ReadonlydirectCurrent: BitFlag

    DirectCurrent

    This feature indicates the cluster can measure a direct current.

    See

    MatterSpecification.v13.Cluster § 2.13.4.1

  • Readonlyharmonics: BitFlag

    Harmonics

    This feature indicates the cluster can measure the harmonics of an alternating current.

    See

    MatterSpecification.v13.Cluster § 2.13.4.4

  • ReadonlypolyphasePower: BitFlag

    PolyphasePower

    This feature indicates the cluster represents the collective measurements for a Polyphase power supply.

    See

    MatterSpecification.v13.Cluster § 2.13.4.3

  • ReadonlypowerQuality: BitFlag

    PowerQuality

    This feature indicates the cluster can measure the harmonic phases of an alternating current.

    See

    MatterSpecification.v13.Cluster § 2.13.4.5

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    activePower: null | number | bigint;
    powerMode: ElectricalPowerMeasurement.PowerMode;
} & {
    activeCurrent?: null | number | bigint;
    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;
} & {
    accuracy: TypeFromFields<{
        accuracyRanges: FieldType<TypeFromFields<{
            fixedMax: OptionalFieldType<(...) | (...)>;
            fixedMin: OptionalFieldType<(...) | (...)>;
            fixedTypical: OptionalFieldType<(...) | (...)>;
            percentMax: OptionalFieldType<number>;
            percentMin: OptionalFieldType<number>;
            percentTypical: OptionalFieldType<number>;
            rangeMax: FieldType<(...) | (...)>;
            rangeMin: FieldType<(...) | (...)>;
        }>[]>;
        maxMeasuredValue: FieldType<number | bigint>;
        measured: FieldType<boolean>;
        measurementType: FieldType<MeasurementType>;
        minMeasuredValue: FieldType<number | bigint>;
    }>[];
    numberOfMeasurementTypes: number;
} & {}

Access the behavior's state.

Type declaration

  • ReadonlyactivePower: 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

  • ReadonlypowerMode: 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

Type declaration

  • Optional ReadonlyactiveCurrent?: 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

  • Optional Readonlyranges?: 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?: 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

Type declaration

  • Readonlyaccuracy: TypeFromFields<{
        accuracyRanges: FieldType<TypeFromFields<{
            fixedMax: OptionalFieldType<(...) | (...)>;
            fixedMin: OptionalFieldType<(...) | (...)>;
            fixedTypical: OptionalFieldType<(...) | (...)>;
            percentMax: OptionalFieldType<number>;
            percentMin: OptionalFieldType<number>;
            percentTypical: OptionalFieldType<number>;
            rangeMax: FieldType<(...) | (...)>;
            rangeMin: FieldType<(...) | (...)>;
        }>[]>;
        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

  • ReadonlynumberOfMeasurementTypes: number

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

    See

    MatterSpecification.v13.Cluster § 2.13.6.2

Methods

[asyncDispose]

asAdmin

assertAttributeEnabled

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(_options?): MaybePromise

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Parameters

    • Optional_options: {}

      Returns MaybePromise

    ProtectedreactTo

    • reactTo<O>(observable, reactor, options?): void

    • Install a Reactor.

      Important: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      Parameters

      Returns void

    requireAttributeEnabled

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods