Console

RelativeHumidityControlTrait 

struct RelativeHumidityControlTrait

This trait belongs to devices that support humidity settings such as humidifiers and dehumidifiers.

  • No supported events for RelativeHumidityControlTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by RelativeHumidityControlTrait.

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

    Declaration

    Swift

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

    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.RelativeHumidityControlTrait, rhs: Google.RelativeHumidityControlTrait) -> 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 setRelativeHumidity command for this trait.

    Declaration

    Swift

    var supportsSetRelativeHumidityCommand: Bool { get }

  • Set the relative humidity level to a specific value.

    Declaration

    Swift

    func setRelativeHumidity(humidity: UInt32) async throws

    Parameters

    humidity

    Setpoint humidity percentage. Must fall between minRelativeHumidity maxRelativeHumidity.

  • The batchable version of setRelativeHumidity command above.

    See also

    setRelativeHumidity

    Declaration

    Swift

    func setRelativeHumidityBatchable(humidity: UInt32) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStepRelativeHumidityCommand: Bool { get }

  • Increase or decrease the relative humidity.

    Declaration

    Swift

    func stepRelativeHumidity(relativeHumidityPercent: UInt32, relativeHumidityWeight: UInt32, stepMode: Google.RelativeHumidityControlTrait.StepMode) async throws

    Parameters

    relativeHumidityPercent

    The percentage value to adjust the humidity level. For example, if the current level of relative humidity is set to 50%, then StepRelativeHumidity with a relativeHumidityPercent of 10 sets relative humidity to 55%.
    relativeHumidityWeight

    The amount of ambiguous humidity change from a small amount to a large amount.
    stepMode

    Indicates the direction of the change.

  • The batchable version of stepRelativeHumidity command above.

    See also

    stepRelativeHumidity

    Declaration

    Swift

    func stepRelativeHumidityBatchable(relativeHumidityPercent: UInt32, relativeHumidityWeight: UInt32, stepMode: Google.RelativeHumidityControlTrait.StepMode) throws -> BatchableCommand<Void>

  • Indicates the direction of a step change.

    Declaration

    Swift

    enum StepMode