Console

ModeOptionStruct 

struct ModeOptionStruct

Represents the possible mode of the cluster instance.

  • Readable text that describes the mode option for the user.

    Declaration

    Swift

    let label: String

  • Identifies the mode option for the supportedModes attribute.

    Declaration

    Swift

    let mode: UInt8

  • A list of semantic tags for the mode option, used to determine the meaning of the mode as defined in a standard- or manufacturer-specific namespace. These values are defined in SemanticTagStruct.

    Declaration

    Swift

    let semanticTags: [Matter.ModeSelectTrait.SemanticTagStruct]

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