Console

ClosureControlTrait 

struct ClosureControlTrait

This trait provides an interface for controlling a closure.

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ClosureControlTrait.

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

    Declaration

    Swift

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

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

  • The current state of the closure.

    Declaration

    Swift

    struct OverallCurrentStateStruct

  • The target state of the closure.

    Declaration

    Swift

    struct OverallTargetStateStruct

  • A reportable error condition has been detected.

    Declaration

    Swift

    struct OperationalErrorEvent

  • Indicates that an overall operation has ended, either successfully or otherwise. For example, this event gets sent upon the completion of a movement operation of blinds or curtains.

    Declaration

    Swift

    struct MovementCompletedEvent

  • Generated when the MainStateEnum attribute changes state to and from Disengaged, indicating if the actuator is engaged or disengaged.

    Declaration

    Swift

    struct EngageStateChangedEvent

  • Generated when the SecureState field in the OverallCurrentState attribute changes, and is used to indicate whether a closure is securing a space against possible unauthorized entry.

    Declaration

    Swift

    struct SecureStateChangedEvent

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

    Declaration

    Swift

    var supportsStopCommand: Bool { get }

  • Stops the closure.

    Declaration

    Swift

    func stop() async throws

  • The batchable version of stop command above.

    See also

    stop

    Declaration

    Swift

    func stopBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsMoveToCommand: Bool { get }

  • The closure updates its position, latch state and motion speed.

    Declaration

    Swift

    func moveTo(optionalArgsProvider: ((Matter.ClosureControlTrait.MoveToCommand.OptionalArgs) -> Void)? = nil) async throws

  • The batchable version of moveTo command above.

    See also

    moveTo

    Declaration

    Swift

    func moveToBatchable(optionalArgsProvider: ((Matter.ClosureControlTrait.MoveToCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsCalibrateCommand: Bool { get }

  • Initiates a calibration of the closure. Procedures of how to achieve the calibration are manufacturer-specific.

    Declaration

    Swift

    func calibrate() async throws

  • The batchable version of calibrate command above.

    See also

    calibrate

    Declaration

    Swift

    func calibrateBatchable() throws -> BatchableCommand<Void>

  • Used to set the speed of the closure.

    Declaration

    Swift

    enum ThreeLevelAutoEnum

  • Error states that can be reported by the closure. The value range of 0x00 to 0x7F is for general errors, and the range of 0x80 to 0xBF is for vendor-specific errors.

    Declaration

    Swift

    enum ClosureErrorEnum

  • The current position of the closure.

    Declaration

    Swift

    enum CurrentPositionEnum

  • The current operational state of the closure.

    Declaration

    Swift

    enum MainStateEnum

  • The target position of the closure.

    Declaration

    Swift

    enum TargetPositionEnum

  • ClosureControl trait FeatureMap.

    Declaration

    Swift

    struct Feature

  • ClosureControl trait LatchControlModesBitmap.

    Declaration

    Swift

    struct LatchControlModesBitmap