|
| 1 | +<?xml version="1.0"?> |
| 2 | +<!-- |
| 3 | +Copyright (c) 2025 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 | +<!-- |
| 18 | +XML generated by Alchemy; DO NOT EDIT. |
| 19 | +Source: src/tls/TLSClientManagement.adoc |
| 20 | +Parameters: in-progress |
| 21 | +Git: 1.4-819-g9894ad1b9 |
| 22 | +--> |
| 23 | +<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd"> |
| 24 | + <domain name="General"/> |
| 25 | + <enum name="TLSEndpointStatusEnum" type="enum8"> |
| 26 | + <cluster code="0x0802"/> |
| 27 | + <item name="Provisioned" value="0x00"/> |
| 28 | + <item name="InUse" value="0x01"/> |
| 29 | + </enum> |
| 30 | + |
| 31 | + <struct name="TLSEndpointStruct" apiMaturity="provisional"> |
| 32 | + <cluster code="0x0802"/> |
| 33 | + <item fieldId="0" name="EndpointID" type="int16u"/> |
| 34 | + <item fieldId="1" name="Hostname" type="octet_string"/> |
| 35 | + <item fieldId="2" name="Port" type="int16u"/> |
| 36 | + <item fieldId="3" name="CAID" type="int16u"/> |
| 37 | + <item fieldId="4" name="CCDID" type="int16u" isNullable="true" optional="true"/> |
| 38 | + <item fieldId="5" name="Status" type="TLSEndpointStatusEnum" min="0x00" max="0x01"/> |
| 39 | + </struct> |
| 40 | + |
| 41 | + <cluster apiMaturity="provisional"> |
| 42 | + <domain name="Cameras"/> |
| 43 | + <name>TLS Client Management</name> |
| 44 | + <code>0x0802</code> |
| 45 | + <define>TLS_CLIENT_MANAGEMENT_CLUSTER</define> |
| 46 | + <description>This Cluster is used to provision TLS Endpoints with enough information to facilitate subsequent connection.</description> |
| 47 | + <client init="false" tick="false">true</client> |
| 48 | + <server init="false" tick="false">true</server> |
| 49 | + <globalAttribute code="0xFFFD" side="either" value="1"/> |
| 50 | + <attribute code="0x0000" side="server" define="MAX_PROVISIONED" type="int8u">MaxProvisioned</attribute> |
| 51 | + <attribute code="0x0001" side="server" define="CURRENT_PROVISIONED" type="int8u">CurrentProvisioned</attribute> |
| 52 | + <attribute code="0x0002" side="server" define="MAX_IN_USE" type="int8u">MaxInUse</attribute> |
| 53 | + <attribute code="0x0003" side="server" define="CURRENT_IN_USE" type="int8u">CurrentInUse</attribute> |
| 54 | + <command code="0x00" source="client" name="ProvisionEndpoint" optional="false" response="ProvisionEndpointResponse"> |
| 55 | + <description>This command SHALL provision a TLS Endpoint for the provided HostName / Port combination.</description> |
| 56 | + <access op="invoke" privilege="administer"/> |
| 57 | + <arg id="0" name="Hostname" type="octet_string"/> |
| 58 | + <arg id="1" name="Port" type="int16u"/> |
| 59 | + <arg id="2" name="CAID" type="int16u"/> |
| 60 | + <arg id="3" name="CCDID" type="int16u" optional="true" isNullable="true"/> |
| 61 | + <arg id="4" name="EndpointID" type="int16u" optional="true" isNullable="true"/> |
| 62 | + </command> |
| 63 | + |
| 64 | + <command code="0x01" source="server" name="ProvisionEndpointResponse" optional="false" disableDefaultResponse="true"> |
| 65 | + <description>This command SHALL be generated in response to a ProvisionEndpointRequest command.</description> |
| 66 | + <arg id="0" name="EndpointID" type="int16u"/> |
| 67 | + </command> |
| 68 | + |
| 69 | + <command code="0x02" source="client" name="FindEndpoint" optional="false" response="FindEndpointResponse"> |
| 70 | + <description>This command SHALL return the TLS Endpoint details for the passed in EndpointID.</description> |
| 71 | + <arg id="0" name="EndpointID" type="int16u" optional="true" isNullable="true"/> |
| 72 | + </command> |
| 73 | + |
| 74 | + <command code="0x03" source="server" name="FindEndpointResponse" optional="false" disableDefaultResponse="true"> |
| 75 | + <description>This command SHALL be generated in response to a FindEndpointRequest command.</description> |
| 76 | + <arg id="0" name="Endpoints" array="true" type="TLSEndpointStruct"/> |
| 77 | + </command> |
| 78 | + |
| 79 | + <command code="0x04" source="client" name="RemoveEndpoint" optional="false"> |
| 80 | + <description>This command SHALL be generated to request the Node terminates the TLS Connection.</description> |
| 81 | + <access op="invoke" privilege="administer"/> |
| 82 | + <arg id="0" name="EndpointID" type="int16u"/> |
| 83 | + </command> |
| 84 | + |
| 85 | + <event code="0x0000" name="EndpointProvisioned" priority="info" side="server"> |
| 86 | + <field id="0" name="EndpointID" type="int16u"/> |
| 87 | + <description>This event SHALL indicate a new TLS Endpoint has been provisioned.</description> |
| 88 | + </event> |
| 89 | + |
| 90 | + <event code="0x0001" name="EndpointRemoved" priority="info" side="server"> |
| 91 | + <field id="0" name="EndpointID" type="int16u"/> |
| 92 | + <description>This event SHALL indicate a TLS Endpoint has been removed.</description> |
| 93 | + </event> |
| 94 | + |
| 95 | + </cluster> |
| 96 | +</configurator> |
0 commit comments