IlpPositioningApi.xid.xml
16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<?xml version="1.0" encoding="UTF-8" ?>
<specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
identity="IlpPositioningApi.xid.xml">
<title>ILP Hybrid Positioning Services</title>
<comment>
This document defines the positioning service interface for the IoT Location Platform (ILP).
The service provides hybrid position calculation for devices and services communicating
via standard IP based protocols. The API currently supports XMF and JSON wire formats.
</comment>
<import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
<import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
<import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
<import ref="https://xid.location.studio/ILP/V1.1.1/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" />
<namespace name="ILP">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!--
*******************************************************
ILP Positioning Calculation Data Types
*******************************************************
-->
<!-- CalculateInput structure -->
<struct name="CalculateInput" type ="IlpInputBase">
<comment>ILP.Positioning.Calculate input data structure.</comment>
<elem name="uuidSession" multiplicity="0..1" type="UUID">
<comment>
Optional session identifier. See CreateSession for creating valid
session identifiers. Transactions can be processed in the context of a session to provide
historical information and link calcuation in time.
</comment>
</elem>
<elem name="durSession" multiplicity="0..1" type="int32">
<comment>
Optional session duration. Default is 0 (not persisted). If specified,
the session created for this transaction will be stored for a maximum of 86400 seconds.
The uuidSession returned in the output, can be used in subsequent calls to Calculate to utilize
the persisted session data. Call ReleaseSession to release any persisted content once the session
is complete.
</comment>
</elem>
<elem name="dynamics" multiplicity="0..1" type="DynamicsProfile" default="0">
<comment>
Specifies the dymnamics of the device providing the data. If not specified, the default dynamics is undefined (0).
This parameter optimizes configuration of the estimator to constraint calculations based on the type
of motion. If session is specified, this value will be overridden.
</comment>
</elem>
<elem name="rankEstimate" multiplicity="0..1" type="EstimateRanking" default="3">
<comment>
Specifies the sort order of the estimates produced by the hybrid calculation. If not defined, the default value is to sort estimates
based on calculation order (0).
</comment>
</elem>
<elem name="confidence" multiplicity="0..1" type="float32" default="0.682689">
<comment>
Specifies the confidence level to report estimate error uncertainty, range between 0.0 and 1.0\n
Common values for confidence are:\n
\t 0.682689 (1 std. dev.)\n
\t 0.954499 (2 std. dev.)\n
\t 0.997300 (3 std. dev.)\n
If confidence is not specified, the default
value is 0.682689.
</comment>
</elem>
<elem name="maxEstimates" multiplicity="0..1" type="uint8" default="1">
<comment>
Specifies the maximum number of estimates (up to 255) to return in the calculation output.
If not specified 1 hybrid estimate is returned.
</comment>
</elem>
<elem name="typeShape" multiplicity="0..*" type="ShapeType">
<comment>
Specifies the preferred shape types to provide estimates in. The highest
ranking estimate will be returned in this specified shape types if supported.\n
If not specified, the set defaults to: Spheroid, Circle.
</comment>
</elem>
<elem name="directive" multiplicity="0..*" type="NameValue" ord="87">
<comment>
A set of directives to influence processing. Unknown directives are ignored.
</comment>
</elem>
<elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
<comment>
Specifies the position to initialize the state of the positioning engine.\n
At least one of observations or state is required,
otherwise there is insufficient data to process.
</comment>
</elem>
<elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
<comment>
Observation set encoding format. Observations may be passed to the service in
an encoding format different than that outer wire format.
By default wire protocol native format is assumed.
</comment>
</elem>
<elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
<comment>
Set of observation data encoded in the format specified by encObs.\n
At least one of observations or state is required,
otherwise there is insufficient data to process.
</comment>
</elem>
</struct>
<!-- Calculate Status-->
<enum name="CalculateStatus" type="Tensor.int8" default="undefined">
<comment>
Specifies the calculation resulting status. Caller should consult this value first to
determine if estimates are valid.
</comment>
<literal name="EstimateReady" value="1"/>
<literal name="undefined" value="0"/>
<literal name="DidNotConverge" value="-1"/>
<literal name="NotEnoughData" value="-2"/>
<literal name="UnspecifiedErr" value="-3"/>
</enum>
<!-- CalculateOutput structure -->
<struct name="CalculateOutput" type="IlpOutputBase" >
<comment>ILP.Positioning.Calculate output data structure. This contains the reuslts of a calculate oeration.</comment>
<elem name="uuidSession" multiplicity="1" type="UUID">
<comment>
Session identifier. This is the Identifier processed session used to process the
calculate transaction. If session, was not previously created by CreateSession, then
the session will not be available for future use.
</comment>
</elem>
<elem name="dynamics" multiplicity="1" type="DynamicsProfile">
<comment>
Specifies the dymnamics of the device providing the data.
</comment>
</elem>
<elem name="rankEstimate" multiplicity="1" type="EstimateRanking">
<comment>
Specifies the sort order of the estimates produced by the hybrid calculation.
</comment>
</elem>
<elem name="status" multiplicity="1" type="CalculateStatus">
<comment>
Specifies the status result of the calculation.
</comment>
</elem>
<elem name="Estimates" multiplicity="0..*" type="Estimate">
<comment>
List of estimates returned from the calculation ranked in the specified order.
</comment>
</elem>
</struct>
<!--
*******************************************************
CreateSession Data Types
*******************************************************
-->
<!-- CreateSessionInput structure -->
<struct name="CreateSessionInput" type="IlpInputBase">
<comment>ILP.Positioning.CreateSession input data structure.</comment>
<elem name="dynamics" multiplicity="1" type="DynamicsProfile">
<comment>
Specifies the dymnamics of the device providing the data. If not known specify undefined.
This parameter optimizes configuration of the estimator to constraint calculations based on the type
of motion. If session is specified, this value will be overridden.
</comment>
</elem>
<elem name="duration" multiplicity="1" type="int32">
<comment>
Number of seconds duration should persist. Maximum value is 86400 (1 day).
</comment>
</elem>
<elem name="typeObs" multiplicity="0..*" type="ObservationType">
<comment>
Optional List of supported observation types. Improves transaction initialization speed if only observation types needed are specified.
If not specified, all supported observations will be available for the session.
</comment>
</elem>
<elem name="ctTypicalObs" multiplicity="0..1" type="int32">
<comment>
Optional count of typical observations. Improves memory allocation when sizing internal buffers to typical number
of observations.
</comment>
</elem>
</struct>
<!-- CreateSessionOutput structure -->
<struct name="CreateSessionOutput" type="IlpOutputBase" >
<comment>ILP.Positioning.CreateSession output data structure.</comment>
<elem name="resultcode" multiplicity="1" type="ResultCode">
<comment>
Result of session creation operation.
</comment>
</elem>
<elem name="uuidSession" multiplicity="0..1" type="UUID">
<comment>
Session identifier of the created session.
</comment>
</elem>
</struct>
<!--
*******************************************************
ReleaseSession Data Types
*******************************************************
-->
<!-- ReleaseSessionInput structure -->
<struct name="ReleaseSessionInput" >
<comment>ILP.Positioning.ReleaseSession input data structure.</comment>
<elem name="uuidSession" multiplicity="1" type="UUID">
<comment>
Session identifier of the session to release.
</comment>
</elem>
</struct>
<!--
*******************************************************
Initialize Data Types
*******************************************************
-->
<!-- InitializeInput structure -->
<struct name="InitializeInput" type="IlpInputBase" >
<comment>ILP.Positioning.Initialize input data structure.</comment>
<elem name="uuidSession" multiplicity="0..1" type="UUID">
<comment>
Optional session identifier. See CreateSession for creating valid
session identifiers. Transactions can be processed in the context of a session to provide
historical information and link calcuation in time.
</comment>
</elem>
<elem name="durSession" multiplicity="0..1" type="int32">
<comment>
Optional session duration. Default is 0 (not persisted). If specified,
the session created for this transaction will be stored for a maximum of 86400 seconds.
The uuidSession returned in the output, can be used in subsequent calls to Calculate to utilize
the persisted session data. Call ReleaseSession to release any persisted content once the session
is complete.
</comment>
</elem>
<elem name="state" multiplicity="1" type="StateInfo">
<comment>
Specifies the position to initialize the state of the positioning engine.
</comment>
</elem>
</struct>
<!-- InitializeOutput structure -->
<struct name="InitializeOutput" type="IlpOutputBase">
<comment>ILP.Positioning.Initialize output data structure.</comment>
<elem name="resultcode" multiplicity="1" type="ResultCode">
<comment>
Result of session creation operation.
</comment>
</elem>
<elem name="uuidSession" multiplicity="0..1" type="UUID">
<comment>
Session identifier of the created session.
</comment>
</elem>
</struct>
<!--
*******************************************************
ILP Positioning Service Interface.
*******************************************************
-->
<interface name="Positioning">
<comment>Hybrid positioning interface defines interactions supporting position calculation functions.</comment>
<operation name="Calculate">
<comment>Calculates the position of the device given the specified observation data.</comment>
<input name="Input" type="CalculateInput" sid="0x1010"/>
<output name="Result" type="CalculateOutput" sid="0x1011" />
</operation>
<operation name="CreateSession">
<comment>
Creates a persistent session object and returns its UUID. Can be used to process a series of related transactions
using the previous filter state. Good for temporal or multiple observation type updates that were not
available at the same time.
</comment>
<input name="Input" type="CreateSessionInput" sid="0x1012"/>
<output name="Result" type="CreateSessionOutput" sid="0x1013"/>
</operation>
<operation name="ReleaseSession">
<comment>
Releases any persistent session data associated with the UUID.
</comment>
<input name="Input" type="ReleaseSessionInput" sid="0x1014"/>
<!-- output name="Result" type="void" sid="0x0000" result="return"/ -->
</operation>
<operation name="Initialize">
<comment>
Initializes the positioning engine to state specified in the provided shape information.
This is an optional interaction given most cases, this initial position can be determmined from
the provided data.
</comment>
<input name="Input" type="InitializeInput" sid="0x1016"/>
<output name="Result" type="InitializeOutput" sid="0x1017" />
</operation>
</interface>
</namespace>
</specification>