272d48d0 by Skip Hines

updated historical specs to work with new code generator

1 parent c34d5251
...@@ -235,7 +235,7 @@ ...@@ -235,7 +235,7 @@
235 </comment> 235 </comment>
236 <elem name="state" type="StateVector" multiplicity="1"/> 236 <elem name="state" type="StateVector" multiplicity="1"/>
237 <elem name="covariance" type="CovarianceMatrix" multiplicity="1"/> 237 <elem name="covariance" type="CovarianceMatrix" multiplicity="1"/>
238 <elem name="referenceframe" type="ReferenceFrame" multiplicity="1" default="ReferenceFrame::WGS84"/> 238 <elem name="referenceframe" type="ReferenceFrame" multiplicity="1" default="ReferenceFrame.WGS84"/>
239 </struct> 239 </struct>
240 240
241 <struct name="Point2D" type="Shape" rttkey="HPE.ShapeType.Point2D"> 241 <struct name="Point2D" type="Shape" rttkey="HPE.ShapeType.Point2D">
...@@ -557,7 +557,7 @@ ...@@ -557,7 +557,7 @@
557 <comment>Azimuth heading of the device in degrees (true North)</comment> 557 <comment>Azimuth heading of the device in degrees (true North)</comment>
558 </elem> 558 </elem>
559 559
560 <elem name="source" type="StateSource" multiplicity="0..1" default="0"> 560 <elem name="source" type="StateSource" multiplicity="0..1" default="undefined">
561 <comment>Source field defines the source of the state information. If not specified, value is undefined. Defining the source of the state information 561 <comment>Source field defines the source of the state information. If not specified, value is undefined. Defining the source of the state information
562 assists the calculation processing by characterizing the nature of the position data relative to associated observations. 562 assists the calculation processing by characterizing the nature of the position data relative to associated observations.
563 </comment> 563 </comment>
......
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="HpeCore.xid.xml">
8 <title>HPE Core Definitions</title>
9 <comment>This file contains the core definitions used by the HPE.</comment>
10
11 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
12 <import ref="https://xid.location.studio/Tensor/V1.0.0/Common.xid.xml" local="Common.xid.xml" />
13
14 <namespace name="HPE">
15 <using namespace="Tensor"/>
16 <!--
17 *******************************************************
18 Standard Definitions
19 *******************************************************
20 -->
21
22 <enum name="ProcessingStatus" type="Tensor.int8" default="undefined">
23 <comment>Status resulting from processing the observation data.</comment>
24 <literal name="success" value="1"/>
25 <literal name="undefined" value="0"/>
26 <literal name="did_not_converge" value="-1"/>
27 <literal name="not_enough_data" value="-2" />
28 <literal name="computation_error" value="-3" />
29 <literal name="parsing_error" value="-4" />
30 <literal name="not_found" value="-5" />
31 <literal name="unknown_error" value="-6" />
32 </enum>
33
34
35 <enum name="DynamicsProfile" type="Tensor.int8" default="undefined">
36 <literal name="undefined" value="0"/>
37 <literal name="stationary" value="1" />
38 <literal name="spacecraft" value="2" />
39 <literal name="aircraft" value="3" />
40 <literal name="marinecraft" value="4" />
41 <literal name="landcraft" value="5" />
42 <literal name="bicycle" value="6" />
43 <literal name="pedestrian" value="7" />
44 <literal name="pedestrian_running" value="8" />
45 <literal name="pedestrian_jogging" value="9" />
46 <literal name="pedestrian_walking" value="10" />
47 </enum>
48
49 <enum name="EstimateRanking" type="Tensor.int8" default="calcorder">
50 <literal name="undefined" value="0"/>
51 <literal name="accuracy" value="1" />
52 <literal name="veracity" value="2" />
53 <literal name="calcorder" value="3" />
54 </enum>
55
56 <enum name="ReferenceFrame" type="Tensor.int8" default="WGS84">
57 <literal name="undefined" value ="0"/>
58 <literal name="WGS84" value ="1" />
59 <literal name="RelativeENU" value="2"/>
60 <literal name="LocalXYZ" value="3" />
61 </enum>
62
63
64 <!--
65 *******************************************************
66 Observation Datatypes
67 *******************************************************
68 -->
69 <enum name="ObservationType" type="Tensor.int8" default="undefined">
70 <literal name="undefined" value="0"/>
71 <literal name="SHAPE" value="1"/>
72 <literal name="MSISDN" value="6"/>
73 <literal name="CELLID" value="7"/>
74 <literal name="GSM_TA" value="8"/>
75 <literal name="GSM_NMR" value="9"/>
76 <literal name="RTT_3G" value="10"/>
77 <literal name="MR_3G" value="11"/>
78 <literal name="LTE_TA" value="12"/>
79 <literal name="LTE_RSSI" value="13"/>
80 <literal name="WIFI_RSS" value="14"/>
81 <literal name="WIFI_RNG" value="15"/>
82 <literal name="BLE_RSS" value="16"/>
83
84 <literal name="CELLULAR_GENERIC" value="17">
85 <comment>Observation type specifies a common cellular observation in generic units.</comment>
86 </literal>
87
88 <literal name="GPS_CODEPHASE_8" value="18">
89 <comment>Eight standard GPS Code phase measurements (81 bytes).</comment>
90 </literal>
91
92 <literal name="GPS_CODEPHASE_MIN6" value="19">
93 <comment>Eight minimum size GPS Code phase measurements (51 bytes).</comment>
94 </literal>
95 <literal name="GPS_CODEPHASE_MIN8" value="20">
96 <comment>Eight minimum size GPS Code phase measurements (65 bytes).</comment>
97 </literal>
98 <literal name="GNSS_PSEUDORANGE" value="21">
99 <comment>GNSS Pseudorange measurements.</comment>
100 </literal>
101
102 <literal name="WIFI_RSS_EXT" value="22"/>
103
104 </enum>
105
106 <array name="ObservationTypeArray" type="ObservationType"/>
107
108 <array name="StateVector" type="float64" size="8" >
109 <comment>
110 Defines the HPE standard state column vector, which is comprised of the following elements in cartesian coordinates:
111 X,Y,Z, Xdot, Ydot, Zdot, clk, clkrate.
112
113 Unless using a different coordinate reference frame, these values are typically in WGS-84 ECEF reference frame, where the
114 units are meters, meters per second. Clock terms (clk and clkrate) are also expressed in meters and meters per second,
115 to provide similar scalaing to physical units. To get to seconds and seconds per second device by the speed of light.
116 </comment>
117 </array>
118
119 <array name="CovarianceMatrix" type="Tensor.float64" size="64" >
120 <comment>
121 Defines a 8x8 Covariance matrix for the HPE standard state vector. This provides a linearized correlation
122 matrix for the estimated state vector. This is the high-fidelity format for providing Gaussian error information
123 passed between calculation processes.al units. To get to seconds and seconds per second device by the speed of light.
124 </comment>
125 </array>
126
127 <struct name="Observation" pack="true">
128 <comment>Bass type for all observation data</comment>
129 <elem name="type" type="ObservationType" multiplicity="1" rttd="true">
130 <comment>Identifies what type of observation this is.</comment>
131 </elem>
132 </struct>
133
134 <struct name="ObservationEpoch" type="Observation" pack="true">
135 <comment>Bass type for time based observation data</comment>
136 <elem name="epoch" type="datetime" multiplicity="1">
137 <comment>
138 Date the observation was attained. For GPS observatios (GPS_CODEPHASE_8, GPS_CODEPHASE_MIN6, GPS_CODEPHASE_MIN8, GNSS_PSEUDORANGE),
139 the epoch time has to have at least millisecond resolution. Fraction of a second epoch error can cause hundreds of meters of error
140 in position.
141 </comment>
142 </elem>
143 </struct>
144
145 <struct name="ObservationSet">
146 <comment>A set of observations for a single device covering multiple epochs.</comment>
147 <elem name="observations" type="Observation" multiplicity="0..*" polymorphic="true"/>
148 </struct>
149
150 <!-- ShapeObservation -->
151 <!-- Disable for now
152 <struct name="ShapeObservation" type="Observation" pack="true" rttkey="HPE.ObservationType.SHAPE">
153 <comment>Observation is comprised of a shape.</comment>
154 <elem name="shape" type="Shape" multiplicity="1" polymorphic="true">
155 <comment>
156 The shape can be any one of the supported shape types inheriting from the Shape base type.
157 </comment>
158 </elem>
159 </struct>
160 -->
161
162 <!--
163 *******************************************************
164 Reference Datatypes
165 *******************************************************
166 -->
167 <enum name="RefDataFormat" type="Tensor.int8" default="undefined">
168 <comment>Specifies the format of the Reference data.</comment>
169 <literal name="undefined" value="0"/>
170 <literal name="GPS_EPHEMERIS" value="1"/>
171 <literal name="GPS_ALMANAC" value="2"/>
172 <literal name="GLONASS_EPHEMERIS" value="3"/>
173 <literal name="GALILEO_EPHEMERIS" value="4"/>
174 <literal name="CELLULAR" value="5"/>
175 <literal name="WIFI_AP" value="6"/>
176 </enum>
177
178 <array name="RefDataFormatArray" type="RefDataFormat"/>
179
180 <struct name="ReferenceData" pack="true">
181 <comment>Bass structure for all reference data types.</comment>
182 <elem name="format" type="RefDataFormat" multiplicity="1" rttd="true">
183 <comment>Identifies the format/type of the reference data.</comment>
184 </elem>
185 </struct>
186
187 <struct name="ReferenceDataSet">
188 <comment>A set of reference data.</comment>
189 <elem name ="id" type="UUID" multiplicity="1" />
190 <elem name="records" type="ReferenceData" multiplicity="1..*" polymorphic="true"/>
191 </struct>
192
193
194 <!--
195 *******************************************************
196 Shape Datatypes
197 *******************************************************
198 -->
199 <enum name="ShapeType" type="Tensor.int8" default="undefined">
200 <!-- we can reduce this set -->
201 <literal name="undefined" value="0"/>
202 <literal name="Covariance" value="1"/>
203
204 <literal name="Point2D" value="20"/>
205 <literal name="Circle" value="21"/>
206 <literal name="Ellipse" value="22"/>
207 <literal name="Arc" value="23"/>
208 <literal name="ArcBand" value="24"/>
209
210 <literal name="Point3D" value="30"/>
211 <literal name="Spheroid" value="31"/>
212 <literal name="Ellipsoid" value="32"/>
213 <literal name="Arc3D" value="33"/>
214 <literal name="ArcBand3D" value="34"/>
215 </enum>
216
217 <array name="ShapeTypeArray" type="ShapeType"/>
218
219 <struct name="Shape" pack="true">
220 <comment>
221 Shapes are used to describe various kinds of geometry.\n
222 When used in an Estimate result the Shape represents the
223 uncertainty area (2D) or uncertainty volume (3D) at the
224 confidence in the Estimate.
225 </comment>
226 <elem name="type" type="ShapeType" multiplicity="1" rttd="true">
227 <comment>This is the one thing all shapes have in common</comment>
228 </elem>
229 </struct>
230
231 <struct name="Covariance" type="Shape" rttkey="HPE.ShapeType.Covariance">
232 <comment>
233 Shape encapsulates the HPE eight parameter state estimate, which is the highest fidelity form
234 to transfer state estimates between calculators and the HPE filter.
235 </comment>
236 <elem name="state" type="StateVector" multiplicity="1"/>
237 <elem name="covariance" type="CovarianceMatrix" multiplicity="1"/>
238 <elem name="referenceframe" type="ReferenceFrame" multiplicity="1" default="ReferenceFrame::WGS84"/>
239 </struct>
240
241 <struct name="Point2D" type="Shape" rttkey="HPE.ShapeType.Point2D">
242 <comment></comment>
243 <elem name="lat" type="float64" multiplicity="1">
244 <tag name="unit" value="degrees"/>
245 <tag name="reference" value="WGS84"/>
246 </elem>
247 <elem name="lon" type="float64" multiplicity="1">
248 <tag name="unit" value="degrees"/>
249 <tag name="reference" value="WGS84"/>
250 </elem>
251 </struct>
252
253
254 <struct name="Circle" type="Point2D" rttkey="HPE.ShapeType.Circle">
255 <comment>In an Estimate, the shape is the uncertainty area.</comment>
256 <elem name="radius" type="float32" multiplicity="1">
257 <tag name="unit" value="meters"/>
258 <comment>
259 In an estimate, radius is the horizontal uncertainty.\n
260 0 &lt;= radius
261 </comment>
262 </elem>
263 </struct>
264
265 <struct name="Ellipse" type="Point2D" rttkey="HPE.ShapeType.Ellipse">
266 <comment>In an Estimate, the shape is the uncertainty area.</comment>
267 <elem name="major" type="float32" multiplicity="1">
268 <tag name="unit" value="meters"/>
269 <comment>major axis horizontal radius</comment>
270 </elem>
271 <elem name="minor" type="float32" multiplicity="1">
272 <tag name="unit" value="meters"/>
273 <comment>minor axis horizontal radius</comment>
274 </elem>
275 <elem name="orient" type="float32" multiplicity="1">
276 <tag name="unit" value="degrees"/>
277 <comment>
278 Angle between north and major axis.\n
279 0 &lt;= orient &lt; 180.
280 </comment>
281 </elem>
282 </struct>
283
284 <struct name="Arc" type="Point2D" rttkey="HPE.ShapeType.Arc">
285 <comment>In an Estimate, the shape is the uncertainty area.</comment>
286 <elem name="outer" type="float32" multiplicity="1">
287 <tag name="unit" value="meters"/>
288 <comment>outer horizontal radius</comment>
289 </elem>
290 <elem name="inner" type="float32" multiplicity="1">
291 <tag name="unit" value="meters"/>
292 <comment>inner horizontal radius</comment>
293 </elem>
294 <elem name="offset" type="float32" multiplicity="1">
295 <tag name="unit" value="degrees"/>
296 <comment>
297 Angle between north and start of arc.\n
298 0 &lt;= offset &lt; 360
299 </comment>
300 </elem>
301 <elem name="opening" type="float32" multiplicity="1">
302 <tag name="unit" value="degrees"/>
303 <comment>
304 Delta angle from offset to end of arc.\n
305 0 &lt; opening &lt;= 360.
306 </comment>
307 </elem>
308 </struct>
309
310 <struct name="ArcBand" type="Point2D" rttkey="HPE.ShapeType.ArcBand">
311 <comment>In an Estimate, the shape is the uncertainty area.</comment>
312 <elem name="major_outer" type="float32" multiplicity="1">
313 <tag name="unit" value="meters"/>
314 <comment>major axis outer radius</comment>
315 </elem>
316 <elem name="major_inner" type="float32" multiplicity="1">
317 <tag name="unit" value="meters"/>
318 <comment>major axis inner radius</comment>
319 </elem>
320 <elem name="minor_outer" type="float32" multiplicity="1">
321 <tag name="unit" value="meters"/>
322 <comment>minor axis outer radius</comment>
323 </elem>
324 <elem name="minor_inner" type="float32" multiplicity="1">
325 <tag name="unit" value="meters"/>
326 <comment>minor axis inner radius</comment>
327 </elem>
328
329 <elem name="orient" type="float32" multiplicity="1">
330 <tag name="unit" value="degrees"/>
331 <comment>
332 Angle between north and major axis.\n
333 0 &lt;= orient &lt; 180.
334 </comment>
335 </elem>
336
337 <elem name="offset" type="float32" multiplicity="1">
338 <tag name="unit" value="degrees"/>
339 <comment>
340 Angle between north and start of arc.\n
341 0 &lt;= offset &lt; 360
342 </comment>
343 </elem>
344 <elem name="opening" type="float32" multiplicity="1">
345 <tag name="unit" value="degrees"/>
346 <comment>
347 delta angle from offset to end of arc.\n
348 0 &lt; opening &lt;= 360.
349 </comment>
350 </elem>
351 </struct>
352
353
354 <struct name="Point3D" type="Point2D" rttkey="HPE.ShapeType.Point3D">
355 <comment></comment>
356 <elem name="alt" type="float64" multiplicity="1">
357 <tag name="unit" value="meters"/>
358 <tag name="reference" value="WGS84"/>
359 </elem>
360 </struct>
361
362 <struct name="Spheroid" type="Point3D" rttkey="HPE.ShapeType.Spheroid">
363 <comment>
364 Spheroid is the shape of a circular "pill".\n
365 In an Estimate, the shape is the uncertainty area.
366 </comment>
367 <elem name="radius" type="float32" multiplicity="1">
368 <tag name="unit" value="meters"/>
369 <comment>
370 In an estimate, radius is the horizontal uncertainty.\n
371 0 &lt;= radius
372 </comment>
373 </elem>
374 <elem name="vert" type="float32" multiplicity="1">
375 <tag name="unit" value="meters"/>
376 <comment>
377 In an estimate, vert is the vertical uncertainty.\n
378 0 &lt;= vert
379 </comment>
380 </elem>
381 </struct>
382
383 <struct name="Ellipsoid" type="Point3D" rttkey="HPE.ShapeType.Ellipsoid">
384 <comment>
385 Ellipsoid is the shape of an oblong "pill" at an orientation.\n
386 In an Estimate, the shape is the uncertainty area.
387 </comment>
388 <elem name="major" type="float32" multiplicity="1">
389 <tag name="unit" value="meters"/>
390 <comment>major axis radius/distance/reach</comment>
391 </elem>
392 <elem name="minor" type="float32" multiplicity="1">
393 <tag name="unit" value="meters"/>
394 <comment>minor axis radius/distance/reach</comment>
395 </elem>
396 <elem name="orient" type="float32" multiplicity="1">
397 <tag name="unit" value="degrees"/>
398 <comment>
399 angle between north and major axis.\n
400 0 &lt;= orient &lt; 180.
401 </comment>
402 </elem>
403 <elem name="vert" type="float32" multiplicity="1">
404 <tag name="unit" value="meters"/>
405 <comment>
406 In an estimate, vert is the vertical uncertainty.\n
407 0 &lt;= vert
408 </comment>
409 </elem>
410 </struct>
411
412
413 <struct name="Arc3D" type="Point3D" rttkey="HPE.ShapeType.Arc3D">
414 <comment>
415 In an Estimate, the shape is the uncertainty area.
416 </comment>
417 <elem name ="height" type="float32" multiplicity="1">
418 <tag name="unit" value="meters"/>
419 <comment>Height above alt(itude) area is projected from.</comment>
420 </elem>
421 <elem name="outer" type="float32" multiplicity="1">
422 <tag name="unit" value="meters"/>
423 <comment>outer radius/distance/reach</comment>
424 </elem>
425 <elem name="inner" type="float32" multiplicity="1">
426 <tag name="unit" value="meters"/>
427 <comment>inner radius/distance/reach</comment>
428 </elem>
429 <elem name="direction" type="float32" multiplicity="1">
430 <tag name="unit" value="degrees"/>
431 <comment>
432 Angle from north to center of arc.\n
433 0 &lt;= direction &lt; 360
434 </comment>
435 </elem>
436 <elem name="opening" type="float32" multiplicity="1">
437 <tag name="unit" value="degrees"/>
438 <comment>
439 Horizontal coverage of the antenna face; half on either side of direction.\n
440 0 &lt; opening &lt;= 360.
441 </comment>
442 </elem>
443 </struct>
444
445 <struct name="ArcBand3D" type="Point3D" rttkey="HPE.ShapeType.ArcBand3D">
446 <comment>
447 In an Estimate, the shape is the uncertainty area.
448 </comment>
449 <elem name ="height" type="float32" multiplicity="1">
450 <tag name="unit" value="meters"/>
451 <comment>Height above alt(itude) area is projected from.</comment>
452 </elem>
453 <elem name="direction" type="float32" multiplicity="1">
454 <tag name="unit" value="degrees"/>
455 <comment>
456 Angle between north and start of arc.\n
457 0 &lt;= direction &lt; 360
458 </comment>
459 </elem>
460 <elem name ="tilt" type="float32" multiplicity="1">
461 <tag name="unit" value="degrees"/>
462 <comment>
463 Vertical tilt from horizon.\n
464 -90.0 &lt;= tilt &lt;= 90.0
465 </comment>
466 </elem>
467
468 <elem name="opening" type="float32" multiplicity="1">
469 <tag name="unit" value="degrees"/>
470 <comment>
471 Horizontal coverage angle of the antenna face; half on either side of direction.\n
472 0 &lt; opening &lt;= 360.
473 </comment>
474 </elem>
475 <elem name="vopening" type="float32" multiplicity="1">
476 <tag name="unit" value="degrees"/>
477 <comment>
478 Vertical coverage angle of the face; half on either side of tilt.\n
479 0 &lt; opening &lt;= 360.
480 </comment>
481 </elem>
482
483 <elem name="radius" type="float32" multiplicity="1">
484 <tag name="unit" value="meters"/>
485 <comment>
486 radius/distance/reach.\n
487 0 &lt; radius
488 </comment>
489 </elem>
490
491 </struct>
492
493
494 <!--
495 *******************************
496 * StateInfo Type Definition
497 *******************************
498 -->
499
500 <enum name="StateSource" type="Tensor.uint8" default="undefined">
501 <comment>Source enumeration defines the source of the state information.</comment>
502 <literal name="undefined" value="0">
503 <comment>Source is not defined or is unknown.</comment>
504 </literal>
505 <literal name="gnss" value="1">
506 <comment>Source is GNSS.</comment>
507 </literal>
508 <literal name="cellular" value="2">
509 <comment>Source is cellular network location.</comment>
510 </literal>
511 <literal name="wifi" value="3">
512 <comment>Source is WiFi location.</comment>
513 </literal>
514 <literal name="bluetooth" value="4">
515 <comment>Source is bluetooth or bluetooth beaconning.</comment>
516 </literal>
517 <literal name="rtls" value="5">
518 <comment>Source is real-time locating sytem (RTLS).</comment>
519 </literal>
520 <literal name="inertial" value="6">
521 <comment>Source is inertial or sensor fusion.</comment>
522 </literal>
523 <literal name="hybrid" value="7">
524 <comment>Source is hybrid comprised of multiple datatypes (not sensor fusion).</comment>
525 </literal>
526 <literal name="previous" value="8">
527 <comment>Previous state calculated by the ILP/HPE engine.</comment>
528 </literal>
529
530 </enum>
531
532 <struct name="StateInfo">
533 <comment>StateInfo provides a positional definition.</comment>
534 <comment>
535 Used in initializaton and position submission type interfaces.
536 </comment>
537 <elem name="epoch" type="datetime" multiplicity="1" />
538
539 <elem name="confidence" type="float32" multiplicity="1">
540 <comment>Confidence of position shape. Valid range is 0.0 to 1.0</comment>
541 </elem>
542
543 <elem name="shape" multiplicity="1" type="Shape" polymorphic="true" >
544 <comment>
545 Position. Polymorphic type, see specializations
546 from Shape for details.
547 </comment>
548 </elem>
549
550 <elem name="speed" type="float32" multiplicity="0..1">
551 <tag name="unit" value="meters/sec"/>
552 <comment>speed of device in meters/sec</comment>
553 </elem>
554
555 <elem name="azimuth" type="float32" multiplicity="0..1">
556 <tag name="unit" value="degrees"/>
557 <comment>Azimuth heading of the device in degrees (true North)</comment>
558 </elem>
559
560 <elem name="source" type="StateSource" multiplicity="0..1" default="0">
561 <comment>Source field defines the source of the state information. If not specified, value is undefined. Defining the source of the state information
562 assists the calculation processing by characterizing the nature of the position data relative to associated observations.
563 </comment>
564 </elem>
565 </struct>
566
567 <!--
568 *******************************************************
569 Estimate Results
570 *******************************************************
571 -->
572
573 <array name="StringIdentifier" type="int8" size="16">
574 <comment>String identifier defines a short fixed string identifier.</comment>
575 </array>
576
577 <struct name="Estimate">
578 <comment>
579 Estimate is the result provided by positioning calculators at the completion
580 of a calculation.
581 </comment>
582
583 <elem name="result" type="ProcessingStatus" multiplicity="1">
584 <comment>
585 The result of the data processing used to produce the estimate.
586 If not success, ignore the remainder of the estimate information.
587 </comment>
588 </elem>
589
590 <elem name="source" type="string" multiplicity="1">
591 <comment>Estimate source identifier. If not defined set to "".</comment>
592 </elem>
593 <elem name="obstype" type="ObservationType" multiplicity="1">
594 <comment>The last observation type used to create the estimate.</comment>
595 </elem>
596 <elem name="tic" type="uint32">
597 <comment>Tic count of the estimate. Set to zero if not known.</comment>
598 </elem>
599 <elem name="epoch" type="datetime" multiplicity="1">
600 <comment>Epoch defines the point in time for which the estimate applies.</comment>
601 </elem>
602 <elem name="veracity" type="float32" multiplicity="1">
603 <comment>
604 Veracity defines the validity of the measurement in the range between 0 and 1.
605 A high score means the estimate is deemed valid and more reliable than a lower score.
606 If no veracity scoring is performed, this will have a value of -1.
607 </comment>
608 </elem>
609 <elem name="confidence" type="float32" multiplicity="1">
610 <comment>The estimate confidence. Valid range is 0.0 to 1.0</comment>
611 </elem>
612 <elem name="shape" type="Shape" multiplicity="1" polymorphic="true">
613 <comment>
614 The estimate shape result. The particular shape is determined by the
615 preferred shapes specified in the BeginCalculation.
616 </comment>
617 </elem>
618 </struct>
619
620 <!-- eventually may be able to support variable sized elements
621 <array name="EstimateArray" type="Estimate">
622 <comment>
623 HPE Estimates are reported in an array providing the requested formats.
624 </comment>
625 </array>
626 -->
627
628 </namespace>
629 </specification>
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="HpeUsage.xid.xml">
8 <title>HPE Usage Messages</title>
9 <comment>This file the usage messages produced by the HPE.</comment>
10
11 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
12 <import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
13 <import ref="https://xid.location.studio/Tensor/V1.0.0/Logging.xid.xml" local="Logging.xid.xml" />
14
15 <namespace name="HPE">
16 <using namespace="Tensor"/>
17 <using namespace="Logging"/>
18
19 <!--Initialization Report Msg-->
20 <struct name="InitializationReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/initrpt"'>
21 <comment>
22 Message captures HPE initialization data.
23 </comment>
24
25 <elem name="state" type="StateInfo" multiplicity="1">
26 <comment>
27 State information.
28 </comment>
29 </elem>
30 </struct>
31
32 <!--Observation Report Msg-->
33 <struct name="ObservationReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/obsrpt"'>
34 <comment>
35 Message captures HPE observation data for playback purposes and debugging.
36 </comment>
37
38 <elem name="observations" type="ObservationSet" multiplicity="1">
39 <comment>
40 Observation Data provided by the caller.
41 </comment>
42 </elem>
43
44 <elem name="refdata" type="ReferenceDataSet" multiplicity="0..1">
45 <comment>
46 Contains reference data provided by the caller.
47 </comment>
48 </elem>
49
50 <elem name="directive" multiplicity="0..*" type="Tensor.NameValue">
51 <comment>
52 A set of directives to influence processing. Unknown directives are ignored.
53 </comment>
54 </elem>
55 </struct>
56
57 <!--TaskReport Msg-->
58 <struct name="TaskReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/taskrpt"'>
59 <comment>
60 Message reports processing task result data. Tasks are any computational elem
61 within the HPE including calculators, converters, estimators.
62 </comment>
63 <elem name="taskid" type="string" multiplicity="1">
64 <comment>
65 The unique tasks identifier. A source may have multiple tasks, this field assigns
66 an identifier that uniquely characterizes what the task was that was accomplished.
67 </comment>
68 </elem>
69 <elem name="start" type="datetime" multiplicity="1">
70 <comment>
71 The start time at which the processor is used.
72 </comment>
73 </elem>
74 <elem name="duration" type="uint16" multiplicity="1">
75 <tag name="unit" value="msec"/>
76 <comment>
77 The duration of the processing in msec. This is not meant to be a high
78 resolution duration monitoring, implement a metric counter for precise timing data.
79 </comment>
80 </elem>
81 <elem name="status" type="ProcessingStatus" multiplicity="1">
82 <comment>The result of the processor use, typically success or failure.</comment>
83 </elem>
84 </struct>
85
86 <!--Position Report Msg-->
87 <struct name="PositionReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/posrpt"'>
88 <comment>
89 Usage message reports position information produced by HPE.
90 </comment>
91 <elem name="position" type="HPE.Spheroid" multiplicity="1">
92 <comment>The 2D/3D position reported. </comment>
93 </elem>
94 <elem name="speed" type="int16" multiplicity="1">
95 <tag name="unit" value="cm/sec"/>
96 <comment>The observed speed. O if not known.</comment>
97 </elem>
98 <elem name="heading" type="int16" multiplicity="1">
99 <tag name="unit" value="degrees"/>
100 <comment>Observed heading relative true north (azimuth).</comment>
101 </elem>
102 <elem name="veracity" type="byte" multiplicity="1">
103 <comment>
104 Veracity defines the validity of the measurement in the range between 0 and 100.
105 A high score means the estimate is deemed valid and more reliable than a lower score.
106 If no veracity scoring is performed, this will have a value of 255
107 </comment>
108 </elem>
109 <elem name="confidence" type="byte" multiplicity="1">
110 <comment>The estimate confidence. Valid range is 0 to 100</comment>
111 </elem>
112 <elem name="calctype" type="string" multiplicity="1">
113 <comment>
114 Positioning calculation stereo type specifier (hybrid, cellular, slam, etc.). If not defined set to "".
115 </comment>
116 </elem>
117 <elem name="obstype" type="ObservationType" multiplicity="1">
118 <comment>The last observation type used to create the estimate.</comment>
119 </elem>
120 </struct>
121
122 </namespace>
123 </specification>
...@@ -51,7 +51,7 @@ ...@@ -51,7 +51,7 @@
51 </comment> 51 </comment>
52 </elem> 52 </elem>
53 53
54 <elem name="dynamics" multiplicity="0..1" type="DynamicsProfile" default="0"> 54 <elem name="dynamics" multiplicity="0..1" type="DynamicsProfile" default="undefined">
55 <comment> 55 <comment>
56 Specifies the dymnamics of the device providing the data. If not specified, the default dynamics is undefined (0). 56 Specifies the dymnamics of the device providing the data. If not specified, the default dynamics is undefined (0).
57 This parameter optimizes configuration of the estimator to constraint calculations based on the type 57 This parameter optimizes configuration of the estimator to constraint calculations based on the type
...@@ -59,7 +59,7 @@ ...@@ -59,7 +59,7 @@
59 </comment> 59 </comment>
60 </elem> 60 </elem>
61 61
62 <elem name="rankEstimate" multiplicity="0..1" type="EstimateRanking" default="3"> 62 <elem name="rankEstimate" multiplicity="0..1" type="EstimateRanking" default="calcorder">
63 <comment> 63 <comment>
64 Specifies the sort order of the estimates produced by the hybrid calculation. If not defined, the default value is to sort estimates 64 Specifies the sort order of the estimates produced by the hybrid calculation. If not defined, the default value is to sort estimates
65 based on calculation order (0). 65 based on calculation order (0).
......
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="IlpApiBase.xid.xml">
8
9 <title>ILP Hybrid Positioning Services API Base Definitions</title>
10 <comment>
11 This document defines the common types API service interface for the IoT Location Platform (ILP).
12 The service provides hybrid position calculation for devices and services communicating
13 via standard IP based protocols. The API currently supports XMF and JSON wire formats.
14 </comment>
15
16 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
18 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
19 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
20 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
21
22 <namespace name="ILP">
23 <using namespace="HPE"/>
24 <using namespace="Tensor"/>
25
26
27 <!--
28 *******************************
29 *IlpInputBase Type Definition
30 *******************************
31 -->
32 <struct name="IlpInputBase" >
33 <comment>Base input fields for operations supporting asynchronous transaction information.</comment>
34 <elem name="idDevice" multiplicity="1" type="string">
35 <comment>
36 Required device identifier, that provides a consistent multi-transaction identifier
37 for a device or equivalent (e.g. service identifier) providing the data. Any errors or issues resulting from processing the data will include this identifier
38 in the system logs, providing traceability. Identifier should be unique.
39 </comment>
40 </elem>
41
42 <elem name="idTransaction" multiplicity="0..1" type="string">
43 <comment>
44 Optional transaction identifier for the caller to uniquely identify and track
45 the transaction and corresponding results. These identifiers will appear in the
46 ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
47 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
48 the ILP system.
49 </comment>
50 </elem>
51
52 <!-- THis is future, don't uncomment until design issues resolved. M. Mathews/s. Hines 161130
53 <elem name="urlCallback" multiplicity="0..1" type="string">
54 <tag key="life-cycle" value="future" />
55 <comment>
56 Optional asynchronous callback used to callback client servers during long operations. Not all
57 interfaces may support this.
58 </comment>
59 </elem>
60 -->
61 </struct>
62
63
64 <!--
65 *******************************
66 *IlpOutputBase Type Definition
67 *******************************
68 -->
69 <struct name="IlpOutputBase" >
70 <comment>Base output fields common to operations supporting asynchronous returning transaction information.</comment>
71 <elem name="idDevice" multiplicity="1" type="string">
72 <comment>
73 Device identifier provided at operation input, provides a consistent identifier
74 for a device or equivalent (e.g. service identifier) providing the data. Any errors or issues resulting from processing the data will include this identifier
75 in the system logs, providing traceability.
76 </comment>
77 </elem>
78
79 <elem name="idTransaction" multiplicity="0..1" type="string">
80 <comment>
81 Optional transaction identifier for the caller to uniquely identify and track
82 the transaction and corresponding results. These identifiers appear in the
83 ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
84 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
85 the ILP system.
86 </comment>
87 </elem>
88
89 <!-- THis is future, don't uncomment until design issues resolved. M. Mathews/s. Hine 161130
90 <elem name="urlCallback" multiplicity="0..1" type="string">
91 <tag key="life-cycle" value="future" />
92 <comment>
93 Optional asynchronous callback used to callback client servers during long operations. Not all
94 interfaces may support this.
95 </comment>
96 </elem>
97 -->
98 </struct>
99
100
101 </namespace>
102 </specification>
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="IlpAssistanceApi.xid.xml">
8 <title>ILP Assistance Services</title>
9 <comment>
10 This document defines the positioning assistance service interface for the IoT Location Platform (ILP).
11 The service provides assistance data supporting GNSS and other positioning technologies for devices
12 and services communicating via standard IP based protocols. The API currently supports XMF and JSON wire formats.
13 </comment>
14
15 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
16 <import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
18 <import ref="https://xid.location.studio/ILP/V1.1.1/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" />
19
20 <namespace name="ILP">
21 <using namespace="HPE"/>
22 <using namespace="Tensor"/>
23
24 <!--
25 *******************************************************
26 GnssData input/ouput structure declarations.
27 *******************************************************
28 -->
29 <!-- GnssDataInput structure -->
30 <struct name="GnssDataInput" type="IlpInputBase">
31 <comment>ILP.Assistance.GnssData input request data.</comment>
32
33 <!-- Define internal data structure -->
34 <struct name="RequestSpec">
35 <comment>Specifies the data request for each constellation type.</comment>
36 <elem name ="constellation" type="HPE.Gnss.Constellation" multiplicity="1">
37 <comment>Specifies the constellation of interest.</comment>
38 </elem>
39 <elem name="directive" multiplicity="0..*" type="NameValue">
40 <comment>
41 A set of directives to influence processing.
42 </comment>
43 </elem>
44 <elem name="minId" multiplicity="0..1" type ="uint8" default="0">
45 <comment>
46 Specifies the minimum satellite ID to return constellation data.
47 </comment>
48 </elem>
49 <elem name="maxId" multiplicity="0..1" type ="uint8" default="255">
50 <comment>
51 Specifies the maximum satellite ID to return constellation data.
52 </comment>
53 </elem>
54 <elem name="AssistData" multiplicity="1..*" type ="HPE.Gnss.AssistanceData">
55 <comment>
56 Specifies the types of constellation assistance data to return.
57 </comment>
58 </elem>
59 </struct>
60
61 <!-- Define input elements.-->
62 <elem name="epoch" multiplicity="0..1" type="datetime">
63 <comment>
64 Optional epoch for which the data is valid. Leave unspecified if the current epoch is desired.
65 </comment>
66 </elem>
67
68 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
69 <comment>
70 ConstellationData encoding format for the response. This field is carried into
71 GetAssistanceData_output.encCon and GetGnssAlmanacs_output.conData will be encoded
72 in this format. If not specified the "native" format of the protocol is used.
73 </comment>
74 </elem>
75
76 <elem name="location" multiplicity="0..1" type="Shape">
77 <comment>
78 Optional specification of the location to compute assistance data. If not specified
79 all available asistance data will be provided.
80 </comment>
81 </elem>
82
83 <elem name="elmask" multiplicity="0..1" type="int8" default="-90">
84 <comment>
85 Optional, specifies the elevation cutoff mask relative to the current
86 location in degrees. If not specified or -90, all values within the specified satellite ID ranges are returned.
87 </comment>
88 <tag name="unit" value="degrees"/>
89 </elem>
90
91 <elem name="Request" multiplicity="1..*" type="RequestSpec">
92 <comment>Specifies the requested data. One specification is required, multiple can be processed simultaneously.</comment>
93 </elem>
94 </struct>
95
96 <!-- GnssDataOutput structure -->
97 <struct name="GnssDataOutput" type="IlpOutputBase">
98 <comment>ILP.Assistance.GnssData output structure. </comment>
99
100 <elem name="resultcode" multiplicity="1" type="ResultCode">
101 <comment>
102 Result of GnssData operation.
103 If resultcode is not success, encCon and constellation data will not be present.
104 </comment>
105 </elem>
106
107 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
108 <comment>
109 Constellation Data encoding format. Data can be provided in a different encoding format
110 than the native protocol format. This is carried over from input.
111 If not present, the data is in the native protocol format (e.g. XMF, JSON).
112 </comment>
113 </elem>
114
115 <elem name="assistdata" multiplicity="0..*" type ="HPE.Gnss.ConstellationData" encoding="encoding">
116 <comment>
117 The list of ConstellationData encoded in the format specified by encoding.
118 </comment>
119 </elem>
120 </struct>
121
122
123 <!--
124 *******************************************************
125 ILP GNSS Assistance Data Service Interface.
126 *******************************************************
127 -->
128 <interface name="Assistance">
129 <comment>Assistance data interface functions.</comment>
130
131 <operation name="Gnss">
132 <comment>Returns caller requested GNSS assistance data.</comment>
133 <input name="Input" type="GnssDataInput" sid="0x1018"/>
134 <output name="Result" type="GnssDataOutput" sid="0x1019"/>
135 </operation>
136
137 </interface>
138
139 </namespace>
140 </specification>
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="IlpPositioningApi.xid.xml">
8 <title>ILP Hybrid Positioning Services</title>
9 <comment>
10 This document defines the positioning service interface for the IoT Location Platform (ILP).
11 The service provides hybrid position calculation for devices and services communicating
12 via standard IP based protocols. The API currently supports XMF and JSON wire formats.
13 </comment>
14
15 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
16 <import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
18 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
19 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
20 <import ref="https://xid.location.studio/ILP/V1.1.1/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" />
21
22 <namespace name="ILP">
23 <using namespace="HPE"/>
24 <using namespace="Tensor"/>
25
26 <!--
27 *******************************************************
28 ILP Positioning Calculation Data Types
29 *******************************************************
30 -->
31
32 <!-- CalculateInput structure -->
33 <struct name="CalculateInput" type ="IlpInputBase">
34 <comment>ILP.Positioning.Calculate input data structure.</comment>
35
36 <elem name="uuidSession" multiplicity="0..1" type="UUID">
37 <comment>
38 Optional session identifier. See CreateSession for creating valid
39 session identifiers. Transactions can be processed in the context of a session to provide
40 historical information and link calcuation in time.
41 </comment>
42 </elem>
43
44 <elem name="durSession" multiplicity="0..1" type="int32">
45 <comment>
46 Optional session duration. Default is 0 (not persisted). If specified,
47 the session created for this transaction will be stored for a maximum of 86400 seconds.
48 The uuidSession returned in the output, can be used in subsequent calls to Calculate to utilize
49 the persisted session data. Call ReleaseSession to release any persisted content once the session
50 is complete.
51 </comment>
52 </elem>
53
54 <elem name="dynamics" multiplicity="0..1" type="DynamicsProfile" default="0">
55 <comment>
56 Specifies the dymnamics of the device providing the data. If not specified, the default dynamics is undefined (0).
57 This parameter optimizes configuration of the estimator to constraint calculations based on the type
58 of motion. If session is specified, this value will be overridden.
59 </comment>
60 </elem>
61
62 <elem name="rankEstimate" multiplicity="0..1" type="EstimateRanking" default="3">
63 <comment>
64 Specifies the sort order of the estimates produced by the hybrid calculation. If not defined, the default value is to sort estimates
65 based on calculation order (0).
66 </comment>
67 </elem>
68
69 <elem name="confidence" multiplicity="0..1" type="float32" default="0.682689">
70 <comment>
71 Specifies the confidence level to report estimate error uncertainty, range between 0.0 and 1.0\n
72 Common values for confidence are:\n
73 \t 0.682689 (1 std. dev.)\n
74 \t 0.954499 (2 std. dev.)\n
75 \t 0.997300 (3 std. dev.)\n
76 If confidence is not specified, the default
77 value is 0.682689.
78 </comment>
79 </elem>
80
81 <elem name="maxEstimates" multiplicity="0..1" type="uint8" default="1">
82 <comment>
83 Specifies the maximum number of estimates (up to 255) to return in the calculation output.
84 If not specified 1 hybrid estimate is returned.
85 </comment>
86 </elem>
87
88 <elem name="typeShape" multiplicity="0..*" type="ShapeType">
89 <comment>
90 Specifies the preferred shape types to provide estimates in. The highest
91 ranking estimate will be returned in this specified shape types if supported.\n
92 If not specified, the set defaults to: Spheroid, Circle.
93 </comment>
94 </elem>
95
96 <elem name="directive" multiplicity="0..*" type="NameValue" ord="87">
97 <comment>
98 A set of directives to influence processing. Unknown directives are ignored.
99 </comment>
100 </elem>
101
102
103 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
104 <comment>
105 Specifies the position to initialize the state of the positioning engine.\n
106 At least one of observations or state is required,
107 otherwise there is insufficient data to process.
108 </comment>
109 </elem>
110
111 <elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
112 <comment>
113 Observation set encoding format. Observations may be passed to the service in
114 an encoding format different than that outer wire format.
115 By default wire protocol native format is assumed.
116 </comment>
117 </elem>
118
119 <elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
120 <comment>
121 Set of observation data encoded in the format specified by encObs.\n
122 At least one of observations or state is required,
123 otherwise there is insufficient data to process.
124 </comment>
125 </elem>
126 </struct>
127
128 <!-- Calculate Status-->
129 <enum name="CalculateStatus" type="Tensor.int8" default="undefined">
130 <comment>
131 Specifies the calculation resulting status. Caller should consult this value first to
132 determine if estimates are valid.
133 </comment>
134 <literal name="EstimateReady" value="1"/>
135 <literal name="undefined" value="0"/>
136 <literal name="DidNotConverge" value="-1"/>
137 <literal name="NotEnoughData" value="-2"/>
138 <literal name="UnspecifiedErr" value="-3"/>
139 </enum>
140
141 <!-- CalculateOutput structure -->
142 <struct name="CalculateOutput" type="IlpOutputBase" >
143 <comment>ILP.Positioning.Calculate output data structure. This contains the reuslts of a calculate oeration.</comment>
144
145 <elem name="uuidSession" multiplicity="1" type="UUID">
146 <comment>
147 Session identifier. This is the Identifier processed session used to process the
148 calculate transaction. If session, was not previously created by CreateSession, then
149 the session will not be available for future use.
150 </comment>
151 </elem>
152
153 <elem name="dynamics" multiplicity="1" type="DynamicsProfile">
154 <comment>
155 Specifies the dymnamics of the device providing the data.
156 </comment>
157 </elem>
158
159 <elem name="rankEstimate" multiplicity="1" type="EstimateRanking">
160 <comment>
161 Specifies the sort order of the estimates produced by the hybrid calculation.
162 </comment>
163 </elem>
164
165 <elem name="status" multiplicity="1" type="CalculateStatus">
166 <comment>
167 Specifies the status result of the calculation.
168 </comment>
169 </elem>
170
171 <elem name="Estimates" multiplicity="0..*" type="Estimate">
172 <comment>
173 List of estimates returned from the calculation ranked in the specified order.
174 </comment>
175 </elem>
176 </struct>
177
178
179 <!--
180 *******************************************************
181 CreateSession Data Types
182 *******************************************************
183 -->
184
185 <!-- CreateSessionInput structure -->
186 <struct name="CreateSessionInput" type="IlpInputBase">
187 <comment>ILP.Positioning.CreateSession input data structure.</comment>
188
189 <elem name="dynamics" multiplicity="1" type="DynamicsProfile">
190 <comment>
191 Specifies the dymnamics of the device providing the data. If not known specify undefined.
192 This parameter optimizes configuration of the estimator to constraint calculations based on the type
193 of motion. If session is specified, this value will be overridden.
194 </comment>
195 </elem>
196
197 <elem name="duration" multiplicity="1" type="int32">
198 <comment>
199 Number of seconds duration should persist. Maximum value is 86400 (1 day).
200 </comment>
201 </elem>
202
203 <elem name="typeObs" multiplicity="0..*" type="ObservationType">
204 <comment>
205 Optional List of supported observation types. Improves transaction initialization speed if only observation types needed are specified.
206 If not specified, all supported observations will be available for the session.
207 </comment>
208 </elem>
209
210 <elem name="ctTypicalObs" multiplicity="0..1" type="int32">
211 <comment>
212 Optional count of typical observations. Improves memory allocation when sizing internal buffers to typical number
213 of observations.
214 </comment>
215 </elem>
216
217 </struct>
218
219 <!-- CreateSessionOutput structure -->
220 <struct name="CreateSessionOutput" type="IlpOutputBase" >
221 <comment>ILP.Positioning.CreateSession output data structure.</comment>
222 <elem name="resultcode" multiplicity="1" type="ResultCode">
223 <comment>
224 Result of session creation operation.
225 </comment>
226 </elem>
227 <elem name="uuidSession" multiplicity="0..1" type="UUID">
228 <comment>
229 Session identifier of the created session.
230 </comment>
231 </elem>
232 </struct>
233
234 <!--
235 *******************************************************
236 ReleaseSession Data Types
237 *******************************************************
238 -->
239
240 <!-- ReleaseSessionInput structure -->
241 <struct name="ReleaseSessionInput" >
242 <comment>ILP.Positioning.ReleaseSession input data structure.</comment>
243 <elem name="uuidSession" multiplicity="1" type="UUID">
244 <comment>
245 Session identifier of the session to release.
246 </comment>
247 </elem>
248
249 </struct>
250
251 <!--
252 *******************************************************
253 Initialize Data Types
254 *******************************************************
255 -->
256
257 <!-- InitializeInput structure -->
258 <struct name="InitializeInput" type="IlpInputBase" >
259 <comment>ILP.Positioning.Initialize input data structure.</comment>
260
261 <elem name="uuidSession" multiplicity="0..1" type="UUID">
262 <comment>
263 Optional session identifier. See CreateSession for creating valid
264 session identifiers. Transactions can be processed in the context of a session to provide
265 historical information and link calcuation in time.
266 </comment>
267 </elem>
268
269 <elem name="durSession" multiplicity="0..1" type="int32">
270 <comment>
271 Optional session duration. Default is 0 (not persisted). If specified,
272 the session created for this transaction will be stored for a maximum of 86400 seconds.
273 The uuidSession returned in the output, can be used in subsequent calls to Calculate to utilize
274 the persisted session data. Call ReleaseSession to release any persisted content once the session
275 is complete.
276 </comment>
277 </elem>
278
279 <elem name="state" multiplicity="1" type="StateInfo">
280 <comment>
281 Specifies the position to initialize the state of the positioning engine.
282 </comment>
283 </elem>
284
285 </struct>
286
287 <!-- InitializeOutput structure -->
288 <struct name="InitializeOutput" type="IlpOutputBase">
289 <comment>ILP.Positioning.Initialize output data structure.</comment>
290 <elem name="resultcode" multiplicity="1" type="ResultCode">
291 <comment>
292 Result of session creation operation.
293 </comment>
294 </elem>
295 <elem name="uuidSession" multiplicity="0..1" type="UUID">
296 <comment>
297 Session identifier of the created session.
298 </comment>
299 </elem>
300 </struct>
301
302
303
304 <!--
305 *******************************************************
306 ILP Positioning Service Interface.
307 *******************************************************
308 -->
309 <interface name="Positioning">
310 <comment>Hybrid positioning interface defines interactions supporting position calculation functions.</comment>
311
312 <operation name="Calculate">
313 <comment>Calculates the position of the device given the specified observation data.</comment>
314 <input name="Input" type="CalculateInput" sid="0x1010"/>
315 <output name="Result" type="CalculateOutput" sid="0x1011" />
316 </operation>
317
318 <operation name="CreateSession">
319 <comment>
320 Creates a persistent session object and returns its UUID. Can be used to process a series of related transactions
321 using the previous filter state. Good for temporal or multiple observation type updates that were not
322 available at the same time.
323 </comment>
324 <input name="Input" type="CreateSessionInput" sid="0x1012"/>
325 <output name="Result" type="CreateSessionOutput" sid="0x1013"/>
326 </operation>
327
328 <operation name="ReleaseSession">
329 <comment>
330 Releases any persistent session data associated with the UUID.
331 </comment>
332 <input name="Input" type="ReleaseSessionInput" sid="0x1014"/>
333 <!-- output name="Result" type="void" sid="0x0000" result="return"/ -->
334 </operation>
335
336 <operation name="Initialize">
337 <comment>
338 Initializes the positioning engine to state specified in the provided shape information.
339 This is an optional interaction given most cases, this initial position can be determmined from
340 the provided data.
341 </comment>
342 <input name="Input" type="InitializeInput" sid="0x1016"/>
343 <output name="Result" type="InitializeOutput" sid="0x1017" />
344 </operation>
345
346 </interface>
347
348 </namespace>
349 </specification>
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="IlpSubmissionApi.xid.xml">
8 <title>ILP Submission API</title>
9 <comment>
10 This document defines a lightweight Observation Submission API for submitting ILP compatible observation
11 data without invoking the full get position operation.
12 </comment>
13
14 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
15 <import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
16 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
18 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
19 <import ref="https://xid.location.studio/ILP/V1.1.1/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" />
20
21 <namespace name="ILP">
22 <using namespace="HPE"/>
23 <using namespace="Tensor"/>
24
25
26 <!-- SubmitInput structure definition.
27 Note: all the tags are defined. These have to
28 match CalculateInput tags of the same name.
29 -->
30 <struct name="PositionInfo" type="IlpInputBase" >
31 <comment>Used as ILP.Submission.PositionInfo input.</comment>
32
33 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
34 <comment>
35 Optional position information.\n
36 At least one of observations or state is required,
37 otherwise there is insufficient data to process.
38 </comment>
39 </elem>
40
41 <elem name="directive" multiplicity="0..*" type="NameValue" ord="87">
42 <comment>
43 A set of directives to influence processing.
44 </comment>
45 </elem>
46
47 <elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
48 <comment>
49 Observation set encoding format. Observations may be passed to the service in
50 an encoding format different than that outer wire format.
51 </comment>
52 </elem>
53
54 <elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
55 <comment>
56 Optional Set of observation data encoded in the format specified by encObs.\n
57 At least one of observations or state is required,
58 otherwise there is insufficient data to process.
59 </comment>
60 </elem>
61 </struct>
62
63 <!--
64 *******************************************************
65 Observation Submission API
66 *******************************************************
67 -->
68 <interface name="Submission">
69 <comment>Interface for submitting data to ILP. </comment>
70
71 <operation name="PositionInfo">
72 <comment>
73 Interaction submits position and observation data.\n
74 There is no response besides bearer response codes.
75 </comment>
76 <input name="Input" type="PositionInfo" sid="0x101E"/>
77 </operation>
78 </interface>
79 </namespace>
80 </specification>
1 Ord.HPE.PositionReport.calctype=117
2 Ord.HPE.PositionReport.confidence=116
3 Ord.HPE.PositionReport.heading=114
4 Ord.HPE.PositionReport.obstype=118
5 Ord.HPE.PositionReport.position=112
6 Ord.HPE.PositionReport.speed=113
7 Ord.HPE.PositionReport.veracity=115
8 Ord.HPE.StateInfo.azimuth=68
9 Ord.HPE.StateInfo.confidence=65
10 Ord.HPE.StateInfo.epoch=64
11 Ord.HPE.StateInfo.shape=66
12 Ord.HPE.StateInfo.source=69
13 Ord.HPE.StateInfo.speed=67
14 Ord.HPE.CalculateComplete.confidence=117
15 Ord.HPE.CalculateComplete.heading=115
16 Ord.HPE.CalculateComplete.obstype=119
17 Ord.HPE.CalculateComplete.position=113
18 Ord.HPE.CalculateComplete.result=112
19 Ord.HPE.CalculateComplete.source=118
20 Ord.HPE.CalculateComplete.speed=114
21 Ord.HPE.CalculateComplete.veracity=116
22 Ord.Logging.DebugInfo.file=64
23 Ord.Logging.DebugInfo.line=65
24 Ord.Logging.DebugInfo.thid=66
25 Ord.Logging.Message.acctid=84
26 Ord.Logging.Message.appid=86
27 Ord.Logging.Message.data=89
28 Ord.Logging.Message.date=80
29 Ord.Logging.Message.debug=87
30 Ord.Logging.Message.devid=85
31 Ord.Logging.Message.etid=83
32 Ord.Logging.Message.info=88
33 Ord.Logging.Message.source=81
34 Ord.Logging.Message.tid=82
35 Ord.ILP.ReleaseSessionInput.uuidSession=64
36 Ord.HPE.Estimate.confidence=69
37 Ord.HPE.Estimate.epoch=68
38 Ord.HPE.Estimate.obstype=66
39 Ord.HPE.Estimate.result=64
40 Ord.HPE.Estimate.shape=70
41 Ord.HPE.Estimate.source=65
42 Ord.HPE.Estimate.tic=67
43 Ord.HPE.Estimate.veracity=71
44 Ord.Logging.MessageBase.type=64
45 Ord.ILP.CreateSessionInput.ctTypicalObs=83
46 Ord.ILP.CreateSessionInput.duration=81
47 Ord.ILP.CreateSessionInput.dynamics=80
48 Ord.ILP.CreateSessionInput.typeObs=82
49 Ord.Tensor.NameValue.name=64
50 Ord.Tensor.NameValue.value=65
51 Ord.HPE.Gnss.ConstellationData.almanacs=66
52 Ord.HPE.Gnss.ConstellationData.constellation=64
53 Ord.HPE.Gnss.ConstellationData.ephemeris=67
54 Ord.HPE.Gnss.ConstellationData.iono=69
55 Ord.HPE.Gnss.ConstellationData.utc=68
56 Ord.HPE.Gnss.ConstellationData.week=65
57 Ord.HPE.Gnss.ConstellationSet.constellationData=64
58 Ord.ILP.GnssDataInput.RequestSpec.AssistData=68
59 Ord.ILP.GnssDataInput.RequestSpec.constellation=64
60 Ord.ILP.GnssDataInput.RequestSpec.directive=65
61 Ord.ILP.GnssDataInput.RequestSpec.maxId=67
62 Ord.ILP.GnssDataInput.RequestSpec.minId=66
63 Ord.ILP.GnssDataInput.Request=84
64 Ord.ILP.GnssDataInput.elmask=83
65 Ord.ILP.GnssDataInput.encoding=81
66 Ord.ILP.GnssDataInput.epoch=80
67 Ord.ILP.GnssDataInput.location=82
68 Ord.HPE.ObservationSet.observations=64
69 Ord.HPE.ReferenceDataSet.id=64
70 Ord.HPE.ReferenceDataSet.records=65
71 Ord.Logging.TraceMsg.level=96
72 Ord.ILP.IlpOutputBase.idDevice=64
73 Ord.ILP.IlpOutputBase.idTransaction=65
74 Ord.ILP.GnssDataOutput.assistdata=82
75 Ord.ILP.GnssDataOutput.encoding=81
76 Ord.ILP.GnssDataOutput.resultcode=80
77 Ord.Logging.UsageMsg.uri=96
78 Ord.HPE.ProcessorUse.duration=113
79 Ord.HPE.ProcessorUse.result=114
80 Ord.HPE.ProcessorUse.start=112
81 Ord.Logging.ActionMsg.category=98
82 Ord.Logging.ActionMsg.id=96
83 Ord.Logging.ActionMsg.iid=99
84 Ord.Logging.ActionMsg.severity=97
85 Ord.ILP.CalculateInput.confidence=84
86 Ord.ILP.CalculateInput.directive=87
87 Ord.ILP.CalculateInput.durSession=81
88 Ord.ILP.CalculateInput.dynamics=82
89 Ord.ILP.CalculateInput.encObs=88
90 Ord.ILP.CalculateInput.maxEstimates=85
91 Ord.ILP.CalculateInput.observations=89
92 Ord.ILP.CalculateInput.rankEstimate=83
93 Ord.ILP.CalculateInput.state=90
94 Ord.ILP.CalculateInput.typeShape=86
95 Ord.ILP.CalculateInput.uuidSession=80
96 Ord.HPE.ObservationReport.directive=114
97 Ord.HPE.ObservationReport.observations=112
98 Ord.HPE.ObservationReport.refdata=113
99 Ord.HPE.Gnss.AcqAssistSet.data=64
100 Ord.ILP.CalculateOutput.Estimates=84
101 Ord.ILP.CalculateOutput.dynamics=81
102 Ord.ILP.CalculateOutput.rankEstimate=82
103 Ord.ILP.CalculateOutput.status=83
104 Ord.ILP.CalculateOutput.uuidSession=80
105 Ord.ILP.InitializeOutput.resultcode=80
106 Ord.ILP.InitializeOutput.uuidSession=81
107 Ord.ILP.InitializeInput.durSession=81
108 Ord.ILP.InitializeInput.state=82
109 Ord.ILP.InitializeInput.uuidSession=80
110 Ord.HPE.TaskReport.duration=114
111 Ord.HPE.TaskReport.start=113
112 Ord.HPE.TaskReport.status=115
113 Ord.HPE.TaskReport.taskid=112
114 Ord.ILP.IlpInputBase.idDevice=64
115 Ord.ILP.IlpInputBase.idTransaction=65
116 Ord.HPE.InitializationReport.state=112
117 Ord.HPE.CalculateBegin.directive=114
118 Ord.HPE.CalculateBegin.observations=112
119 Ord.HPE.CalculateBegin.refdata=113
120 Ord.ILP.CreateSessionOutput.resultcode=80
121 Ord.ILP.CreateSessionOutput.uuidSession=81
122 Ord.ILP.PositionInfo.directive=87
123 Ord.ILP.PositionInfo.encObs=88
124 Ord.ILP.PositionInfo.observations=89
125 Ord.ILP.PositionInfo.state=90
126 Ord.HPE.NameValue.name=64
127 Ord.HPE.NameValue.value=65
128 Size.Logging.ActionMsg=-1
129 Size.Logging.DebugInfo=-1
130 Size.Logging.Message=-1
131 Size.Logging.MessageBase=-1
132 Size.Logging.TraceMsg=-1
133 Size.Logging.UsageMsg=-1
134 Size.ILP.Positioning.Calculate.Input=-1
135 Size.ILP.Positioning.Calculate.Output=-1
136 Size.Tensor.NameValue=-1
137 Size.ILP.Assistance.Gnss.Input=-1
138 Size.ILP.Assistance.Gnss.Output=-1
139 Size.HPE.Cellular.AntennaSpec=50
140 Size.HPE.Cellular.CellAntReferenceData=95
141 Size.HPE.Cellular.CellId=12
142 Size.HPE.Cellular.CellLocInfo=32
143 Size.HPE.Cellular.CellularObservation=21
144 Size.HPE.Cellular.GenericInfo=32
145 Size.HPE.Cellular.LteRssiInfo=24
146 Size.HPE.Cellular.LteTimeAdvanceInfo=28
147 Size.HPE.Cellular.MSISDNObservation=11
148 Size.HPE.Cellular.MeasuredResultInfo=26
149 Size.HPE.Cellular.NMRInfo=27
150 Size.HPE.Cellular.RttInfo=31
151 Size.HPE.Cellular.TimeAdvance=23
152 Size.ILP.Positioning.ReleaseSession.Input=-1
153 Size.ILP.CalculateInput=-1
154 Size.ILP.CalculateOutput=-1
155 Size.ILP.CreateSessionInput=-1
156 Size.ILP.CreateSessionOutput=-1
157 Size.ILP.GnssDataInput=-1
158 Size.ILP.GnssDataOutput=-1
159 Size.ILP.IlpInputBase=-1
160 Size.ILP.IlpOutputBase=-1
161 Size.ILP.InitializeInput=-1
162 Size.ILP.InitializeOutput=-1
163 Size.ILP.PositionInfo=-1
164 Size.ILP.ReleaseSessionInput=-1
165 Size.Logging.MessageConsumer.Handler.Input=-1
166 Size.ILP.Positioning.Initialize.Input=-1
167 Size.ILP.Positioning.Initialize.Output=-1
168 Size.HPE.WiFi.WiFiRssi=16
169 Size.ILP.Positioning.CreateSession.Input=-1
170 Size.ILP.Positioning.CreateSession.Output=-1
171 Size.HPE.Gnss.AcqAssistElem=13
172 Size.HPE.Gnss.AcqAssistSet=-1
173 Size.HPE.Gnss.Almanac=25
174 Size.HPE.Gnss.CodephaseMeasurement=9
175 Size.HPE.Gnss.CodephaseMeasurementMin=7
176 Size.HPE.Gnss.ConstellationData=-1
177 Size.HPE.Gnss.ConstellationSet=-1
178 Size.HPE.Gnss.Ephemeris=59
179 Size.HPE.Gnss.GnssPseudorangeMeasurement=1
180 Size.HPE.Gnss.GnssPsuedorangeObservations=37
181 Size.HPE.Gnss.GpsCodePhaseObs8=81
182 Size.HPE.Gnss.GpsCodePhaseObsMin6=51
183 Size.HPE.Gnss.GpsCodePhaseObsMin8=65
184 Size.HPE.Gnss.IonosphericCorrection=8
185 Size.HPE.Gnss.PseudorangeObservation=37
186 Size.HPE.Gnss.SatelliteId=2
187 Size.HPE.Gnss.UtcParameters=13
188 Size.ILP.GnssDataInput.RequestSpec=-1
189 Size.ILP.Submission.PositionInfo.Input=-1
190 Size.Logging.MessageSource.LogMessages.Data=-1
191 Size.HPE.Arc=33
192 Size.HPE.Arc3D=45
193 Size.HPE.ArcBand=45
194 Size.HPE.ArcBand3D=49
195 Size.HPE.CalculateBegin=-1
196 Size.HPE.CalculateComplete=-1
197 Size.HPE.Circle=21
198 Size.HPE.Covariance=578
199 Size.HPE.Ellipse=29
200 Size.HPE.Ellipsoid=41
201 Size.HPE.Estimate=-1
202 Size.HPE.InitializationReport=-1
203 Size.HPE.NameValue=-1
204 Size.HPE.Observation=1
205 Size.HPE.ObservationEpoch=9
206 Size.HPE.ObservationReport=-1
207 Size.HPE.ObservationSet=-1
208 Size.HPE.Point2D=17
209 Size.HPE.Point3D=25
210 Size.HPE.PositionReport=-1
211 Size.HPE.ProcessorUse=-1
212 Size.HPE.ReferenceData=1
213 Size.HPE.ReferenceDataSet=-1
214 Size.HPE.Shape=1
215 Size.HPE.Spheroid=33
216 Size.HPE.StateInfo=-1
217 Size.HPE.TaskReport=-1
218 Idx.HPE.Arc3D.direction=4
219 Idx.HPE.Arc3D.height=1
220 Idx.HPE.Arc3D.inner=3
221 Idx.HPE.Arc3D.opening=5
222 Idx.HPE.Arc3D.outer=2
223 Idx.HPE.Gnss.GnssPseudorangeMeasurement.id=1
224 Idx.HPE.Cellular.LteRssiInfo.nprb=3
225 Idx.HPE.Cellular.LteRssiInfo.rsrp=1
226 Idx.HPE.Cellular.LteRssiInfo.rsrq=2
227 Idx.HPE.Gnss.CodephaseMeasurementMin.cn0=2
228 Idx.HPE.Gnss.CodephaseMeasurementMin.codephase=4
229 Idx.HPE.Gnss.CodephaseMeasurementMin.doppler=3
230 Idx.HPE.Gnss.CodephaseMeasurementMin.id=1
231 Idx.HPE.Cellular.AntennaSpec.RTTCalib=10
232 Idx.HPE.Cellular.AntennaSpec.RTTCalibUncert=11
233 Idx.HPE.Cellular.AntennaSpec.TxPower=8
234 Idx.HPE.Cellular.AntennaSpec.direction=3
235 Idx.HPE.Cellular.AntennaSpec.frequency=9
236 Idx.HPE.Cellular.AntennaSpec.height=2
237 Idx.HPE.Cellular.AntennaSpec.opening=5
238 Idx.HPE.Cellular.AntennaSpec.radius=7
239 Idx.HPE.Cellular.AntennaSpec.sectorid=1
240 Idx.HPE.Cellular.AntennaSpec.tilt=4
241 Idx.HPE.Cellular.AntennaSpec.vopening=6
242 Idx.HPE.Gnss.Almanac.M0=11
243 Idx.HPE.Gnss.Almanac.Omega0=9
244 Idx.HPE.Gnss.Almanac.OmegaDot=4
245 Idx.HPE.Gnss.Almanac.SvHealth=12
246 Idx.HPE.Gnss.Almanac.af0=5
247 Idx.HPE.Gnss.Almanac.af1=6
248 Idx.HPE.Gnss.Almanac.deltai0=3
249 Idx.HPE.Gnss.Almanac.eccentricity=7
250 Idx.HPE.Gnss.Almanac.i0=3
251 Idx.HPE.Gnss.Almanac.id=1
252 Idx.HPE.Gnss.Almanac.omega=10
253 Idx.HPE.Gnss.Almanac.sqrtA=8
254 Idx.HPE.Gnss.Almanac.toa=2
255 Idx.HPE.ArcBand3D.direction=2
256 Idx.HPE.ArcBand3D.height=1
257 Idx.HPE.ArcBand3D.opening=4
258 Idx.HPE.ArcBand3D.radius=6
259 Idx.HPE.ArcBand3D.tilt=3
260 Idx.HPE.ArcBand3D.vopening=5
261 Idx.HPE.Cellular.GenericInfo.rss=1
262 Idx.HPE.Cellular.GenericInfo.rssUncert=2
263 Idx.HPE.Cellular.GenericInfo.service=6
264 Idx.HPE.Cellular.GenericInfo.taHighPart=4
265 Idx.HPE.Cellular.GenericInfo.taLowPart=3
266 Idx.HPE.Cellular.GenericInfo.taUncert=5
267 Idx.HPE.Gnss.IonosphericCorrection.a0=1
268 Idx.HPE.Gnss.IonosphericCorrection.a1=2
269 Idx.HPE.Gnss.IonosphericCorrection.a2=3
270 Idx.HPE.Gnss.IonosphericCorrection.a3=4
271 Idx.HPE.Gnss.IonosphericCorrection.b0=5
272 Idx.HPE.Gnss.IonosphericCorrection.b1=6
273 Idx.HPE.Gnss.IonosphericCorrection.b2=7
274 Idx.HPE.Gnss.IonosphericCorrection.b3=8
275 Idx.HPE.Cellular.CellLocInfo.alt=3
276 Idx.HPE.Cellular.CellLocInfo.lat=1
277 Idx.HPE.Cellular.CellLocInfo.lon=2
278 Idx.HPE.Cellular.CellLocInfo.radius=4
279 Idx.HPE.Cellular.CellLocInfo.vert=5
280 Idx.HPE.Gnss.GnssPsuedorangeObservations.cn0=6
281 Idx.HPE.Gnss.GnssPsuedorangeObservations.id=1
282 Idx.HPE.Gnss.GnssPsuedorangeObservations.mpathIndicator=7
283 Idx.HPE.Gnss.GnssPsuedorangeObservations.pr=3
284 Idx.HPE.Gnss.GnssPsuedorangeObservations.prUncert=5
285 Idx.HPE.Gnss.GnssPsuedorangeObservations.prr=2
286 Idx.HPE.Gnss.GnssPsuedorangeObservations.prrUncert=4
287 Idx.HPE.Gnss.GpsCodePhaseObsMin6.measurements=1
288 Idx.HPE.Point2D.lat=1
289 Idx.HPE.Point2D.lon=2
290 Idx.HPE.Gnss.GpsCodePhaseObsMin8.measurements=1
291 Idx.HPE.ReferenceData.format=1
292 Idx.HPE.Cellular.RttInfo.dupmode=1
293 Idx.HPE.Cellular.RttInfo.exrtt=5
294 Idx.HPE.Cellular.RttInfo.quality=3
295 Idx.HPE.Cellular.RttInfo.rtt=4
296 Idx.HPE.Cellular.RttInfo.rxtxtime=2
297 Idx.HPE.Cellular.RttInfo.tamode=1
298 Idx.HPE.WiFi.WiFiRssi.macaddr=2
299 Idx.HPE.WiFi.WiFiRssi.rssi=1
300 Idx.HPE.Spheroid.radius=1
301 Idx.HPE.Spheroid.vert=2
302 Idx.HPE.Gnss.SatelliteId.constellation=1
303 Idx.HPE.Gnss.SatelliteId.id=2
304 Idx.HPE.ObservationEpoch.epoch=1
305 Idx.HPE.Gnss.AcqAssistElem.CodeCount=5
306 Idx.HPE.Gnss.AcqAssistElem.azimuth=7
307 Idx.HPE.Gnss.AcqAssistElem.codephase=4
308 Idx.HPE.Gnss.AcqAssistElem.doppler0=2
309 Idx.HPE.Gnss.AcqAssistElem.doppler1=3
310 Idx.HPE.Gnss.AcqAssistElem.elevation=8
311 Idx.HPE.Gnss.AcqAssistElem.id=1
312 Idx.HPE.Gnss.AcqAssistElem.searchWindow=6
313 Idx.HPE.Cellular.MSISDNObservation.cc=1
314 Idx.HPE.Cellular.MSISDNObservation.nsn=2
315 Idx.HPE.Ellipsoid.major=1
316 Idx.HPE.Ellipsoid.minor=2
317 Idx.HPE.Ellipsoid.orient=3
318 Idx.HPE.Ellipsoid.vert=4
319 Idx.HPE.Cellular.CellId.cid=6
320 Idx.HPE.Cellular.CellId.ecgi=6
321 Idx.HPE.Cellular.CellId.lac=5
322 Idx.HPE.Cellular.CellId.mcc=3
323 Idx.HPE.Cellular.CellId.mnc=4
324 Idx.HPE.Cellular.CellId.mncLength=2
325 Idx.HPE.Cellular.CellId.rtype=1
326 Idx.HPE.Gnss.CodephaseMeasurement.mpathIndicator=1
327 Idx.HPE.Gnss.CodephaseMeasurement.rmsErr=2
328 Idx.HPE.Ellipse.major=1
329 Idx.HPE.Ellipse.minor=2
330 Idx.HPE.Ellipse.orient=3
331 Idx.HPE.Arc.inner=2
332 Idx.HPE.Arc.offset=3
333 Idx.HPE.Arc.opening=4
334 Idx.HPE.Arc.outer=1
335 Idx.HPE.Circle.radius=1
336 Idx.HPE.ArcBand.major_inner=2
337 Idx.HPE.ArcBand.major_outer=1
338 Idx.HPE.ArcBand.minor_inner=4
339 Idx.HPE.ArcBand.minor_outer=3
340 Idx.HPE.ArcBand.offset=6
341 Idx.HPE.ArcBand.opening=7
342 Idx.HPE.ArcBand.orient=5
343 Idx.HPE.Gnss.Ephemeris.Cic=14
344 Idx.HPE.Gnss.Ephemeris.Cis=13
345 Idx.HPE.Gnss.Ephemeris.Crc=16
346 Idx.HPE.Gnss.Ephemeris.Crs=15
347 Idx.HPE.Gnss.Ephemeris.Cuc=18
348 Idx.HPE.Gnss.Ephemeris.Cus=17
349 Idx.HPE.Gnss.Ephemeris.M0=10
350 Idx.HPE.Gnss.Ephemeris.Omega0=8
351 Idx.HPE.Gnss.Ephemeris.OmegaDot=6
352 Idx.HPE.Gnss.Ephemeris.SvHealth=25
353 Idx.HPE.Gnss.Ephemeris.TGD=24
354 Idx.HPE.Gnss.Ephemeris.af0=21
355 Idx.HPE.Gnss.Ephemeris.af1=22
356 Idx.HPE.Gnss.Ephemeris.af2=23
357 Idx.HPE.Gnss.Ephemeris.deltan=11
358 Idx.HPE.Gnss.Ephemeris.eccentricity=4
359 Idx.HPE.Gnss.Ephemeris.i0=5
360 Idx.HPE.Gnss.Ephemeris.id=1
361 Idx.HPE.Gnss.Ephemeris.idot=12
362 Idx.HPE.Gnss.Ephemeris.iodc=20
363 Idx.HPE.Gnss.Ephemeris.iode=3
364 Idx.HPE.Gnss.Ephemeris.omega=9
365 Idx.HPE.Gnss.Ephemeris.sqrtA=7
366 Idx.HPE.Gnss.Ephemeris.toc=19
367 Idx.HPE.Gnss.Ephemeris.toe=2
368 Idx.HPE.Observation.type=1
369 Idx.HPE.Cellular.LteTimeAdvanceInfo.aoa=3
370 Idx.HPE.Cellular.LteTimeAdvanceInfo.ta=2
371 Idx.HPE.Cellular.LteTimeAdvanceInfo.tamode=1
372 Idx.HPE.Cellular.LteTimeAdvanceInfo.uerxtx=4
373 Idx.HPE.Cellular.TimeAdvance.ta=1
374 Idx.HPE.Cellular.CellularObservation.cid=1
375 Idx.HPE.Point3D.alt=1
376 Idx.HPE.Gnss.GpsCodePhaseObs8.measurements=1
377 Idx.HPE.Gnss.PseudorangeObservation.cn0=6
378 Idx.HPE.Gnss.PseudorangeObservation.id=1
379 Idx.HPE.Gnss.PseudorangeObservation.mpathIndicator=7
380 Idx.HPE.Gnss.PseudorangeObservation.pr=3
381 Idx.HPE.Gnss.PseudorangeObservation.prUncert=5
382 Idx.HPE.Gnss.PseudorangeObservation.prr=2
383 Idx.HPE.Gnss.PseudorangeObservation.prrUncert=4
384 Idx.HPE.Cellular.CellAntReferenceData.antenna=2
385 Idx.HPE.Cellular.CellAntReferenceData.cid=1
386 Idx.HPE.Cellular.CellAntReferenceData.location=3
387 Idx.HPE.Cellular.MeasuredResultInfo.cpichEcNO=3
388 Idx.HPE.Cellular.MeasuredResultInfo.cpichRSCP=2
389 Idx.HPE.Cellular.MeasuredResultInfo.deltaRSCP=5
390 Idx.HPE.Cellular.MeasuredResultInfo.dupmode=1
391 Idx.HPE.Cellular.MeasuredResultInfo.pathloss=4
392 Idx.HPE.Covariance.covariance=2
393 Idx.HPE.Covariance.referenceframe=3
394 Idx.HPE.Covariance.state=1
395 Idx.HPE.Shape.type=1
396 Idx.HPE.Gnss.UtcParameters.DN=7
397 Idx.HPE.Gnss.UtcParameters.DeltaTls=3
398 Idx.HPE.Gnss.UtcParameters.DeltaTlsf=8
399 Idx.HPE.Gnss.UtcParameters.WNlsf=6
400 Idx.HPE.Gnss.UtcParameters.WNt=5
401 Idx.HPE.Gnss.UtcParameters.a0=1
402 Idx.HPE.Gnss.UtcParameters.a1=2
403 Idx.HPE.Gnss.UtcParameters.tot=4
404 Idx.HPE.Cellular.NMRInfo.arfcn=1
405 Idx.HPE.Cellular.NMRInfo.bsic=2
406 Idx.HPE.Cellular.NMRInfo.rxlevel=3
407 Off.HPE.Arc3D.direction=37
408 Off.HPE.Arc3D.height=25
409 Off.HPE.Arc3D.inner=33
410 Off.HPE.Arc3D.opening=41
411 Off.HPE.Arc3D.outer=29
412 Off.HPE.Gnss.GnssPseudorangeMeasurement.id=0
413 Off.HPE.Cellular.LteRssiInfo.nprb=23
414 Off.HPE.Cellular.LteRssiInfo.rsrp=21
415 Off.HPE.Cellular.LteRssiInfo.rsrq=22
416 Off.HPE.Gnss.CodephaseMeasurementMin.cn0=1
417 Off.HPE.Gnss.CodephaseMeasurementMin.codephase=4
418 Off.HPE.Gnss.CodephaseMeasurementMin.doppler=2
419 Off.HPE.Gnss.CodephaseMeasurementMin.id=0
420 Off.HPE.Cellular.AntennaSpec.RTTCalib=42
421 Off.HPE.Cellular.AntennaSpec.RTTCalibUncert=46
422 Off.HPE.Cellular.AntennaSpec.TxPower=26
423 Off.HPE.Cellular.AntennaSpec.direction=6
424 Off.HPE.Cellular.AntennaSpec.frequency=34
425 Off.HPE.Cellular.AntennaSpec.height=2
426 Off.HPE.Cellular.AntennaSpec.opening=14
427 Off.HPE.Cellular.AntennaSpec.radius=22
428 Off.HPE.Cellular.AntennaSpec.sectorid=0
429 Off.HPE.Cellular.AntennaSpec.tilt=10
430 Off.HPE.Cellular.AntennaSpec.vopening=18
431 Off.HPE.Gnss.Almanac.M0=21
432 Off.HPE.Gnss.Almanac.Omega0=15
433 Off.HPE.Gnss.Almanac.OmegaDot=4
434 Off.HPE.Gnss.Almanac.SvHealth=24
435 Off.HPE.Gnss.Almanac.af0=6
436 Off.HPE.Gnss.Almanac.af1=8
437 Off.HPE.Gnss.Almanac.deltai0=2
438 Off.HPE.Gnss.Almanac.eccentricity=10
439 Off.HPE.Gnss.Almanac.i0=2
440 Off.HPE.Gnss.Almanac.id=0
441 Off.HPE.Gnss.Almanac.omega=18
442 Off.HPE.Gnss.Almanac.sqrtA=12
443 Off.HPE.Gnss.Almanac.toa=1
444 Off.HPE.ArcBand3D.direction=29
445 Off.HPE.ArcBand3D.height=25
446 Off.HPE.ArcBand3D.opening=37
447 Off.HPE.ArcBand3D.radius=45
448 Off.HPE.ArcBand3D.tilt=33
449 Off.HPE.ArcBand3D.vopening=41
450 Off.HPE.Cellular.GenericInfo.rss=21
451 Off.HPE.Cellular.GenericInfo.rssUncert=25
452 Off.HPE.Cellular.GenericInfo.service=31
453 Off.HPE.Cellular.GenericInfo.taHighPart=28
454 Off.HPE.Cellular.GenericInfo.taLowPart=26
455 Off.HPE.Cellular.GenericInfo.taUncert=29
456 Off.HPE.Gnss.IonosphericCorrection.a0=0
457 Off.HPE.Gnss.IonosphericCorrection.a1=1
458 Off.HPE.Gnss.IonosphericCorrection.a2=2
459 Off.HPE.Gnss.IonosphericCorrection.a3=3
460 Off.HPE.Gnss.IonosphericCorrection.b0=4
461 Off.HPE.Gnss.IonosphericCorrection.b1=5
462 Off.HPE.Gnss.IonosphericCorrection.b2=6
463 Off.HPE.Gnss.IonosphericCorrection.b3=7
464 Off.HPE.Cellular.CellLocInfo.alt=16
465 Off.HPE.Cellular.CellLocInfo.lat=0
466 Off.HPE.Cellular.CellLocInfo.lon=8
467 Off.HPE.Cellular.CellLocInfo.radius=24
468 Off.HPE.Cellular.CellLocInfo.vert=28
469 Off.HPE.Gnss.GnssPsuedorangeObservations.cn0=35
470 Off.HPE.Gnss.GnssPsuedorangeObservations.id=9
471 Off.HPE.Gnss.GnssPsuedorangeObservations.mpathIndicator=36
472 Off.HPE.Gnss.GnssPsuedorangeObservations.pr=19
473 Off.HPE.Gnss.GnssPsuedorangeObservations.prUncert=31
474 Off.HPE.Gnss.GnssPsuedorangeObservations.prr=11
475 Off.HPE.Gnss.GnssPsuedorangeObservations.prrUncert=27
476 Off.HPE.Gnss.GpsCodePhaseObsMin6.measurements=9
477 Off.HPE.Point2D.lat=1
478 Off.HPE.Point2D.lon=9
479 Off.HPE.Gnss.GpsCodePhaseObsMin8.measurements=9
480 Off.HPE.ReferenceData.format=0
481 Off.HPE.Cellular.RttInfo.dupmode=21
482 Off.HPE.Cellular.RttInfo.exrtt=27
483 Off.HPE.Cellular.RttInfo.quality=24
484 Off.HPE.Cellular.RttInfo.rtt=25
485 Off.HPE.Cellular.RttInfo.rxtxtime=22
486 Off.HPE.Cellular.RttInfo.tamode=21
487 Off.HPE.WiFi.WiFiRssi.macaddr=10
488 Off.HPE.WiFi.WiFiRssi.rssi=9
489 Off.HPE.Spheroid.radius=25
490 Off.HPE.Spheroid.vert=29
491 Off.HPE.Gnss.SatelliteId.constellation=0
492 Off.HPE.Gnss.SatelliteId.id=1
493 Off.HPE.ObservationEpoch.epoch=1
494 Off.HPE.Gnss.AcqAssistElem.CodeCount=8
495 Off.HPE.Gnss.AcqAssistElem.azimuth=11
496 Off.HPE.Gnss.AcqAssistElem.codephase=6
497 Off.HPE.Gnss.AcqAssistElem.doppler0=2
498 Off.HPE.Gnss.AcqAssistElem.doppler1=4
499 Off.HPE.Gnss.AcqAssistElem.elevation=12
500 Off.HPE.Gnss.AcqAssistElem.id=0
501 Off.HPE.Gnss.AcqAssistElem.searchWindow=10
502 Off.HPE.Cellular.MSISDNObservation.cc=1
503 Off.HPE.Cellular.MSISDNObservation.nsn=3
504 Off.HPE.Ellipsoid.major=25
505 Off.HPE.Ellipsoid.minor=29
506 Off.HPE.Ellipsoid.orient=33
507 Off.HPE.Ellipsoid.vert=37
508 Off.HPE.Cellular.CellId.cid=8
509 Off.HPE.Cellular.CellId.ecgi=11
510 Off.HPE.Cellular.CellId.lac=6
511 Off.HPE.Cellular.CellId.mcc=2
512 Off.HPE.Cellular.CellId.mnc=4
513 Off.HPE.Cellular.CellId.mncLength=1
514 Off.HPE.Cellular.CellId.rtype=0
515 Off.HPE.Gnss.CodephaseMeasurement.mpathIndicator=7
516 Off.HPE.Gnss.CodephaseMeasurement.rmsErr=8
517 Off.HPE.Ellipse.major=17
518 Off.HPE.Ellipse.minor=21
519 Off.HPE.Ellipse.orient=25
520 Off.HPE.Arc.inner=21
521 Off.HPE.Arc.offset=25
522 Off.HPE.Arc.opening=29
523 Off.HPE.Arc.outer=17
524 Off.HPE.Circle.radius=17
525 Off.HPE.ArcBand.major_inner=21
526 Off.HPE.ArcBand.major_outer=17
527 Off.HPE.ArcBand.minor_inner=29
528 Off.HPE.ArcBand.minor_outer=25
529 Off.HPE.ArcBand.offset=37
530 Off.HPE.ArcBand.opening=41
531 Off.HPE.ArcBand.orient=33
532 Off.HPE.Gnss.Ephemeris.Cic=37
533 Off.HPE.Gnss.Ephemeris.Cis=35
534 Off.HPE.Gnss.Ephemeris.Crc=41
535 Off.HPE.Gnss.Ephemeris.Crs=39
536 Off.HPE.Gnss.Ephemeris.Cuc=45
537 Off.HPE.Gnss.Ephemeris.Cus=43
538 Off.HPE.Gnss.Ephemeris.M0=27
539 Off.HPE.Gnss.Ephemeris.Omega0=19
540 Off.HPE.Gnss.Ephemeris.OmegaDot=12
541 Off.HPE.Gnss.Ephemeris.SvHealth=58
542 Off.HPE.Gnss.Ephemeris.TGD=57
543 Off.HPE.Gnss.Ephemeris.af0=51
544 Off.HPE.Gnss.Ephemeris.af1=54
545 Off.HPE.Gnss.Ephemeris.af2=56
546 Off.HPE.Gnss.Ephemeris.deltan=31
547 Off.HPE.Gnss.Ephemeris.eccentricity=4
548 Off.HPE.Gnss.Ephemeris.i0=8
549 Off.HPE.Gnss.Ephemeris.id=0
550 Off.HPE.Gnss.Ephemeris.idot=33
551 Off.HPE.Gnss.Ephemeris.iodc=49
552 Off.HPE.Gnss.Ephemeris.iode=3
553 Off.HPE.Gnss.Ephemeris.omega=23
554 Off.HPE.Gnss.Ephemeris.sqrtA=15
555 Off.HPE.Gnss.Ephemeris.toc=47
556 Off.HPE.Gnss.Ephemeris.toe=1
557 Off.HPE.Observation.type=0
558 Off.HPE.Cellular.LteTimeAdvanceInfo.aoa=24
559 Off.HPE.Cellular.LteTimeAdvanceInfo.ta=22
560 Off.HPE.Cellular.LteTimeAdvanceInfo.tamode=21
561 Off.HPE.Cellular.LteTimeAdvanceInfo.uerxtx=26
562 Off.HPE.Cellular.TimeAdvance.ta=21
563 Off.HPE.Cellular.CellularObservation.cid=9
564 Off.HPE.Point3D.alt=17
565 Off.HPE.Gnss.GpsCodePhaseObs8.measurements=9
566 Off.HPE.Gnss.PseudorangeObservation.cn0=35
567 Off.HPE.Gnss.PseudorangeObservation.id=9
568 Off.HPE.Gnss.PseudorangeObservation.mpathIndicator=36
569 Off.HPE.Gnss.PseudorangeObservation.pr=19
570 Off.HPE.Gnss.PseudorangeObservation.prUncert=31
571 Off.HPE.Gnss.PseudorangeObservation.prr=11
572 Off.HPE.Gnss.PseudorangeObservation.prrUncert=27
573 Off.HPE.Cellular.CellAntReferenceData.antenna=13
574 Off.HPE.Cellular.CellAntReferenceData.cid=1
575 Off.HPE.Cellular.CellAntReferenceData.location=63
576 Off.HPE.Cellular.MeasuredResultInfo.cpichEcNO=23
577 Off.HPE.Cellular.MeasuredResultInfo.cpichRSCP=22
578 Off.HPE.Cellular.MeasuredResultInfo.deltaRSCP=25
579 Off.HPE.Cellular.MeasuredResultInfo.dupmode=21
580 Off.HPE.Cellular.MeasuredResultInfo.pathloss=24
581 Off.HPE.Covariance.covariance=65
582 Off.HPE.Covariance.referenceframe=577
583 Off.HPE.Covariance.state=1
584 Off.HPE.Shape.type=0
585 Off.HPE.Gnss.UtcParameters.DN=11
586 Off.HPE.Gnss.UtcParameters.DeltaTls=7
587 Off.HPE.Gnss.UtcParameters.DeltaTlsf=12
588 Off.HPE.Gnss.UtcParameters.WNlsf=10
589 Off.HPE.Gnss.UtcParameters.WNt=9
590 Off.HPE.Gnss.UtcParameters.a0=0
591 Off.HPE.Gnss.UtcParameters.a1=4
592 Off.HPE.Gnss.UtcParameters.tot=8
593 Off.HPE.Cellular.NMRInfo.arfcn=21
594 Off.HPE.Cellular.NMRInfo.bsic=23
595 Off.HPE.Cellular.NMRInfo.rxlevel=25
596 SID.ILP.Assistance.Gnss.Input=4120
597 SID.ILP.Assistance.Gnss.Output=4121
598 SID.ILP.Positioning.Calculate.Input=4112
599 SID.ILP.Positioning.Calculate.Output=4113
600 SID.ILP.Positioning.CreateSession.Input=4114
601 SID.ILP.Positioning.CreateSession.Output=4115
602 SID.ILP.Positioning.Initialize.Input=4118
603 SID.ILP.Positioning.Initialize.Output=4119
604 SID.ILP.Positioning.ReleaseSession.Input=4116
605 SID.ILP.Submission.PositionInfo.Input=4126
606 SID.Logging.MessageConsumer.Handler.Input=4096
607 SID.Logging.MessageSource.LogMessages.Data=4096
...@@ -29,9 +29,14 @@ This is a public repo containing published XID (Xtensible Interface Definition) ...@@ -29,9 +29,14 @@ This is a public repo containing published XID (Xtensible Interface Definition)
29 * HPE/CommonDefs/V1.1.1/* 29 * HPE/CommonDefs/V1.1.1/*
30 * ILP/V1.1.1/* 30 * ILP/V1.1.1/*
31 31
32 These two versions are historical copies that work with the old code generator.
33 The V1.1.1 versions above were updated for the new code generator.
34 The changes are related to enum defaults; new code generator requires literal name and does not accept numerical value.
35 * HPE/V1.1.1_orig/*
36 * ILP/V1.1.1_orig/*
37
32 ### Deprecated ### 38 ### Deprecated ###
33 39
34 N/A
35 40
36 ### Retired ### 41 ### Retired ###
37 42
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!