Console

ElectricalEnergyMeasurementTrait 

struct ElectricalEnergyMeasurementTrait

This trait provides a mechanism for querying data about electrical energy imported or provided by the server.

  • List of the event types that are supported by ElectricalEnergyMeasurementTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • No supported commands for ElectricalEnergyMeasurementTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the ElectricalEnergyMeasurementTrait.

    Declaration

    Swift

    let attributes: Matter.ElectricalEnergyMeasurementTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the ElectricalEnergyMeasurementTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Matter.ElectricalEnergyMeasurementTrait, rhs: Matter.ElectricalEnergyMeasurementTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The accuracy of a measurement for a range of measurement values, shown as a maximum +/- percentage of the true value, a maximum +/- fixed value of the true value, or both.

    Declaration

    Swift

    struct MeasurementAccuracyRangeStruct

  • The set of accuracy ranges for a given measurement, the maximum and minimum values for the measurement, and whether the measurement is directly measured or only estimated from other existing information.

    Declaration

    Swift

    struct MeasurementAccuracyStruct

  • Indicates when cumulative measurements were most recently zero.

    Declaration

    Swift

    struct CumulativeEnergyResetStruct

  • Indicates the amount of energy measured during a given measurement period.

    Declaration

    Swift

    struct EnergyMeasurementStruct

  • This event gets generated when the server takes a snapshot of the cumulative energy imported or exported from the server.

    Declaration

    Swift

    struct CumulativeEnergyMeasuredEvent

  • This event gets generated when the server reaches the end of a reporting period for imported or exported energy.

    Declaration

    Swift

    struct PeriodicEnergyMeasuredEvent

  • The type of measurement.

    Declaration

    Swift

    enum MeasurementTypeEnum

  • ElectricalEnergyMeasurement Trait FeatureMap.

    Declaration

    Swift

    struct Feature