Console

OperationalStateStruct 

struct OperationalStateStruct

Used to indicate a possible state of the device.

  • A human-readable description of the operational state. Only present when the operationalStateId is vendor-specific.

    Declaration

    Swift

    let operationalStateLabel: String?

  • 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)?