forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTimeSync.xml
411 lines (404 loc) · 18.5 KB
/
TimeSync.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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2021). All rights reserved.
The information within this document is the property of the Connectivity
Standards Alliance and its use and disclosure are restricted, except as
expressly set forth herein.
Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
nontransferable, worldwide, limited and revocable license (without the right to
sublicense), under Connectivity Standards Alliance's applicable copyright
rights, to view, download, save, reproduce and use the document solely for your
own internal purposes and in accordance with the terms of the license set forth
herein. This license does not authorize you to, and you expressly warrant that
you shall not: (a) permit others (outside your organization) to use this
document; (b) post or publish this document; (c) modify, adapt, translate, or
otherwise change this document in any manner or create any derivative work
based on this document; (d) remove or modify any notice or label on this
document, including this Copyright Notice, License and Disclaimer. The
Connectivity Standards Alliance does not grant you any license hereunder other
than as expressly stated herein.
Elements of this document may be subject to third party intellectual property
rights, including without limitation, patent, copyright or trademark rights,
and any such third party may or may not be a member of the Connectivity
Standards Alliance. Connectivity Standards Alliance members grant other
Connectivity Standards Alliance members certain intellectual property rights as
set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
Standards Alliance members do not grant you any rights under this license. The
Connectivity Standards Alliance is not responsible for, and shall not be held
responsible in any manner for, identifying or failing to identify any or all
such third party intellectual property rights. Please visit www.csa-iot.org for
more information on how to become a member of the Connectivity Standards
Alliance.
This document and the information contained herein are provided on an “AS IS”
basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
LOSS OR DAMAGE.
All company, brand and product names in this document may be trademarks that
are the sole property of their respective owners.
This notice and disclaimer must be included on all copies of this document.
Connectivity Standards Alliance
508 Second Street, Suite 206
Davis, CA 95616, USA
:imagesdir: service_device_management/images
:xrefstyle: full
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0038" name="Time Synchronization Cluster" revision="2">
<revisionHistory>
<revision revision="1" summary="Initial Release"/>
<revision revision="2" summary="Make TrustedTimeSource fabric-aware, add TSC feature, define list max sizes, change writable attributes to commands, remote port, add attribute for DNS support"/>
</revisionHistory>
<clusterIds>
<clusterId id="0x0038" name="Time Synchronization"/>
</clusterIds>
<classification hierarchy="base" role="utility" picsCode="TIMESYNC" scope="Node"/>
<features>
<feature bit="0" code="TZ" name="TimeZone" summary="Server supports time zone.">
<optionalConform/>
</feature>
<feature bit="1" code="NTPC" name="NTPClient" summary="Server supports an NTP or SNTP client.">
<optionalConform/>
</feature>
<feature bit="2" code="NTPS" name="NTPServer" summary="Server supports an NTP server role.">
<optionalConform/>
</feature>
<feature bit="3" code="TSC" name="TimeSyncClient" summary="Time synchronization client cluster is present.">
<optionalConform/>
</feature>
</features>
<dataTypes>
<enum name="GranularityEnum">
<item value="0" name="NoTimeGranularity" summary="This indicates that the node is not currently synchronized with a UTC Time source and its clock is based on the Last Known Good UTC Time only.">
<mandatoryConform/>
</item>
<item value="1" name="MinutesGranularity" summary="This indicates the node was synchronized to an upstream source in the past, but sufficient clock drift has occurred such that the clock error is now > 5 seconds.">
<mandatoryConform/>
</item>
<item value="2" name="SecondsGranularity" summary="This indicates the node is synchronized to an upstream source using a low resolution protocol. UTC Time is accurate to ± 5 seconds.">
<mandatoryConform/>
</item>
<item value="3" name="MillisecondsGranularity" summary="This indicates the node is synchronized to an upstream source using high resolution time-synchronization protocol such as NTP, or has built-in GNSS with some amount of jitter applying its GNSS timestamp. UTC Time is accurate to ± 50 ms.">
<mandatoryConform/>
</item>
<item value="4" name="MicrosecondsGranularity" summary="This indicates the node is synchronized to an upstream source using a highly precise time-synchronization protocol such as PTP, or has built-in GNSS. UTC time is accurate to ± 10 μs.">
<mandatoryConform/>
</item>
</enum>
<enum name="Status Codes" type="status"/>
<enum name="TimeSourceEnum">
<item value="0" name="None" summary="Node is not currently synchronized with a UTC Time source.">
<mandatoryConform/>
</item>
<item value="1" name="Unknown" summary="Node uses an unlisted time source.">
<mandatoryConform/>
</item>
<item value="2" name="Admin" summary="Node received time from a client using the SetUTCTime Command.">
<mandatoryConform/>
</item>
<item value="3" name="NodeTimeCluster" summary="Synchronized time by querying the Time Synchronization cluster of another Node.">
<mandatoryConform/>
</item>
<item value="4" name="NonMatterSNTP" summary="SNTP from a server not in the Matter network. NTS is not used.">
<mandatoryConform/>
</item>
<item value="5" name="NonMatterNTP" summary="NTP from servers not in the Matter network. None of the servers used NTS.">
<mandatoryConform/>
</item>
<item value="6" name="MatterSNTP" summary="SNTP from a server within the Matter network. NTS is not used.">
<mandatoryConform/>
</item>
<item value="7" name="MatterNTP" summary="NTP from servers within the Matter network. None of the servers used NTS.">
<mandatoryConform/>
</item>
<item value="8" name="MixedNTP" summary="NTP from multiple servers in the Matter network and external. None of the servers used NTS.">
<mandatoryConform/>
</item>
<item value="9" name="NonMatterSNTPNTS" summary="SNTP from a server not in the Matter network. NTS is used.">
<mandatoryConform/>
</item>
<item value="10" name="NonMatterNTPNTS" summary="NTP from servers not in the Matter network. NTS is used on at least one server.">
<mandatoryConform/>
</item>
<item value="11" name="MatterSNTPNTS" summary="SNTP from a server within the Matter network. NTS is used.">
<mandatoryConform/>
</item>
<item value="12" name="MatterNTPNTS" summary="NTP from a server within the Matter network. NTS is used on at least one server.">
<mandatoryConform/>
</item>
<item value="13" name="MixedNTPNTS" summary="NTP from multiple servers in the Matter network and external. NTS is used on at least one server.">
<mandatoryConform/>
</item>
<item value="14" name="CloudSource" summary="Time synchronization comes from a vendor cloud-based source (e.g. "Date" header in authenticated HTTPS connection).">
<mandatoryConform/>
</item>
<item value="15" name="PTP" summary="Time synchronization comes from PTP.">
<mandatoryConform/>
</item>
<item value="16" name="GNSS" summary="Time synchronization comes from a GNSS source.">
<mandatoryConform/>
</item>
</enum>
<enum name="TimeZoneDatabaseEnum">
<item value="0" name="Full" summary="Node has a full list of the available time zones">
<mandatoryConform/>
</item>
<item value="1" name="Partial" summary="Node has a partial list of the available time zones">
<mandatoryConform/>
</item>
<item value="2" name="None" summary="Node does not have a time zone database">
<mandatoryConform/>
</item>
</enum>
<struct name="DSTOffsetStruct">
<field id="0" name="Offset" type="int32">
<mandatoryConform/>
<constraint type="desc"/>
</field>
<field id="1" name="ValidStarting" type="epoch-us">
<mandatoryConform/>
</field>
<field id="2" name="ValidUntil" type="epoch-us">
<quality nullable="true"/>
<mandatoryConform/>
</field>
</struct>
<struct name="FabricScopedTrustedTimeSourceStruct">
<field id="0" name="NodeID" type="node-id">
<mandatoryConform/>
</field>
<field id="1" name="Endpoint" type="endpoint-no">
<mandatoryConform/>
</field>
</struct>
<struct name="TimeZoneStruct">
<field id="0" name="Offset" type="int32">
<mandatoryConform/>
<constraint type="between" from="-43200" to="50400"/>
</field>
<field id="1" name="ValidAt" type="epoch-us">
<mandatoryConform/>
</field>
<field id="2" name="Name" type="string">
<optionalConform/>
<constraint type="lengthBetween" from="0" to="64"/>
</field>
</struct>
<struct name="TrustedTimeSourceStruct">
<field id="0" name="FabricIndex" type="fabric-idx">
<mandatoryConform/>
</field>
<field id="1" name="NodeID" type="node-id">
<mandatoryConform/>
</field>
<field id="2" name="Endpoint" type="endpoint-no">
<mandatoryConform/>
</field>
</struct>
</dataTypes>
<attributes>
<attribute id="0x0000" name="UTCTime" type="epoch-us" default="null">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="true" nullable="true" scene="false" persistence="volatile" reportable="false"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0001" name="Granularity" type="GranularityEnum" default="NoTimeGranularity">
<access read="true" readPrivilege="view"/>
<mandatoryConform/>
<constraint type="desc"/>
</attribute>
<attribute id="0x0002" name="TimeSource" type="TimeSourceEnum" default="None">
<access read="true" readPrivilege="view"/>
<optionalConform/>
<constraint type="desc"/>
</attribute>
<attribute id="0x0003" name="TrustedTimeSource" type="TrustedTimeSourceStruct" default="null">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="true" scene="false" persistence="nonVolatile" reportable="false"/>
<mandatoryConform>
<feature name="TSC"/>
</mandatoryConform>
</attribute>
<attribute id="0x0004" name="DefaultNTP" type="string" default="null">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="true" scene="false" persistence="nonVolatile" reportable="false"/>
<mandatoryConform>
<feature name="NTPC"/>
</mandatoryConform>
<constraint type="maxLength" value="128"/>
</attribute>
<attribute id="0x0005" name="TimeZone" type="list" default="[{0,0}]">
<entry type="TimeZoneStruct"/>
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="nonVolatile" reportable="false"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<constraint type="countBetween" from="1" to="2"/>
</attribute>
<attribute id="0x0006" name="DSTOffset" type="list" default="[]">
<entry type="DSTOffsetStruct"/>
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="nonVolatile" reportable="false"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
</attribute>
<attribute id="0x0007" name="LocalTime" type="epoch-us" default="null">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="true" nullable="true" scene="false" persistence="volatile" reportable="false"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
</attribute>
<attribute id="0x0008" name="TimeZoneDatabase" type="TimeZoneDatabaseEnum" default="None">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
</attribute>
<attribute id="0x0009" name="NTPServerAvailable" type="bool" default="False">
<access read="true" readPrivilege="view"/>
<mandatoryConform>
<feature name="NTPS"/>
</mandatoryConform>
</attribute>
<attribute id="0x000A" name="TimeZoneListMaxSize" type="uint8">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<constraint type="between" from="1" to="2"/>
</attribute>
<attribute id="0x000B" name="DSTOffsetListMaxSize" type="uint8">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<constraint type="min" value="1"/>
</attribute>
<attribute id="0x000C" name="SupportsDNSResolve" type="bool" default="False">
<access read="true" readPrivilege="view"/>
<quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
<mandatoryConform>
<feature name="NTPC"/>
</mandatoryConform>
</attribute>
</attributes>
<commands>
<command id="0x00" name="SetUTCTime" direction="commandToServer" response="Y">
<access invokePrivilege="admin"/>
<mandatoryConform/>
<field id="0" name="UTCTime" type="epoch-us" default="0">
<mandatoryConform/>
</field>
<field id="1" name="Granularity" type="GranularityEnum" default="NoTimeGranularity">
<mandatoryConform/>
</field>
<field id="2" name="TimeSource" type="TimeSourceEnum" default="None">
<optionalConform/>
</field>
</command>
<command id="0x01" name="SetTrustedTimeSource" direction="commandToServer" response="Y">
<access invokePrivilege="admin" fabricScoped="true"/>
<mandatoryConform>
<feature name="TSC"/>
</mandatoryConform>
<field id="0" name="TrustedTimeSource" type="FabricScopedTrustedTimeSourceStruct">
<quality nullable="true"/>
<mandatoryConform/>
</field>
</command>
<command id="0x02" name="SetTimeZone" direction="commandToServer" response="SetTimeZoneResponse">
<access invokePrivilege="manage"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<field id="0" name="TimeZone" type="list">
<entry type="TimeZoneStruct"/>
<mandatoryConform/>
<constraint type="countBetween" from="1" to="2"/>
</field>
</command>
<command id="0x03" name="SetTimeZoneResponse" direction="responseFromServer">
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<field id="0" name="DSTOffsetsRequired" type="bool" default="true">
<mandatoryConform/>
</field>
</command>
<command id="0x04" name="SetDSTOffset" direction="commandToServer" response="Y">
<access invokePrivilege="manage"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<field id="0" name="DSTOffset" type="list">
<entry type="DSTOffsetStruct"/>
<mandatoryConform/>
</field>
</command>
<command id="0x05" name="SetDefaultNTP" direction="commandToServer" response="Y">
<access invokePrivilege="admin"/>
<mandatoryConform>
<feature name="NTPC"/>
</mandatoryConform>
<field id="0" name="DefaultNTP" type="string">
<quality nullable="true"/>
<mandatoryConform/>
<constraint type="maxLength" value="128"/>
</field>
</command>
</commands>
<events>
<event id="0x00" name="DSTTableEmpty" priority="info">
<access readPrivilege="view"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
</event>
<event id="0x01" name="DSTStatus" priority="info">
<access readPrivilege="view"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<field id="0" name="DSTOffsetActive" type="bool">
<mandatoryConform/>
</field>
</event>
<event id="0x02" name="TimeZoneStatus" priority="info">
<access readPrivilege="view"/>
<mandatoryConform>
<feature name="TZ"/>
</mandatoryConform>
<field id="0" name="Offset" type="int32">
<mandatoryConform/>
<constraint type="between" from="-43200" to="50400"/>
</field>
<field id="1" name="Name" type="string">
<optionalConform/>
<constraint type="lengthBetween" from="0" to="64 bytes"/>
</field>
</event>
<event id="0x03" name="TimeFailure" priority="info">
<access readPrivilege="view"/>
<mandatoryConform/>
</event>
<event id="0x04" name="MissingTrustedTimeSource" priority="info">
<access readPrivilege="view"/>
<mandatoryConform>
<feature name="TSC"/>
</mandatoryConform>
</event>
</events>
</cluster>