forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathicd-management-cluster.xml
207 lines (190 loc) · 8.9 KB
/
icd-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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?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" />
<bitmap name="UserActiveModeTriggerBitmap" type="bitmap32">
<cluster code="0x0046"/>
<field name="PowerCycle" mask="0x1"/>
<field name="SettingsMenu" mask="0x2"/>
<field name="CustomInstruction" mask="0x4"/>
<field name="DeviceManual" mask="0x8"/>
<field name="ActuateSensor" mask="0x10"/>
<field name="ActuateSensorSeconds" mask="0x20"/>
<field name="ActuateSensorTimes" mask="0x40"/>
<field name="ActuateSensorLightsBlink" mask="0x80"/>
<field name="ResetButton" mask="0x100"/>
<field name="ResetButtonLightsBlink" mask="0x200"/>
<field name="ResetButtonSeconds" mask="0x400"/>
<field name="ResetButtonTimes" mask="0x800"/>
<field name="SetupButton" mask="0x1000"/>
<field name="SetupButtonSeconds" mask="0x2000"/>
<field name="SetupButtonLightsBlink" mask="0x4000"/>
<field name="SetupButtonTimes" mask="0x8000"/>
<field name="AppDefinedButton" mask="0x10000"/>
</bitmap>
<enum name="ClientTypeEnum" type="enum8">
<cluster code="0x0046"/>
<item value="0" name="Permanent"/>
<item value="1" name="Ephemeral"/>
</enum>
<struct name = "MonitoringRegistrationStruct" isFabricScoped="true">
<cluster code="0x0046"/>
<item fieldId="1" name="CheckInNodeID" type="node_id" isFabricSensitive="true"/>
<item fieldId="2" name="MonitoredSubject" type="int64u" isFabricSensitive="true"/>
<!-- RESERVED = 0x03 -->
<item fieldId="4" name="ClientType" type="ClientTypeEnum" isFabricSensitive="true" default="0"/>
</struct>
<enum name="OperatingModeEnum" type="enum8">
<cluster code="0x0046" />
<item value="0" name="SIT" />
<item value="1" name="LIT" />
</enum>
<cluster>
<domain>General</domain>
<name>ICD Management</name>
<code>0x0046</code>
<define>ICD_MANAGEMENT_CLUSTER</define>
<description>Allows servers to ensure that listed clients are notified when a server is available for communication.</description>
<!-- Cluster feature map -->
<globalAttribute side="server" code="0xFFFC" value="0x0000"/>
<!-- Current cluster version -->
<globalAttribute side="either" code="0xFFFD" value="3"/>
<features>
<feature bit="0" code="CIP" name="CheckInProtocolSupport" summary="Device supports attributes and commands for the Check-In Protocol support.">
<otherwiseConform>
<mandatoryConform>
<feature name="LITS"/>
</mandatoryConform>
<optionalConform/>
</otherwiseConform>
</feature>
<feature bit="1" code="UAT" name="UserActiveModeTrigger" summary="Device supports the user active mode trigger feature.">
<otherwiseConform>
<mandatoryConform>
<feature name="LITS"/>
</mandatoryConform>
<optionalConform/>
</otherwiseConform>
</feature>
<feature bit="2" code="LITS" name="LongIdleTimeSupport" summary="Device supports operating as a Long Idle Time ICD.">
<otherwiseConform>
<optionalConform/>
</otherwiseConform>
</feature>
<feature bit="3" code="DSLS" name="DynamicSitLitSupport" summary="Device supports dynamic switching from SIT to LIT operating modes.">
<otherwiseConform>
<optionalConform>
<feature name="LITS"/>
</optionalConform>
</otherwiseConform>
</feature>
</features>
<attribute side="server" code="0x00" name="IdleModeDuration" define="IDLE_MODE_DURATION" type="int32u" min="1" max="64800" default="1">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x01" name="ActiveModeDuration" define="ACTIVE_MODE_DURATION" type="int32u" default="300">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x02" name="ActiveModeThreshold" define="ACTIVE_MODE_THRESHOLD" type="int16u" default="300">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x03" name="RegisteredClients" define="REGISTERED_CLIENTS" type="array" entryType="MonitoringRegistrationStruct" optional="true">
<access op="read" privilege="administer"/>
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</attribute>
<attribute side="server" code="0x04" name="ICDCounter" define="ICD_COUNTER" type="int32u" default="0" optional="true">
<access op="read" privilege="administer"/>
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</attribute>
<attribute side="server" code="0x05" name="ClientsSupportedPerFabric" define="CLIENTS_SUPPORTED_PER_FABRIC" type="int16u" min="1" default="1" optional="true">
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</attribute>
<attribute side="server" code="0x06" name="UserActiveModeTriggerHint" define="USER_ACTIVE_MODE_TRIGGER_HINT" type="UserActiveModeTriggerBitmap" optional="true">
<otherwiseConform>
<mandatoryConform>
<feature name="UAT"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute side="server" code="0x07" name="UserActiveModeTriggerInstruction" define="USER_ACTIVE_MODE_TRIGGER_INSTRUCTION" type="char_string" length="128" optional="true">
</attribute>
<attribute side="server" code="0x08" name="OperatingMode" define="OPERATING_MODE" type="OperatingModeEnum" default="0" optional="true">
<otherwiseConform>
<mandatoryConform>
<feature name="LITS"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute side="server" code="0x09" name="MaximumCheckInBackOff" define="MAXIMUM_CHECK_IN_BACK_OFF" type="int32u" default="1" max="64800" optional="true">
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</attribute>
<command source="client" code="0x00" name="RegisterClient" response="RegisterClientResponse" isFabricScoped="true" optional="true">
<description>Register a client to the end device</description>
<arg name="CheckInNodeID" type="node_id" optional="false"/>
<arg name="MonitoredSubject" type="int64u" optional="false"/>
<arg name="Key" type="octet_string" length="16" optional="false"/>
<arg name="VerificationKey" type="octet_string" length="16" optional="true"/>
<arg name="ClientType" type="ClientTypeEnum" optional="false"/>
<access op="invoke" privilege="manage"/>
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</command>
<command source="server" code="0x01" name="RegisterClientResponse" optional="true" disableDefaultResponse="true">
<description>RegisterClient response command</description>
<arg name="ICDCounter" type="int32u" isNullable="false"/>
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</command>
<command source="client" code="0x02" name="UnregisterClient" isFabricScoped="true" optional="true">
<description>Unregister a client from an end device</description>
<arg name="CheckInNodeID" type="node_id"/>
<arg name="VerificationKey" type="octet_string" length="16" optional="true"/>
<access op="invoke" privilege="manage"/>
<mandatoryConform>
<feature name="CIP"/>
</mandatoryConform>
</command>
<command source="client" code="0x03" name="StayActiveRequest" response="StayActiveResponse" optional="true">
<description>Request the end device to stay in Active Mode for an additional ActiveModeThreshold</description>
<access op="invoke" privilege="manage"/>
<arg name="StayActiveDuration" type="int32u" isNullable="false"/>
<otherwiseConform>
<mandatoryConform>
<feature name="LITS"/>
</mandatoryConform>
<optionalConform/>
</otherwiseConform>
</command>
<command source="server" code="0x04" name="StayActiveResponse" optional="true" disableDefaultResponse="true">
<description>StayActiveRequest response command</description>
<arg name="PromisedActiveDuration" type="int32u" isNullable="false"/>
<otherwiseConform>
<mandatoryConform>
<feature name="LITS"/>
</mandatoryConform>
<optionalConform/>
</otherwiseConform>
</command>
</cluster>
</configurator>