Console

OpenCloseTrait 

struct OpenCloseTrait

This trait belongs to devices that support opening and closing, and in some cases opening and closing partially or potentially in more than one direction.

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by OpenCloseTrait.

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

    Declaration

    Swift

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

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

  • Current state for the given open direction.

    Declaration

    Swift

    struct DirectionOpenState

  • Follow up response for the open command.

    Declaration

    Swift

    struct OpenFollowUpEvent

  • Follow up response for the close command.

    Declaration

    Swift

    struct CloseFollowUpEvent

  • Follow up response for the goToOpenPercentage command.

    Declaration

    Swift

    struct GoToOpenPercentageFollowUpEvent

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

    Declaration

    Swift

    var supportsOpenCommand: Bool { get }

  • Fully open the device.

    Declaration

    Swift

    func open(openDirection: Google.OpenCloseTrait.Direction) async throws

    Parameters

    openDirection

    The direction in which to open. Only present if the device supports multiple directions, as indicated by the OpenCloseTrait/Attributes/openDirection attribute, and a direction is specified by the user.

  • The batchable version of open command above.

    See also

    open

    Declaration

    Swift

    func openBatchable(openDirection: Google.OpenCloseTrait.Direction) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsCloseCommand: Bool { get }

  • Fully close the device.

    Declaration

    Swift

    func close() async throws

  • The batchable version of close command above.

    See also

    close

    Declaration

    Swift

    func closeBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsGoToOpenPercentageCommand: Bool { get }

  • Open the device to a specific percentage, where 0 is closed and 100 is fully open.

    Declaration

    Swift

    func goToOpenPercentage(openPercent: Float64, openDirection: Google.OpenCloseTrait.Direction) async throws

    Parameters

    openPercent

    Indicates the percentage that a device should be opened, where 0 is closed and 100 is fully open.
    openDirection

    The direction in which to open. Only present if the device supports multiple directions, as indicated by the OpenCloseTrait/Attributes/openDirection attribute, and a direction is specified by the user.

  • The batchable version of goToOpenPercentage command above.

    See also

    goToOpenPercentage

    Declaration

    Swift

    func goToOpenPercentageBatchable(openPercent: Float64, openDirection: Google.OpenCloseTrait.Direction) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStepCommand: Bool { get }

  • Adjust the open-close state of the device relative to the current state.

    Declaration

    Swift

    func step(openRelativePercent: Float64, openDirection: Google.OpenCloseTrait.Direction) async throws

    Parameters

    openRelativePercent

    The exact percentage to change open-close state.
    openDirection

    The direction in which to open. Only present if the device supports multiple directions, as indicated by the OpenCloseTrait/Attributes/openDirection attribute, and a direction is specified by the user.

  • The batchable version of step command above.

    See also

    step

    Declaration

    Swift

    func stepBatchable(openRelativePercent: Float64, openDirection: Google.OpenCloseTrait.Direction) throws -> BatchableCommand<Void>

  • Direction in which the device is opened.

    Declaration

    Swift

    enum Direction

  • OpenClose trait FeatureMap.

    Declaration

    Swift

    struct OpenCloseFeature