Console

FanControlTrait 

struct FanControlTrait

This trait provides an interface for controlling the speed of a fan.

  • No supported events for FanControlTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by FanControlTrait.

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

    Declaration

    Swift

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

    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.FanControlTrait, rhs: Matter.FanControlTrait) -> 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 step command for this trait.

    Declaration

    Swift

    var supportsStepCommand: Bool { get }

  • Speed up or slow down the fan, in steps, without the client having to know the fan speed.

    Declaration

    Swift

    func step(direction: Matter.FanControlTrait.StepDirectionEnum, optionalArgsProvider: ((Matter.FanControlTrait.StepCommand.OptionalArgs) -> Void)? = nil) async throws

    Parameters

    direction

    Whether the fan speed increases or decreases to the next step value. Valid directions are defined in StepDirectionEnum.

  • The batchable version of step command above.

    See also

    step

    Declaration

    Swift

    func stepBatchable(direction: Matter.FanControlTrait.StepDirectionEnum, optionalArgsProvider: ((Matter.FanControlTrait.StepCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

  • Specifies the air flow direction.

    Declaration

    Swift

    enum AirflowDirectionEnum

  • Specifies the current fan mode.

    Declaration

    Swift

    enum FanModeEnum

  • Supported fan speed ranges.

    Declaration

    Swift

    enum FanModeSequenceEnum

  • The direction to take for a fan speed change.

    Declaration

    Swift

    enum StepDirectionEnum

  • FanControl cluster FeatureMap.

    Declaration

    Swift

    struct Feature

  • The current active fan rocking motion setting.

    Declaration

    Swift

    struct RockBitmap

  • The current active fan wind feature setting.

    Declaration

    Swift

    struct WindBitmap