src/app/zap-templates/zcl/media-input-cluster.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 Copyright (c) 2021 Project CHIP Authors
   4
   5 Licensed under the Apache License, Version 2.0 (the "License");
   6 you may not use this file except in compliance with the License.
   7 You may obtain a copy of the License at
   8
   9     http://www.apache.org/licenses/LICENSE-2.0
  10
  11 Unless required by applicable law or agreed to in writing, software
  12 distributed under the License is distributed on an "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 See the License for the specific language governing permissions and
  15 limitations under the License.
  16 -->
  17 <configurator>
  18   <domain name="CHIP"/>
  19   <cluster>
  20     <domain>General</domain>
  21     <name>Media Input</name>
  22     <code>0x0507</code>
  23     <define>MEDIA_INPUT_CLUSTER</define>
  24     <client init="false" tick="false">true</client>
  25     <server init="false" tick="false">true</server>
  26     <description>This cluster provides an interface for controlling the Input Selector on a media device such as a TV.</description>
  27     <attribute side="server" code="0x0000" define="MEDIA_INPUT_LIST" type="OCTET_STRING" length="32" writable="false" optional="false">media input list</attribute>
  28     <attribute side="server" code="0x0001" define="MEDIA_INPUT_CURRENT_INPUT" type="INT8U" min="0x00" max="0xFF" writable="false" default="0x00" optional="true">current media input</attribute>
  29
  30     <command source="client" code="0x00" name="SelectInput" optional="false">
  31       <description>Upon receipt, this SHALL change the input on the media device to the input at a specific index in the Input List.</description>
  32       <arg name="index" type="INT8U"/>
  33     </command>
  34
  35     <command source="client" code="0x01" name="ShowInputStatus" optional="false">
  36       <description>Upon receipt, this SHALL display the active status of the input list on screen.</description>
  37     </command>
  38
  39     <command source="client" code="0x02" name="HideInputStatus" optional="false">
  40       <description>Upon receipt, this SHALL hide the input list from the screen.</description>
  41     </command>
  42
  43     <command source="client" code="0x03" name="RenameInput" optional="false">
  44       <description>Upon receipt, this SHALL rename the input at a specific index in the Input List. Updates to the input name SHALL appear in the TV settings menus.    </description>
  45       <arg name="index" type="INT8U"/>
  46       <arg name="name" type="CHAR_STRING"/>
  47     </command>
  48
  49   </cluster>
  50
  51   <struct name="MediaInputInfo">
  52     <item name="Index" type="INT8U"/>
  53     <item name="InputType" type="MediaInputType"/>
  54     <item name="Name" type="CHAR_STRING"/>
  55     <item name="Description" type="CHAR_STRING"/>
  56   </struct>
  57
  58   <enum name="MediaInputType" type="ENUM8">
  59     <item name="Internal" value="0x00"/>
  60     <item name="Aux" value="0x01"/>
  61     <item name="Coax" value="0x02"/>
  62     <item name="Composite" value="0x03"/>
  63     <item name="Hdmi" value="0x04"/>
  64     <item name="Input" value="0x05"/>
  65     <item name="Line" value="0x06"/>
  66     <item name="Optical" value="0x07"/>
  67     <item name="Video" value="0x08"/>
  68     <item name="Scart" value="0x09"/>
  69     <item name="Usb" value="0x0A"/>
  70     <item name="Other" value="0x0B"/>
  71   </enum>
  72
  73 </configurator>