Console

ErrorStateStruct 

struct ErrorStateStruct

Used to indicate the error state of the device when the operationalState attribute is Error.

  • Present only when errorStateId is populated with a vendor-specific error ID.

    Declaration

    Swift

    let errorStateLabel: String?

  • Details about the error condition.

    Declaration

    Swift

    let errorStateDetails: 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)?