Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
29ec9747 by Skip Hines
Options

ILP-17 : Create V1.2 for HPE and ILP. HpeWiFi.xid.xml now using "mac48" type.

1 parent 61e08a71
Inline Side-by-side
Showing 11 changed files with 2413 additions and 1 deletions
HPE/V1.2/HpeCellular.xid.xml 0 → 100644
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 XtensibleInterfaceDefinition.xsd"
7 identity="HpeCellular.xid.xml">
8 <title>HPE Celullar Data Definition</title>
9 <comment>File contains data definitions for 2G, 3G, and 4G HPE location related datatypes.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
13
14 <namespace name="HPE.Cellular">
15 <using namespace="Tensor"/>
16 <using namespace="HPE"/>
17
18 <enum name="RadioType" type="Tensor.uint8" default="undefined">
19 <comment>Specifies the specific variant of Radio Data.</comment>
20 <literal name="undefined" value="0"/>
21 <literal name="GSM" value="1"/>
22 <literal name="WCDMA" value="2"/>
23 <literal name="LTE" value="3"/>
24 <literal name="CDMA" value="4"/>
25 </enum>
26
27 <enum name="DuplexMode" type="Tensor.int8" default="FDD">
28 <comment>Defines the communication duplexing mode.</comment>
29 <literal name="FDD" value="0"/>
30 <literal name="TDD" value="1"/>
31 </enum>
32
33 <enum name="TimeAdvMode" type="Tensor.int8" default="RAW">
34 <comment>Defines Time Advance measurement mode.</comment>
35 <literal name="TYPE1" value="0"/>
36 <literal name="TYPE2" value="1"/>
37 <literal name="UE" value="2"/>
38 <literal name="SUPL" value="3"/>
39 <literal name="RAW" value="4"/>
40 </enum>
41
42 <!-- Referece Data types-->
43 <struct name="CellId" pack="true">
44 <comment>
45 CellIDInfo is a structure that uniquely identifies the Cell Tower in the cellular network.\n
46 It relies on the RadioType field to interpret the meaning of specific fields.</comment>
47 <elem name ="rtype" type="RadioType" multiplicity="1"/>
48 <elem name ="mncLength" type="uint8" multiplicity="1">
49 <comment>
50 Indicates number of digits for MNC to pad to (2 or 3).\n
51 If unknown, use 0.\n
52 For:\n
53 \t rtype=4(CDMA), this field is ignored.
54 </comment>
55 </elem>
56 <elem name ="mcc" type="uint16" multiplicity="1">
57 <comment>Mobile Country Code.</comment>
58 </elem>
59 <elem name ="mnc" type="uint16" multiplicity="1">
60 <comment>
61 Mobile Network Code.\n
62 For:\n
63 \t rtype=4(CDMA) this field is the SID
64 </comment>
65 </elem>
66 <elem name ="lac" type="uint16" multiplicity="1">
67 <comment>
68 Location Area Code.\n
69 For:\n
70 \t rtype=3(LTE) this field is the TAC.\n
71 \r rtype=4(CDMA) this field is the NID.
72 </comment>
73 </elem>
74 <elem name ="cid" type="uint32" multiplicity="1">
75 <comment>
76 Cell ID.\n
77 For:\n
78 \t rtype=4(CDMA) this field is the BID.
79 </comment>
80 </elem>
81 </struct>
82
83 <struct name="AntennaSpec" pack="true">
84 <comment>Specifies the details about a specific antenna.</comment>
85 <comment>Geometric specification matches HPE.ArcBand3D</comment>
86 <elem name ="sectorid" type="uint16" multiplicity="1"/>
87 <elem name ="height" type="float32" multiplicity="1">
88 <tag name="unit" value="meters"/>
89 <comment>Height of the antenna from the CellLocInfo altitude.</comment>
90 </elem>
91 <elem name ="direction" type="float32" multiplicity="1">
92 <tag name="unit" value="degrees"/>
93 <comment>angle from north to center of arc; aka orientation. 0 &lt;= direction &lt; 360.</comment>
94 </elem>
95 <elem name ="tilt" type="float32" multiplicity="1">
96 <tag name="unit" value="degrees"/>
97 <comment>Vertical tilt from horizon.</comment>
98 </elem>
99 <elem name="opening" type="float32" multiplicity="1">
100 <tag name="unit" value="degrees"/>
101 <comment>Coverage angle of the antenna face; half on either side of direction. 0 &lt; opening &lt;= 360.</comment>
102 </elem>
103 <elem name="vopening" type="float32" multiplicity="1">
104 <tag name="unit" value="degrees"/>
105 <comment>Vertical coverage angle of the antenna face; half on either side of tilt 0 &lt; opening &lt;= 360.</comment>
106 </elem>
107 <elem name="radius" type="uint32" multiplicity="1">
108 <tag name="unit" value="meters"/>
109 <comment>Maximum antenna radius; distance the cell is usable at TxPower.
110 aka: MAR, SectorRadius
111 </comment>
112 </elem>
113 <elem name="TxPower" type="float64" multiplicity="1">
114 <tag name="unit" value="dBm"/>
115 <comment>Transmit power.</comment>
116 </elem>
117 <elem name="frequency" type="float64" multiplicity="1">
118 <tag name="unit" value="Hz"/>
119 <comment>Radio frequency of the transimitted signal</comment>
120 </elem>
121 <elem name="RTTCalib" type="float32" multiplicity="1">
122 <tag name="unit" value="meter"/>
123 <comment>RTT Calibration is the survey result of the average RTT error of the cell in meters. Set to zero when not available</comment>
124 </elem>
125 <elem name="RTTCalibUncert" type="float32" multiplicity="1">
126 <tag name="unit" value="meter"/>
127 <comment>standard deviation of the RTTCalib. set to zero if not available</comment>
128 </elem>
129 </struct>
130
131 <struct name="CellLocInfo" pack="true">
132 <comment>Geometric specification matches HPE.Spheroid</comment>
133 <comment>Provides the Cell tower location estimate @ 68% confidence</comment>
134 <elem name="lat" type="float64" multiplicity="1">
135 <tag name="unit" value="WGS84"/>
136 </elem>
137 <elem name="lon" type="float64" multiplicity="1">
138 <tag name="unit" value="WGS84"/>
139 </elem>
140 <elem name="alt" type="float64" multiplicity="1">
141 <tag name="unit" value="WGS84"/>
142 </elem>
143 <elem name="radius" type="float32" multiplicity="1">
144 <tag name="unit" value="meters"/>
145 <comment>Horizontal uncertainty of cell-site position at 68% confidence. 0 &lt;= hunc </comment>
146 </elem>
147 <elem name="vert" type="float32" multiplicity="1">
148 <tag name="unit" value="meters"/>
149 <comment>Vertical uncertainty of cell-site position at 68% confidence. 0 &lt;= vunc</comment>
150 </elem>
151
152 </struct>
153
154 <struct name="CellAntReferenceData" type="HPE.ReferenceData" pack="true" rttkey="HPE.RefDataFormat.CELLULAR">
155 <comment>
156 Data provdes a complete set of information for a particular antenna typically associated with one or more observations.
157 The default RefDataFormat is CELLULAR.
158 </comment>
159 <elem name ="cid" type="CellId" multiplicity="1"/>
160 <elem name ="antenna" type="AntennaSpec" multiplicity="1"/>
161 <elem name ="location" type="CellLocInfo" multiplicity="1"/>
162 </struct>
163
164 <!-- Observation Data types-->
165 <struct name="MSISDNObservation" type="Observation" pack="true" rttkey="HPE.ObservationType.MSISDN">
166 <comment>
167 MSISDN only observation. Observation must comply with E.164 standard in section 6.2.1
168 (https://www.itu.int/rec/T-REC-E.164-201011-I/en).
169 </comment>
170
171 <elem name ="cc" type="uint16" multiplicity="1" default="1">
172 <tag name="unit" value="1 to 3 digits"/>
173 <comment>
174 Country Code must have one (1) to three (3) digits.</comment>
175 </elem>
176
177 <elem name ="nsn" type="uint64" multiplicity="1">
178 <tag name="unit" value="digits as a regular number"/>
179 <comment>
180 NSNs can have up to 12 digits.
181 </comment>
182 </elem>
183 </struct>
184
185 <struct name="CellularObservation" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.CELLID">
186 <comment>CellID only observation.</comment>
187 <comment>Also, base type for all cellular measurements.</comment>
188 <elem name ="cid" type="CellId" multiplicity="1"/>
189 </struct>
190
191 <!-- 2G Observations -->
192 <struct name="TimeAdvance" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.GSM_TA">
193 <comment>TimeAdvanceInfo is a structure which defines the Time Advance measurements of a base station.</comment>
194 <elem name ="ta" type="uint16" multiplicity="1">
195 <tag name="unit" value="bit period = 48/13 micro-second"/>
196 <comment>Range 0-255, values over 63 correspond to the access delay measured by the BTS.</comment>
197 <comment>Unit: 1 bits period = 48/13 micro-second</comment>
198 </elem>
199 </struct>
200
201 <struct name="NMRInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.GSM_NMR">
202 <comment>
203 NMRInfo is a structure that defines important elements
204 in the network measurement report in GSM network.
205 </comment>
206 <elem name ="arfcn" type="uint16" multiplicity="1">
207 <comment>Absolute RF channel number. Range 0-1023.</comment>
208 </elem>
209 <elem name ="bsic" type="uint16" multiplicity="1">
210 <comment>Bsic Station Identity Code GSM 03.03. Range 0-63.</comment>
211 </elem>
212 <elem name ="rxlevel" type="uint16" multiplicity="1">
213 <comment>Corresponds according to the mapping defined in TS. GSM 05.08 to the received signal
214 strength on carrier N. N is the index to the frequency
215 in the sorted list of frequencies defined in the
216 EXTENDED MEASUREMENT ORDER message. Range 0-63.
217 </comment>
218 </elem>
219 </struct>
220
221
222 <!-- 3G Observation data types.-->
223 <struct name="RttInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.RTT_3G">
224 <comment>RTTInfo is a structure which defines the round trip time measured results in 3G network.</comment>
225 <elem name ="tamode" type="TimeAdvMode" multiplicity="1">
226 <comment>Measurement mode of the Roud Trip Time. Currently the RTT structure is only valid for FDD</comment>
227 <comment>Only Type1 and Type2 in TimeAdvMode are valid in RTT structure, need to ignore SUPL, RAW, UE</comment>
228 </elem>
229 <elem name ="rxtxtime" type="uint16" multiplicity="1">
230 <comment>
231 RxTxTime depends on duplex mode.
232 TDD: 0-8191
233 FDD: 768..1280
234 </comment>
235 </elem>
236 <elem name ="quality" type="uint8" multiplicity="1">
237 <comment>Quality of the UE Rx-Tx time difference measurement.</comment>
238 </elem>
239 <elem name ="rtt" type="uint16" multiplicity="1">
240 <comment>Round Trip Time measurement. Range = 0-32766</comment>
241 </elem>
242 <elem name ="exrtt" type="uint32" multiplicity="1">
243 <comment>Extended Round Trip Time continuation of intervals. 32767..103041</comment>
244 </elem>
245 </struct>
246
247 <struct name="MeasuredResultInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.MR_3G">
248 <comment>3G MeasuredResultInfo is a structure which defines the measured result.</comment>
249 <elem name ="dupmode" type="DuplexMode" multiplicity="1">
250 <comment>Duplex mode of the cell.</comment>
251 </elem>
252 <elem name ="cpichRSCP" type="uint8" multiplicity="1">
253 <comment>Range 0 to 63</comment>
254 </elem>
255 <elem name ="cpichEcNO" type="uint8" multiplicity="1">
256 <comment>Range 0 to 63</comment>
257 </elem>
258 <elem name ="pathloss" type="uint8" multiplicity="1">
259 <comment>Range 0 to 127</comment>
260 </elem>
261 <elem name ="deltaRSCP" type="int8" multiplicity="1">
262 <comment>Range (-5) to (-1)</comment>
263 </elem>
264 </struct>
265
266 <!-- 4G Datatypes -->
267 <struct name="LteTimeAdvanceInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.LTE_TA">
268 <comment>LTE timing advance information typically provided by the serving cell.</comment>
269 <elem name ="tamode" type="TimeAdvMode" multiplicity="1">
270 <comment>Measurement mode of the Time Advance.</comment>
271 </elem>
272 <elem name ="ta" type="uint16" multiplicity="1">
273 <comment>Timing Advance, range: (0...7690) (as per 3GPP 36.321).</comment>
274 </elem>
275 <elem name ="aoa" type="uint16" multiplicity="1">
276 <comment>Angle of Arrival</comment>
277 </elem>
278 <elem name ="uerxtx" type="uint16" multiplicity="1">
279 <comment>RxTx time measured from User Entity. Range(0...4095)</comment>
280 </elem>
281 </struct>
282
283 <struct name="LteRssiInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.LTE_RSSI">
284 <comment>
285 LTERSSIInfo is a 4G LTE structure which defines the signal RSSI information.
286 </comment>
287 <elem name ="rsrp" type="uint8" multiplicity="1">
288 <tag name="unit" value="dBm"/>
289 <comment>Reference signal received power</comment>
290 </elem>
291 <elem name ="rsrq" type="uint8" multiplicity="1">
292 <tag name="unit" value="dB"/>
293 <comment>Reference signal received quality</comment>
294 </elem>
295 <elem name ="nprb" type="uint8" multiplicity="1">
296 <tag name="unit" value="dimensionless"/>
297 <comment>Number of channels used to calculate rsrp</comment>
298 </elem>
299 </struct>
300
301 <struct name="GenericInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.CELLULAR_GENERIC">
302 <comment>Observation type specifies a common cellular observation in generic units. Sometimes observations are translated into a simpler format for transport.</comment>
303 <elem name ="rss" type="float32" multiplicity="1">
304 <comment>Received Signal Strength (RSS), the value is 0 if not defined. The units are -dBm.</comment>
305 </elem>
306 <elem name ="rssUncert" type="uint8" multiplicity="1">
307 <comment>RSS standard deviation uncertainty in dB units. the value is 0 if not defined or unknown.</comment>
308 </elem>
309 <elem name ="taLowPart" type="uint16" multiplicity="1">
310 <comment>Low part of timing advance measurement. Range is 0 to 49,999 nsecs (max 15km). Value is 0 if not defined</comment>
311 </elem>
312 <elem name ="taHighPart" type="uint8" multiplicity="1">
313 <comment>High part of timing advance measurement. Range is 0 to 255 in units of 50 usec (max. 2550 usec or 3,825 km). Value is 0 if not used.</comment>
314 </elem>
315 <elem name ="taUncert" type="uint16" multiplicity="1">
316 <comment>Timing advance standard deviation uncertainty in nanosecond units. The value is 0 if not defined.</comment>
317 </elem>
318 <elem name ="service" type="bool" multiplicity="1">
319 <comment>Serving Cell indicator. If true, the measurement is from the serving cell, false if from a neighboring cell. If not defined set to false.</comment>
320 </elem>
321 </struct>
322
323 <!--
324 <struct name="" type="CellularObservation" pack="true">
325 <comment></comment>
326 <elem name ="" type="uint16" multiplicity="1">
327 <comment></comment>
328 </elem>
329 <elem name ="" type="uint16" multiplicity="1">
330 <comment></comment>
331 </elem>
332 </struct>
333 -->
334 </namespace>
335 </specification>
HPE/V1.2/HpeCore.xid.xml 0 → 100644
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 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>
HPE/V1.2/HpeGnss.xid.xml 0 → 100644
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 XtensibleInterfaceDefinition.xsd"
7 identity="HpeGnss.xid.xml">
8 <title>HPE GNSS Data Definition</title>
9 <comment>File contains data definitions for GNSS HPE location related datatypes.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
13
14 <namespace name="HPE.Gnss">
15 <using namespace="Tensor"/>
16 <using namespace="HPE"/>
17
18
19 <enum name="Constellation" type="uint8" default="unspecified">
20 <comment>
21 Specifies the specific GNSS constellation. These are oreable values to
22 be used as flags.
23 </comment>
24 <literal name="unspecified" value="0x00"/>
25 <literal name="GPS" value="0x01"/>
26 <literal name="GLONASS" value="0x02"/>
27 <literal name="GALILEO" value="0x03"/>
28 <literal name="BEIDOU" value="0x04"/>
29 <literal name="QZSS" value="0x05"/>
30 <literal name="MBS_FLAG" value="0x20"/>
31 <literal name="RTLS_FLAG" value="0x40"/>
32 </enum>
33
34 <enum name="AssistanceData" type="uint8" default="unspecified">
35 <comment>
36 Enumeration literals defining the types of assistance data supported.
37 </comment>
38 <literal name="unspecified" value="0x00"/>
39 <literal name="GpsAlmanac" value="0x01"/>
40 <literal name="GpsEphemeris" value="0x02"/>
41 <literal name="GpsUtcParameters" value="0x03"/>
42 <literal name="GpsIonosphericCorrection" value="0x04"/>
43 <literal name="AcquisitionAssistance" value="0x05"/>
44 </enum>
45
46 <!-- Satellite ID -->
47 <struct name="SatelliteId" pack="true">
48 <comment>Satellite identifier specifies constellation and satellite identifier.</comment>
49 <elem name ="constellation" type="Constellation" multiplicity="1"/>
50 <elem name ="id" type="uint8" multiplicity="1">
51 <comment>Satellite identifier: range 0 to 63.</comment>
52 </elem>
53 </struct>
54
55
56 <!--
57 *******************************************************
58 Almanac Data Structures
59 *******************************************************
60 -->
61
62 <!-- Almanac -->
63 <struct name="Almanac" pack="true">
64 <comment>Generalized Almanac orbit in GPS reference frame. One record per satellite.</comment>
65
66 <elem name ="id" type="uint8" multiplicity="1">
67 <comment>Satellite identifier, valid range is 0-63.</comment>
68 </elem>
69 <elem name ="toa" type="uint8" multiplicity="1">
70 <comment>Time of almanac in seconds. Value is integer encoded with scale factor 2^12</comment>
71 <tag name="unit" value="2^12 seconds"/>
72 </elem>
73 <elem name ="deltai0" type="int16" multiplicity="1">
74 <comment>Relative inclination to i0 = 0.3 semi-circles at reference time. Value is integer encoded with scale factor 2^-19</comment>
75 <tag name="unit" value="2^-19 semi-circles"/>
76 </elem>
77 <elem name ="OmegaDot" type="int16" multiplicity="1">
78 <comment>Rate of Right Ascension in semi-circles/sec. Value is integer encoded with scale factor 2^-38</comment>
79 <tag name="unit" value="2^-38 seconds"/>
80 </elem>
81 <elem name ="af0" type="int16" multiplicity="1">
82 <comment>SV clock bias in seconds. Value is integer encoded with scale factor 2^-20</comment>
83 <tag name="unit" value="2^-20 seconds"/>
84 </elem>
85 <elem name ="af1" type="int16" multiplicity="1">
86 <comment>SV clock bias rate in seconds/second. Value is integer encoded with scale factor 2^-38</comment>
87 <tag name="unit" value="2^-38 seconds"/>
88 </elem>
89 <elem name ="eccentricity" type="uint16" multiplicity="1">
90 <comment>Eccentricity of the orbit. Value is integer encoded with scale factor 2^-21</comment>
91 <tag name="unit" value="2^-21"/>
92 </elem>
93 <elem name ="sqrtA" type="uint24" multiplicity="1">
94 <comment>Square root of Mean anomaly. Value is integer encoded with scale factor 2^-11</comment>
95 <tag name="unit" value="2^-11 meters^1/2"/>
96 </elem>
97 <elem name ="Omega0" type="int24" multiplicity="1">
98 <comment>Longitude of ascending node in semi-circles. Value is integer encoded with scale factor 2^-23</comment>
99 <tag name="unit" value="2^-23 semi-circles"/>
100 </elem>
101 <elem name ="omega" type="int24" multiplicity="1">
102 <comment>omega argument of perigee in semi-circles. Value is integer encoded with scale factor 2^-23</comment>
103 <tag name="unit" value="2^-23 semi-circles"/>
104 </elem>
105 <elem name ="M0" type="int24" multiplicity="1">
106 <comment>Mean anomaly at reference time in semi-circles. Value is integer encoded with scale factor 2^-23</comment>
107 <tag name="unit" value="2^-23 semi-circles"/>
108 </elem>
109 <elem name ="SvHealth" type="uint8" multiplicity="1">
110 <comment>Satellite health flags.</comment>
111 </elem>
112 </struct>
113
114
115 <!-- Ephemeris -->
116 <struct name="Ephemeris" pack="true">
117 <comment>Generalized GPS 15 element precision Keplerian orbit in GPS reference frame. One record per satellite.</comment>
118 <elem name ="id" type="uint8" multiplicity="1">
119 <comment>Satellite identifier, valid range is 0-63.</comment>
120 </elem>
121 <elem name ="toe" type="uint16" multiplicity="1">
122 <comment>Time of Ephemeris. Value is integer encoded with scale factor 2^4</comment>
123 <tag name="unit" value="2^4 seconds"/>
124 </elem>
125 <elem name ="iode" type="uint8" multiplicity="1">
126 <comment>Issue of data Ephemeris. The value for comparison with the 8 LSBs of the IODC</comment>
127 </elem>
128 <elem name ="eccentricity" type="uint32" multiplicity="1">
129 <comment>Eccentricity of the orbit. Value is integer encoded with scale factor 2^-33</comment>
130 <tag name="unit" value="2^-33"/>
131 </elem>
132 <elem name ="i0" type="int32" multiplicity="1">
133 <comment>Inclination at reference time in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
134 <tag name="unit" value="2^-31 semi-circles"/>
135 </elem>
136 <elem name ="OmegaDot" type="int24" multiplicity="1">
137 <comment>Rate of Right Ascension in semi-circles/sec. Value is integer encoded with scale factor 2^-43</comment>
138 <tag name="unit" value="2^-43 seconds"/>
139 </elem>
140 <elem name ="sqrtA" type="uint32" multiplicity="1">
141 <comment>Square root of Mean anomaly. Value is integer encoded with scale factor 2^-19</comment>
142 <tag name="unit" value="2^-19 meters^1/2"/>
143 </elem>
144 <elem name ="Omega0" type="int32" multiplicity="1">
145 <comment>Longitude of ascending node in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
146 <tag name="unit" value="2^-31 semi-circles"/>
147 </elem>
148 <elem name ="omega" type="int32" multiplicity="1">
149 <comment>omega argument of perigee in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
150 <tag name="unit" value="2^-31 semi-circles"/>
151 </elem>
152 <elem name ="M0" type="int32" multiplicity="1">
153 <comment>Mean anomaly at reference time in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
154 <tag name="unit" value="2^-31 semi-circles"/>
155 </elem>
156 <elem name ="deltan" type="int16" multiplicity="1">
157 <comment>Mean Motion Difference From Computed Value in semi-circles/sec. Value is integer encoded with scale factor 2^-43</comment>
158 <tag name="unit" value="2^-43 semi-circles"/>
159 </elem>
160 <elem name ="idot" type="int16" multiplicity="1">
161 <comment>Rate of Inclination in semi-circles/sec. Value is integer encoded with scale factor 2^-43</comment>
162 <tag name="unit" value="2^-43 semi-circles"/>
163 </elem>
164 <elem name ="Cis" type="int16" multiplicity="1">
165 <comment>Amp. Sin Correction of Inclination in radians. Value is integer encoded with scale factor 2^-29</comment>
166 <tag name="unit" value="2^-29 radians"/>
167 </elem>
168 <elem name ="Cic" type="int16" multiplicity="1">
169 <comment>Amp. Cosine Correction of Inclination in radians. Value is integer encoded with scale factor 2^-29</comment>
170 <tag name="unit" value="2^-29 radians"/>
171 </elem>
172 <elem name ="Crs" type="int16" multiplicity="1">
173 <comment>Amp. Sin Correction of orbit radius in meters. Value is integer encoded with scale factor 2^-5</comment>
174 <tag name="unit" value="2^-5 meters"/>
175 </elem>
176 <elem name ="Crc" type="int16" multiplicity="1">
177 <comment>Amp. Cosine Correction of orbit radius in meters. Value is integer encoded with scale factor 2^-5</comment>
178 <tag name="unit" value="2^-5 meters"/>
179 </elem>
180 <elem name ="Cus" type="int16" multiplicity="1">
181 <comment>Amp. Sin Correction of Latitude in radians. Value is integer encoded with scale factor 2^-29</comment>
182 <tag name="unit" value="2^-29 radians"/>
183 </elem>
184 <elem name ="Cuc" type="int16" multiplicity="1">
185 <comment>Amp. Cosine Correction of Latitude in radians. Value is integer encoded with scale factor 2^-29</comment>
186 <tag name="unit" value="2^-29 radians"/>
187 </elem>
188 <elem name ="toc" type="uint16" multiplicity="1">
189 <comment>Time of clock. Value is integer encoded with scale factor 2^4</comment>
190 <tag name="unit" value="2^4 seconds"/>
191 </elem>
192 <elem name ="iodc" type="uint16" multiplicity="1">
193 <comment>Issue of data Clock. </comment>
194 <tag name="unit" value="discretes"/>
195 </elem>
196 <elem name ="af0" type="int24" multiplicity="1">
197 <comment>SV clock bias in seconds. Value is integer encoded with scale factor 2^-31.</comment>
198 <tag name="unit" value="2^-31 seconds"/>
199 </elem>
200 <elem name ="af1" type="int16" multiplicity="1">
201 <comment>SV clock bias rate in seconds/second. Value is integer encoded with scale factor 2^-43.</comment>
202 <tag name="unit" value="2^-43 seconds"/>
203 </elem>
204 <elem name ="af2" type="int8" multiplicity="1">
205 <comment>SV clock bias rate in seconds/second^2. Value is integer encoded with scale factor 2^-55.</comment>
206 <tag name="unit" value="2^-55 seconds"/>
207 </elem>
208 <elem name ="TGD" type="int8" multiplicity="1">
209 <comment>L1-L2 group delay differential in seconds. Value is integer encoded with a scale factor 2^-31.</comment>
210 <tag name="unit" value="2^-31 seconds"/>
211 </elem>
212 <elem name ="SvHealth" type="uint8" multiplicity="1">
213 <comment>Satellite health flags.</comment>
214 </elem>
215 </struct>
216
217 <!-- UTC Parameters -->
218 <struct name="UtcParameters" pack="true">
219 <comment>Conversion data between GPS time and UTC.</comment>
220 <elem name ="a0" type="int32" multiplicity="1">
221 <comment>Constant term of the polynomial in seconds. Value is integer encoded with scale factor 2^-30.</comment>
222 <tag name="unit" value="2^-30 seconds"/>
223 </elem>
224 <elem name ="a1" type="int24" multiplicity="1">
225 <comment>First order term of the polynomial in seconds/second. Value is integer encoded with scale factor 2^-50.</comment>
226 <tag name="unit" value="2^-50 seconds"/>
227 </elem>
228 <elem name ="DeltaTls" type="int8" multiplicity="1">
229 <comment>Delta time due to Leap Seconds. </comment>
230 <tag name="unit" value="seconds"/>
231 </elem>
232 <elem name ="tot" type="uint8" multiplicity="1">
233 <comment>Time of Utc Data. Value is integer encoded with scale factor 2^12</comment>
234 <tag name="unit" value="2^12 seconds"/>
235 </elem>
236 <elem name ="WNt" type="uint8" multiplicity="1">
237 <comment>UTC Reference Week Number in weeks</comment>
238 <tag name="unit" value="weeks"/>
239 </elem>
240 <elem name ="WNlsf" type="uint8" multiplicity="1">
241 <comment>Week Number LeapSecond Future in weeks</comment>
242 <tag name="unit" value="weeks"/>
243 </elem>
244 <elem name ="DN" type="uint8" multiplicity="1">
245 <comment>Day number in days</comment>
246 <tag name="unit" value="days"/>
247 </elem>
248 <elem name ="DeltaTlsf" type="int8" multiplicity="1">
249 <comment>Delta time due to Leap Seconds Future</comment>
250 <tag name="unit" value="seconds"/>
251 </elem>
252 </struct>
253
254 <!-- Ionosperhic Correction -->
255 <struct name="IonosphericCorrection" pack="true">
256 <comment>Klobuchar Ionospheric Correction model parameters. See ICD200 para. 20.3.3.5.2.5</comment>
257 <elem name ="a0" type="int8" multiplicity="1">
258 <comment>alpha0 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-30.</comment>
259 <tag name="unit" value="2^-30 seconds"/>
260 </elem>
261 <elem name ="a1" type="int8" multiplicity="1">
262 <comment>alpha1 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-27.</comment>
263 <tag name="unit" value="2^-27 seconds"/>
264 </elem>
265 <elem name ="a2" type="int8" multiplicity="1">
266 <comment>alpha2 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-24.</comment>
267 <tag name="unit" value="2^-24 seconds"/>
268 </elem>
269 <elem name ="a3" type="int8" multiplicity="1">
270 <comment>alpha3 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-24.</comment>
271 <tag name="unit" value="2^-24 seconds"/>
272 </elem>
273 <elem name ="b0" type="int8" multiplicity="1">
274 <comment>beta0 term of the polynomial in seconds. Value is integer encoded with scale factor 2^11.</comment>
275 <tag name="unit" value="2^11 seconds"/>
276 </elem>
277 <elem name ="b1" type="int8" multiplicity="1">
278 <comment>beta1 term of the polynomial in seconds. Value is integer encoded with scale factor 2^14.</comment>
279 <tag name="unit" value="2^14 seconds"/>
280 </elem>
281 <elem name ="b2" type="int8" multiplicity="1">
282 <comment>beta2 term of the polynomial in seconds. Value is integer encoded with scale factor 2^16.</comment>
283 <tag name="unit" value="2^16 seconds"/>
284 </elem>
285 <elem name ="b3" type="int8" multiplicity="1">
286 <comment>beta3 term of the polynomial in seconds. Value is integer encoded with scale factor 2^16.</comment>
287 <tag name="unit" value="2^16 seconds"/>
288 </elem>
289 </struct>
290
291 <!-- ConstellationData -->
292 <struct name="ConstellationData">
293 <comment>Grouping of constellation data. Reference frame is GPS.</comment>
294 <comment>Will be extended to include other constellation data.</comment>
295
296 <!-- this has been embedded in a device, Only add. -->
297 <array name="AlmanacArray" type="Almanac"/>
298 <array name="EphemerisArray" type="Ephemeris" />
299
300 <elem name ="constellation" type="Constellation" multiplicity="1" ord="64"/>
301 <elem name ="week" type="uint16" multiplicity="1" ord="65"/>
302 <elem name ="almanacs" type="AlmanacArray" multiplicity="0..1" ord="66"/>
303 <!-- the following are are decoded in C decoding API yet -->
304 <elem name ="ephemeris" type="EphemerisArray" multiplicity="0..1" ord="67"/>
305 <elem name ="utc" type="UtcParameters" multiplicity="0..1" ord="68"/>
306 <elem name ="iono" type="IonosphericCorrection" multiplicity="0..1" ord="69" />
307 </struct>
308
309 <struct name="ConstellationSet">
310 <comment>Set of ConstellationData</comment>
311 <elem name ="constellationData" type="ConstellationData" multiplicity="0..*" ord="64"/>
312 </struct>
313
314
315
316
317
318 <!--
319 *******************************************************
320 Acquisistion Assistance Data
321 *******************************************************
322 -->
323
324 <!-- AcqAssistElem -->
325 <struct name="AcqAssistElem" pack="true">
326 <comment>Acquisistion assistance for a single satellite.</comment>
327 <elem name ="id" type="SatelliteId" multiplicity="1"/>
328
329 <elem name ="doppler0" type="int16" multiplicity="1">
330 <comment>Doppler 0th order term. Value is integer encoded with scale factor 2^-21</comment>
331 <tag name="unit" value="2^-21"/>
332 </elem>
333 <elem name ="doppler1" type="int16" multiplicity="1">
334 <comment>doppler first order term in Hz/sec. Value is integer encoded with scale factor 2^12</comment>
335 <tag name="unit" value="2^12 seconds"/>
336 </elem>
337 <elem name ="codephase" type="uint16" multiplicity="1">
338 <comment>code phase 0-1022 in 1/8 code chips. Value is integer encoded with scale factor 2^-3</comment>
339 <tag name="unit" value="2^-3 code chips"/>
340 </elem>
341 <elem name ="CodeCount" type="uint16" multiplicity="1">
342 <comment>Integer count of whole code epochs including the GPS bit number range 0 - 80 counts. </comment>
343 <tag name="unit" value="code epochs"/>
344 </elem>
345 <elem name ="searchWindow" type="uint8" multiplicity="1">
346 <comment>Rate of right ascension in semi-circles/sec. Value is integer encoded with scale factor 2^-38</comment>
347 <tag name="unit" value="2^-38 seconds"/>
348 </elem>
349 <elem name ="azimuth" type="int8" multiplicity="1">
350 <comment>Azimuth in degrees. Value is a scaled integer encoded with scale factor 2.5</comment>
351 <tag name="unit" value="2.5 degrees"/>
352 </elem>
353 <elem name ="elevation" type="int8" multiplicity="1">
354 <comment>Elevation in degrees.</comment>
355 <tag name="unit" value="degrees"/>
356 </elem>
357 </struct>
358
359 <!-- AcqAssistSet -->
360 <struct name="AcqAssistSet">
361 <comment>A set of doppler acquisition assistance elements</comment>
362 <elem name="data" type="AcqAssistElem" multiplicity="1..*" polymorphic="false"/>
363 </struct>
364
365
366 <!--
367 *******************************************************
368 GNSS Measurement data
369 *******************************************************
370 -->
371
372 <!-- CodephaseMeasurementMin-->
373 <struct name="CodephaseMeasurementMin" pack="true">
374 <comment>
375 Measurement of a single satellite codephase. This is a more compact version without RMS error and multipath indicator.
376 These will be encoded in cno in a future version.
377 </comment>
378 <elem name ="id" type="uint8" multiplicity="1">
379 <comment>
380 Satellite identifier: 0 - 63. If set to 255 (0xff), the measurement is considered invalid and ignored.
381 This marks the end of measurements in fixed array sets. See GpsCodePhaseObsMin6 for an example.
382 </comment>
383 </elem>
384 <elem name ="cn0" type="uint8" multiplicity="1">
385 <comment>Carrier noise ratio.</comment>
386 <tag name="unit" value="ratio"/>
387 </elem>
388 <elem name ="doppler" type="int16" multiplicity="1">
389 <comment>Measured Doppler shift in Hz. Value is integer encoded with scale factor 0.2</comment>
390 <tag name="unit" value="0.2 Hz"/>
391 </elem>
392 <elem name ="codephase" type="uint24" multiplicity="1">
393 <comment>Whole and fractional parts of code phase. Value is integer encoded with scale factor 2^-10</comment>
394 <tag name="unit" value="2^-10 code chips"/>
395 </elem>
396 </struct>
397
398 <!-- CodephaseMeasurement -->
399 <struct name="CodephaseMeasurement" type="CodephaseMeasurementMin" pack="true">
400 <comment>Measurement of a single satellite codephase including mpathIndicator and rmsErr.</comment>
401 <elem name ="mpathIndicator" type="uint8" multiplicity="1">
402 <comment>Multipath indicator. Default value is 0.</comment>
403 </elem>
404 <elem name ="rmsErr" type="uint8" multiplicity="1">
405 <comment>Pseudo range RMS Error value indexed 0..63, default is 0</comment>
406 <tag name="unit" value="2.5 degrees"/>
407 </elem>
408 </struct>
409
410 <!-- Observation Data types-->
411 <struct name="GpsCodePhaseObs8" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.GPS_CODEPHASE_8">
412 <comment>
413 Eight standard GPS code phase measurements: 9 + (9 x 8) = 81 bytes. Mark
414 the end of the unused or invalid measurements with id=255 (0xFF). They will be ignored.
415 </comment>
416 <array name ="CodephaseMeasurement8" type="CodephaseMeasurement" size="8"/>
417 <elem name ="measurements" type="CodephaseMeasurement8" multiplicity="1">
418 </elem>
419 </struct>
420
421 <struct name="GpsCodePhaseObsMin6" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.GPS_CODEPHASE_MIN6">
422 <comment>
423 Six minimum size GPS code phase measurements: 9 + (7 x 6) = 51 bytes.
424 Mark the end of the unused or invalid measurements with id=255 (0xFF). They will be ignored.
425 </comment>
426 <array name ="CodephaseMeasurementMin6" type="CodephaseMeasurementMin" size="6"/>
427 <elem name ="measurements" type="CodephaseMeasurementMin6" multiplicity="1">
428 </elem>
429 </struct>
430
431 <struct name="GpsCodePhaseObsMin8" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.GPS_CODEPHASE_MIN8">
432 <comment>
433 Eight minimum size GPS code phase measurements: 9 + (7 x 8) = 65 bytes.
434 Mark the end of the unused or invalid measurements with id=255 (0xFF). They will be ignored.
435 </comment>
436 <array name ="CodephaseMeasurementMin8" type="CodephaseMeasurementMin" size="8"/>
437 <elem name ="measurements" type="CodephaseMeasurementMin8" multiplicity="1">
438 </elem>
439 </struct>
440
441 <struct name="PseudorangeObservation" type="ObservationEpoch" rttkey="HPE.ObservationType.GNSS_PSEUDORANGE">
442 <comment>GNSS observation data in generic format suited for variable sized input.</comment>
443 <elem name ="id" type="SatelliteId" multiplicity="1"/>
444
445 <elem name ="prr" type="float64" multiplicity="1">
446 <comment>Pseudorange rate measurement in meters per second.</comment>
447 <tag name="unit" value="meters per second"/>
448 </elem>
449 <elem name ="pr" type="float64" multiplicity="1">
450 <comment>Pseudorange measurement in meters.</comment>
451 <tag name="unit" value="meters"/>
452 </elem>
453 <elem name ="prrUncert" type="float32" multiplicity="1">
454 <comment>Pseudorange rate measurement uncertainty in meters per second. This is the one standard deviation confidence (68%) uncertainty.</comment>
455 <tag name="unit" value="meters per second"/>
456 </elem>
457 <elem name ="prUncert" type="float32" multiplicity="1">
458 <comment>Pseudorange measurement uncertainty in meters. This is the one standard deviation confidence (68%) uncertainty.</comment>
459 <tag name="unit" value="meters"/>
460 </elem>
461 <elem name ="cn0" type="uint8" multiplicity="1">
462 <comment>Carrier noise ratio.</comment>
463 <tag name="unit" value="ratio"/>
464 </elem>
465 <elem name ="mpathIndicator" type="uint8" multiplicity="1">
466 <comment>Multipath indicator. Default value is 0.</comment>
467 </elem>
468 </struct>
469
470 </namespace>
471 </specification>
HPE/V1.2/HpeUsage.xid.xml 0 → 100644
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 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.2/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>
HPE/V1.2/HpeWiFi.xid.xml 0 → 100644
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 XtensibleInterfaceDefinition.xsd"
7 identity="HpeWiFi.xid.xml">
8 <title>HPE Wi-Fi Data Definition</title>
9 <comment>File contains data definitions observation datatypes.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
13
14 <namespace name="HPE.WiFi">
15 <using namespace="Tensor"/>
16 <using namespace="HPE"/>
17
18 <array name="SSID" type="int8" size="33">
19 <comment>ssid string of wifi access point</comment>
20 </array>
21
22 <struct name="WiFiRssi" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.WIFI_RSS">
23 <comment>Wi-Fi RSSI observation</comment>
24 <elem name ="rssi" type="uint8" multiplicity="1">
25 <tag name="unit" value="-dBm"/>
26 <comment>RSS signal measured value(used as negative). </comment>
27 </elem>
28 <elem name ="macaddr" type="mac48" multiplicity="1">
29 <comment>Access point mac address</comment>
30 </elem>
31 </struct>
32
33 <struct name="WiFiRssiExt" type="WiFiRssi" rttkey="HPE.ObservationType.WIFI_RSS_EXT">
34 <comment>Extension of the WifiRssi data structure</comment>
35 <elem name="ssid" type="SSID" multiplicity="1">
36 <comment>ssid of the wifi access point</comment>
37 </elem>
38 <elem name="freq" type="float32" multiplicity="1">
39 <comment>Radio frequency of the Wifi Access point</comment>
40 </elem>
41 <elem name="uncert" type="float32" multiplicity="1">
42 <comment> uncertainty of the rssi measurements</comment>
43 </elem>
44 </struct>
45
46 </namespace>
47 </specification>
ILP/V1.2/ApiBase.xid.xml 0 → 100644
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 XtensibleInterfaceDefinition.xsd"
7 identity="ApiBase.xid.xml">
8
9 <title>ILP Services API Base Definitions</title>
10 <comment>
11 This document defines the common types API service interface for the ILP and Simultaneous Localization
12 and Mapping (SLAM) services definitions. The service provides access to ILP and SLAM technologies for position
13 calculation for devices and services communicating via standard
14 IP based protocols. The API currently supports XMF and JSON wire formats.
15 </comment>
16
17 <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
18 <import ref="https://xid.location.studio/Tensor/V1.0.0/Common.xid.xml" local="Definitions.xid.xml" />
19 <import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
20 <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
21 <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
22 <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
23
24 <namespace name="ILP">
25 <using namespace="HPE"/>
26 <using namespace="Tensor"/>
27
28
29 <!--
30 *******************************
31 *InputBase Type Definition
32 *******************************
33 -->
34 <struct name="InputBase" >
35 <comment>Base input fields for operations supporting asynchronous transaction information.</comment>
36 <elem name="directive" multiplicity="0..*" type="NameValue">
37 <comment>
38 A set of directives to influence processing.
39 </comment>
40 </elem>
41
42 <elem name="devid" multiplicity="1" type="string">
43 <comment>
44 Required device identifier, that provides a consistent multi-transaction identifier
45 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
46 in the system logs, providing traceability. Identifier should be unique.
47 </comment>
48 </elem>
49
50 <elem name="etid" multiplicity="0..1" type="string">
51 <comment>
52 Optional external transaction identifier for the caller to uniquely identify and track
53 the transaction and corresponding results. These identifiers will appear in the
54 ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
55 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
56 the ILP system.
57 </comment>
58 </elem>
59 </struct>
60
61
62 <!--
63 *******************************
64 *OutputBase Type Definition
65 *******************************
66 -->
67 <struct name="OutputBase" >
68 <comment>Base output fields common to operations supporting asynchronous returning transaction information.</comment>
69 <elem name="devid" multiplicity="0..1" type="string">
70 <comment>
71 Device identifier provided at operation input, provides a consistent identifier
72 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
73 in the system logs, providing traceability.
74 </comment>
75 </elem>
76
77 <elem name="etid" multiplicity="0..1" type="string">
78 <comment>
79 Optional external transaction identifier for the caller to uniquely identify and track
80 the transaction and corresponding results. These identifiers appear in the
81 ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
82 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
83 the ILP system.
84 </comment>
85
86 </elem>
87
88 <elem name="resultcode" type="ResultCode" multiplicity="1" >
89 <comment>Result of the operation.</comment>
90 </elem>
91
92 <elem name="errinfo" type="Tensor.string" multiplicity="0..1">
93 <comment>Error information if result was not success.</comment>
94 </elem>
95
96 </struct>
97
98 </namespace>
99 </specification>
ILP/V1.2/IlpApiBase.xid.xml 0 → 100644
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 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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
18 <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
19 <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
20 <import ref="https://xid.location.studio/HPE/V1.2/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>
ILP/V1.2/IlpAssistanceApi.xid.xml 0 → 100644
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 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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
18 <import ref="https://xid.location.studio/ILP/V1.2/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>
ILP/V1.2/IlpPositioningApi.xid.xml 0 → 100644
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 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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
18 <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
19 <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
20 <import ref="https://xid.location.studio/ILP/V1.2/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>
ILP/V1.2/IlpSubmissionApi.xid.xml 0 → 100644
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 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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
16 <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
17 <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
18 <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
19 <import ref="https://xid.location.studio/ILP/V1.2/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>
README.md
...@@ -5,9 +5,41 @@ This is a public repo containing published XID (Xtensible Interface Definition) ...@@ -5,9 +5,41 @@ This is a public repo containing published XID (Xtensible Interface Definition)
5 5
6 ---------- 6 ----------
7 7
8 ## State ##
9
10 * *In Process* means these are currently being edited
11 * *Stable* means they are not changing (but can have documentation changes)
12 * *Decrecated* means it is going away soon
13 * *Retired* means it is gone (no systems support the API)
14
15 ### In Process ###
16
17 * HPE/V1.2/*
18 * ILP/V1.2/*
19 * ILP/SLAM/V1.0.0_alpha/*
20
21 ### Stable ###
22
23 * schema/V1.0.0/*
24 * Tensor/V1.0.0/*
25 * HPE/V1.1.1/*
26 * HPE/CommonDefs/V1.1.1/*
27 * ILP/V1.1.1/*
28
29 ### Decrecated ###
30
31 N/A
32
33 ### Retired ###
34
35 N/A
36
37 ---
38 ---
39
8 ## Naming conventions ## 40 ## Naming conventions ##
9 41
10 Besides XID specs written in XML, there is a new concept of Concrete Interface Definitions (CID). These are complete specifications (no imports) that will have their own schema. XID and CID files can be written in XML, JSON, or XMF (if you are really the hardcore type person), XID CG should be able to input or output in these formats. Given that, the filename convention will be : 42 XID specs are written in XML, but there is a new concept of Concrete Interface Definitions (CID). These are complete, single-source, full-qualified specifications (no imports) that will have their own schema. XID and CID files can be written in XML, JSON, or XMF (if you are really the hardcore type person), XIDCG will be able to input or output in these formats. Given that, the filename conventions reflect this future :
11 43
12 **[filename].[xid|cid].[xml|json|xmf]** 44 **[filename].[xid|cid].[xml|json|xmf]**
13 45
...@@ -19,6 +51,11 @@ XSD Schemas for the XID/CID should be stored separately and versioned consistent ...@@ -19,6 +51,11 @@ XSD Schemas for the XID/CID should be stored separately and versioned consistent
19 51
20 **/schema/[version]/[specification].xsd** 52 **/schema/[version]/[specification].xsd**
21 53
54 ### [version] ###
55 The [version] specifier should be V{major}.{minor}; for historical reasons the original XIDs have V{major}.{minor}.{bug}
56 We have decided that once published, a structural bug fix is significant to an API and is therefore a {minor} revision ... hence the elimination of {bug}.
57 \<comment>, \<artifact>, \<tag> and other edits to XID/CID and schema files that do not affect the structural integrity of the API can be updated without changing the {major}.{minor} version.
58
22 ## Process ## 59 ## Process ##
23 60
24 Update access to the master branch will be limited. Updates and new XID specs must be added on branches and merged to master via pull requests. Updates to existing XID specification (other than typo and documentation updates), will require updating the version directory. 61 Update access to the master branch will be limited. Updates and new XID specs must be added on branches and merged to master via pull requests. Updates to existing XID specification (other than typo and documentation updates), will require updating the version directory.
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!