Console

DimensionStateStruct 

struct DimensionStateStruct

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

  • The position of the closure, expressed as a percentage from 0.00% to 100.00%.

    Declaration

    Swift

    let position: UInt16?

  • The latching state of the closure. A null value indicates that the latching state is not known or is not set.

    Declaration

    Swift

    let latch: Bool?

  • The speed of the closure, as defined in the ThreeLevelAutoEnum.

    Declaration

    Swift

    let speed: Matter.ClosureDimensionTrait.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)?