Console

IdentifyTrait 

struct IdentifyTrait

This trait supports an endpoint identification state (such as a flashing light) that indicates to an observer (such as an installer) which of several nodes or endpoints it is.

  • No supported events for IdentifyTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by IdentifyTrait.

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

    Declaration

    Swift

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

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

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

    Declaration

    Swift

    var supportsIdentifyCommand: Bool { get }

  • Start or stop the identification state for the receiving device. When this command is called, the identifyTime attribute is set to the value of identifyTime specified in this command.

    Declaration

    Swift

    func identify(identifyTime: UInt16) async throws

    Parameters

    identifyTime

    The amount of time, in seconds, that the device should identify itself. A value of 0 stops the identification state. A value other than 0 starts the identification state, which lasts for the value (seconds) specified.

  • The batchable version of identify command above.

    See also

    identify

    Declaration

    Swift

    func identifyBatchable(identifyTime: UInt16) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsTriggerEffectCommand: Bool { get }

  • Start an effect that provides visual feedback to the user. For example, a device’s LED may turn green when it has successfully connected to the network.

    Declaration

    Swift

    func triggerEffect(effectIdentifier: Matter.IdentifyTrait.EffectIdentifierEnum, effectVariant: Matter.IdentifyTrait.EffectVariantEnum) async throws

    Parameters

    effectIdentifier

    The identify effect to use. Must be a value from [IdentifyTrait.EffectIdentifierEnum].
    effectVariant

    Variant of the effect, indicated by the effectIdentifier parameter, that is triggered. This must be one of the values in [IdentifyTrait.EffectVariantEnum].

  • The batchable version of triggerEffect command above.

    See also

    triggerEffect

    Declaration

    Swift

    func triggerEffectBatchable(effectIdentifier: Matter.IdentifyTrait.EffectIdentifierEnum, effectVariant: Matter.IdentifyTrait.EffectVariantEnum) throws -> BatchableCommand<Void>

  • The effect to use for an identification state or triggered effect.

    Declaration

    Swift

    enum EffectIdentifierEnum

  • Variants of the effect identifier.

    Declaration

    Swift

    enum EffectVariantEnum

  • The identification state presented to the user.

    Declaration

    Swift

    enum IdentifyTypeEnum