forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathzone-management-cluster.xml
159 lines (138 loc) · 7.5 KB
/
zone-management-cluster.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<?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.
-->
<!--
XML generated by Alchemy; DO NOT EDIT.
Source: src/app_clusters/ZoneManagement.adoc
Parameters: in-progress
Git: 1.4-282-gad46b0990
-->
<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd">
<domain name="Measurement & Sensing"/>
<enum name="StatusCodeEnum" type="enum8">
<cluster code="0x0550"/>
<item name="ZoneNotFound" value="0x02"/>
<item name="ZoneInUse" value="0x03"/>
</enum>
<enum name="ZoneEventStoppedReasonEnum" type="enum8">
<cluster code="0x0550"/>
<item name="ActionStopped" value="0x00"/>
<item name="Timeout" value="0x01"/>
</enum>
<enum name="ZoneEventTriggeredReasonEnum" type="enum8">
<cluster code="0x0550"/>
<item name="Motion" value="0x00"/>
</enum>
<enum name="ZoneSourceEnum" type="enum8">
<cluster code="0x0550"/>
<item name="Mfg" value="0x00"/>
<item name="User" value="0x01"/>
</enum>
<enum name="ZoneTypeEnum" type="enum8">
<cluster code="0x0550"/>
<item name="TwoDCARTZone" value="0x00"/>
</enum>
<enum name="ZoneUseEnum" type="enum8">
<cluster code="0x0550"/>
<item name="Motion" value="0x00"/>
<item name="Privacy" value="0x01"/>
<item name="Focus" value="0x02"/>
</enum>
<struct name="TwoDCartesianVertexStruct" apiMaturity="provisional">
<cluster code="0x0550"/>
<item fieldId="0" name="X" type="int16u" default="0"/>
<item fieldId="1" name="Y" type="int16u" default="0"/>
</struct>
<struct name="TwoDCartesianZoneStruct" apiMaturity="provisional">
<cluster code="0x0550"/>
<item fieldId="0" name="Name" type="char_string" length="16"/>
<item fieldId="1" name="Use" type="ZoneUseEnum" min="0x00" max="0x02"/>
<item fieldId="2" name="Vertices" array="true" type="TwoDCartesianVertexStruct" length="12" minLength="3"/>
<item fieldId="3" name="Color" type="char_string" optional="true" length="9" minLength="7"/>
</struct>
<struct name="ZoneInformationStruct" apiMaturity="provisional">
<cluster code="0x0550"/>
<item fieldId="0" name="ZoneID" type="int16u"/>
<item fieldId="1" name="ZoneType" type="ZoneTypeEnum" min="0x00" max="0x00"/>
<item fieldId="2" name="ZoneSource" type="ZoneSourceEnum" min="0x00" max="0x01"/>
</struct>
<struct name="ZoneTriggerControlStruct" apiMaturity="provisional">
<cluster code="0x0550"/>
<item fieldId="0" name="InitialDuration" type="int16u" default="10"/>
<item fieldId="1" name="AugmentationDuration" type="int16u" default="5"/>
<item fieldId="2" name="MaxDuration" type="elapsed_s" default="30"/>
<item fieldId="3" name="BlindDuration" type="int16u" default="30"/>
<item fieldId="4" name="Sensitivity" type="int8u" optional="true" default="5" min="1" max="10"/>
</struct>
<cluster apiMaturity="provisional">
<domain name="Measurement & Sensing"/>
<name>Zone Management</name>
<code>0x0550</code>
<define>ZONE_MANAGEMENT_CLUSTER</define>
<description>This cluster provides an interface to manage regions of interest, or Zones, which can be either manufacturer or user defined.</description>
<client init="false" tick="false">true</client>
<features>
<feature bit="0" code="TWODCART" name="TwoDimensionalCartesianZone" summary="Support Two Dimensional Cartesian Zones">
<optionalConform/>
</feature>
<feature bit="1" code="PERZONESENS" name="PerZoneSensitivity" summary="Supports a sensitivity value per Zone">
<optionalConform/>
</feature>
</features>
<server init="false" tick="false">true</server>
<globalAttribute code="0xFFFD" side="either" value="1"/>
<attribute code="0x0000" side="server" define="SUPPORTED_ZONE_SOURCES" type="array" entryType="ZoneSourceEnum">SupportedZoneSources</attribute>
<attribute code="0x0001" side="server" define="ZONES" type="array" entryType="ZoneInformationStruct" optional="true">Zones</attribute>
<attribute code="0x0002" side="server" define="TIME_CONTROL" type="array" entryType="ZoneTriggerControlStruct" writable="true">Triggers</attribute>
<attribute code="0x0003" side="server" define="SENSITIVITY" type="int8u" min="1" max="10" default="5" writable="true" optional="true">Sensitivity</attribute>
<command code="0x00" source="client" name="CreateTwoDCartesianZone" optional="true" response="CreateTwoDCartesianZoneResponse">
<description>This command SHALL create and store a TwoD Cartesian Zone.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="Zone" type="TwoDCartesianZoneStruct"/>
</command>
<command code="0x01" source="server" name="CreateTwoDCartesianZoneResponse" optional="true">
<description/>
<arg id="0" name="ZoneID" type="int16u"/>
</command>
<command code="0x02" source="client" name="UpdateTwoDCartesianZone" optional="true">
<description>The UpdateTwoDCartesianZone SHALL update a stored TwoD Cartesian Zone.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ZoneID" type="int16u"/>
<arg id="1" name="Zone" type="TwoDCartesianZoneStruct"/>
</command>
<command code="0x03" source="client" name="GetTwoDCartesianZone" optional="true" response="GetTwoDCartesianZoneResponse">
<description>The GetTwoDCartesianZone SHALL return the TwoD Cartesian Zone for the passed in ZoneID.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ZoneID" type="int16u" optional="true" isNullable="true"/>
</command>
<command code="0x04" source="server" name="GetTwoDCartesianZoneResponse" optional="true" disableDefaultResponse="true">
<description>This command SHALL be generated in response to a GetTwoDCartesianZone command.</description>
<arg id="0" name="Zones" array="true" type="TwoDCartesianZoneStruct"/>
</command>
<command code="0x05" source="client" name="RemoveZone" optional="false">
<description>This command SHALL remove the Zone mapped to the passed in ZoneID.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ZoneID" type="int16u"/>
</command>
<event code="0x0000" name="ZoneTriggered" priority="info" side="server">
<field id="0" name="Zones" array="true" type="int16u"/>
<field id="1" name="Reason" type="ZoneEventTriggeredReasonEnum" min="0x00" max="0x00"/>
<description>This event SHALL be generated when a Zone is first triggered.</description>
</event>
<event code="0x0001" name="ZoneStopped" priority="info" side="server">
<field id="0" name="Zones" array="true" type="int16u"/>
<field id="1" name="Reason" type="ZoneEventStoppedReasonEnum" min="0x00" max="0x01"/>
<description>This event SHALL be generated when either when the TriggerDetectedDuration value is exceeded by the TimeSinceInitialTrigger value or when the MaxDuration value is exceeded by the TimeSinceInitialTrigger value as described in ZoneTriggerControlStruct.</description>
</event>
</cluster>
</configurator>