wifi-network-management-cluster.xml

<?xml version="1.0"?>
<!--
Copyright (c) 2024 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="CHIP"/>

    <cluster>
        <domain>Network Infrastructure</domain>
        <name>Wi-Fi Network Management</name>
        <code>0x0451</code>
        <define>WIFI_NETWORK_MANAGEMENT_CLUSTER</define>
        <description>Functionality to retrieve operational information about a managed Wi-Fi network.</description>

        <client tick="false" init="false">true</client>
        <server tick="false" init="false">true</server>

        <!-- cluster revision -->
        <globalAttribute side="either" code="0xFFFD" value="1"/>

        <attribute side="server" code="0x0000" name="SSID" define="SSID" type="octet_string" length="32" writable="false" isNullable="true" optional="false">
            <mandatoryConform/>
        </attribute>
        <attribute side="server" code="0x0001" name="PassphraseSurrogate" define="PASSPHRASE_SURROGATE" type="int64u" writable="false" isNullable="true" optional="false">
            <access op="read" privilege="manage"/>
            <mandatoryConform/>
        </attribute>

        <command source="client" code="0x00" name="NetworkPassphraseRequest" optional="false" response="NetworkPassphraseResponse">
            <description>Request the current WPA-Personal passphrase or PSK associated with the managed Wi-Fi network.</description>
            <access op="invoke" privilege="manage"/>
            <mandatoryConform/>
        </command>
        <command source="server" code="0x01" name="NetworkPassphraseResponse" optional="false">
            <description>This is the response to a NetworkPassphraseRequest.</description>
            <arg name="Passphrase" type="octet_string" length="64"/>
            <mandatoryConform/>
        </command>
    </cluster>
</configurator>