Console

ModeOptionStruct 

struct ModeOptionStruct

Describes a mode that may be selected on the device.

  • Text that describes the mode option and is meant to be read and understood by the user.

    Declaration

    Swift

    let label: String

  • A unique identifier for the mode option.

    Declaration

    Swift

    let mode: UInt8

  • A list of tags that are associated with the mode option, which may be used by a device to determine the semantics of a certain mode.

    Declaration

    Swift

    let modeTags: [Matter.RvcCleanModeTrait.ModeTagStruct]

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