/**
 * @license
 * Copyright 2022-2026 Matter.js Authors
 * SPDX-License-Identifier: Apache-2.0
 */
import { Resource } from "#models/Resource.js";
Resource.add({
  tag: "cluster",
  name: "ModeSelect",
  pics: "MOD",
  xref: "cluster\xA71.9",
  details: "This cluster provides an interface for controlling a characteristic of a device that can be set to one of several predefined values. For example, the light pattern of a disco ball, the mode of a massage chair, or the wash cycle of a laundry machine.\nThe server allows the client to set a mode on the server. A mode is one of a list of options that may be presented by a client for a user choice, or understood by the client, via the semantic tags on the mode.\nA semantic tag is either a standard tag within a standard category namespace, or a manufacturer specific tag, within the namespace of the vendor ID of the manufacturer. If there is no semantic tag, the mode is anonymous, and the selection is made by the user solely based on the Label string.\nEach cluster ID that indicates this specification shall define a distinct purpose for the cluster instance. For example: A LightBlinking cluster ID supports blinking modes for a light (and is described that way).\nAn anonymous mode shall support the derived cluster purpose. A manufacturer specific semantic tag shall support the derived cluster purpose. An anonymous mode shall NOT replace the meaning of a standard semantic tag, when one exists, for the cluster purpose.",
  children: [
    {
      tag: "attribute",
      name: "FeatureMap",
      xref: "cluster\xA71.9.4",
      children: [{
        tag: "field",
        name: "DEPONOFF",
        xref: "cluster\xA71.9.4.1",
        details: "This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same endpoint. See Section 1.9.6.6, \u201COnMode Attribute\u201D for more information."
      }]
    },
    {
      tag: "attribute",
      name: "Description",
      xref: "cluster\xA71.9.6.1",
      details: "This attribute describes the purpose of the server, in readable text.\nFor example, a coffee machine may have a Mode Select cluster for the amount of milk to add, and another Mode Select cluster for the amount of sugar to add. In this case, the first instance can have the description Milk and the second instance can have the description Sugar. This allows the user to tell the purpose of each of the instances."
    },
    {
      tag: "attribute",
      name: "StandardNamespace",
      xref: "cluster\xA71.9.6.2",
      details: "This attribute, when not null, shall indicate a single standard namespace for any standard semantic tag value supported in this or any other cluster instance with the same value of this attribute. A null value indicates no standard namespace, and therefore, no standard semantic tags are provided in this cluster instance. Each standard namespace and corresponding values and value meanings shall be defined in another document."
    },
    {
      tag: "attribute",
      name: "SupportedModes",
      xref: "cluster\xA71.9.6.3",
      details: "This attribute is the list of supported modes that may be selected for the CurrentMode attribute. Each item in this list represents a unique mode as indicated by the Mode field of the ModeOptionStruct. Each entry in this list shall have a unique value for the Mode field."
    },
    {
      tag: "attribute",
      name: "CurrentMode",
      xref: "cluster\xA71.9.6.4",
      details: "This attribute represents the current mode of the server.\nThe value of this field must match the Mode field of one of the entries in the SupportedModes attribute."
    },
    {
      tag: "attribute",
      name: "StartUpMode",
      xref: "cluster\xA71.9.6.5",
      details: "The StartUpMode attribute value indicates the desired startup mode for the server when it is supplied with power.\nIf this attribute is not null, the CurrentMode attribute shall be set to the StartUpMode value, when the server is powered up, except in the case when the OnMode attribute overrides the StartUpMode attribute (see Section 1.9.6.6.1, \u201COnMode with Power Up\u201D).\nThis behavior does not apply to reboots associated with OTA. After an OTA restart, the CurrentMode attribute shall return to its value prior to the restart.\nThe value of this field shall match the Mode field of one of the entries in the SupportedModes attribute.\nIf this attribute is not implemented, or is set to the null value, it shall have no effect."
    },
    {
      tag: "attribute",
      name: "OnMode",
      xref: "cluster\xA71.9.6.6",
      details: "Indicates the value of CurrentMode that depends on the state of the On/Off cluster on the same endpoint. If this attribute is not present or is set to null, it shall NOT have an effect, otherwise the CurrentMode attribute shall depend on the OnOff attribute of the On/Off cluster\nThe value of this field shall match the Mode field of one of the entries in the SupportedModes attribute."
    },
    {
      tag: "command",
      name: "ChangeToMode",
      xref: "cluster\xA71.9.7.1",
      details: "On receipt of this command, if the NewMode field indicates a valid mode transition within the supported list, the server shall set the CurrentMode attribute to the NewMode value, otherwise, the server shall respond with an INVALID_COMMAND status response."
    },
    {
      tag: "datatype",
      name: "SemanticTagStruct",
      xref: "cluster\xA71.9.5.1",
      details: "A Semantic Tag is meant to be interpreted by the client for the purpose the cluster serves.",
      children: [
        {
          tag: "field",
          name: "MfgCode",
          xref: "cluster\xA71.9.5.1.2",
          details: 'This field shall indicate a manufacturer code (Vendor ID), and the Value field shall indicate a semantic tag defined by the manufacturer. Each manufacturer code supports a single namespace of values. The same manufacturer code and semantic tag value in separate cluster instances are part of the same namespace and have the same meaning. For example: a manufacturer tag meaning "pinch", has the same meaning in a cluster whose purpose is to choose the amount of sugar, or amount of salt.'
        },
        {
          tag: "field",
          name: "Value",
          xref: "cluster\xA71.9.5.1.1",
          details: "This field shall indicate the semantic tag within a semantic tag namespace which is either manufacturer specific or standard. For semantic tags in a standard namespace, see Standard Namespace."
        }
      ]
    },
    {
      tag: "datatype",
      name: "ModeOptionStruct",
      xref: "cluster\xA71.9.5.2",
      details: "This is a struct representing a possible mode of the server.",
      children: [
        {
          tag: "field",
          name: "Label",
          xref: "cluster\xA71.9.5.2.1",
          details: "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."
        },
        {
          tag: "field",
          name: "Mode",
          xref: "cluster\xA71.9.5.2.2",
          details: "The Mode field is used to identify the mode option. The value shall be unique for every item in the SupportedModes attribute."
        },
        {
          tag: "field",
          name: "SemanticTags",
          xref: "cluster\xA71.9.5.2.3",
          details: '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.\nA 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.\nAll standard semantic tags are from a single namespace indicated by the StandardNamespace attribute.\nFor 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.'
        }
      ]
    }
  ]
});
//# sourceMappingURL=mode-select-cluster.resource.js.map
