Switching to local XIDs in slam core repo for further improvements
Showing
9 changed files
with
0 additions
and
578 deletions
This diff is collapsed.
Click to expand it.
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="ProbeApi.xid.xml"> | ||
8 | <title>SLAM Probe API Specifications</title> | ||
9 | <comment> | ||
10 | This file defines the SLAM Probe API. The probe API is used to load one or more probe data records from a single device. | ||
11 | </comment> | ||
12 | |||
13 | <!-- Include used definitions --> | ||
14 | <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" /> | ||
15 | <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" /> | ||
16 | <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" /> | ||
17 | <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="SLAM/ApiBase.xid.xml" /> | ||
18 | <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid.xml" local="SLAM/TileDefinitions.xid.xml" /> | ||
19 | |||
20 | <namespace name="SLAM"> | ||
21 | <using namespace="HPE"/> | ||
22 | <using namespace="Tensor"/> | ||
23 | |||
24 | <enum name="DeviceClass" type="Tensor.int8" default="undefined"> | ||
25 | <comment> | ||
26 | Device class enumeration specifies the class or primary use of the device. | ||
27 | This allows probe data recorded to be analyzed by classes of devices. | ||
28 | </comment> | ||
29 | <literal name ="undefined" value="0"/> | ||
30 | <literal name ="mobileSmartphone" value="1"/> | ||
31 | <literal name ="mobilePad" value="2"/> | ||
32 | <literal name ="mobileTablet" value="3"/> | ||
33 | <literal name ="mobileOther" value="4"/> | ||
34 | <literal name ="iotTag" value="5"/> | ||
35 | <literal name ="iotComm" value="6"/> | ||
36 | <literal name ="iotStatic" value="7"/> | ||
37 | <literal name ="iotOther" value="8"/> | ||
38 | <literal name ="autoTrack" value="9"/> | ||
39 | <literal name ="autoNav" value="10"/> | ||
40 | <literal name ="autoOther" value="11"/> | ||
41 | </enum> | ||
42 | |||
43 | <struct name="ProbeRecord"> | ||
44 | <comment> | ||
45 | A record capturing RF and otherinformation at a specified location. Probe records are captured | ||
46 | as part of probe data collected by probe devices. | ||
47 | </comment> | ||
48 | <elem name="state" multiplicity="1" type="StateInfo"> | ||
49 | <comment> | ||
50 | Required device position and other state information. At least one of | ||
51 | observations or state is required, otherwise there is insufficient data to process. | ||
52 | </comment> | ||
53 | </elem> | ||
54 | <elem name="floor" multiplicity="1" type ="int8" default="0"> | ||
55 | <comment>The floor number of this scan</comment> | ||
56 | </elem> | ||
57 | <elem name="obsset" multiplicity="1" type="ObservationSet" > | ||
58 | <comment> | ||
59 | Set of observation data containing the probe measurements. | ||
60 | </comment> | ||
61 | </elem> | ||
62 | <elem name="name" multiplicity ="0..1" type="string"> | ||
63 | <comment>Optional Name of this probe location.</comment> | ||
64 | </elem> | ||
65 | <elem name="description" multiplicity ="0..1" type="string"> | ||
66 | <comment>Optional human readable description.</comment> | ||
67 | </elem> | ||
68 | <elem name="address" multiplicity ="0..1" type="AddressInfo" > | ||
69 | <comment>Optional address information.</comment> | ||
70 | </elem> | ||
71 | <elem name="contact" multiplicity ="0..1" type="ContactInfo" > | ||
72 | <comment> | ||
73 | Optional contact information. These are for probes locations typically associated with | ||
74 | a business or public entity that has associated contact information. | ||
75 | </comment> | ||
76 | </elem> | ||
77 | <elem name="data" multiplicity ="0..1" type="Tensor.json"> | ||
78 | <comment>Optional other information describing this probe location in json format.</comment> | ||
79 | </elem> | ||
80 | </struct> | ||
81 | |||
82 | <struct name ="ProbeSourceInfo"> | ||
83 | <comment> | ||
84 | Structure contains information about the probe data source. | ||
85 | </comment> | ||
86 | <elem name="classDevice" multiplicity="1" type="DeviceClass" > | ||
87 | <comment>Required field specifies the class of device used to collect the probe data.</comment> | ||
88 | </elem> | ||
89 | <elem name="modelDevice" multiplicity ="1" type="Tensor.string"> | ||
90 | <comment>String defining a device</comment> | ||
91 | </elem> | ||
92 | <elem name="mfgDevice" multiplicity ="1" type="Tensor.string"> | ||
93 | <comment>Optional device manufacturer information.</comment> | ||
94 | </elem> | ||
95 | <elem name="osNameVer" multiplicity ="1" type="Tensor.uri"> | ||
96 | <comment>Operating system name use the format [os: e.g. windows, android, iphone, custom]/[version: information]/[language]/[etc].</comment> | ||
97 | </elem> | ||
98 | <elem name="appNameVer" multiplicity ="1" type="Tensor.string"> | ||
99 | <comment>Specifies the application/library name with version information with the following format.[app name]/[ver].</comment> | ||
100 | </elem> | ||
101 | <elem name="idUser" multiplicity ="0..1" type="Tensor.string"> | ||
102 | <comment>Optional user identifier.</comment> | ||
103 | </elem> | ||
104 | <elem name="keySource" multiplicity="0..1" type="Tensor.string"> | ||
105 | <comment>Optional source key identifier, provides public key value to assist in authentication of probe information.</comment> | ||
106 | </elem> | ||
107 | </struct> | ||
108 | |||
109 | |||
110 | <!-- | ||
111 | ******************************************************* | ||
112 | Probe Submission API | ||
113 | ******************************************************* | ||
114 | --> | ||
115 | <interface name="Probe"> | ||
116 | <comment>Interface for submitting RF probe data.</comment> | ||
117 | |||
118 | <operation name="Submit"> | ||
119 | <comment> | ||
120 | Interaction submits probe data and outputs responds with operation result. | ||
121 | </comment> | ||
122 | <input name="input" type="Tensor.InputBase" sid="0x1032"> | ||
123 | <elem name="captureDate" type="datetime" multiplicity="1"> | ||
124 | <comment>General date and time probe data was captured.</comment> | ||
125 | </elem> | ||
126 | <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0" > | ||
127 | <comment> | ||
128 | Probe data and source information encoding format. Probe records may be passed to the service in | ||
129 | an encoding format different than that outer wire format. This can protect sensitive data. | ||
130 | By default wire protocol native format is assumed. | ||
131 | </comment> | ||
132 | </elem> | ||
133 | <elem name="sourceInfo" type="ProbeSourceInfo" multiplicity="0..1" encoding ="encoding"> | ||
134 | <comment> | ||
135 | Optional source information. If not provided, probe data will ultimately have a low veracity score. If at all possible | ||
136 | probe data should have source information. The system correlates source data with other known sources to calculate veracity. | ||
137 | </comment> | ||
138 | </elem> | ||
139 | <elem name="probes" multiplicity ="0..*" type="ProbeRecord" encoding ="encoding"> | ||
140 | <comment>Zero or more probe records encoded in the specified format.</comment> | ||
141 | </elem> | ||
142 | </input> | ||
143 | </operation> | ||
144 | </interface> | ||
145 | |||
146 | </namespace> | ||
147 | </specification> |
ILP/SLAM/V1.0.0_alpha/README.md
deleted
100644 → 0
1 | # SLAM XIDs # | ||
2 | SLAM 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/SLAM/V1.0.0_alpha/XIDData.prop \ | ||
13 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/CommonDefs.xid.xml \ | ||
14 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/ReferenceData.xid.xml \ | ||
15 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid.xml \ | ||
16 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/SurveyApi.xid.xml \ | ||
17 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/ProbeApi.xid.xml \ | ||
18 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileManagementApi.xid.xml \ | ||
19 | https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileServiceApi.xid.xml | ||
20 | |||
21 | OR | ||
22 | |||
23 | $ java -Xnoclassgc -jar $XIDSDK/bin/xidcg.jar \ | ||
24 | -v \ | ||
25 | -prop ../../Tensor/V1.0.0/XIDData.prop \ | ||
26 | -prop ../../HPE/V1.2/XIDData.prop \ | ||
27 | -prop XIDData.prop \ | ||
28 | CommonDefs.xid.xml \ | ||
29 | ReferenceData.xid.xml \ | ||
30 | TileDefinitions.xid.xml \ | ||
31 | SurveyApi.xid.xml \ | ||
32 | ProbeApi.xid.xml \ | ||
33 | TileManagementApi.xid.xml \ | ||
34 | TileServiceApi.xid.xml | ||
35 | ~~~ | ||
36 | |||
37 | If xidcg reports: | ||
38 | |||
39 | ~~~ | ||
40 | Generating: xidout/meta/XID/XIDData.prop | ||
41 | ~~~ | ||
42 | |||
43 | Then something has changed and XIDData.prop needs to get updated. | ||
44 |
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="ReferenceData.xid.xml"> | ||
8 | <title>SLAM Tile reference data</title> | ||
9 | <comment>This file defines the SLAM tile refeence definitions and related data types.</comment> | ||
10 | |||
11 | <!-- Include all known definitions --> | ||
12 | <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" /> | ||
13 | <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" /> | ||
14 | <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" /> | ||
15 | <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/CommonDefs.xid.xml" local="SLAM/Commondefs.xid.xml" /> | ||
16 | |||
17 | <namespace name="SLAM"> | ||
18 | |||
19 | <using namespace="HPE"/> | ||
20 | <using namespace="Tensor"/> | ||
21 | <using namespace="HPE.WiFi"/> | ||
22 | <using namespace="HPE.Cellular"/> | ||
23 | |||
24 | <enum name="RefPointSyncStatus" type="Tensor.int8" default ="sync_required"> | ||
25 | <comment>synchronization status of the reference point</comment> | ||
26 | <literal name="sync_required" value="0"/> | ||
27 | <literal name="in_sync" value="1"/> | ||
28 | </enum> | ||
29 | |||
30 | <enum name="RefPointUseStatus" type="Tensor.int8" default ="unknown"> | ||
31 | <comment>use status of the reference point</comment> | ||
32 | <literal name="unknown" value="0"/> | ||
33 | <literal name="outdated" value="1"/> | ||
34 | <literal name="valid" value="2"/> | ||
35 | <literal name="quarantined" value="3"/> | ||
36 | <literal name="invalid" value="4"/> | ||
37 | <literal name="deprecated" value="5"/> | ||
38 | <literal name="discardable" value="6"/> | ||
39 | </enum> | ||
40 | |||
41 | <enum name="RefPointType" type="Tensor.int8" default="undefined"> | ||
42 | <comment>Specifies the format of the Reference data.</comment> | ||
43 | <literal name="undefined" value="0"/> | ||
44 | <literal name="RF" value="1"/> | ||
45 | <literal name="Cellular" value="2"/> | ||
46 | <literal name="Wifi" value="3"/> | ||
47 | <literal name="Bluetooth" value="4"/> | ||
48 | <literal name="GenericRF" value="5"/> | ||
49 | </enum> | ||
50 | |||
51 | <struct name="RefPoint" > | ||
52 | <comment>defines the base structure of a reference point</comment> | ||
53 | <elem name="type" type="RefPointType" multiplicity="1" rttd="true"> | ||
54 | <comment>Identifies the format/type of the reference data.</comment> | ||
55 | </elem> | ||
56 | |||
57 | <elem name="id" multiplicity="1" type="HashKey" > | ||
58 | <comment>a unique hash of the reference data format and reference point identifier, which is different, depending on the type of the Reference point</comment> | ||
59 | </elem> | ||
60 | |||
61 | <elem name="position" multiplicity="0..1" type="Spheroid" > | ||
62 | <comment>the estimated position of the access point</comment> | ||
63 | </elem> | ||
64 | |||
65 | <elem name ="veracity" multiplicity="1" type="Tensor.float32"> | ||
66 | <comment>The veracity of the reference point, 1= 100% trusted and validated, 0% not trusted at all.</comment> | ||
67 | </elem> | ||
68 | |||
69 | <elem name="usestatus" multiplicity="1" type="RefPointUseStatus"> | ||
70 | <comment>status of the reference point</comment> | ||
71 | </elem> | ||
72 | <elem name="validbegin" type="datetime" multiplicity="1"> | ||
73 | <comment>time stamp of the begining of the valid period</comment> | ||
74 | </elem> | ||
75 | <elem name="validend" type="datetime" multiplicity="1"> | ||
76 | <comment>time stamp of the ending of the valid period</comment> | ||
77 | </elem> | ||
78 | <elem name ="data" type="Tensor.json" multiplicity="0..1"> | ||
79 | <comment>json formatted data specific to the device</comment> | ||
80 | </elem> | ||
81 | <elem name="floor" multiplicity ="0..1" type="int8" > | ||
82 | <comment>Optional floor identifier, default is zero meaning the ground floor</comment> | ||
83 | </elem> | ||
84 | |||
85 | </struct> | ||
86 | |||
87 | <!-- ReferencePoint --> | ||
88 | <struct name="RFRefPoint" type="RefPoint" rttkey="SLAM.RefPointType.RF"> | ||
89 | |||
90 | <comment>structure defines a reference Point.</comment> | ||
91 | <elem name="txpwr" type="Tensor.float32" multiplicity="1"> | ||
92 | <comment>transmission power</comment> | ||
93 | </elem> | ||
94 | <elem name="attenuation" type="Tensor.float32" multiplicity="1"> | ||
95 | <comment> attenuation exponent</comment> | ||
96 | </elem> | ||
97 | <elem name="freq" type="Tensor.float32" multiplicity="1"> | ||
98 | <comment> radio frequency of the reference in Hz</comment> | ||
99 | </elem> | ||
100 | |||
101 | </struct> | ||
102 | |||
103 | <struct name="WifiRefPoint" type="RFRefPoint" rttkey="SLAM.RefPointType.Wifi"> | ||
104 | |||
105 | <elem name="ssid" type="HPE.WiFi.SSID" multiplicity="1"> | ||
106 | <comment>ssid of the access point</comment> | ||
107 | </elem> | ||
108 | <elem name ="macaddr" type="mac48" multiplicity="1"> | ||
109 | <comment>the mac address of the access point</comment> | ||
110 | </elem> | ||
111 | |||
112 | </struct> | ||
113 | |||
114 | <struct name="BluetoothRefPoint" type="RFRefPoint" rttkey="SLAM.RefPointType.Bluetooth"> | ||
115 | |||
116 | <elem name="ssid" type="Tensor.string" multiplicity="1"> | ||
117 | <comment>ssid of the access point</comment> | ||
118 | </elem> | ||
119 | <elem name ="macaddr" type="Tensor.string" multiplicity="1"> | ||
120 | <comment>the mac address of the access point</comment> | ||
121 | </elem> | ||
122 | |||
123 | </struct> | ||
124 | |||
125 | <struct name="CellularRefPoint" type="RFRefPoint" rttkey="SLAM.RefPointType.Cellular"> | ||
126 | |||
127 | <elem name ="cid" type="CellId" multiplicity="1"/> | ||
128 | <elem name ="antenna" type="AntennaSpec" multiplicity="1"/> | ||
129 | </struct> | ||
130 | |||
131 | <struct name="GenericRFRefPoint" type="RFRefPoint" rttkey="SLAM.RefPointType.GenericRF"> | ||
132 | <elem name="uri" type="Tensor.uri" multiplicity="1"> | ||
133 | <comment>identifier that determines the genericRF type and unique identifier. encoded into the hash key</comment> | ||
134 | </elem> | ||
135 | |||
136 | </struct> | ||
137 | |||
138 | <struct name="RefPointSet"> | ||
139 | <comment>a set of reference points</comment> | ||
140 | <elem name="refpoints" type="RefPoint" multiplicity="0..*" polymorphic="true"/> | ||
141 | |||
142 | </struct> | ||
143 | |||
144 | </namespace> | ||
145 | </specification> |
1 | <?xml version="1.0" encoding="UTF-8" ?> | ||
2 | |||
3 | <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd" | ||
4 | xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd" | ||
5 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
6 | xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd" | ||
7 | identity="SurveyApi.xid.xml"> | ||
8 | <title>SLAM Survey API Specifications</title> | ||
9 | <comment> | ||
10 | This file defines the SLAM survey API. The survey API is used to bulk load high-definition survey | ||
11 | data from one or more probe data sets. | ||
12 | </comment> | ||
13 | |||
14 | <!-- Include all known definitions --> | ||
15 | <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" /> | ||
16 | <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" /> | ||
17 | <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" /> | ||
18 | <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="piBase.xid.xml" /> | ||
19 | <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid.xml" local="SLAM/TileDefinitions.xid.xml" /> | ||
20 | |||
21 | <namespace name="SLAM"> | ||
22 | <using namespace="HPE"/> | ||
23 | <using namespace="Tensor"/> | ||
24 | |||
25 | <!-- | ||
26 | ******************************************************* | ||
27 | Survey Submission API | ||
28 | ******************************************************* | ||
29 | --> | ||
30 | <interface name="Survey"> | ||
31 | <comment>Interface for submitting SLAM compliant survey data.</comment> | ||
32 | |||
33 | <operation name="Submit"> | ||
34 | <comment> | ||
35 | Interaction submits survey data and outputs submission result and UUID. | ||
36 | </comment> | ||
37 | <input name="input" type="Tensor.InputBase" sid="0x1030"> | ||
38 | <elem name="survey" multiplicity="1" type="SurveyData"></elem> | ||
39 | </input> | ||
40 | <output name="output" type="Tensor.OutputBase" sid="0x1031"> | ||
41 | <comment>Survey submission output returns status and UUID of the submitted survey.</comment> | ||
42 | <elem name="id" multiplicity="1" type="Tensor.UUID"/> | ||
43 | </output> | ||
44 | </operation> | ||
45 | |||
46 | <operation name="Download"> | ||
47 | <comment>Downloads survey data given id.</comment> | ||
48 | <input name="input" type="Tensor.InputBase" sid="0x1032"> | ||
49 | <elem name="id" multiplicity="1" type="Tensor.UUID"> | ||
50 | <comment>UUID of Survey set.</comment> | ||
51 | </elem> | ||
52 | <elem name="part" multiplicity="1" type="Tensor.int32" default="-1"> | ||
53 | <comment>Survey part id of interest. Default value is -1, which will return </comment> | ||
54 | </elem> | ||
55 | </input> | ||
56 | <output name="output" type="Tensor.OutputBase" sid="0x1033"> | ||
57 | <comment>Survey download output data structure contains a zero or more surveys.</comment> | ||
58 | <elem name="surveys" multiplicity="0..*" type="SurveyData"></elem> | ||
59 | </output> | ||
60 | </operation> | ||
61 | </interface> | ||
62 | |||
63 | </namespace> | ||
64 | </specification> |
This diff is collapsed.
Click to expand it.
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="TileManagementApi.xid.xml"> | ||
8 | <title>SLAM Tile Management API Specifications</title> | ||
9 | <comment>This file defines the SLAM tile management API.</comment> | ||
10 | |||
11 | <!-- Include all known definitions --> | ||
12 | <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="ApiBase.xid.xml" /> | ||
13 | <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/ReferenceData.xid.xml" local="SLAM/ReferenceData.xid.xml" /> | ||
14 | <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid.xml" local="SLAM/TileDefinitions.xid.xml" /> | ||
15 | |||
16 | |||
17 | <namespace name="SLAM"> | ||
18 | <using namespace="HPE"/> | ||
19 | <using namespace="Tensor"/> | ||
20 | |||
21 | <!-- | ||
22 | ******************************************************* | ||
23 | Tile Management API | ||
24 | ******************************************************* | ||
25 | --> | ||
26 | <interface name="TileManagement"> | ||
27 | <comment>Interface for submitting a new tile to the DB. </comment> | ||
28 | <operation name="DeleteTile"> | ||
29 | <comment> | ||
30 | Interaction to delete a tile. | ||
31 | </comment> | ||
32 | <input name="input" type="Tensor.InputBase" sid="0x101b"> | ||
33 | <comment>defines the input data for DeleteTile operation</comment> | ||
34 | <elem name="tileid" type="Tensor.UUID" multiplicity="1" > | ||
35 | <comment>element specifies UUID of the the tile</comment> | ||
36 | </elem> | ||
37 | </input> | ||
38 | </operation> | ||
39 | |||
40 | <operation name="UploadTile"> | ||
41 | |||
42 | <comment>interation to upload a tile</comment> | ||
43 | <input name="input" type="Tensor.InputBase" sid="0x102b"> | ||
44 | <comment>defines the input data structure for UploadTile operation</comment> | ||
45 | <elem name="tile" type="Tile" multiplicity="1"> | ||
46 | <comment>the tile structure</comment> | ||
47 | </elem> | ||
48 | </input> | ||
49 | </operation> | ||
50 | |||
51 | <operation name="UpdateTile"> | ||
52 | |||
53 | <comment>interation to update a tile</comment> | ||
54 | <input name="input" type="Tensor.InputBase" sid="0x103b"> | ||
55 | <comment>defines the input data structure for UpdateTile operation</comment> | ||
56 | <elem name="tile" type="Tile" multiplicity="1"> | ||
57 | <comment>the tile structure</comment> | ||
58 | </elem> | ||
59 | </input> | ||
60 | |||
61 | </operation> | ||
62 | |||
63 | </interface> | ||
64 | |||
65 | </namespace> | ||
66 | </specification> |
1 | <?xml version="1.0" encoding="UTF-8" ?> | ||
2 | |||
3 | <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd" | ||
4 | xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd" | ||
5 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
6 | xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd" | ||
7 | identity="TileServiceApi.xid.xml"> | ||
8 | <title>Tile Services API Specifications</title> | ||
9 | <comment>This file defines the SLAM tile services API.</comment> | ||
10 | |||
11 | <!-- Include all known definitions --> | ||
12 | <import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" /> | ||
13 | <import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" /> | ||
14 | <import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.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/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid.xml" local="SLAM/TileDefinitions.xid.xml" /> | ||
17 | |||
18 | |||
19 | <namespace name="SLAM"> | ||
20 | <using namespace="HPE"/> | ||
21 | <using namespace="Tensor"/> | ||
22 | |||
23 | <interface name="TileService"> | ||
24 | <comment>Interface for tile service. </comment> | ||
25 | |||
26 | <!-- DownloadTile operation--> | ||
27 | <operation name="DownloadTile"> | ||
28 | <comment>Interaction download a tile</comment> | ||
29 | <input name="input" type="Tensor.InputBase" sid="0x101a"> | ||
30 | <comment>defines the input data structure for DownloadTile operation </comment> | ||
31 | <elem name="tileid" type="Tensor.UUID" multiplicity="1" > | ||
32 | <comment>element specifies UUID of the the tile</comment> | ||
33 | </elem> | ||
34 | </input> | ||
35 | |||
36 | <output name="output" type="Tensor.OutputBase" sid="0x102a"> | ||
37 | <comment>defines the output data for DownloadTile operation</comment> | ||
38 | <elem name="tile" type="Tile" multiplicity="0..1" > | ||
39 | <comment>element defines the downloaded tile</comment> | ||
40 | </elem> | ||
41 | </output> | ||
42 | |||
43 | </operation> | ||
44 | |||
45 | <!-- FindTilesByBoundingbox operation --> | ||
46 | <operation name="FindTilesByBoundingbox"> | ||
47 | <comment>find tiles</comment> | ||
48 | <input name="input" type="Tensor.InputBase" sid="0x103a"> | ||
49 | <comment>defines the input data for FindTilesByBoundingbox operation </comment> | ||
50 | <elem name="bounding" type="BoundingBox" multiplicity="1"> | ||
51 | <comment>the bounding box that intersect with tiles</comment> | ||
52 | </elem> | ||
53 | <elem name="floor" type="Tensor.int16" multiplicity="0..1"> | ||
54 | <comment>optional floor number for more precise search</comment> | ||
55 | </elem> | ||
56 | </input> | ||
57 | |||
58 | <output name="output" type="Tensor.OutputBase" sid="0x104a"> | ||
59 | <comment>defines the output data for FindTilesByBoundingbox operation</comment> | ||
60 | <elem name="tiles" type="TileSet" multiplicity="0..1"> | ||
61 | <comment>a set of tiles as the result of the FindTilesByPos operation</comment> | ||
62 | </elem> | ||
63 | </output> | ||
64 | </operation> | ||
65 | |||
66 | <!-- FindTilesByRefId operation --> | ||
67 | <operation name="FindTilesByRefId"> | ||
68 | <comment>find tiles</comment> | ||
69 | <input name="input" type="Tensor.InputBase" sid="0x103a"> | ||
70 | <comment>defines the input data for FindTilesByRefId operation </comment> | ||
71 | <elem name="refids" type="Tensor.string" multiplicity="1..*"> | ||
72 | <comment>the bounding box that intersect with tiles</comment> | ||
73 | </elem> | ||
74 | <elem name="floor" type="Tensor.int16" multiplicity="0..1"> | ||
75 | <comment>optional floor number for more precise search</comment> | ||
76 | </elem> | ||
77 | <elem name="signaltype" type="ObservationType" multiplicity="1"> | ||
78 | <comment>the radio type of the reference points</comment> | ||
79 | </elem> | ||
80 | </input> | ||
81 | |||
82 | <output name="output" type="Tensor.OutputBase" sid="0x104a"> | ||
83 | <comment>defines the output data for FindTilesByRefId operation</comment> | ||
84 | <elem name="tiles" type="TileSet" multiplicity="0..1"> | ||
85 | <comment>a set of tiles as the result of the FindTilesByPos operation</comment> | ||
86 | </elem> | ||
87 | </output> | ||
88 | </operation> | ||
89 | |||
90 | <!-- EstimatePosition operation --> | ||
91 | <operation name="EstimatePosition"> | ||
92 | <comment> estimate posiion from a set of Wifi rssi observations</comment> | ||
93 | <input name="input" type="Tensor.InputBase" sid="0x106a"> | ||
94 | <comment>input for EstimatePosition operation</comment> | ||
95 | <elem name="observations" type="ObservationSet" multiplicity="1"> | ||
96 | <comment>a set of observed rssi values</comment> | ||
97 | </elem> | ||
98 | </input> | ||
99 | |||
100 | <output name="output" type="Tensor.OutputBase" sid="0x107a"> | ||
101 | <comment>output for EstimatePosition operation</comment> | ||
102 | <elem name="pos" type="Shape" multiplicity="0..*" polymorphic="true"> | ||
103 | <comment>approximate position of the tile</comment> | ||
104 | </elem> | ||
105 | |||
106 | </output> | ||
107 | </operation> | ||
108 | |||
109 | </interface> | ||
110 | |||
111 | </namespace> | ||
112 | </specification> |
ILP/SLAM/V1.0.0_alpha/XIDData.prop
deleted
100644 → 0
This diff is collapsed.
Click to expand it.
-
Please register or sign in to post a comment