-
Notifications
You must be signed in to change notification settings - Fork 48
/
events_pointset.html
314 lines (247 loc) · 15.5 KB
/
events_pointset.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Overpass:300,400,600,800">
<script src="https://code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<link href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<link rel="stylesheet" type="text/css" href="schema_doc.css">
<script src="https://use.fontawesome.com/facf9fa52c.js"></script>
<script src="schema_doc.min.js"></script>
<meta charset="utf-8"/>
<title>Pointset Events</title>
<script src="schema_extras.js" ></script></head>
<body onload="anchorOnLoad();removedHostedMDExtensions();" id="root"><nav> <ol class="breadcrumb bg-white" style="padding: 0"> <li class="breadcrumb-item"><a href="../../">UDMI</a></li> <li class="breadcrumb-item"><a href="../">Schema</a></li> <li class="breadcrumb-item"><a href="./">Schema Viewer</a></li> </ol> </nav> <h1>Pointset Events</h1><div class="text-right">
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target=".collapse:not(.show)" aria-expanded="false">Expand all</button>
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target=".collapse.show" aria-expanded="false">Collapse all</button>
</div>
<div class="breadcrumbs"></div><span class="badge badge-dark value-type">Type: object</span><br/>
<span class="description"><p>A set of points reporting telemetry data. <a href="../../docs/messages/pointset.md#telemetry">Pointset Events Documentation</a></p>
</span> <span class="badge badge-info no-additional">No Additional Properties</span>
<div class="accordion" id="accordiontimestamp">
<div class="card">
<div class="card-header" id="headingtimestamp">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#timestamp"
aria-expanded="" aria-controls="timestamp" onclick="setAnchor('#timestamp')"><span class="property-name">timestamp</span> <span class="badge badge-warning required-property">Required</span></button>
</h2>
</div>
<div id="timestamp"
class="collapse property-definition-div" aria-labelledby="headingtimestamp"
data-parent="#accordiontimestamp">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#timestamp" onclick="anchorLink('timestamp')">timestamp</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
<span class="description"><p>RFC 3339 UTC timestamp the telemetry event was generated</p>
</span>
<br/>
<div class="badge badge-secondary">Example:</div>
<br/><div id="timestamp_ex1" class="jumbotron examples"><div class="highlight"><pre><span></span><span class="s2">"2019-01-17T14:02:29.364Z"</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionversion">
<div class="card">
<div class="card-header" id="headingversion">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#version"
aria-expanded="" aria-controls="version" onclick="setAnchor('#version')"><span class="property-name">version</span> <span class="badge badge-warning required-property">Required</span></button>
</h2>
</div>
<div id="version"
class="collapse property-definition-div" aria-labelledby="headingversion"
data-parent="#accordionversion">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#version" onclick="anchorLink('version')">version</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
<span class="description"><p>Version of the UDMI schema</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionupgraded_from">
<div class="card">
<div class="card-header" id="headingupgraded_from">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#upgraded_from"
aria-expanded="" aria-controls="upgraded_from" onclick="setAnchor('#upgraded_from')"><span class="property-name">upgraded_from</span></button>
</h2>
</div>
<div id="upgraded_from"
class="collapse property-definition-div" aria-labelledby="headingupgraded_from"
data-parent="#accordionupgraded_from">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#upgraded_from" onclick="anchorLink('upgraded_from')">upgraded_from</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
<span class="description"><p>Original version of schema pre-upgrade</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionpartial_update">
<div class="card">
<div class="card-header" id="headingpartial_update">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#partial_update"
aria-expanded="" aria-controls="partial_update" onclick="setAnchor('#partial_update')"><span class="property-name">partial_update</span></button>
</h2>
</div>
<div id="partial_update"
class="collapse property-definition-div" aria-labelledby="headingpartial_update"
data-parent="#accordionpartial_update">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#partial_update" onclick="anchorLink('partial_update')">partial_update</a></div><span class="badge badge-dark value-type">Type: boolean</span><br/>
<span class="description"><p>Indicates if this is a partial update (only some points may be included)</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionpoints">
<div class="card">
<div class="card-header" id="headingpoints">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#points"
aria-expanded="" aria-controls="points" onclick="setAnchor('#points')"><span class="property-name">points</span> <span class="badge badge-warning required-property">Required</span></button>
</h2>
</div>
<div id="points"
class="collapse property-definition-div" aria-labelledby="headingpoints"
data-parent="#accordionpoints">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#points" onclick="anchorLink('points')">points</a></div><span class="badge badge-dark value-type">Type: object</span><br/>
<span class="description"><p>Collection of point names, defining the representative point set for this device.</p>
</span> <span class="badge badge-info no-additional">No Additional Properties</span>
<div class="accordion" id="accordionpoints_pattern1">
<div class="card">
<div class="card-header" id="headingpoints_pattern1">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#points_pattern1"
aria-expanded="" aria-controls="points_pattern1" onclick="setAnchor('#points_pattern1')"><span class="property-name">^[a-z][a-z0-9]*(_[a-z0-9]+)*$</span> <span class="badge badge-info pattern-property">Pattern Property</span></button>
</h2>
</div>
<div id="points_pattern1"
class="collapse property-definition-div" aria-labelledby="headingpoints_pattern1"
data-parent="#accordionpoints_pattern1">
<div class="card-body pl-5"><h2 class="handle">
<label>Pattern Property</label>
</h2>
<p>All property whose name matches the following regular expression must respect the following conditions</p>
<span class="pattern-value">Property name regular expression: <code>^[a-z][a-z0-9]*(_[a-z0-9]+)*$</code></span>
<br/>
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#points" onclick="anchorLink('points')">points</a>
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#points_pattern1" onclick="anchorLink('points_pattern1')">events_pointset_point.json#</a></div><span class="badge badge-dark value-type">Type: object</span><br/>
<span class="description"><p>Object representation for for a single point</p>
</span>
<span class="badge badge-info no-additional">No Additional Properties</span>
<div class="accordion" id="accordionpoints_pattern1_present_value">
<div class="card">
<div class="card-header" id="headingpoints_pattern1_present_value">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#points_pattern1_present_value"
aria-expanded="" aria-controls="points_pattern1_present_value" onclick="setAnchor('#points_pattern1_present_value')"><span class="property-name">present_value</span> <span class="badge badge-warning required-property">Required</span></button>
</h2>
</div>
<div id="points_pattern1_present_value"
class="collapse property-definition-div" aria-labelledby="headingpoints_pattern1_present_value"
data-parent="#accordionpoints_pattern1_present_value">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#points" onclick="anchorLink('points')">points</a>
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#points_pattern1" onclick="anchorLink('points_pattern1')">Point Pointset Events</a>
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#points_pattern1_present_value" onclick="anchorLink('points_pattern1_present_value')">present_value</a></div><span class="badge badge-dark value-type">Type: object</span><br/>
<span class="description"><p>The specific point data reading</p>
</span>
<br/>
<div class="badge badge-secondary">Examples:</div>
<br/><div id="points_pattern1_present_value_ex1" class="jumbotron examples"><div class="highlight"><pre><span></span><span class="mf">24.1</span>
</pre></div>
</div><div id="points_pattern1_present_value_ex2" class="jumbotron examples"><div class="highlight"><pre><span></span><span class="s2">"running"</span>
</pre></div>
</div><div id="points_pattern1_present_value_ex3" class="jumbotron examples"><div class="highlight"><pre><span></span><span class="mf">4</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<p class="generated-by-footer">Generated using <a href="https:/coveooss/json-schema-for-humans">json-schema-for-humans</a></p>
</footer></body>
</html>