src/app/zap-templates/zcl/commissioning.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" spec="chip-0.7" dependsOn="zcl-1.0-07-5123-03" certifiable="true"/>
  19     <enum name="NetworkCommissioningError" type="ENUM8">
  20         <item name="Success" value="0x0"/>
  21         <item name="OutOfRange" value="0x1"/>
  22         <item name="BoundsExceeded" value="0x2"/>
  23         <item name="NetworkIDNotFound" value="0x3"/>
  24         <item name="DuplicateNetworkID" value="0x4"/>
  25         <item name="NetworkNotFound" value="0x5"/>
  26         <item name="RegulatoryError" value="0x6"/>
  27         <item name="AuthFailure" value="0x7"/>
  28         <item name="UnsupportedSecurity" value="0x8"/>
  29         <item name="OtherConnectionFailure" value="0x9"/>
  30         <item name="IPV6Failed" value="0xa"/>
  31         <item name="IPBindFailed" value="0xb"/>
  32         <item name="Label9" value="0xc"/>
  33         <item name="Label10" value="0xd"/>
  34         <item name="Label11" value="0xe"/>
  35         <item name="Label12" value="0xf"/>
  36         <item name="Label13" value="0x10"/>
  37         <item name="Label14" value="0x11"/>
  38         <item name="Label15" value="0x12"/>
  39         <item name="UnknownError" value="0x13"/>
  40     </enum>
  41     <bitmap name="SecurityType" type="BITMAP8">
  42         <field name="Unencrypted" mask="0x1"/>
  43         <field name="WEP-PERSONAL" mask="0x2"/>
  44         <field name="WPA-PERSONAL" mask="0x4"/>
  45         <field name="WPA2-PERSONAL" mask="0x8"/>
  46         <field name="WPA3-PERSONAL" mask="0x10"/>
  47     </bitmap>
  48     <struct name="WiFiInterfaceScanResult">
  49         <item name="Security" type="BITMAP8"/>
  50         <item name="SSID" type="OCTET_STRING"/>
  51         <item name="BSSID" type="OCTET_STRING"/>
  52         <item name="Channel" type="INT8U"/>
  53         <item name="FrequencyBand" type="INT32U"/>
  54     </struct>
  55     <struct name="ThreadInterfaceScanResult">
  56         <item name="DiscoveryResponse" type="OCTET_STRING"/>
  57     </struct>
  58     <cluster>
  59         <name>Network Commissioning</name>
  60         <domain>CHIP</domain>
  61         <description>TODO</description>
  62         <code>0x0031</code>
  63         <define>NETWORK_COMMISSIONING_CLUSTER</define>
  64         <client tick="false" init="false">true</client>
  65         <server tick="false" init="false">true</server>
  66         <command source="client" code="0x00" name="ScanNetworks" optional="false" cli="chip network_commissioning scannetworks">
  67             <description>TODO</description>
  68             <arg name="ssid" type="OCTET_STRING"/>
  69             <arg name="breadcrumb" type="INT64U"/>
  70             <arg name="timeoutMs" type="INT32U"/>
  71         </command>
  72         <command source="server" code="0x01" name="ScanNetworksResponse" optional="false" cli="chip network_commissioning scannetworksresponse">
  73             <description>TODO</description>
  74             <arg name="errorCode" type="INT8U"/>
  75             <arg name="debugText" type="CHAR_STRING"/>
  76             <arg name="wifiScanResults" type="WiFiInterfaceScanResult" array="true"/>
  77             <arg name="threadScanResults" type="ThreadInterfaceScanResult" array="true"/>
  78         </command>
  79         <command source="client" code="0x02" name="AddWiFiNetwork" optional="true" cli="chip network_commissioning addwifinetwork">
  80             <description>TODO</description>
  81             <arg name="ssid" type="OCTET_STRING"/>
  82             <arg name="credentials" type="OCTET_STRING"/>
  83             <arg name="breadcrumb" type="INT64U"/>
  84             <arg name="timeoutMs" type="INT32U"/>
  85         </command>
  86         <command source="server" code="0x03" name="AddWiFiNetworkResponse" optional="true" cli="chip network_commissioning addwifiresponse">
  87             <description>TODO</description>
  88             <arg name="errorCode" type="INT8U"/>
  89             <arg name="debugText" type="CHAR_STRING"/>
  90         </command>
  91         <command source="client" code="0x04" name="UpdateWiFiNetwork" optional="true" cli="chip network_commissioning updatewifinetwork">
  92             <description>TODO</description>
  93             <arg name="ssid" type="OCTET_STRING"/>
  94             <arg name="credentials" type="OCTET_STRING"/>
  95             <arg name="breadcrumb" type="INT64U"/>
  96             <arg name="timeoutMs" type="INT32U"/>
  97         </command>
  98         <command source="server" code="0x05" name="UpdateWiFiNetworkResponse" optional="true" cli="chip network_commissioning updatewifiresponse">
  99             <description>TODO</description>
 100             <arg name="errorCode" type="INT8U"/>
 101             <arg name="debugText" type="CHAR_STRING"/>
 102         </command>
 103         <command source="client" code="0x06" name="AddThreadNetwork" optional="true" cli="chip network_commissioning addthreadnetwork">
 104             <description>TODO</description>
 105             <arg name="operationalDataset" type="OCTET_STRING"/>
 106             <arg name="breadcrumb" type="INT64U"/>
 107             <arg name="timeoutMs" type="INT32U"/>
 108         </command>
 109         <command source="server" code="0x07" name="AddThreadNetworkResponse" optional="true" cli="chip network_commissioning addthreadnetworkresponse">
 110             <description>TODO</description>
 111             <arg name="errorCode" type="INT8U"/>
 112             <arg name="debugText" type="CHAR_STRING"/>
 113         </command>
 114         <command source="client" code="0x08" name="UpdateThreadNetwork" optional="true" cli="chip network_commissioning updatethreadnetwork">
 115             <description>TODO</description>
 116             <arg name="operationalDataset" type="OCTET_STRING"/>
 117             <arg name="breadcrumb" type="INT64U"/>
 118             <arg name="timeoutMs" type="INT32U"/>
 119         </command>
 120         <command source="server" code="0x09" name="UpdateThreadNetworkResponse" optional="true" cli="chip network_commissioning updatethreadnetworkresponse">
 121             <description>TODO</description>
 122             <arg name="errorCode" type="INT8U"/>
 123             <arg name="debugText" type="CHAR_STRING"/>
 124         </command>
 125         <command source="client" code="0x0a" name="RemoveNetwork" optional="false" cli="chip network_commissioning removenetwork">
 126             <description>TODO</description>
 127             <arg name="NetworkID" type="OCTET_STRING"/>
 128             <arg name="Breadcrumb" type="INT64U"/>
 129             <arg name="TimeoutMs" type="INT32U"/>
 130         </command>
 131         <command source="server" code="0x0b" name="RemoveNetworkResponse" optional="false" cli="chip network_commissioning removenetworkresponse">
 132             <description>TODO</description>
 133             <arg name="errorCode" type="INT8U"/>
 134             <arg name="debugText" type="CHAR_STRING"/>
 135         </command>
 136         <command source="client" code="0x0c" name="EnableNetwork" optional="false" cli="chip network_commissioning enablenetwork">
 137             <description>TODO</description>
 138             <arg name="networkID" type="OCTET_STRING"/>
 139             <arg name="breadcrumb" type="INT64U"/>
 140             <arg name="timeoutMs" type="INT32U"/>
 141         </command>
 142         <command source="server" code="0x0d" name="EnableNetworkResponse" optional="false" cli="chip network_commissioning enablenetworkresponse">
 143             <description>TODO</description>
 144             <arg name="errorCode" type="INT8U"/>
 145             <arg name="debugText" type="CHAR_STRING"/>
 146         </command>
 147         <command source="client" code="0x0e" name="DisableNetwork" optional="false" cli="chip network_commissioning disablenetwork">
 148             <description>TODO</description>
 149             <arg name="networkID" type="OCTET_STRING"/>
 150             <arg name="breadcrumb" type="INT64U"/>
 151             <arg name="timeoutMs" type="INT32U"/>
 152         </command>
 153         <command source="server" code="0x0f" name="DisableNetworkResponse" optional="false" cli="chip network_commissioning disablenetworkresponse">
 154             <description>TODO</description>
 155             <arg name="errorCode" type="INT8U"/>
 156             <arg name="debugText" type="CHAR_STRING"/>
 157         </command>
 158         <command source="client" code="0x10" name="GetLastNetworkCommissioningResult" optional="false" cli="chip network_commissioning getlastnetworkcommissioningresult">
 159             <description>TODO</description>
 160             <arg name="timeoutMs" type="INT32U"/>
 161         </command>
 162     </cluster>
 163 </configurator>