administrator-commissioning-cluster.xml

<?xml version="1.0"?>
<!--
Copyright (c) 2021 Project CHIP Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<configurator>
  <domain name="General"/>

  <enum name="StatusCode" type="enum8">
    <cluster code="0x003c"/>
     <item name="Busy" value="0x02"/>
     <item name="PAKEParameterError" value="0x03"/>
     <item name="WindowNotOpen" value="0x04"/>
  </enum>

  <enum name="CommissioningWindowStatusEnum" type="enum8">
    <cluster code="0x003c"/>
     <item name="WindowNotOpen" value="0x00"/>
     <item name="EnhancedWindowOpen" value="0x01"/>
     <item name="BasicWindowOpen" value="0x02"/>
  </enum>

  <cluster>
    <name>Administrator Commissioning</name>
    <domain>General</domain>
    <code>0x003c</code>
    <define>ADMINISTRATOR_COMMISSIONING_CLUSTER</define>
    <description>Commands to trigger a Node to allow a new Administrator to commission it.</description>

    <features>
      <feature bit="0" code="BC" name="Basic" summary="Node supports Basic Commissioning Method.">
        <optionalConform/>
      </feature>
    </features>
    <attribute side="server" code="0x0000" name="WindowStatus" define="WINDOW_STATUS" type="CommissioningWindowStatusEnum">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0001" name="AdminFabricIndex" define="ADMIN_FABRIC_INDEX" type="fabric_idx" isNullable="true">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0002" name="AdminVendorId" define="ADMIN_VENDOR_ID" type="vendor_id" isNullable="true">
      <mandatoryConform/>
    </attribute>
    
    <command source="client" code="0x00" name="OpenCommissioningWindow" mustUseTimedInvoke="true" optional="false">
      <description>This command is used by a current Administrator to instruct a Node to go into commissioning mode using enhanced commissioning method.</description>
      <arg name="CommissioningTimeout" type="int16u"/>
      <arg name="PAKEPasscodeVerifier" type="octet_string"/>
      <arg name="Discriminator" type="int16u"/>
      <arg name="Iterations" type="int32u"/>
      <arg name="Salt" type="octet_string" length="32"/>
      <access op="invoke" privilege="administer"/>
      <mandatoryConform/>
    </command>

    <command source="client" code="0x01" name="OpenBasicCommissioningWindow" mustUseTimedInvoke="true" optional="true">
      <description>This command is used by a current Administrator to instruct a Node to go into commissioning mode using basic commissioning method, if the node supports it.</description>
      <arg name="CommissioningTimeout" type="int16u"/>
      <access op="invoke" privilege="administer"/>
      <mandatoryConform>
        <feature name="BC"/>
      </mandatoryConform>
    </command>

    <command source="client" code="0x02" name="RevokeCommissioning" mustUseTimedInvoke="true" optional="false">
      <description>This command is used by a current Administrator to instruct a Node to revoke any active Open Commissioning Window or Open Basic Commissioning Window command.</description>
      <access op="invoke" privilege="administer"/>
      <mandatoryConform/>
    </command>

  </cluster>
</configurator>