Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
392403c1 by Skip Hines
Options

Updated V1.2 to use Tensor/V1.0.0/ApiBase.xid.xml

1 parent 5158b0c6
Inline Side-by-side
Showing 11 changed files with 137 additions and 521 deletions
HPE/V1.2/README.md 0 → 100644
1 # HPE XIDs #
2 HPE XIDs do not encode their ordinals (i.e. tags and offets). XIDData.prop is required to maintain backward compatibility.
3
4
5 ## Generate / Verify XIDData.prop ##
6
7 ~~~sh
8 $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \
9 -v \
10 -prop https://xid.location.studio/Tensor/V1.0.0/XIDData.prop \
11 -prop https://xid.location.studio/HPE/V1.2/XIDData.prop \
12 https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml \
13 https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml \
14 https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml \
15 https://xid.location.studio/HPE/V1.2/HpeUsage.xid.xml \
16 https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml
17
18 OR
19
20 $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \
21 -v \
22 -prop ../../Tensor/V1.0.0/XIDData.prop \
23 -prop XIDData.prop \
24 HpeCellular.xid.xml \
25 HpeCore.xid.xml \
26 HpeGnss.xid.xml \
27 HpeUsage.xid.xml \
28 HpeWiFi.xid.xml
29 ~~~
30
31
32 If xidcg reports:
33
34 ~~~
35 Generating: xidout/meta/XID/XIDData.prop
36 ~~~
37
38 Then something has changed and XIDData.prop needs to get updated.
39
ILP/V1.1.1/ApiBase.xid.xml deleted 100644 → 0
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="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.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
20 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
21 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
22 <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/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/ApiBase.xid.xml deleted 100644 → 0
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="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 deleted 100644 → 0
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
7 identity="IlpApiBase.xid">
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/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
20 <namespace name="ILP">
21 <using namespace="HPE"/>
22 <using namespace="Tensor"/>
23
24
25 <!--
26 *******************************
27 *IlpInputBase Type Definition
28 *******************************
29 -->
30 <struct name="IlpInputBase" >
31 <comment>Base input fields for operations supporting asynchronous transaction information.</comment>
32 <elem name="idDevice" multiplicity="1" type="string">
33 <comment>
34 Required device identifier, that provides a consistent multi-transaction identifier
35 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
36 in the system logs, providing traceability. Identifier should be unique.
37 </comment>
38 </elem>
39
40 <elem name="idTransaction" multiplicity="0..1" type="string">
41 <comment>
42 Optional transaction identifier for the caller to uniquely identify and track
43 the transaction and corresponding results. These identifiers will appear in the
44 ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
45 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
46 the ILP system.
47 </comment>
48 </elem>
49
50 <!-- THis is future, don't uncomment until design issues resolved. M. Mathews/s. Hines 161130
51 <elem name="urlCallback" multiplicity="0..1" type="string">
52 <tag key="life-cycle" value="future" />
53 <comment>
54 Optional asynchronous callback used to callback client servers during long operations. Not all
55 interfaces may support this.
56 </comment>
57 </elem>
58 -->
59 </struct>
60
61
62 <!--
63 *******************************
64 *IlpOutputBase Type Definition
65 *******************************
66 -->
67 <struct name="IlpOutputBase" >
68 <comment>Base output fields common to operations supporting asynchronous returning transaction information.</comment>
69 <elem name="idDevice" multiplicity="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="idTransaction" multiplicity="0..1" type="string">
78 <comment>
79 Optional 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 </elem>
86
87 <!-- THis is future, don't uncomment until design issues resolved. M. Mathews/s. Hine 161130
88 <elem name="urlCallback" multiplicity="0..1" type="string">
89 <tag key="life-cycle" value="future" />
90 <comment>
91 Optional asynchronous callback used to callback client servers during long operations. Not all
92 interfaces may support this.
93 </comment>
94 </elem>
95 -->
96 </struct>
97
98
99 </namespace>
100 </specification>
ILP/V1.2/IlpAssistanceApi.xid.xml
...@@ -12,8 +12,9 @@ ...@@ -12,8 +12,9 @@
12 and services communicating via standard IP based protocols. The API currently supports XMF and JSON wire formats. 12 and services communicating via standard IP based protocols. The API currently supports XMF and JSON wire formats.
13 </comment> 13 </comment>
14 14
15 <import ref="https://xid.location.studio/ILP/V1.2/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" /> 15 <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="ApiBase.xid.xml" />
16 16 <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
17
17 <namespace name="ILP"> 18 <namespace name="ILP">
18 <using namespace="HPE"/> 19 <using namespace="HPE"/>
19 <using namespace="Tensor"/> 20 <using namespace="Tensor"/>
...@@ -24,7 +25,7 @@ ...@@ -24,7 +25,7 @@
24 ******************************************************* 25 *******************************************************
25 --> 26 -->
26 <!-- GnssDataInput structure --> 27 <!-- GnssDataInput structure -->
27 <struct name="GnssDataInput" type="IlpInputBase"> 28 <struct name="GnssDataInput" type="InputBase">
28 <comment>ILP.Assistance.GnssData input request data.</comment> 29 <comment>ILP.Assistance.GnssData input request data.</comment>
29 30
30 <!-- Define internal data structure --> 31 <!-- Define internal data structure -->
...@@ -70,7 +71,7 @@ ...@@ -70,7 +71,7 @@
70 </comment> 71 </comment>
71 </elem> 72 </elem>
72 73
73 <elem name="location" multiplicity="0..1" type="Shape"> 74 <elem name="location" multiplicity="0..1" type="Shape" polymorphic="true">
74 <comment> 75 <comment>
75 Optional specification of the location to compute assistance data. If not specified 76 Optional specification of the location to compute assistance data. If not specified
76 all available asistance data will be provided. 77 all available asistance data will be provided.
...@@ -91,16 +92,9 @@ ...@@ -91,16 +92,9 @@
91 </struct> 92 </struct>
92 93
93 <!-- GnssDataOutput structure --> 94 <!-- GnssDataOutput structure -->
94 <struct name="GnssDataOutput" type="IlpOutputBase"> 95 <struct name="GnssDataOutput" type="OutputBase">
95 <comment>ILP.Assistance.GnssData output structure. </comment> 96 <comment>ILP.Assistance.GnssData output structure. </comment>
96 97
97 <elem name="resultcode" multiplicity="1" type="ResultCode">
98 <comment>
99 Result of GnssData operation.
100 If resultcode is not success, encCon and constellation data will not be present.
101 </comment>
102 </elem>
103
104 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0"> 98 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
105 <comment> 99 <comment>
106 Constellation Data encoding format. Data can be provided in a different encoding format 100 Constellation Data encoding format. Data can be provided in a different encoding format
......
ILP/V1.2/IlpPositioningApi.xid.xml
...@@ -12,7 +12,8 @@ ...@@ -12,7 +12,8 @@
12 via standard IP based protocols. The API currently supports XMF and JSON wire formats. 12 via standard IP based protocols. The API currently supports XMF and JSON wire formats.
13 </comment> 13 </comment>
14 14
15 <import ref="https://xid.location.studio/ILP/V1.2/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" /> 15 <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="ApiBase.xid.xml" />
16 <import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
16 17
17 <namespace name="ILP"> 18 <namespace name="ILP">
18 <using namespace="HPE"/> 19 <using namespace="HPE"/>
...@@ -25,7 +26,7 @@ ...@@ -25,7 +26,7 @@
25 --> 26 -->
26 27
27 <!-- CalculateInput structure --> 28 <!-- CalculateInput structure -->
28 <struct name="CalculateInput" type ="IlpInputBase"> 29 <struct name="CalculateInput" type ="InputBase">
29 <comment>ILP.Positioning.Calculate input data structure.</comment> 30 <comment>ILP.Positioning.Calculate input data structure.</comment>
30 31
31 <elem name="uuidSession" multiplicity="0..1" type="UUID"> 32 <elem name="uuidSession" multiplicity="0..1" type="UUID">
...@@ -88,13 +89,6 @@ If not specified, the set defaults to: Spheroid, Circle. ...@@ -88,13 +89,6 @@ If not specified, the set defaults to: Spheroid, Circle.
88 </comment> 89 </comment>
89 </elem> 90 </elem>
90 91
91 <elem name="directive" multiplicity="0..*" type="NameValue" ord="87">
92 <comment>
93 A set of directives to influence processing. Unknown directives are ignored.
94 </comment>
95 </elem>
96
97
98 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90"> 92 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
99 <comment> 93 <comment>
100 Specifies the position to initialize the state of the positioning engine.\n 94 Specifies the position to initialize the state of the positioning engine.\n
...@@ -134,7 +128,7 @@ If not specified, the set defaults to: Spheroid, Circle. ...@@ -134,7 +128,7 @@ If not specified, the set defaults to: Spheroid, Circle.
134 </enum> 128 </enum>
135 129
136 <!-- CalculateOutput structure --> 130 <!-- CalculateOutput structure -->
137 <struct name="CalculateOutput" type="IlpOutputBase" > 131 <struct name="CalculateOutput" type="OutputBase" >
138 <comment>ILP.Positioning.Calculate output data structure. This contains the reuslts of a calculate oeration.</comment> 132 <comment>ILP.Positioning.Calculate output data structure. This contains the reuslts of a calculate oeration.</comment>
139 133
140 <elem name="uuidSession" multiplicity="1" type="UUID"> 134 <elem name="uuidSession" multiplicity="1" type="UUID">
...@@ -173,131 +167,6 @@ If not specified, the set defaults to: Spheroid, Circle. ...@@ -173,131 +167,6 @@ If not specified, the set defaults to: Spheroid, Circle.
173 167
174 <!-- 168 <!--
175 ******************************************************* 169 *******************************************************
176 CreateSession Data Types
177 *******************************************************
178 -->
179
180 <!-- CreateSessionInput structure -->
181 <struct name="CreateSessionInput" type="IlpInputBase">
182 <comment>ILP.Positioning.CreateSession input data structure.</comment>
183
184 <elem name="dynamics" multiplicity="1" type="DynamicsProfile">
185 <comment>
186 Specifies the dymnamics of the device providing the data. If not known specify undefined.
187 This parameter optimizes configuration of the estimator to constraint calculations based on the type
188 of motion. If session is specified, this value will be overridden.
189 </comment>
190 </elem>
191
192 <elem name="duration" multiplicity="1" type="int32">
193 <comment>
194 Number of seconds duration should persist. Maximum value is 86400 (1 day).
195 </comment>
196 </elem>
197
198 <elem name="typeObs" multiplicity="0..*" type="ObservationType">
199 <comment>
200 Optional List of supported observation types. Improves transaction initialization speed if only observation types needed are specified.
201 If not specified, all supported observations will be available for the session.
202 </comment>
203 </elem>
204
205 <elem name="ctTypicalObs" multiplicity="0..1" type="int32">
206 <comment>
207 Optional count of typical observations. Improves memory allocation when sizing internal buffers to typical number
208 of observations.
209 </comment>
210 </elem>
211
212 </struct>
213
214 <!-- CreateSessionOutput structure -->
215 <struct name="CreateSessionOutput" type="IlpOutputBase" >
216 <comment>ILP.Positioning.CreateSession output data structure.</comment>
217 <elem name="resultcode" multiplicity="1" type="ResultCode">
218 <comment>
219 Result of session creation operation.
220 </comment>
221 </elem>
222 <elem name="uuidSession" multiplicity="0..1" type="UUID">
223 <comment>
224 Session identifier of the created session.
225 </comment>
226 </elem>
227 </struct>
228
229 <!--
230 *******************************************************
231 ReleaseSession Data Types
232 *******************************************************
233 -->
234
235 <!-- ReleaseSessionInput structure -->
236 <struct name="ReleaseSessionInput" >
237 <comment>ILP.Positioning.ReleaseSession input data structure.</comment>
238 <elem name="uuidSession" multiplicity="1" type="UUID">
239 <comment>
240 Session identifier of the session to release.
241 </comment>
242 </elem>
243
244 </struct>
245
246 <!--
247 *******************************************************
248 Initialize Data Types
249 *******************************************************
250 -->
251
252 <!-- InitializeInput structure -->
253 <struct name="InitializeInput" type="IlpInputBase" >
254 <comment>ILP.Positioning.Initialize input data structure.</comment>
255
256 <elem name="uuidSession" multiplicity="0..1" type="UUID">
257 <comment>
258 Optional session identifier. See CreateSession for creating valid
259 session identifiers. Transactions can be processed in the context of a session to provide
260 historical information and link calcuation in time.
261 </comment>
262 </elem>
263
264 <elem name="durSession" multiplicity="0..1" type="int32">
265 <comment>
266 Optional session duration. Default is 0 (not persisted). If specified,
267 the session created for this transaction will be stored for a maximum of 86400 seconds.
268 The uuidSession returned in the output, can be used in subsequent calls to Calculate to utilize
269 the persisted session data. Call ReleaseSession to release any persisted content once the session
270 is complete.
271 </comment>
272 </elem>
273
274 <elem name="state" multiplicity="1" type="StateInfo">
275 <comment>
276 Specifies the position to initialize the state of the positioning engine.
277 </comment>
278 </elem>
279
280 </struct>
281
282 <!-- InitializeOutput structure -->
283 <struct name="InitializeOutput" type="IlpOutputBase">
284 <comment>ILP.Positioning.Initialize output data structure.</comment>
285 <elem name="resultcode" multiplicity="1" type="ResultCode">
286 <comment>
287 Result of session creation operation.
288 </comment>
289 </elem>
290 <elem name="uuidSession" multiplicity="0..1" type="UUID">
291 <comment>
292 Session identifier of the created session.
293 </comment>
294 </elem>
295 </struct>
296
297
298
299 <!--
300 *******************************************************
301 ILP Positioning Service Interface. 170 ILP Positioning Service Interface.
302 ******************************************************* 171 *******************************************************
303 --> 172 -->
...@@ -308,36 +177,7 @@ If not specified, the set defaults to: Spheroid, Circle. ...@@ -308,36 +177,7 @@ If not specified, the set defaults to: Spheroid, Circle.
308 <comment>Calculates the position of the device given the specified observation data.</comment> 177 <comment>Calculates the position of the device given the specified observation data.</comment>
309 <input name="Input" type="CalculateInput" sid="0x1010"/> 178 <input name="Input" type="CalculateInput" sid="0x1010"/>
310 <output name="Result" type="CalculateOutput" sid="0x1011" /> 179 <output name="Result" type="CalculateOutput" sid="0x1011" />
311 </operation>
312
313 <operation name="CreateSession">
314 <comment>
315 Creates a persistent session object and returns its UUID. Can be used to process a series of related transactions
316 using the previous filter state. Good for temporal or multiple observation type updates that were not
317 available at the same time.
318 </comment>
319 <input name="Input" type="CreateSessionInput" sid="0x1012"/>
320 <output name="Result" type="CreateSessionOutput" sid="0x1013"/>
321 </operation>
322
323 <operation name="ReleaseSession">
324 <comment>
325 Releases any persistent session data associated with the UUID.
326 </comment>
327 <input name="Input" type="ReleaseSessionInput" sid="0x1014"/>
328 <!-- output name="Result" type="void" sid="0x0000" result="return"/ -->
329 </operation> 180 </operation>
330
331 <operation name="Initialize">
332 <comment>
333 Initializes the positioning engine to state specified in the provided shape information.
334 This is an optional interaction given most cases, this initial position can be determmined from
335 the provided data.
336 </comment>
337 <input name="Input" type="InitializeInput" sid="0x1016"/>
338 <output name="Result" type="InitializeOutput" sid="0x1017" />
339 </operation>
340
341 </interface> 181 </interface>
342 182
343 </namespace> 183 </namespace>
......
ILP/V1.2/IlpSubmissionApi.xid.xml
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
11 data without invoking the full get position operation. 11 data without invoking the full get position operation.
12 </comment> 12 </comment>
13 13
14 <import ref="https://xid.location.studio/ILP/V1.2/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" /> 14 <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="ApiBase.xid.xml" />
15 15
16 <namespace name="ILP"> 16 <namespace name="ILP">
17 <using namespace="HPE"/> 17 <using namespace="HPE"/>
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
22 Note: all the tags are defined. These have to 22 Note: all the tags are defined. These have to
23 match CalculateInput tags of the same name. 23 match CalculateInput tags of the same name.
24 --> 24 -->
25 <struct name="PositionInfo" type="IlpInputBase" > 25 <struct name="PositionInfo" type="InputBase" >
26 <comment>Used as ILP.Submission.PositionInfo input.</comment> 26 <comment>Used as ILP.Submission.PositionInfo input.</comment>
27 27
28 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90"> 28 <elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
...@@ -33,12 +33,6 @@ ...@@ -33,12 +33,6 @@
33 </comment> 33 </comment>
34 </elem> 34 </elem>
35 35
36 <elem name="directive" multiplicity="0..*" type="NameValue" ord="87">
37 <comment>
38 A set of directives to influence processing.
39 </comment>
40 </elem>
41
42 <elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88"> 36 <elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
43 <comment> 37 <comment>
44 Observation set encoding format. Observations may be passed to the service in 38 Observation set encoding format. Observations may be passed to the service in
......
ILP/V1.2/README.md 0 → 100644
1 # ILP XIDs #
2 ILP XIDs do not encode their ordinals (i.e. tags and offets). XIDData.prop is required to maintain backward compatibility.
3
4
5 ## Generate / Verify XIDData.prop ##
6
7 ~~~sh
8 $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \
9 -v \
10 -prop https://xid.location.studio/Tensor/V1.0.0/XIDData.prop \
11 -prop https://xid.location.studio/HPE/V1.2/XIDData.prop \
12 -prop https://xid.location.studio/ILP/V1.2/XIDData.prop \
13 https://xid.location.studio/ILP/V1.2/IlpAssistanceApi.xid.xml \
14 https://xid.location.studio/ILP/V1.2/IlpPositioningApi.xid.xml \
15 https://xid.location.studio/ILP/V1.2/IlpSubmissionApi.xid.xml
16
17 OR
18
19 $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \
20 -v \
21 -prop ../../Tensor/V1.0.0/XIDData.prop \
22 -prop ../../HPE/V1.2/XIDData.prop \
23 -prop XIDData.prop \
24 IlpAssistanceApi.xid.xml \
25 IlpPositioningApi.xid.xml \
26 IlpSubmissionApi.xid.xml
27 ~~~
28
29 If xidcg reports:
30
31 ~~~
32 Generating: xidout/meta/XID/XIDData.prop
33 ~~~
34
35 Then something has changed and XIDData.prop needs to get updated.
36
ILP/V1.2/XIDData.prop
...@@ -401,7 +401,6 @@ Ord.HPE.TaskReport.start=113 ...@@ -401,7 +401,6 @@ Ord.HPE.TaskReport.start=113
401 Ord.HPE.TaskReport.status=115 401 Ord.HPE.TaskReport.status=115
402 Ord.HPE.TaskReport.taskid=112 402 Ord.HPE.TaskReport.taskid=112
403 Ord.ILP.CalculateInput.confidence=84 403 Ord.ILP.CalculateInput.confidence=84
404 Ord.ILP.CalculateInput.directive=87
405 Ord.ILP.CalculateInput.durSession=81 404 Ord.ILP.CalculateInput.durSession=81
406 Ord.ILP.CalculateInput.dynamics=82 405 Ord.ILP.CalculateInput.dynamics=82
407 Ord.ILP.CalculateInput.encObs=88 406 Ord.ILP.CalculateInput.encObs=88
...@@ -416,12 +415,6 @@ Ord.ILP.CalculateOutput.dynamics=81 ...@@ -416,12 +415,6 @@ Ord.ILP.CalculateOutput.dynamics=81
416 Ord.ILP.CalculateOutput.rankEstimate=82 415 Ord.ILP.CalculateOutput.rankEstimate=82
417 Ord.ILP.CalculateOutput.status=83 416 Ord.ILP.CalculateOutput.status=83
418 Ord.ILP.CalculateOutput.uuidSession=80 417 Ord.ILP.CalculateOutput.uuidSession=80
419 Ord.ILP.CreateSessionInput.ctTypicalObs=83
420 Ord.ILP.CreateSessionInput.duration=81
421 Ord.ILP.CreateSessionInput.dynamics=80
422 Ord.ILP.CreateSessionInput.typeObs=82
423 Ord.ILP.CreateSessionOutput.resultcode=80
424 Ord.ILP.CreateSessionOutput.uuidSession=81
425 Ord.ILP.GnssDataInput.Request=84 418 Ord.ILP.GnssDataInput.Request=84
426 Ord.ILP.GnssDataInput.RequestSpec.AssistData=68 419 Ord.ILP.GnssDataInput.RequestSpec.AssistData=68
427 Ord.ILP.GnssDataInput.RequestSpec.constellation=64 420 Ord.ILP.GnssDataInput.RequestSpec.constellation=64
...@@ -432,23 +425,11 @@ Ord.ILP.GnssDataInput.elmask=83 ...@@ -432,23 +425,11 @@ Ord.ILP.GnssDataInput.elmask=83
432 Ord.ILP.GnssDataInput.encoding=81 425 Ord.ILP.GnssDataInput.encoding=81
433 Ord.ILP.GnssDataInput.epoch=80 426 Ord.ILP.GnssDataInput.epoch=80
434 Ord.ILP.GnssDataInput.location=82 427 Ord.ILP.GnssDataInput.location=82
435 Ord.ILP.GnssDataOutput.assistdata=82 428 Ord.ILP.GnssDataOutput.assistdata=81
436 Ord.ILP.GnssDataOutput.encoding=81 429 Ord.ILP.GnssDataOutput.encoding=80
437 Ord.ILP.GnssDataOutput.resultcode=80
438 Ord.ILP.IlpInputBase.idDevice=64
439 Ord.ILP.IlpInputBase.idTransaction=65
440 Ord.ILP.IlpOutputBase.idDevice=64
441 Ord.ILP.IlpOutputBase.idTransaction=65
442 Ord.ILP.InitializeInput.durSession=81
443 Ord.ILP.InitializeInput.state=82
444 Ord.ILP.InitializeInput.uuidSession=80
445 Ord.ILP.InitializeOutput.resultcode=80
446 Ord.ILP.InitializeOutput.uuidSession=81
447 Ord.ILP.PositionInfo.directive=87
448 Ord.ILP.PositionInfo.encObs=88 430 Ord.ILP.PositionInfo.encObs=88
449 Ord.ILP.PositionInfo.observations=89 431 Ord.ILP.PositionInfo.observations=89
450 Ord.ILP.PositionInfo.state=90 432 Ord.ILP.PositionInfo.state=90
451 Ord.ILP.ReleaseSessionInput.uuidSession=64
452 Ord.Logging.ActionMsg.category=98 433 Ord.Logging.ActionMsg.category=98
453 Ord.Logging.ActionMsg.id=96 434 Ord.Logging.ActionMsg.id=96
454 Ord.Logging.ActionMsg.iid=99 435 Ord.Logging.ActionMsg.iid=99
...@@ -486,19 +467,35 @@ Ord.Logging.TransactionMsg.devid=83 ...@@ -486,19 +467,35 @@ Ord.Logging.TransactionMsg.devid=83
486 Ord.Logging.TransactionMsg.etid=81 467 Ord.Logging.TransactionMsg.etid=81
487 Ord.Logging.TransactionMsg.tid=80 468 Ord.Logging.TransactionMsg.tid=80
488 Ord.Logging.UsageMsg.uri=96 469 Ord.Logging.UsageMsg.uri=96
470 Ord.Tensor.Command.argument=66
471 Ord.Tensor.Command.etid=65
472 Ord.Tensor.Command.name=64
473 Ord.Tensor.CommandApi.Execute.Input.commands=64
474 Ord.Tensor.CommandApi.Execute.Input.wantresponses=65
475 Ord.Tensor.CommandApi.Execute.Output.lastcommand=64
476 Ord.Tensor.CommandApi.Execute.Output.lastresult=65
477 Ord.Tensor.CommandApi.Execute.Output.responses=66
478 Ord.Tensor.CommandResponse.etid=65
479 Ord.Tensor.CommandResponse.name=64
480 Ord.Tensor.CommandResponse.output=67
481 Ord.Tensor.CommandResponse.result=66
482 Ord.Tensor.InputBase.devid=64
483 Ord.Tensor.InputBase.directive=66
484 Ord.Tensor.InputBase.etid=65
489 Ord.Tensor.NameValue.name=64 485 Ord.Tensor.NameValue.name=64
490 Ord.Tensor.NameValue.value=65 486 Ord.Tensor.NameValue.value=65
487 Ord.Tensor.OutputBase.devid=64
488 Ord.Tensor.OutputBase.errinfo=67
489 Ord.Tensor.OutputBase.etid=65
490 Ord.Tensor.OutputBase.resultcode=66
491 Ord.Tensor.VoidType.reserved=64 491 Ord.Tensor.VoidType.reserved=64
492 SID.ILP.Assistance.Gnss.Input=4120 492 SID.ILP.Assistance.Gnss.Input=4120
493 SID.ILP.Assistance.Gnss.Output=4121 493 SID.ILP.Assistance.Gnss.Output=4121
494 SID.ILP.Positioning.Calculate.Input=4112 494 SID.ILP.Positioning.Calculate.Input=4112
495 SID.ILP.Positioning.Calculate.Output=4113 495 SID.ILP.Positioning.Calculate.Output=4113
496 SID.ILP.Positioning.CreateSession.Input=4114
497 SID.ILP.Positioning.CreateSession.Output=4115
498 SID.ILP.Positioning.Initialize.Input=4118
499 SID.ILP.Positioning.Initialize.Output=4119
500 SID.ILP.Positioning.ReleaseSession.Input=4116
501 SID.ILP.Submission.PositionInfo.Input=4126 496 SID.ILP.Submission.PositionInfo.Input=4126
497 SID.Tensor.CommandApi.Execute.Input=256
498 SID.Tensor.CommandApi.Execute.Output=257
502 Size.HPE.Arc3D=45 499 Size.HPE.Arc3D=45
503 Size.HPE.Arc=33 500 Size.HPE.Arc=33
504 Size.HPE.ArcBand3D=49 501 Size.HPE.ArcBand3D=49
...@@ -556,24 +553,12 @@ Size.ILP.Assistance.Gnss.Input=-1 ...@@ -556,24 +553,12 @@ Size.ILP.Assistance.Gnss.Input=-1
556 Size.ILP.Assistance.Gnss.Output=-1 553 Size.ILP.Assistance.Gnss.Output=-1
557 Size.ILP.CalculateInput=-1 554 Size.ILP.CalculateInput=-1
558 Size.ILP.CalculateOutput=-1 555 Size.ILP.CalculateOutput=-1
559 Size.ILP.CreateSessionInput=-1
560 Size.ILP.CreateSessionOutput=-1
561 Size.ILP.GnssDataInput.RequestSpec=-1 556 Size.ILP.GnssDataInput.RequestSpec=-1
562 Size.ILP.GnssDataInput=-1 557 Size.ILP.GnssDataInput=-1
563 Size.ILP.GnssDataOutput=-1 558 Size.ILP.GnssDataOutput=-1
564 Size.ILP.IlpInputBase=-1
565 Size.ILP.IlpOutputBase=-1
566 Size.ILP.InitializeInput=-1
567 Size.ILP.InitializeOutput=-1
568 Size.ILP.PositionInfo=-1 559 Size.ILP.PositionInfo=-1
569 Size.ILP.Positioning.Calculate.Input=-1 560 Size.ILP.Positioning.Calculate.Input=-1
570 Size.ILP.Positioning.Calculate.Output=-1 561 Size.ILP.Positioning.Calculate.Output=-1
571 Size.ILP.Positioning.CreateSession.Input=-1
572 Size.ILP.Positioning.CreateSession.Output=-1
573 Size.ILP.Positioning.Initialize.Input=-1
574 Size.ILP.Positioning.Initialize.Output=-1
575 Size.ILP.Positioning.ReleaseSession.Input=-1
576 Size.ILP.ReleaseSessionInput=-1
577 Size.ILP.Submission.PositionInfo.Input=-1 562 Size.ILP.Submission.PositionInfo.Input=-1
578 Size.Logging.ActionMsg=-1 563 Size.Logging.ActionMsg=-1
579 Size.Logging.AppMetrics=-1 564 Size.Logging.AppMetrics=-1
...@@ -586,5 +571,11 @@ Size.Logging.TaskReport=-1 ...@@ -586,5 +571,11 @@ Size.Logging.TaskReport=-1
586 Size.Logging.TraceMsg=-1 571 Size.Logging.TraceMsg=-1
587 Size.Logging.TransactionMsg=-1 572 Size.Logging.TransactionMsg=-1
588 Size.Logging.UsageMsg=-1 573 Size.Logging.UsageMsg=-1
574 Size.Tensor.Command=-1
575 Size.Tensor.CommandApi.Execute.Input=-1
576 Size.Tensor.CommandApi.Execute.Output=-1
577 Size.Tensor.CommandResponse=-1
578 Size.Tensor.InputBase=-1
589 Size.Tensor.NameValue=-1 579 Size.Tensor.NameValue=-1
580 Size.Tensor.OutputBase=-1
590 Size.Tensor.VoidType=-1 581 Size.Tensor.VoidType=-1
......
Tensor/V1.0.0/README.md
...@@ -10,8 +10,19 @@ $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \ ...@@ -10,8 +10,19 @@ $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \
10 https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml \ 10 https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml \
11 https://xid.location.studio/Tensor/V1.0.0/Command.xid.xml \ 11 https://xid.location.studio/Tensor/V1.0.0/Command.xid.xml \
12 https://xid.location.studio/Tensor/V1.0.0/Common.xid.xml \ 12 https://xid.location.studio/Tensor/V1.0.0/Common.xid.xml \
13 https://xid.location.studio/Tensor/V1.0.0/Definiions.xid.xml \ 13 https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml \
14 https://xid.location.studio/Tensor/V1.0.0/Logging.xid.xml 14 https://xid.location.studio/Tensor/V1.0.0/Logging.xid.xml
15
16 OR
17
18 $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \
19 -v \
20 -prop XIDData.prop \
21 ApiBase.xid.xml \
22 Command.xid.xml \
23 Common.xid.xml \
24 Definitions.xid.xml \
25 Logging.xid.xml
15 ~~~ 26 ~~~
16 27
17 If xidcg reports: 28 If xidcg reports:
......
Tensor/V1.0.0/XIDData.prop
...@@ -47,8 +47,15 @@ Ord.Tensor.CommandResponse.etid=65 ...@@ -47,8 +47,15 @@ Ord.Tensor.CommandResponse.etid=65
47 Ord.Tensor.CommandResponse.name=64 47 Ord.Tensor.CommandResponse.name=64
48 Ord.Tensor.CommandResponse.output=67 48 Ord.Tensor.CommandResponse.output=67
49 Ord.Tensor.CommandResponse.result=66 49 Ord.Tensor.CommandResponse.result=66
50 Ord.Tensor.InputBase.devid=64
51 Ord.Tensor.InputBase.directive=66
52 Ord.Tensor.InputBase.etid=65
50 Ord.Tensor.NameValue.name=64 53 Ord.Tensor.NameValue.name=64
51 Ord.Tensor.NameValue.value=65 54 Ord.Tensor.NameValue.value=65
55 Ord.Tensor.OutputBase.devid=64
56 Ord.Tensor.OutputBase.errinfo=67
57 Ord.Tensor.OutputBase.etid=65
58 Ord.Tensor.OutputBase.resultcode=66
52 Ord.Tensor.VoidType.reserved=64 59 Ord.Tensor.VoidType.reserved=64
53 SID.Tensor.CommandApi.Execute.Input=256 60 SID.Tensor.CommandApi.Execute.Input=256
54 SID.Tensor.CommandApi.Execute.Output=257 61 SID.Tensor.CommandApi.Execute.Output=257
...@@ -67,5 +74,7 @@ Size.Tensor.Command=-1 ...@@ -67,5 +74,7 @@ Size.Tensor.Command=-1
67 Size.Tensor.CommandApi.Execute.Input=-1 74 Size.Tensor.CommandApi.Execute.Input=-1
68 Size.Tensor.CommandApi.Execute.Output=-1 75 Size.Tensor.CommandApi.Execute.Output=-1
69 Size.Tensor.CommandResponse=-1 76 Size.Tensor.CommandResponse=-1
77 Size.Tensor.InputBase=-1
70 Size.Tensor.NameValue=-1 78 Size.Tensor.NameValue=-1
79 Size.Tensor.OutputBase=-1
71 Size.Tensor.VoidType=-1 80 Size.Tensor.VoidType=-1
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!