diagnostic-logs-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="CHIP" spec="chip-0.7" dependsOn="zcl-1.0-07-5123-03" certifiable="true"/>
  <enum name="IntentEnum" type="enum8">
    <cluster code="0x0032"/>
    <item name="EndUserSupport" value="0x0"/>
    <item name="NetworkDiag" value="0x1"/>
    <item name="CrashLogs" value="0x2"/>
  </enum>
  <enum name="StatusEnum" type="enum8">
    <cluster code="0x0032"/>
    <item name="Success" value="0x0"/>
    <item name="Exhausted" value="0x1"/>
    <item name="NoLogs" value="0x2"/>
    <item name="Busy" value="0x3"/>
    <item name="Denied" value="0x4"/>
  </enum>
  <enum name="TransferProtocolEnum" type="enum8">
    <cluster code="0x0032"/>
    <item name="ResponsePayload" value="0x0"/>
    <item name="BDX" value="0x1"/>
  </enum>
  <cluster>
    <name>Diagnostic Logs</name>
    <domain>CHIP</domain>
    <description>The cluster provides commands for retrieving unstructured diagnostic logs from a Node that may be used to aid in diagnostics.</description>
    <code>0x0032</code>
    <define>DIAGNOSTIC_LOGS_CLUSTER</define>
    <client tick="false" init="false">true</client>
    <server tick="false" init="false">true</server>
    <command source="client" code="0x00" name="RetrieveLogsRequest" response="RetrieveLogsResponse" optional="false" cli="chip logs retrieve">
      <description>Retrieving diagnostic logs from a Node</description>
      <arg name="Intent" type="IntentEnum"/>
      <arg name="RequestedProtocol" type="TransferProtocolEnum"/>
      <arg name="TransferFileDesignator" type="char_string" length="32" optional="true"/>
      <mandatoryConform/>
    </command>
    <command source="server" code="0x01" name="RetrieveLogsResponse" optional="false" cli="chip logs response">
      <description>Response to the RetrieveLogsRequest</description>
      <arg name="Status" type="StatusEnum"/>
      <arg name="LogContent" type="long_octet_string"/>
      <arg name="UTCTimeStamp" type="epoch_us" optional="true"/>
      <arg name="TimeSinceBoot" type="systime_us" optional="true"/>
      <mandatoryConform/>
    </command>
  </cluster>
</configurator>