Variable PositionTagConst

PositionTag: Of<{
    id: 8;
    tags: {
        Bottom: {
            id: 3;
            label: "Bottom";
        };
        Column: {
            id: 6;
            label: "Column";
        };
        Left: {
            id: 0;
            label: "Left";
        };
        Middle: {
            id: 4;
            label: "Middle";
        };
        Right: {
            id: 1;
            label: "Right";
        };
        Row: {
            id: 5;
            label: "Row";
        };
        Top: {
            id: 2;
            label: "Top";
        };
    };
}> = ...

The tags contained in this namespace may be used in any domain or context, to indicate an association with a position relative to the device (e.g. the temperature sensor in the top drawer of a refrigerator, or location of the buttons on a multi-button switch device). Note the difference with Chapter 5, Common Direction Semantic Tag Namespace.

When multiple endpoints are used for device types, and the associated consumer-facing locations of those endpoints are organized in a straight line, grid or matrix, these endpoints SHOULD be allocated in top-to-bottom, left-to-right order.

For grids or arrays larger than 3 elements in any direction, the Row and Column tags SHOULD be used.

If the Row or Column tags are used, the Label field in the same Semantic Tag structure shall be filled with a number comprised of Arabic numerals encoded as a string to indicate the row/column of the item. Number words (e.g. "one", "two", etc.) shall NOT be used to describe the position of the item. The first row/column shall use Label "1".

Type declaration

  • Readonlyid: 8
  • Readonlytags: {
        Bottom: {
            id: 3;
            label: "Bottom";
        };
        Column: {
            id: 6;
            label: "Column";
        };
        Left: {
            id: 0;
            label: "Left";
        };
        Middle: {
            id: 4;
            label: "Middle";
        };
        Right: {
            id: 1;
            label: "Right";
        };
        Row: {
            id: 5;
            label: "Row";
        };
        Top: {
            id: 2;
            label: "Top";
        };
    }
    • ReadonlyBottom: {
          id: 3;
          label: "Bottom";
      }
      • Readonlyid: 3
      • Readonlylabel: "Bottom"
    • ReadonlyColumn: {
          id: 6;
          label: "Column";
      }

      Numeric value provided in Label field

      • Readonlyid: 6
      • Readonlylabel: "Column"
    • ReadonlyLeft: {
          id: 0;
          label: "Left";
      }
      • Readonlyid: 0
      • Readonlylabel: "Left"
    • ReadonlyMiddle: {
          id: 4;
          label: "Middle";
      }
      • Readonlyid: 4
      • Readonlylabel: "Middle"
    • ReadonlyRight: {
          id: 1;
          label: "Right";
      }
      • Readonlyid: 1
      • Readonlylabel: "Right"
    • ReadonlyRow: {
          id: 5;
          label: "Row";
      }

      Numeric value provided in Label field

      • Readonlyid: 5
      • Readonlylabel: "Row"
    • ReadonlyTop: {
          id: 2;
          label: "Top";
      }
      • Readonlyid: 2
      • Readonlylabel: "Top"

See

MatterSpecification.v13.Namespace § 9

Settings

Member Visibility