Console

ClosureDimensionTrait 

struct ClosureDimensionTrait

This trait provides an interface for controlling a single degree of freedom (also referred to as a dimension or an axis) of a composed closure. Some device types may define that a Closure Dimension trait instance is associated with a corresponding Closure Control trait instance on the same device. In such cases, the Closure Dimension trait does not operate independently, rather, it relies on the Closure Control trait for supervisory logic.

  • No supported events for ClosureDimensionTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ClosureDimensionTrait.

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

    Declaration

    Swift

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

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

  • Describes the current state of a dimension of a composed closure.

    Declaration

    Swift

    struct DimensionStateStruct

  • Defines an operational range, from a minimum to a maximum percentage. for a dimension of a closure.

    Declaration

    Swift

    struct RangePercent100thsStruct

  • Defines an operational range, from a minimum to a maximum value, for a dimension of a closure.

    Declaration

    Swift

    struct UnitRangeStruct

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

    Declaration

    Swift

    var supportsSetTargetCommand: Bool { get }

  • Moves a dimension of the closure to a target position.

    Declaration

    Swift

    func setTarget(optionalArgsProvider: ((Matter.ClosureDimensionTrait.SetTargetCommand.OptionalArgs) -> Void)? = nil) async throws

  • The batchable version of setTarget command above.

    See also

    setTarget

    Declaration

    Swift

    func setTargetBatchable(optionalArgsProvider: ((Matter.ClosureDimensionTrait.SetTargetCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStepCommand: Bool { get }

  • Moves a dimension of the closure by a specified number of steps to a target position.

    Declaration

    Swift

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

    Parameters

    direction

    Indicates whether the Position field of the TargetState attribute must be increased toward 100.00% or decreased toward 0.00%.
    numberOfSteps

    The number of steps by which the position should be changed. The size of one step, given in hundredths of a percent, is determined by the stepValue attribute.

  • The batchable version of step command above.

    See also

    step

    Declaration

    Swift

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

  • Used to set the speed of the closure.

    Declaration

    Swift

    enum ThreeLevelAutoEnum

  • Describes the units of measure for a dimension of a composed closure. The unit range is determined by the values stored in the min and max fields of the UnitRangeStruct.

    Declaration

    Swift

    enum ClosureUnitEnum

  • Describes the modulation type of a composed closure.

    Declaration

    Swift

    enum ModulationTypeEnum

  • Describes the overflow state of a composed closure.

    Declaration

    Swift

    enum OverflowEnum

  • Describes the axis of rotation of a panel.

    Declaration

    Swift

    enum RotationAxisEnum

  • Describes the direction of a step motion for a composed closure.

    Declaration

    Swift

    enum StepDirectionEnum

  • Describes the direction of translation for a composed closure.

    Declaration

    Swift

    enum TranslationDirectionEnum

  • ClosureDimension cluster FeatureMap.

    Declaration

    Swift

    struct Feature

  • Describes the latch control modes supported by the closure dimension.

    Declaration

    Swift

    struct LatchControlModesBitmap