Console

OverallTargetStateStruct 

struct OverallTargetStateStruct

The target state of the closure.

  • The target position that the closure is moving to. A null value indicates there is no target position.

    Declaration

    Swift

    let position: Matter.ClosureControlTrait.TargetPositionEnum?

  • The desired latching state of the closure. A null value indicates that there is no desired latching state.

    Declaration

    Swift

    let latch: Bool?

  • The desired speed at which the closure should perform the movement toward the target position. If no speed value has yet been set, the server sets one of the speed values defined in ThreeLevelAutoEnum.

    Declaration

    Swift

    let speed: Matter.ClosureControlTrait.ThreeLevelAutoEnum?

  • Creates a new Struct instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder) throws

    Parameters

    decoder

    The raw data representing this Struct.

  • Writes this Struct to the given TraitEncoder. Throws HomeError.parseError if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • Returns the field corresponding to the given field ID.

    Declaration

    Swift

    static func structField(id: UInt32) -> (any Field)?