Console

LightEffectsTrait 

struct LightEffectsTrait

This trait belongs to devices that can support complex lighting commands to change states, such as looping through various colors.

  • No supported events for LightEffectsTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by LightEffectsTrait.

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

    Declaration

    Swift

    let attributes: Google.LightEffectsTrait.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 LightEffectsTrait.

    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: Google.LightEffectsTrait, rhs: Google.LightEffectsTrait) -> 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)

  • Represents a color using the HSV model.

    Declaration

    Swift

    struct SpectrumHSV

  • Color of the light for the duration of the effect.

    Declaration

    Swift

    struct Color

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

    Declaration

    Swift

    var supportsPulseEffectSetCommand: Bool { get }

  • Activates the pulse effect.

    Declaration

    Swift

    func pulseEffectSet(durationSeconds: UInt32, color: Google.LightEffectsTrait.Color) async throws

    Parameters

    durationSeconds

    Duration for the pulse effect, in seconds.
    color

    Color of the light for the duration of the effect.

  • The batchable version of pulseEffectSet command above.

    See also

    pulseEffectSet

    Declaration

    Swift

    func pulseEffectSetBatchable(durationSeconds: UInt32, color: Google.LightEffectsTrait.Color) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsSleepEffectSetCommand: Bool { get }

  • Activates the sleep effect.

    Declaration

    Swift

    func sleepEffectSet(durationSeconds: UInt32) async throws

    Parameters

    durationSeconds

    Duration for the sleep effect, in seconds.

  • The batchable version of sleepEffectSet command above.

    See also

    sleepEffectSet

    Declaration

    Swift

    func sleepEffectSetBatchable(durationSeconds: UInt32) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsWakeEffectSetCommand: Bool { get }

  • Activates the wake effect.

    Declaration

    Swift

    func wakeEffectSet(durationSeconds: UInt32) async throws

    Parameters

    durationSeconds

    Duration for the wake effect, in seconds.

  • The batchable version of wakeEffectSet command above.

    See also

    wakeEffectSet

    Declaration

    Swift

    func wakeEffectSetBatchable(durationSeconds: UInt32) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStopEffectCommand: Bool { get }

  • Stops the active effect.

    Declaration

    Swift

    func stopEffect() async throws

  • The batchable version of stopEffect command above.

    See also

    stopEffect

    Declaration

    Swift

    func stopEffectBatchable() throws -> BatchableCommand<Void>

  • Contains specific capabilities related to light effects.

    Declaration

    Swift

    struct LightEffectsFeature