Console

BasicInformationTrait 

struct BasicInformationTrait

This trait provides attributes and events for determining basic information about nodes.

  • 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.BasicInformationTrait, rhs: Matter.BasicInformationTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Attributes for the BasicInformationTrait.

    Declaration

    Swift

    struct Attributes

  • A set of constant values related to the overall capabilities of the node.

    Declaration

    Swift

    struct CapabilityMinimaStruct

  • Color values.

    Declaration

    Swift

    enum ColorEnum

  • Indicates that the node has left a given fabric.

    Declaration

    Swift

    struct LeaveEvent

  • The product’s appearance.

    Declaration

    Swift

    struct ProductAppearanceStruct

  • Product finish values.

    Declaration

    Swift

    enum ProductFinishEnum

  • Indicates that the state of the node’s reachability has changed.

    Declaration

    Swift

    struct ReachableChangedEvent

  • Indicates that the node has begun an orderly shutdown sequence on a best effort basis.

    Declaration

    Swift

    struct ShutDownEvent

  • Indicates that the node has completed a boot or reboot process.

    Declaration

    Swift

    struct StartUpEvent

  • List of attributes for the BasicInformationTrait.

    Declaration

    Swift

    let attributes: Matter.BasicInformationTrait.Attributes

  • 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

  • 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 trait identifier.

    Declaration

    Swift

    static let identifier: String

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

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • Send a manufacturer specific ping.

    Declaration

    Swift

    func mfgSpecificPing() async throws

  • The batchable version of mfgSpecificPing command above.

    See also

    mfgSpecificPing

    Declaration

    Swift

    func mfgSpecificPingBatchable() throws -> BatchableCommand<Void>

  • List of the commands that are supported by BasicInformationTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • Whether the device supports the mfgSpecificPing command for this trait.

    Declaration

    Swift

    var supportsMfgSpecificPingCommand: Bool { get }