TlvModeOption: ObjectSchema<{
    label: FieldType<string>;
    mode: FieldType<number>;
    semanticTags: FieldType<TypeFromFields<{
        mfgCode: FieldType<VendorId>;
        value: FieldType<number>;
    }>[]>;
}> = ...

This is a struct representing a possible mode of the server.

Type declaration

  • label: FieldType<string>

    This field is readable text that describes the mode option that can be used by a client to indicate to the user what this option means. This field is meant to be readable and understandable by the user.

    MatterSpecification.v13.Cluster § 1.9.5.2.1

  • mode: FieldType<number>

    The Mode field is used to identify the mode option. The value shall be unique for every item in the SupportedModes attribute.

    MatterSpecification.v13.Cluster § 1.9.5.2.2

  • semanticTags: FieldType<TypeFromFields<{
        mfgCode: FieldType<VendorId>;
        value: FieldType<number>;
    }>[]>

    This field is a list of semantic tags that map to the mode option. This may be used by clients to determine the meaning of the mode option as defined in a standard or manufacturer specific namespace. Semantic tags can help clients look for options that meet certain criteria. A semantic tag shall be either a standard tag or manufacturer specific tag as defined in each SemanticTagStruct list entry.

    A mode option may have more than one semantic tag. A mode option may be mapped to a mixture of standard and manufacturer specific semantic tags.

    All standard semantic tags are from a single namespace indicated by the StandardNamespace attribute.

    For example: A mode labeled "100%" can have both the HIGH (MS) and MAX (standard) semantic tag. Clients seeking the option for either HIGH or MAX will find the same option in this case.

    MatterSpecification.v13.Cluster § 1.9.5.2.3

MatterSpecification.v13.Cluster § 1.9.5.2