-
Notifications
You must be signed in to change notification settings - Fork 2.4k
CommissioningProxy PR1: add cluster definition and generated code #72600
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mergify
merged 6 commits into
project-chip:master
from
simonhmorris1:cp-pr1-cluster-def
Jun 23, 2026
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7f88dba
CommissioningProxy: add cluster definition and generated code
simonhmorris1 678b127
Remove PythonProxyCommissioner, CHI, add CachedResults
simonhmorris1 9bd1d68
Adds missing CP auto-gen config
simonhmorris1 ae4c1ed
CommissioningProxy: register cluster XML in ZAP codegen config
simonhmorris1 b543fdf
Removes CP active Python code
simonhmorris1 b871472
Merge branch 'master' into cp-pr1-cluster-def
simonhmorris1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
168 changes: 168 additions & 0 deletions
168
src/app/zap-templates/zcl/data-model/chip/commissioning-proxy-cluster.xml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| <?xml version="1.0"?> | ||
| <!-- | ||
| Copyright (c) 2026 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. | ||
| --> | ||
| <!-- | ||
| XML generated by Alchemy; DO NOT EDIT. | ||
| Source: src/app_clusters/CommissioningProxy.adoc | ||
| Parameters: zap attribute=hrap-proxy attribute=in-progress sdk-root=../connectedhomeip spec-root=./ ./src/app_clusters/CommissioningProxy.adoc | ||
| Git: v0.0.1-1599-g914288416 | ||
| Alchemy: v1.6.12 | ||
| --> | ||
| <configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd"> | ||
| <domain name=""/> | ||
| <bitmap name="CapabilitiesBitmap" type="bitmap8"> | ||
| <cluster code="0x0455"/> | ||
| <field name="BLE" mask="0x02"/> | ||
| <field name="WiFiPAF" mask="0x08"/> | ||
| <field name="NTL" mask="0x10"/> | ||
| </bitmap> | ||
|
|
||
| <bitmap name="WiFiBandBitmap" type="bitmap16"> | ||
| <cluster code="0x0455"/> | ||
| <field name="2G4" mask="0x0001"/> | ||
| <field name="5G" mask="0x0004"/> | ||
| </bitmap> | ||
|
|
||
| <struct name="ScanResultStruct" apiMaturity="provisional"> | ||
| <cluster code="0x0455"/> | ||
| <item fieldId="0" name="Address" type="octet_string" isNullable="true" length="100"/> | ||
| <item fieldId="1" name="Transport" type="CapabilitiesBitmap" max="0x1A"/> | ||
| <item fieldId="2" name="Discriminator" type="int16u" max="4095"/> | ||
| <item fieldId="3" name="VendorID" type="vendor_id"/> | ||
| <item fieldId="4" name="ProductID" type="int16u"/> | ||
| <item fieldId="5" name="ExtendedData" type="octet_string" isNullable="true" length="128"/> | ||
| <item fieldId="6" name="WiFiBand" type="WiFiBandBitmap" optional="true" max="0x0005"/> | ||
| </struct> | ||
|
|
||
| <cluster apiMaturity="provisional"> | ||
| <domain>Network Infrastructure</domain> | ||
| <name>Commissioning Proxy</name> | ||
| <code>0x0455</code> | ||
| <define>COMMISSIONING_PROXY_CLUSTER</define> | ||
| <description>This cluster provides a proxy service allowing a Commissioner to utilize commissioning transports not supported locally, or to extend the commissioning range of the Commissioner.</description> | ||
| <client init="false" tick="false">true</client> | ||
| <server init="false" tick="false">true</server> | ||
| <globalAttribute code="0xFFFD" side="either" value="1"/> | ||
| <features> | ||
| <feature bit="0" code="WI" name="WiFiNetworkInterface" summary="Wi-Fi related features"> | ||
| <optionalConform/> | ||
| </feature> | ||
| <feature bit="1" code="BGS" name="BackgroundScan" summary="Background scan"> | ||
| <optionalConform/> | ||
| </feature> | ||
| </features> | ||
| <attribute code="0x0000" side="server" name="Transport" define="TRANSPORT" type="CapabilitiesBitmap" min="1"/> | ||
| <attribute code="0x0001" side="server" name="ScanMaxTime" define="SCAN_MAX_TIME" type="int8u" min="1" writable="true"/> | ||
| <attribute code="0x0002" side="server" name="MaxSessions" define="MAX_SESSIONS" type="int8u" min="1"/> | ||
| <attribute code="0x0003" side="server" name="MaxCachedResults" define="MAX_CACHED_RESULTS" type="int8u" min="1" optional="true"> | ||
| <mandatoryConform> | ||
| <feature name="BGS"/> | ||
| </mandatoryConform> | ||
| </attribute> | ||
| <attribute code="0x0004" side="server" name="NumCachedResults" define="NUM_CACHED_RESULTS" type="int8u" optional="true"> | ||
| <mandatoryConform> | ||
| <feature name="BGS"/> | ||
| </mandatoryConform> | ||
| </attribute> | ||
| <attribute code="0x0005" side="server" name="CacheTimeout" define="CACHE_TIMEOUT" type="int16u" min="1" writable="true" optional="true"> | ||
| <mandatoryConform> | ||
| <feature name="BGS"/> | ||
| </mandatoryConform> | ||
| </attribute> | ||
| <attribute code="0x0006" side="server" name="CachedResults" define="CACHED_RESULTS" type="array" entryType="ScanResultStruct" isNullable="true" length="255" optional="true"> | ||
| <mandatoryConform> | ||
| <feature name="BGS"/> | ||
| </mandatoryConform> | ||
| </attribute> | ||
| <attribute code="0x0007" side="server" name="WiFiBand" define="WI_FI_BAND" type="WiFiBandBitmap" max="0x0005" optional="true"> | ||
| <optionalConform> | ||
| <feature name="WI"/> | ||
| </optionalConform> | ||
| </attribute> | ||
| <command code="0x00" source="client" name="ProxyConnectRequest" response="ProxyConnectResponse" isFabricScoped="true"> | ||
| <description>This command serves to establish a transport connection to a commissionable device discovered by the proxy.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="Address" type="octet_string" isNullable="true" length="100"/> | ||
| <arg fieldId="1" name="Transport" type="CapabilitiesBitmap" max="0x1A"/> | ||
| <arg fieldId="2" name="Discriminator" type="int16u" max="4095"/> | ||
| <arg fieldId="3" name="VendorID" type="vendor_id"/> | ||
| <arg fieldId="4" name="ProductID" type="int16u"/> | ||
| <arg fieldId="5" name="Timeout" type="int16u"/> | ||
| <arg fieldId="6" name="WiFiBand" type="WiFiBandBitmap" optional="true" max="0x0005"/> | ||
| </command> | ||
|
|
||
| <command code="0x01" source="server" name="ProxyConnectResponse" disableDefaultResponse="true"> | ||
| <description>This command provides the results of the ProxyConnectRequest Command and a unique SessionID for this proxy commissioning session.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="SessionID" type="int16u" max="65534"/> | ||
| </command> | ||
|
|
||
| <command code="0x02" source="client" name="ProxyDisconnectRequest" isFabricScoped="true"> | ||
| <description>This disconnects a transport connection created via the ProxyConnectRequest command.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="SessionID" type="int16u" isNullable="true"/> | ||
| </command> | ||
|
|
||
| <command code="0x03" source="client" name="ProxyScanRequest" response="ProxyScanResponse"> | ||
| <description>This command requests the proxy to provide a list of all commissionable devices found on the requested transports and bands.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="Transport" type="CapabilitiesBitmap" max="0x1A"/> | ||
| <arg fieldId="1" name="WiFiBands" type="WiFiBandBitmap" optional="true" max="0x0005"/> | ||
| </command> | ||
|
|
||
| <command code="0x04" source="server" name="ProxyScanResponse" disableDefaultResponse="true"> | ||
| <description>This command is used to present results to the Commissioner.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="NumberOfResults" type="int8u"/> | ||
| <arg fieldId="1" name="ProxyScanResult" array="true" type="ScanResultStruct" length="255"/> | ||
| </command> | ||
|
|
||
| <command code="0x05" source="client" name="ProxyBackGroundScanStartRequest" optional="true"> | ||
| <description>This command requests the proxy to start background scanning for commissionable devices on the selected transports.</description> | ||
| <arg fieldId="0" name="Transport" type="CapabilitiesBitmap" max="0x1A"/> | ||
| <arg fieldId="1" name="Timeout" type="int16u"/> | ||
| <arg fieldId="2" name="WiFiBands" type="WiFiBandBitmap" optional="true" max="0x0005"/> | ||
| <mandatoryConform> | ||
| <feature name="BGS"/> | ||
| </mandatoryConform> | ||
| </command> | ||
|
|
||
| <command code="0x06" source="client" name="ProxyBackGroundScanStopRequest" optional="true"> | ||
| <description>This command requests the proxy to stop background scanning for commissionable devices on the selected transports.</description> | ||
| <arg fieldId="0" name="Transport" type="CapabilitiesBitmap" max="0x1A"/> | ||
| <arg fieldId="1" name="WiFiBands" type="WiFiBandBitmap" optional="true" max="0x0005"/> | ||
| <mandatoryConform> | ||
| <feature name="BGS"/> | ||
| </mandatoryConform> | ||
| </command> | ||
|
|
||
| <command code="0x07" source="client" name="ProxyMessageRequest" response="ProxyMessageResponse" isFabricScoped="true"> | ||
| <description>This command sends a message packet to the proxy.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="SessionID" type="int16u"/> | ||
| <arg fieldId="1" name="ResponseTimeout" type="int8u"/> | ||
| <arg fieldId="2" name="Message" type="long_octet_string" isNullable="true" length="1280"/> | ||
| </command> | ||
|
|
||
| <command code="0x08" source="server" name="ProxyMessageResponse" disableDefaultResponse="true"> | ||
| <description>This command is used to transfer messages originating from the Commissionee to the Commissioner.</description> | ||
| <quality largeMessage="true"/> | ||
| <arg fieldId="0" name="SessionID" type="int16u"/> | ||
| <arg fieldId="1" name="Message" type="long_octet_string" isNullable="true" length="1280"/> | ||
| </command> | ||
|
|
||
| </cluster> | ||
| </configurator> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.