Interface PeriodicEnergyMeasuredEvent

Body of the ElectricalEnergyMeasurement periodicEnergyMeasured event

See

MatterSpecification.v13.Cluster § 2.12.7.2

interface PeriodicEnergyMeasuredEvent {
    energyExported?: TypeFromFields<{
        endSystime: OptionalFieldType<number | bigint>;
        endTimestamp: OptionalFieldType<number>;
        energy: FieldType<number | bigint>;
        startSystime: OptionalFieldType<number | bigint>;
        startTimestamp: OptionalFieldType<number>;
    }>;
    energyImported?: TypeFromFields<{
        endSystime: OptionalFieldType<number | bigint>;
        endTimestamp: OptionalFieldType<number>;
        energy: FieldType<number | bigint>;
        startSystime: OptionalFieldType<number | bigint>;
        startTimestamp: OptionalFieldType<number>;
    }>;
}

Hierarchy (view full)

Properties

energyExported? energyImported?

Properties

OptionalenergyExported

energyExported?: TypeFromFields<{
    endSystime: OptionalFieldType<number | bigint>;
    endTimestamp: OptionalFieldType<number>;
    energy: FieldType<number | bigint>;
    startSystime: OptionalFieldType<number | bigint>;
    startTimestamp: OptionalFieldType<number>;
}>

This field shall be the value of PeriodicEnergyExported attribute at the timestamp indicated in its EndTimestamp field, EndSystime field, or both.

Type declaration

  • endSystime: OptionalFieldType<number | bigint>

    This field shall indicate the seconds since boot at the end of the period during which the value of the Energy field was measured.

    If the server had not yet determined the time in UTC by the end of the measurement period, or does not have the capability of determining the time in UTC, this field shall be indicated.

    Otherwise, if the server had determined the time in UTC by the end of the measurement period, this field may be omitted; if it is indicated, its value shall be the seconds since boot at the UTC time indicated in EndTimestamp.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.5

  • endTimestamp: OptionalFieldType<number>

    This field shall indicate the timestamp in UTC of the end of the period during which the value of the Energy field was measured.

    If the server had determined the time in UTC by the end of the measurement period, this field shall be indicated.

    Otherwise, if the server had not yet determined the time in UTC by the end of the measurement period, or does not have the capability of determining the time in UTC, this field shall be omitted.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.3

  • energy: FieldType<number | bigint>

    This field shall be the reported energy.

    If the EnergyMeasurementStruct represents cumulative energy, then this shall represent the cumulative energy recorded at either the value of the EndTimestamp field or the value of the EndSystime field, or both.

    If the EnergyMeasurementStruct represents periodic energy, then this shall represent the energy recorded during the period specified by either the StartTimestamp and EndTimestamp fields, the period specified by the StartSystime and EndSystime fields, or both.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.1

  • startSystime: OptionalFieldType<number | bigint>

    This field shall indicate the seconds since boot at the beginning of the period during which the value of the Energy field was measured.

    If this EnergyMeasurementStruct represents cumulative energy, this field shall be omitted.

    Otherwise, if the server had not yet determined the time in UTC at the start of the measurement period, or does not have the capability of determining the time in UTC, this field shall be indicated.

    Otherwise, if the server had determined the time in UTC at or before the beginning of the measurement period, this field may be omitted; if it is indicated, its value shall be the seconds since boot at the UTC time indicated in StartTimestamp.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.4

  • startTimestamp: OptionalFieldType<number>

    This field shall indicate the timestamp in UTC of the beginning of the period during which the value of the Energy field was measured.

    If this EnergyMeasurementStruct represents cumulative energy, this field shall be omitted.

    Otherwise, if the server had determined the time in UTC at or before the beginning of the measurement period, this field shall be indicated.

    Otherwise, if the server had not yet determined the time in UTC at or before the beginning of the measurement period, or does not have the capability of determining the time in UTC, this field shall be omitted.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.2

See

MatterSpecification.v13.Cluster § 2.12.7.2.2

OptionalenergyImported

energyImported?: TypeFromFields<{
    endSystime: OptionalFieldType<number | bigint>;
    endTimestamp: OptionalFieldType<number>;
    energy: FieldType<number | bigint>;
    startSystime: OptionalFieldType<number | bigint>;
    startTimestamp: OptionalFieldType<number>;
}>

This field shall be the value of PeriodicEnergyImported attribute at the timestamp indicated in its EndTimestamp field, EndSystime field, or both.

Type declaration

  • endSystime: OptionalFieldType<number | bigint>

    This field shall indicate the seconds since boot at the end of the period during which the value of the Energy field was measured.

    If the server had not yet determined the time in UTC by the end of the measurement period, or does not have the capability of determining the time in UTC, this field shall be indicated.

    Otherwise, if the server had determined the time in UTC by the end of the measurement period, this field may be omitted; if it is indicated, its value shall be the seconds since boot at the UTC time indicated in EndTimestamp.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.5

  • endTimestamp: OptionalFieldType<number>

    This field shall indicate the timestamp in UTC of the end of the period during which the value of the Energy field was measured.

    If the server had determined the time in UTC by the end of the measurement period, this field shall be indicated.

    Otherwise, if the server had not yet determined the time in UTC by the end of the measurement period, or does not have the capability of determining the time in UTC, this field shall be omitted.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.3

  • energy: FieldType<number | bigint>

    This field shall be the reported energy.

    If the EnergyMeasurementStruct represents cumulative energy, then this shall represent the cumulative energy recorded at either the value of the EndTimestamp field or the value of the EndSystime field, or both.

    If the EnergyMeasurementStruct represents periodic energy, then this shall represent the energy recorded during the period specified by either the StartTimestamp and EndTimestamp fields, the period specified by the StartSystime and EndSystime fields, or both.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.1

  • startSystime: OptionalFieldType<number | bigint>

    This field shall indicate the seconds since boot at the beginning of the period during which the value of the Energy field was measured.

    If this EnergyMeasurementStruct represents cumulative energy, this field shall be omitted.

    Otherwise, if the server had not yet determined the time in UTC at the start of the measurement period, or does not have the capability of determining the time in UTC, this field shall be indicated.

    Otherwise, if the server had determined the time in UTC at or before the beginning of the measurement period, this field may be omitted; if it is indicated, its value shall be the seconds since boot at the UTC time indicated in StartTimestamp.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.4

  • startTimestamp: OptionalFieldType<number>

    This field shall indicate the timestamp in UTC of the beginning of the period during which the value of the Energy field was measured.

    If this EnergyMeasurementStruct represents cumulative energy, this field shall be omitted.

    Otherwise, if the server had determined the time in UTC at or before the beginning of the measurement period, this field shall be indicated.

    Otherwise, if the server had not yet determined the time in UTC at or before the beginning of the measurement period, or does not have the capability of determining the time in UTC, this field shall be omitted.

    See

    MatterSpecification.v13.Cluster § 2.12.5.1.2

See

MatterSpecification.v13.Cluster § 2.12.7.2.1

Settings

Member Visibility

On This Page

Properties