Console

PowerSourceTrait 

struct PowerSourceTrait

This trait provides an interface to devices that provide power to other devices.

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • No supported commands for PowerSourceTrait.

    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 PowerSourceTrait.

    Declaration

    Swift

    let attributes: Matter.PowerSourceTrait.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 PowerSourceTrait.

    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.PowerSourceTrait, rhs: Matter.PowerSourceTrait) -> 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)

  • This event is generated when the set of wired faults currently detected by the device on this wired power source changes. This event corresponds to a change in value in PowerSourceTrait/Attributes/ActiveWiredFaults.

    Declaration

    Swift

    struct WiredFaultChangeEvent

  • This event is generated when the set of battery faults currently detected by the device on this battery power source changes. This event corresponds to a change in value in PowerSourceTrait/Attributes/ActiveBatFaults.

    Declaration

    Swift

    struct BatFaultChangeEvent

  • This event is generated when the set of charge faults currently detected by the device on this battery power source changes. This event corresponds to a change in value in PowerSourceTrait/Attributes/ActiveBatChargeFaults.

    Declaration

    Swift

    struct BatChargeFaultChangeEvent

  • The preferred chemistry of the battery source.

    Declaration

    Swift

    enum BatApprovedChemistryEnum

  • Faults that can be detected on a battery power source that is capable of charging.

    Declaration

    Swift

    enum BatChargeFaultEnum

  • The ranking of the charge level of the battery used to indicate when intervention is required.

    Declaration

    Swift

    enum BatChargeLevelEnum

  • The state of the battery charge.

    Declaration

    Swift

    enum BatChargeStateEnum

  • The ID of the common or colloquial designation of the battery.

    Declaration

    Swift

    enum BatCommonDesignationEnum

  • Faults that can be detected on a battery power source.

    Declaration

    Swift

    enum BatFaultEnum

  • Indicates the replaceability of the battery.

    Declaration

    Swift

    enum BatReplaceabilityEnum

  • The participation of the power source in providing power to the device.

    Declaration

    Swift

    enum PowerSourceStatusEnum

  • The type of current to be provided by the hard-wired power source.

    Declaration

    Swift

    enum WiredCurrentTypeEnum

  • Faults that can be detected on a wired power source.

    Declaration

    Swift

    enum WiredFaultEnum

  • PowerSource trait FeatureMap.

    Declaration

    Swift

    struct Feature