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
<?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="HpeCellular.xid.xml">
<title>HPE Celullar Data Definition</title>
<comment>File contains data definitions for 2G, 3G, and 4G HPE location related datatypes.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<namespace name="HPE.Cellular">
<using namespace="Tensor"/>
<using namespace="HPE"/>
<enum name="RadioType" type="Tensor.uint8" default="undefined">
<comment>Specifies the specific variant of Radio Data.</comment>
<literal name="undefined" value="0"/>
<literal name="GSM" value="1"/>
<literal name="WCDMA" value="2"/>
<literal name="LTE" value="3"/>
<literal name="CDMA" value="4"/>
</enum>
<enum name="DuplexMode" type="Tensor.int8" default="FDD">
<comment>Defines the communication duplexing mode.</comment>
<literal name="FDD" value="0"/>
<literal name="TDD" value="1"/>
</enum>
<enum name="TimeAdvMode" type="Tensor.int8" default="RAW">
<comment>Defines Time Advance measurement mode.</comment>
<literal name="TYPE1" value="0"/>
<literal name="TYPE2" value="1"/>
<literal name="UE" value="2"/>
<literal name="SUPL" value="3"/>
<literal name="RAW" value="4"/>
</enum>
<!-- Referece Data types-->
<struct name="CellId" pack="true">
<comment>
CellIDInfo is a structure that uniquely identifies the Cell Tower in the cellular network.\n
It relies on the RadioType field to interpret the meaning of specific fields.</comment>
<elem name ="rtype" type="RadioType" multiplicity="1"/>
<elem name ="mncLength" type="uint8" multiplicity="1">
<comment>
Indicates number of digits for MNC to pad to (2 or 3).\n
If unknown, use 0.\n
For:\n
\t rtype=4(CDMA), this field is ignored.
</comment>
</elem>
<elem name ="mcc" type="uint16" multiplicity="1">
<comment>Mobile Country Code.</comment>
</elem>
<elem name ="mnc" type="uint16" multiplicity="1">
<comment>
Mobile Network Code.\n
For:\n
\t rtype=4(CDMA) this field is the SID
</comment>
</elem>
<elem name ="lac" type="uint16" multiplicity="1">
<comment>
Location Area Code.\n
For:\n
\t rtype=3(LTE) this field is the TAC.\n
\r rtype=4(CDMA) this field is the NID.
</comment>
</elem>
<elem name ="cid" type="uint32" multiplicity="1">
<comment>
Cell ID.\n
For:\n
\t rtype=4(CDMA) this field is the BID.
</comment>
</elem>
</struct>
<struct name="AntennaSpec" pack="true">
<comment>Specifies the details about a specific antenna.</comment>
<comment>Geometric specification matches HPE.ArcBand3D</comment>
<elem name ="sectorid" type="uint16" multiplicity="1"/>
<elem name ="height" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>Height of the antenna from the CellLocInfo altitude.</comment>
</elem>
<elem name ="direction" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>angle from north to center of arc; aka orientation. 0 &lt;= direction &lt; 360.</comment>
</elem>
<elem name ="tilt" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>Vertical tilt from horizon.</comment>
</elem>
<elem name="opening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>Coverage angle of the antenna face; half on either side of direction. 0 &lt; opening &lt;= 360.</comment>
</elem>
<elem name="vopening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>Vertical coverage angle of the antenna face; half on either side of tilt 0 &lt; opening &lt;= 360.</comment>
</elem>
<elem name="radius" type="uint32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>Maximum antenna radius; distance the cell is usable at TxPower.
aka: MAR, SectorRadius
</comment>
</elem>
<elem name="TxPower" type="float64" multiplicity="1">
<tag name="unit" value="dBm"/>
<comment>Transmit power.</comment>
</elem>
<elem name="frequency" type="float64" multiplicity="1">
<tag name="unit" value="Hz"/>
<comment>Radio frequency of the transimitted signal</comment>
</elem>
<elem name="RTTCalib" type="float32" multiplicity="1">
<tag name="unit" value="meter"/>
<comment>RTT Calibration is the survey result of the average RTT error of the cell in meters. Set to zero when not available</comment>
</elem>
<elem name="RTTCalibUncert" type="float32" multiplicity="1">
<tag name="unit" value="meter"/>
<comment>standard deviation of the RTTCalib. set to zero if not available</comment>
</elem>
</struct>
<struct name="CellLocInfo" pack="true">
<comment>Geometric specification matches HPE.Spheroid</comment>
<comment>Provides the Cell tower location estimate @ 68% confidence</comment>
<elem name="lat" type="float64" multiplicity="1">
<tag name="unit" value="WGS84"/>
</elem>
<elem name="lon" type="float64" multiplicity="1">
<tag name="unit" value="WGS84"/>
</elem>
<elem name="alt" type="float64" multiplicity="1">
<tag name="unit" value="WGS84"/>
</elem>
<elem name="radius" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>Horizontal uncertainty of cell-site position at 68% confidence. 0 &lt;= hunc </comment>
</elem>
<elem name="vert" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>Vertical uncertainty of cell-site position at 68% confidence. 0 &lt;= vunc</comment>
</elem>
</struct>
<struct name="CellAntReferenceData" type="HPE.ReferenceData" pack="true" rttkey="HPE.RefDataFormat.CELLULAR">
<comment>
Data provdes a complete set of information for a particular antenna typically associated with one or more observations.
The default RefDataFormat is CELLULAR.
</comment>
<elem name ="cid" type="CellId" multiplicity="1"/>
<elem name ="antenna" type="AntennaSpec" multiplicity="1"/>
<elem name ="location" type="CellLocInfo" multiplicity="1"/>
</struct>
<!-- Observation Data types-->
<struct name="MSISDNObservation" type="Observation" pack="true" rttkey="HPE.ObservationType.MSISDN">
<comment>
MSISDN only observation. Observation must comply with E.164 standard in section 6.2.1
(https://www.itu.int/rec/T-REC-E.164-201011-I/en).
</comment>
<elem name ="cc" type="uint16" multiplicity="1" default="1">
<tag name="unit" value="1 to 3 digits"/>
<comment>
Country Code must have one (1) to three (3) digits.</comment>
</elem>
<elem name ="nsn" type="uint64" multiplicity="1">
<tag name="unit" value="digits as a regular number"/>
<comment>
NSNs can have up to 12 digits.
</comment>
</elem>
</struct>
<struct name="CellularObservation" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.CELLID">
<comment>CellID only observation.</comment>
<comment>Also, base type for all cellular measurements.</comment>
<elem name ="cid" type="CellId" multiplicity="1"/>
</struct>
<!-- 2G Observations -->
<struct name="TimeAdvance" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.GSM_TA">
<comment>TimeAdvanceInfo is a structure which defines the Time Advance measurements of a base station.</comment>
<elem name ="ta" type="uint16" multiplicity="1">
<tag name="unit" value="bit period = 48/13 micro-second"/>
<comment>Range 0-255, values over 63 correspond to the access delay measured by the BTS.</comment>
<comment>Unit: 1 bits period = 48/13 micro-second</comment>
</elem>
</struct>
<struct name="NMRInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.GSM_NMR">
<comment>
NMRInfo is a structure that defines important elements
in the network measurement report in GSM network.
</comment>
<elem name ="arfcn" type="uint16" multiplicity="1">
<comment>Absolute RF channel number. Range 0-1023.</comment>
</elem>
<elem name ="bsic" type="uint16" multiplicity="1">
<comment>Bsic Station Identity Code GSM 03.03. Range 0-63.</comment>
</elem>
<elem name ="rxlevel" type="uint16" multiplicity="1">
<comment>Corresponds according to the mapping defined in TS. GSM 05.08 to the received signal
strength on carrier N. N is the index to the frequency
in the sorted list of frequencies defined in the
EXTENDED MEASUREMENT ORDER message. Range 0-63.
</comment>
</elem>
</struct>
<!-- 3G Observation data types.-->
<struct name="RttInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.RTT_3G">
<comment>RTTInfo is a structure which defines the round trip time measured results in 3G network.</comment>
<elem name ="tamode" type="TimeAdvMode" multiplicity="1">
<comment>Measurement mode of the Roud Trip Time. Currently the RTT structure is only valid for FDD</comment>
<comment>Only Type1 and Type2 in TimeAdvMode are valid in RTT structure, need to ignore SUPL, RAW, UE</comment>
</elem>
<elem name ="rxtxtime" type="uint16" multiplicity="1">
<comment>
RxTxTime depends on duplex mode.
TDD: 0-8191
FDD: 768..1280
</comment>
</elem>
<elem name ="quality" type="uint8" multiplicity="1">
<comment>Quality of the UE Rx-Tx time difference measurement.</comment>
</elem>
<elem name ="rtt" type="uint16" multiplicity="1">
<comment>Round Trip Time measurement. Range = 0-32766</comment>
</elem>
<elem name ="exrtt" type="uint32" multiplicity="1">
<comment>Extended Round Trip Time continuation of intervals. 32767..103041</comment>
</elem>
</struct>
<struct name="MeasuredResultInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.MR_3G">
<comment>3G MeasuredResultInfo is a structure which defines the measured result.</comment>
<elem name ="dupmode" type="DuplexMode" multiplicity="1">
<comment>Duplex mode of the cell.</comment>
</elem>
<elem name ="cpichRSCP" type="uint8" multiplicity="1">
<comment>Range 0 to 63</comment>
</elem>
<elem name ="cpichEcNO" type="uint8" multiplicity="1">
<comment>Range 0 to 63</comment>
</elem>
<elem name ="pathloss" type="uint8" multiplicity="1">
<comment>Range 0 to 127</comment>
</elem>
<elem name ="deltaRSCP" type="int8" multiplicity="1">
<comment>Range (-5) to (-1)</comment>
</elem>
</struct>
<!-- 4G Datatypes -->
<struct name="LteTimeAdvanceInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.LTE_TA">
<comment>LTE timing advance information typically provided by the serving cell.</comment>
<elem name ="tamode" type="TimeAdvMode" multiplicity="1">
<comment>Measurement mode of the Time Advance.</comment>
</elem>
<elem name ="ta" type="uint16" multiplicity="1">
<comment>Timing Advance, range: (0...7690) (as per 3GPP 36.321).</comment>
</elem>
<elem name ="aoa" type="uint16" multiplicity="1">
<comment>Angle of Arrival</comment>
</elem>
<elem name ="uerxtx" type="uint16" multiplicity="1">
<comment>RxTx time measured from User Entity. Range(0...4095)</comment>
</elem>
</struct>
<struct name="LteRssiInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.LTE_RSSI">
<comment>
LTERSSIInfo is a 4G LTE structure which defines the signal RSSI information.
</comment>
<elem name ="rsrp" type="uint8" multiplicity="1">
<tag name="unit" value="dBm"/>
<comment>Reference signal received power</comment>
</elem>
<elem name ="rsrq" type="uint8" multiplicity="1">
<tag name="unit" value="dB"/>
<comment>Reference signal received quality</comment>
</elem>
<elem name ="nprb" type="uint8" multiplicity="1">
<tag name="unit" value="dimensionless"/>
<comment>Number of channels used to calculate rsrp</comment>
</elem>
</struct>
<struct name="GenericInfo" type="CellularObservation" pack="true" rttkey="HPE.ObservationType.CELLULAR_GENERIC">
<comment>Observation type specifies a common cellular observation in generic units. Sometimes observations are translated into a simpler format for transport.</comment>
<elem name ="rss" type="float32" multiplicity="1">
<comment>Received Signal Strength (RSS), the value is 0 if not defined. The units are -dBm.</comment>
</elem>
<elem name ="rssUncert" type="uint8" multiplicity="1">
<comment>RSS standard deviation uncertainty in dB units. the value is 0 if not defined or unknown.</comment>
</elem>
<elem name ="taLowPart" type="uint16" multiplicity="1">
<comment>Low part of timing advance measurement. Range is 0 to 49,999 nsecs (max 15km). Value is 0 if not defined</comment>
</elem>
<elem name ="taHighPart" type="uint8" multiplicity="1">
<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>
</elem>
<elem name ="taUncert" type="uint16" multiplicity="1">
<comment>Timing advance standard deviation uncertainty in nanosecond units. The value is 0 if not defined.</comment>
</elem>
<elem name ="service" type="bool" multiplicity="1">
<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>
</elem>
</struct>
<!--
<struct name="" type="CellularObservation" pack="true">
<comment></comment>
<elem name ="" type="uint16" multiplicity="1">
<comment></comment>
</elem>
<elem name ="" type="uint16" multiplicity="1">
<comment></comment>
</elem>
</struct>
-->
</namespace>
</specification>
HPE/V1.2/HpeCore.xid.xml 0 → 100644
<?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="HpeCore.xid.xml">
<title>HPE Core Definitions</title>
<comment>This file contains the core definitions used by the HPE.</comment>
<import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
<import ref="https://xid.location.studio/Tensor/V1.0.0/Common.xid.xml" local="Common.xid.xml" />
<namespace name="HPE">
<using namespace="Tensor"/>
<!--
*******************************************************
Standard Definitions
*******************************************************
-->
<enum name="ProcessingStatus" type="Tensor.int8" default="undefined">
<comment>Status resulting from processing the observation data.</comment>
<literal name="success" value="1"/>
<literal name="undefined" value="0"/>
<literal name="did_not_converge" value="-1"/>
<literal name="not_enough_data" value="-2" />
<literal name="computation_error" value="-3" />
<literal name="parsing_error" value="-4" />
<literal name="not_found" value="-5" />
<literal name="unknown_error" value="-6" />
</enum>
<enum name="DynamicsProfile" type="Tensor.int8" default="undefined">
<literal name="undefined" value="0"/>
<literal name="stationary" value="1" />
<literal name="spacecraft" value="2" />
<literal name="aircraft" value="3" />
<literal name="marinecraft" value="4" />
<literal name="landcraft" value="5" />
<literal name="bicycle" value="6" />
<literal name="pedestrian" value="7" />
<literal name="pedestrian_running" value="8" />
<literal name="pedestrian_jogging" value="9" />
<literal name="pedestrian_walking" value="10" />
</enum>
<enum name="EstimateRanking" type="Tensor.int8" default="calcorder">
<literal name="undefined" value="0"/>
<literal name="accuracy" value="1" />
<literal name="veracity" value="2" />
<literal name="calcorder" value="3" />
</enum>
<enum name="ReferenceFrame" type="Tensor.int8" default="WGS84">
<literal name="undefined" value ="0"/>
<literal name="WGS84" value ="1" />
<literal name="RelativeENU" value="2"/>
<literal name="LocalXYZ" value="3" />
</enum>
<!--
*******************************************************
Observation Datatypes
*******************************************************
-->
<enum name="ObservationType" type="Tensor.int8" default="undefined">
<literal name="undefined" value="0"/>
<literal name="SHAPE" value="1"/>
<literal name="MSISDN" value="6"/>
<literal name="CELLID" value="7"/>
<literal name="GSM_TA" value="8"/>
<literal name="GSM_NMR" value="9"/>
<literal name="RTT_3G" value="10"/>
<literal name="MR_3G" value="11"/>
<literal name="LTE_TA" value="12"/>
<literal name="LTE_RSSI" value="13"/>
<literal name="WIFI_RSS" value="14"/>
<literal name="WIFI_RNG" value="15"/>
<literal name="BLE_RSS" value="16"/>
<literal name="CELLULAR_GENERIC" value="17">
<comment>Observation type specifies a common cellular observation in generic units.</comment>
</literal>
<literal name="GPS_CODEPHASE_8" value="18">
<comment>Eight standard GPS Code phase measurements (81 bytes).</comment>
</literal>
<literal name="GPS_CODEPHASE_MIN6" value="19">
<comment>Eight minimum size GPS Code phase measurements (51 bytes).</comment>
</literal>
<literal name="GPS_CODEPHASE_MIN8" value="20">
<comment>Eight minimum size GPS Code phase measurements (65 bytes).</comment>
</literal>
<literal name="GNSS_PSEUDORANGE" value="21">
<comment>GNSS Pseudorange measurements.</comment>
</literal>
<literal name="WIFI_RSS_EXT" value="22"/>
</enum>
<array name="ObservationTypeArray" type="ObservationType"/>
<array name="StateVector" type="float64" size="8" >
<comment>
Defines the HPE standard state column vector, which is comprised of the following elements in cartesian coordinates:
X,Y,Z, Xdot, Ydot, Zdot, clk, clkrate.
Unless using a different coordinate reference frame, these values are typically in WGS-84 ECEF reference frame, where the
units are meters, meters per second. Clock terms (clk and clkrate) are also expressed in meters and meters per second,
to provide similar scalaing to physical units. To get to seconds and seconds per second device by the speed of light.
</comment>
</array>
<array name="CovarianceMatrix" type="Tensor.float64" size="64" >
<comment>
Defines a 8x8 Covariance matrix for the HPE standard state vector. This provides a linearized correlation
matrix for the estimated state vector. This is the high-fidelity format for providing Gaussian error information
passed between calculation processes.al units. To get to seconds and seconds per second device by the speed of light.
</comment>
</array>
<struct name="Observation" pack="true">
<comment>Bass type for all observation data</comment>
<elem name="type" type="ObservationType" multiplicity="1" rttd="true">
<comment>Identifies what type of observation this is.</comment>
</elem>
</struct>
<struct name="ObservationEpoch" type="Observation" pack="true">
<comment>Bass type for time based observation data</comment>
<elem name="epoch" type="datetime" multiplicity="1">
<comment>
Date the observation was attained. For GPS observatios (GPS_CODEPHASE_8, GPS_CODEPHASE_MIN6, GPS_CODEPHASE_MIN8, GNSS_PSEUDORANGE),
the epoch time has to have at least millisecond resolution. Fraction of a second epoch error can cause hundreds of meters of error
in position.
</comment>
</elem>
</struct>
<struct name="ObservationSet">
<comment>A set of observations for a single device covering multiple epochs.</comment>
<elem name="observations" type="Observation" multiplicity="0..*" polymorphic="true"/>
</struct>
<!-- ShapeObservation -->
<!-- Disable for now
<struct name="ShapeObservation" type="Observation" pack="true" rttkey="HPE.ObservationType.SHAPE">
<comment>Observation is comprised of a shape.</comment>
<elem name="shape" type="Shape" multiplicity="1" polymorphic="true">
<comment>
The shape can be any one of the supported shape types inheriting from the Shape base type.
</comment>
</elem>
</struct>
-->
<!--
*******************************************************
Reference Datatypes
*******************************************************
-->
<enum name="RefDataFormat" type="Tensor.int8" default="undefined">
<comment>Specifies the format of the Reference data.</comment>
<literal name="undefined" value="0"/>
<literal name="GPS_EPHEMERIS" value="1"/>
<literal name="GPS_ALMANAC" value="2"/>
<literal name="GLONASS_EPHEMERIS" value="3"/>
<literal name="GALILEO_EPHEMERIS" value="4"/>
<literal name="CELLULAR" value="5"/>
<literal name="WIFI_AP" value="6"/>
</enum>
<array name="RefDataFormatArray" type="RefDataFormat"/>
<struct name="ReferenceData" pack="true">
<comment>Bass structure for all reference data types.</comment>
<elem name="format" type="RefDataFormat" multiplicity="1" rttd="true">
<comment>Identifies the format/type of the reference data.</comment>
</elem>
</struct>
<struct name="ReferenceDataSet">
<comment>A set of reference data.</comment>
<elem name ="id" type="UUID" multiplicity="1" />
<elem name="records" type="ReferenceData" multiplicity="1..*" polymorphic="true"/>
</struct>
<!--
*******************************************************
Shape Datatypes
*******************************************************
-->
<enum name="ShapeType" type="Tensor.int8" default="undefined">
<!-- we can reduce this set -->
<literal name="undefined" value="0"/>
<literal name="Covariance" value="1"/>
<literal name="Point2D" value="20"/>
<literal name="Circle" value="21"/>
<literal name="Ellipse" value="22"/>
<literal name="Arc" value="23"/>
<literal name="ArcBand" value="24"/>
<literal name="Point3D" value="30"/>
<literal name="Spheroid" value="31"/>
<literal name="Ellipsoid" value="32"/>
<literal name="Arc3D" value="33"/>
<literal name="ArcBand3D" value="34"/>
</enum>
<array name="ShapeTypeArray" type="ShapeType"/>
<struct name="Shape" pack="true">
<comment>
Shapes are used to describe various kinds of geometry.\n
When used in an Estimate result the Shape represents the
uncertainty area (2D) or uncertainty volume (3D) at the
confidence in the Estimate.
</comment>
<elem name="type" type="ShapeType" multiplicity="1" rttd="true">
<comment>This is the one thing all shapes have in common</comment>
</elem>
</struct>
<struct name="Covariance" type="Shape" rttkey="HPE.ShapeType.Covariance">
<comment>
Shape encapsulates the HPE eight parameter state estimate, which is the highest fidelity form
to transfer state estimates between calculators and the HPE filter.
</comment>
<elem name="state" type="StateVector" multiplicity="1"/>
<elem name="covariance" type="CovarianceMatrix" multiplicity="1"/>
<elem name="referenceframe" type="ReferenceFrame" multiplicity="1" default="ReferenceFrame::WGS84"/>
</struct>
<struct name="Point2D" type="Shape" rttkey="HPE.ShapeType.Point2D">
<comment></comment>
<elem name="lat" type="float64" multiplicity="1">
<tag name="unit" value="degrees"/>
<tag name="reference" value="WGS84"/>
</elem>
<elem name="lon" type="float64" multiplicity="1">
<tag name="unit" value="degrees"/>
<tag name="reference" value="WGS84"/>
</elem>
</struct>
<struct name="Circle" type="Point2D" rttkey="HPE.ShapeType.Circle">
<comment>In an Estimate, the shape is the uncertainty area.</comment>
<elem name="radius" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>
In an estimate, radius is the horizontal uncertainty.\n
0 &lt;= radius
</comment>
</elem>
</struct>
<struct name="Ellipse" type="Point2D" rttkey="HPE.ShapeType.Ellipse">
<comment>In an Estimate, the shape is the uncertainty area.</comment>
<elem name="major" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>major axis horizontal radius</comment>
</elem>
<elem name="minor" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>minor axis horizontal radius</comment>
</elem>
<elem name="orient" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Angle between north and major axis.\n
0 &lt;= orient &lt; 180.
</comment>
</elem>
</struct>
<struct name="Arc" type="Point2D" rttkey="HPE.ShapeType.Arc">
<comment>In an Estimate, the shape is the uncertainty area.</comment>
<elem name="outer" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>outer horizontal radius</comment>
</elem>
<elem name="inner" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>inner horizontal radius</comment>
</elem>
<elem name="offset" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Angle between north and start of arc.\n
0 &lt;= offset &lt; 360
</comment>
</elem>
<elem name="opening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Delta angle from offset to end of arc.\n
0 &lt; opening &lt;= 360.
</comment>
</elem>
</struct>
<struct name="ArcBand" type="Point2D" rttkey="HPE.ShapeType.ArcBand">
<comment>In an Estimate, the shape is the uncertainty area.</comment>
<elem name="major_outer" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>major axis outer radius</comment>
</elem>
<elem name="major_inner" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>major axis inner radius</comment>
</elem>
<elem name="minor_outer" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>minor axis outer radius</comment>
</elem>
<elem name="minor_inner" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>minor axis inner radius</comment>
</elem>
<elem name="orient" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Angle between north and major axis.\n
0 &lt;= orient &lt; 180.
</comment>
</elem>
<elem name="offset" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Angle between north and start of arc.\n
0 &lt;= offset &lt; 360
</comment>
</elem>
<elem name="opening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
delta angle from offset to end of arc.\n
0 &lt; opening &lt;= 360.
</comment>
</elem>
</struct>
<struct name="Point3D" type="Point2D" rttkey="HPE.ShapeType.Point3D">
<comment></comment>
<elem name="alt" type="float64" multiplicity="1">
<tag name="unit" value="meters"/>
<tag name="reference" value="WGS84"/>
</elem>
</struct>
<struct name="Spheroid" type="Point3D" rttkey="HPE.ShapeType.Spheroid">
<comment>
Spheroid is the shape of a circular "pill".\n
In an Estimate, the shape is the uncertainty area.
</comment>
<elem name="radius" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>
In an estimate, radius is the horizontal uncertainty.\n
0 &lt;= radius
</comment>
</elem>
<elem name="vert" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>
In an estimate, vert is the vertical uncertainty.\n
0 &lt;= vert
</comment>
</elem>
</struct>
<struct name="Ellipsoid" type="Point3D" rttkey="HPE.ShapeType.Ellipsoid">
<comment>
Ellipsoid is the shape of an oblong "pill" at an orientation.\n
In an Estimate, the shape is the uncertainty area.
</comment>
<elem name="major" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>major axis radius/distance/reach</comment>
</elem>
<elem name="minor" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>minor axis radius/distance/reach</comment>
</elem>
<elem name="orient" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
angle between north and major axis.\n
0 &lt;= orient &lt; 180.
</comment>
</elem>
<elem name="vert" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>
In an estimate, vert is the vertical uncertainty.\n
0 &lt;= vert
</comment>
</elem>
</struct>
<struct name="Arc3D" type="Point3D" rttkey="HPE.ShapeType.Arc3D">
<comment>
In an Estimate, the shape is the uncertainty area.
</comment>
<elem name ="height" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>Height above alt(itude) area is projected from.</comment>
</elem>
<elem name="outer" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>outer radius/distance/reach</comment>
</elem>
<elem name="inner" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>inner radius/distance/reach</comment>
</elem>
<elem name="direction" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Angle from north to center of arc.\n
0 &lt;= direction &lt; 360
</comment>
</elem>
<elem name="opening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Horizontal coverage of the antenna face; half on either side of direction.\n
0 &lt; opening &lt;= 360.
</comment>
</elem>
</struct>
<struct name="ArcBand3D" type="Point3D" rttkey="HPE.ShapeType.ArcBand3D">
<comment>
In an Estimate, the shape is the uncertainty area.
</comment>
<elem name ="height" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>Height above alt(itude) area is projected from.</comment>
</elem>
<elem name="direction" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Angle between north and start of arc.\n
0 &lt;= direction &lt; 360
</comment>
</elem>
<elem name ="tilt" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Vertical tilt from horizon.\n
-90.0 &lt;= tilt &lt;= 90.0
</comment>
</elem>
<elem name="opening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Horizontal coverage angle of the antenna face; half on either side of direction.\n
0 &lt; opening &lt;= 360.
</comment>
</elem>
<elem name="vopening" type="float32" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>
Vertical coverage angle of the face; half on either side of tilt.\n
0 &lt; opening &lt;= 360.
</comment>
</elem>
<elem name="radius" type="float32" multiplicity="1">
<tag name="unit" value="meters"/>
<comment>
radius/distance/reach.\n
0 &lt; radius
</comment>
</elem>
</struct>
<!--
*******************************
* StateInfo Type Definition
*******************************
-->
<enum name="StateSource" type="Tensor.uint8" default="undefined">
<comment>Source enumeration defines the source of the state information.</comment>
<literal name="undefined" value="0">
<comment>Source is not defined or is unknown.</comment>
</literal>
<literal name="gnss" value="1">
<comment>Source is GNSS.</comment>
</literal>
<literal name="cellular" value="2">
<comment>Source is cellular network location.</comment>
</literal>
<literal name="wifi" value="3">
<comment>Source is WiFi location.</comment>
</literal>
<literal name="bluetooth" value="4">
<comment>Source is bluetooth or bluetooth beaconning.</comment>
</literal>
<literal name="rtls" value="5">
<comment>Source is real-time locating sytem (RTLS).</comment>
</literal>
<literal name="inertial" value="6">
<comment>Source is inertial or sensor fusion.</comment>
</literal>
<literal name="hybrid" value="7">
<comment>Source is hybrid comprised of multiple datatypes (not sensor fusion).</comment>
</literal>
<literal name="previous" value="8">
<comment>Previous state calculated by the ILP/HPE engine.</comment>
</literal>
</enum>
<struct name="StateInfo">
<comment>StateInfo provides a positional definition.</comment>
<comment>
Used in initializaton and position submission type interfaces.
</comment>
<elem name="epoch" type="datetime" multiplicity="1" />
<elem name="confidence" type="float32" multiplicity="1">
<comment>Confidence of position shape. Valid range is 0.0 to 1.0</comment>
</elem>
<elem name="shape" multiplicity="1" type="Shape" polymorphic="true" >
<comment>
Position. Polymorphic type, see specializations
from Shape for details.
</comment>
</elem>
<elem name="speed" type="float32" multiplicity="0..1">
<tag name="unit" value="meters/sec"/>
<comment>speed of device in meters/sec</comment>
</elem>
<elem name="azimuth" type="float32" multiplicity="0..1">
<tag name="unit" value="degrees"/>
<comment>Azimuth heading of the device in degrees (true North)</comment>
</elem>
<elem name="source" type="StateSource" multiplicity="0..1" default="0">
<comment>Source field defines the source of the state information. If not specified, value is undefined. Defining the source of the state information
assists the calculation processing by characterizing the nature of the position data relative to associated observations.
</comment>
</elem>
</struct>
<!--
*******************************************************
Estimate Results
*******************************************************
-->
<array name="StringIdentifier" type="int8" size="16">
<comment>String identifier defines a short fixed string identifier.</comment>
</array>
<struct name="Estimate">
<comment>
Estimate is the result provided by positioning calculators at the completion
of a calculation.
</comment>
<elem name="result" type="ProcessingStatus" multiplicity="1">
<comment>
The result of the data processing used to produce the estimate.
If not success, ignore the remainder of the estimate information.
</comment>
</elem>
<elem name="source" type="string" multiplicity="1">
<comment>Estimate source identifier. If not defined set to "".</comment>
</elem>
<elem name="obstype" type="ObservationType" multiplicity="1">
<comment>The last observation type used to create the estimate.</comment>
</elem>
<elem name="tic" type="uint32">
<comment>Tic count of the estimate. Set to zero if not known.</comment>
</elem>
<elem name="epoch" type="datetime" multiplicity="1">
<comment>Epoch defines the point in time for which the estimate applies.</comment>
</elem>
<elem name="veracity" type="float32" multiplicity="1">
<comment>
Veracity defines the validity of the measurement in the range between 0 and 1.
A high score means the estimate is deemed valid and more reliable than a lower score.
If no veracity scoring is performed, this will have a value of -1.
</comment>
</elem>
<elem name="confidence" type="float32" multiplicity="1">
<comment>The estimate confidence. Valid range is 0.0 to 1.0</comment>
</elem>
<elem name="shape" type="Shape" multiplicity="1" polymorphic="true">
<comment>
The estimate shape result. The particular shape is determined by the
preferred shapes specified in the BeginCalculation.
</comment>
</elem>
</struct>
<!-- eventually may be able to support variable sized elements
<array name="EstimateArray" type="Estimate">
<comment>
HPE Estimates are reported in an array providing the requested formats.
</comment>
</array>
-->
</namespace>
</specification>
HPE/V1.2/HpeGnss.xid.xml 0 → 100644
<?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="HpeGnss.xid.xml">
<title>HPE GNSS Data Definition</title>
<comment>File contains data definitions for GNSS HPE location related datatypes.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<namespace name="HPE.Gnss">
<using namespace="Tensor"/>
<using namespace="HPE"/>
<enum name="Constellation" type="uint8" default="unspecified">
<comment>
Specifies the specific GNSS constellation. These are oreable values to
be used as flags.
</comment>
<literal name="unspecified" value="0x00"/>
<literal name="GPS" value="0x01"/>
<literal name="GLONASS" value="0x02"/>
<literal name="GALILEO" value="0x03"/>
<literal name="BEIDOU" value="0x04"/>
<literal name="QZSS" value="0x05"/>
<literal name="MBS_FLAG" value="0x20"/>
<literal name="RTLS_FLAG" value="0x40"/>
</enum>
<enum name="AssistanceData" type="uint8" default="unspecified">
<comment>
Enumeration literals defining the types of assistance data supported.
</comment>
<literal name="unspecified" value="0x00"/>
<literal name="GpsAlmanac" value="0x01"/>
<literal name="GpsEphemeris" value="0x02"/>
<literal name="GpsUtcParameters" value="0x03"/>
<literal name="GpsIonosphericCorrection" value="0x04"/>
<literal name="AcquisitionAssistance" value="0x05"/>
</enum>
<!-- Satellite ID -->
<struct name="SatelliteId" pack="true">
<comment>Satellite identifier specifies constellation and satellite identifier.</comment>
<elem name ="constellation" type="Constellation" multiplicity="1"/>
<elem name ="id" type="uint8" multiplicity="1">
<comment>Satellite identifier: range 0 to 63.</comment>
</elem>
</struct>
<!--
*******************************************************
Almanac Data Structures
*******************************************************
-->
<!-- Almanac -->
<struct name="Almanac" pack="true">
<comment>Generalized Almanac orbit in GPS reference frame. One record per satellite.</comment>
<elem name ="id" type="uint8" multiplicity="1">
<comment>Satellite identifier, valid range is 0-63.</comment>
</elem>
<elem name ="toa" type="uint8" multiplicity="1">
<comment>Time of almanac in seconds. Value is integer encoded with scale factor 2^12</comment>
<tag name="unit" value="2^12 seconds"/>
</elem>
<elem name ="deltai0" type="int16" multiplicity="1">
<comment>Relative inclination to i0 = 0.3 semi-circles at reference time. Value is integer encoded with scale factor 2^-19</comment>
<tag name="unit" value="2^-19 semi-circles"/>
</elem>
<elem name ="OmegaDot" type="int16" multiplicity="1">
<comment>Rate of Right Ascension in semi-circles/sec. Value is integer encoded with scale factor 2^-38</comment>
<tag name="unit" value="2^-38 seconds"/>
</elem>
<elem name ="af0" type="int16" multiplicity="1">
<comment>SV clock bias in seconds. Value is integer encoded with scale factor 2^-20</comment>
<tag name="unit" value="2^-20 seconds"/>
</elem>
<elem name ="af1" type="int16" multiplicity="1">
<comment>SV clock bias rate in seconds/second. Value is integer encoded with scale factor 2^-38</comment>
<tag name="unit" value="2^-38 seconds"/>
</elem>
<elem name ="eccentricity" type="uint16" multiplicity="1">
<comment>Eccentricity of the orbit. Value is integer encoded with scale factor 2^-21</comment>
<tag name="unit" value="2^-21"/>
</elem>
<elem name ="sqrtA" type="uint24" multiplicity="1">
<comment>Square root of Mean anomaly. Value is integer encoded with scale factor 2^-11</comment>
<tag name="unit" value="2^-11 meters^1/2"/>
</elem>
<elem name ="Omega0" type="int24" multiplicity="1">
<comment>Longitude of ascending node in semi-circles. Value is integer encoded with scale factor 2^-23</comment>
<tag name="unit" value="2^-23 semi-circles"/>
</elem>
<elem name ="omega" type="int24" multiplicity="1">
<comment>omega argument of perigee in semi-circles. Value is integer encoded with scale factor 2^-23</comment>
<tag name="unit" value="2^-23 semi-circles"/>
</elem>
<elem name ="M0" type="int24" multiplicity="1">
<comment>Mean anomaly at reference time in semi-circles. Value is integer encoded with scale factor 2^-23</comment>
<tag name="unit" value="2^-23 semi-circles"/>
</elem>
<elem name ="SvHealth" type="uint8" multiplicity="1">
<comment>Satellite health flags.</comment>
</elem>
</struct>
<!-- Ephemeris -->
<struct name="Ephemeris" pack="true">
<comment>Generalized GPS 15 element precision Keplerian orbit in GPS reference frame. One record per satellite.</comment>
<elem name ="id" type="uint8" multiplicity="1">
<comment>Satellite identifier, valid range is 0-63.</comment>
</elem>
<elem name ="toe" type="uint16" multiplicity="1">
<comment>Time of Ephemeris. Value is integer encoded with scale factor 2^4</comment>
<tag name="unit" value="2^4 seconds"/>
</elem>
<elem name ="iode" type="uint8" multiplicity="1">
<comment>Issue of data Ephemeris. The value for comparison with the 8 LSBs of the IODC</comment>
</elem>
<elem name ="eccentricity" type="uint32" multiplicity="1">
<comment>Eccentricity of the orbit. Value is integer encoded with scale factor 2^-33</comment>
<tag name="unit" value="2^-33"/>
</elem>
<elem name ="i0" type="int32" multiplicity="1">
<comment>Inclination at reference time in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
<tag name="unit" value="2^-31 semi-circles"/>
</elem>
<elem name ="OmegaDot" type="int24" multiplicity="1">
<comment>Rate of Right Ascension in semi-circles/sec. Value is integer encoded with scale factor 2^-43</comment>
<tag name="unit" value="2^-43 seconds"/>
</elem>
<elem name ="sqrtA" type="uint32" multiplicity="1">
<comment>Square root of Mean anomaly. Value is integer encoded with scale factor 2^-19</comment>
<tag name="unit" value="2^-19 meters^1/2"/>
</elem>
<elem name ="Omega0" type="int32" multiplicity="1">
<comment>Longitude of ascending node in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
<tag name="unit" value="2^-31 semi-circles"/>
</elem>
<elem name ="omega" type="int32" multiplicity="1">
<comment>omega argument of perigee in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
<tag name="unit" value="2^-31 semi-circles"/>
</elem>
<elem name ="M0" type="int32" multiplicity="1">
<comment>Mean anomaly at reference time in semi-circles. Value is integer encoded with scale factor 2^-31</comment>
<tag name="unit" value="2^-31 semi-circles"/>
</elem>
<elem name ="deltan" type="int16" multiplicity="1">
<comment>Mean Motion Difference From Computed Value in semi-circles/sec. Value is integer encoded with scale factor 2^-43</comment>
<tag name="unit" value="2^-43 semi-circles"/>
</elem>
<elem name ="idot" type="int16" multiplicity="1">
<comment>Rate of Inclination in semi-circles/sec. Value is integer encoded with scale factor 2^-43</comment>
<tag name="unit" value="2^-43 semi-circles"/>
</elem>
<elem name ="Cis" type="int16" multiplicity="1">
<comment>Amp. Sin Correction of Inclination in radians. Value is integer encoded with scale factor 2^-29</comment>
<tag name="unit" value="2^-29 radians"/>
</elem>
<elem name ="Cic" type="int16" multiplicity="1">
<comment>Amp. Cosine Correction of Inclination in radians. Value is integer encoded with scale factor 2^-29</comment>
<tag name="unit" value="2^-29 radians"/>
</elem>
<elem name ="Crs" type="int16" multiplicity="1">
<comment>Amp. Sin Correction of orbit radius in meters. Value is integer encoded with scale factor 2^-5</comment>
<tag name="unit" value="2^-5 meters"/>
</elem>
<elem name ="Crc" type="int16" multiplicity="1">
<comment>Amp. Cosine Correction of orbit radius in meters. Value is integer encoded with scale factor 2^-5</comment>
<tag name="unit" value="2^-5 meters"/>
</elem>
<elem name ="Cus" type="int16" multiplicity="1">
<comment>Amp. Sin Correction of Latitude in radians. Value is integer encoded with scale factor 2^-29</comment>
<tag name="unit" value="2^-29 radians"/>
</elem>
<elem name ="Cuc" type="int16" multiplicity="1">
<comment>Amp. Cosine Correction of Latitude in radians. Value is integer encoded with scale factor 2^-29</comment>
<tag name="unit" value="2^-29 radians"/>
</elem>
<elem name ="toc" type="uint16" multiplicity="1">
<comment>Time of clock. Value is integer encoded with scale factor 2^4</comment>
<tag name="unit" value="2^4 seconds"/>
</elem>
<elem name ="iodc" type="uint16" multiplicity="1">
<comment>Issue of data Clock. </comment>
<tag name="unit" value="discretes"/>
</elem>
<elem name ="af0" type="int24" multiplicity="1">
<comment>SV clock bias in seconds. Value is integer encoded with scale factor 2^-31.</comment>
<tag name="unit" value="2^-31 seconds"/>
</elem>
<elem name ="af1" type="int16" multiplicity="1">
<comment>SV clock bias rate in seconds/second. Value is integer encoded with scale factor 2^-43.</comment>
<tag name="unit" value="2^-43 seconds"/>
</elem>
<elem name ="af2" type="int8" multiplicity="1">
<comment>SV clock bias rate in seconds/second^2. Value is integer encoded with scale factor 2^-55.</comment>
<tag name="unit" value="2^-55 seconds"/>
</elem>
<elem name ="TGD" type="int8" multiplicity="1">
<comment>L1-L2 group delay differential in seconds. Value is integer encoded with a scale factor 2^-31.</comment>
<tag name="unit" value="2^-31 seconds"/>
</elem>
<elem name ="SvHealth" type="uint8" multiplicity="1">
<comment>Satellite health flags.</comment>
</elem>
</struct>
<!-- UTC Parameters -->
<struct name="UtcParameters" pack="true">
<comment>Conversion data between GPS time and UTC.</comment>
<elem name ="a0" type="int32" multiplicity="1">
<comment>Constant term of the polynomial in seconds. Value is integer encoded with scale factor 2^-30.</comment>
<tag name="unit" value="2^-30 seconds"/>
</elem>
<elem name ="a1" type="int24" multiplicity="1">
<comment>First order term of the polynomial in seconds/second. Value is integer encoded with scale factor 2^-50.</comment>
<tag name="unit" value="2^-50 seconds"/>
</elem>
<elem name ="DeltaTls" type="int8" multiplicity="1">
<comment>Delta time due to Leap Seconds. </comment>
<tag name="unit" value="seconds"/>
</elem>
<elem name ="tot" type="uint8" multiplicity="1">
<comment>Time of Utc Data. Value is integer encoded with scale factor 2^12</comment>
<tag name="unit" value="2^12 seconds"/>
</elem>
<elem name ="WNt" type="uint8" multiplicity="1">
<comment>UTC Reference Week Number in weeks</comment>
<tag name="unit" value="weeks"/>
</elem>
<elem name ="WNlsf" type="uint8" multiplicity="1">
<comment>Week Number LeapSecond Future in weeks</comment>
<tag name="unit" value="weeks"/>
</elem>
<elem name ="DN" type="uint8" multiplicity="1">
<comment>Day number in days</comment>
<tag name="unit" value="days"/>
</elem>
<elem name ="DeltaTlsf" type="int8" multiplicity="1">
<comment>Delta time due to Leap Seconds Future</comment>
<tag name="unit" value="seconds"/>
</elem>
</struct>
<!-- Ionosperhic Correction -->
<struct name="IonosphericCorrection" pack="true">
<comment>Klobuchar Ionospheric Correction model parameters. See ICD200 para. 20.3.3.5.2.5</comment>
<elem name ="a0" type="int8" multiplicity="1">
<comment>alpha0 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-30.</comment>
<tag name="unit" value="2^-30 seconds"/>
</elem>
<elem name ="a1" type="int8" multiplicity="1">
<comment>alpha1 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-27.</comment>
<tag name="unit" value="2^-27 seconds"/>
</elem>
<elem name ="a2" type="int8" multiplicity="1">
<comment>alpha2 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-24.</comment>
<tag name="unit" value="2^-24 seconds"/>
</elem>
<elem name ="a3" type="int8" multiplicity="1">
<comment>alpha3 term of the polynomial in seconds. Value is integer encoded with scale factor 2^-24.</comment>
<tag name="unit" value="2^-24 seconds"/>
</elem>
<elem name ="b0" type="int8" multiplicity="1">
<comment>beta0 term of the polynomial in seconds. Value is integer encoded with scale factor 2^11.</comment>
<tag name="unit" value="2^11 seconds"/>
</elem>
<elem name ="b1" type="int8" multiplicity="1">
<comment>beta1 term of the polynomial in seconds. Value is integer encoded with scale factor 2^14.</comment>
<tag name="unit" value="2^14 seconds"/>
</elem>
<elem name ="b2" type="int8" multiplicity="1">
<comment>beta2 term of the polynomial in seconds. Value is integer encoded with scale factor 2^16.</comment>
<tag name="unit" value="2^16 seconds"/>
</elem>
<elem name ="b3" type="int8" multiplicity="1">
<comment>beta3 term of the polynomial in seconds. Value is integer encoded with scale factor 2^16.</comment>
<tag name="unit" value="2^16 seconds"/>
</elem>
</struct>
<!-- ConstellationData -->
<struct name="ConstellationData">
<comment>Grouping of constellation data. Reference frame is GPS.</comment>
<comment>Will be extended to include other constellation data.</comment>
<!-- this has been embedded in a device, Only add. -->
<array name="AlmanacArray" type="Almanac"/>
<array name="EphemerisArray" type="Ephemeris" />
<elem name ="constellation" type="Constellation" multiplicity="1" ord="64"/>
<elem name ="week" type="uint16" multiplicity="1" ord="65"/>
<elem name ="almanacs" type="AlmanacArray" multiplicity="0..1" ord="66"/>
<!-- the following are are decoded in C decoding API yet -->
<elem name ="ephemeris" type="EphemerisArray" multiplicity="0..1" ord="67"/>
<elem name ="utc" type="UtcParameters" multiplicity="0..1" ord="68"/>
<elem name ="iono" type="IonosphericCorrection" multiplicity="0..1" ord="69" />
</struct>
<struct name="ConstellationSet">
<comment>Set of ConstellationData</comment>
<elem name ="constellationData" type="ConstellationData" multiplicity="0..*" ord="64"/>
</struct>
<!--
*******************************************************
Acquisistion Assistance Data
*******************************************************
-->
<!-- AcqAssistElem -->
<struct name="AcqAssistElem" pack="true">
<comment>Acquisistion assistance for a single satellite.</comment>
<elem name ="id" type="SatelliteId" multiplicity="1"/>
<elem name ="doppler0" type="int16" multiplicity="1">
<comment>Doppler 0th order term. Value is integer encoded with scale factor 2^-21</comment>
<tag name="unit" value="2^-21"/>
</elem>
<elem name ="doppler1" type="int16" multiplicity="1">
<comment>doppler first order term in Hz/sec. Value is integer encoded with scale factor 2^12</comment>
<tag name="unit" value="2^12 seconds"/>
</elem>
<elem name ="codephase" type="uint16" multiplicity="1">
<comment>code phase 0-1022 in 1/8 code chips. Value is integer encoded with scale factor 2^-3</comment>
<tag name="unit" value="2^-3 code chips"/>
</elem>
<elem name ="CodeCount" type="uint16" multiplicity="1">
<comment>Integer count of whole code epochs including the GPS bit number range 0 - 80 counts. </comment>
<tag name="unit" value="code epochs"/>
</elem>
<elem name ="searchWindow" type="uint8" multiplicity="1">
<comment>Rate of right ascension in semi-circles/sec. Value is integer encoded with scale factor 2^-38</comment>
<tag name="unit" value="2^-38 seconds"/>
</elem>
<elem name ="azimuth" type="int8" multiplicity="1">
<comment>Azimuth in degrees. Value is a scaled integer encoded with scale factor 2.5</comment>
<tag name="unit" value="2.5 degrees"/>
</elem>
<elem name ="elevation" type="int8" multiplicity="1">
<comment>Elevation in degrees.</comment>
<tag name="unit" value="degrees"/>
</elem>
</struct>
<!-- AcqAssistSet -->
<struct name="AcqAssistSet">
<comment>A set of doppler acquisition assistance elements</comment>
<elem name="data" type="AcqAssistElem" multiplicity="1..*" polymorphic="false"/>
</struct>
<!--
*******************************************************
GNSS Measurement data
*******************************************************
-->
<!-- CodephaseMeasurementMin-->
<struct name="CodephaseMeasurementMin" pack="true">
<comment>
Measurement of a single satellite codephase. This is a more compact version without RMS error and multipath indicator.
These will be encoded in cno in a future version.
</comment>
<elem name ="id" type="uint8" multiplicity="1">
<comment>
Satellite identifier: 0 - 63. If set to 255 (0xff), the measurement is considered invalid and ignored.
This marks the end of measurements in fixed array sets. See GpsCodePhaseObsMin6 for an example.
</comment>
</elem>
<elem name ="cn0" type="uint8" multiplicity="1">
<comment>Carrier noise ratio.</comment>
<tag name="unit" value="ratio"/>
</elem>
<elem name ="doppler" type="int16" multiplicity="1">
<comment>Measured Doppler shift in Hz. Value is integer encoded with scale factor 0.2</comment>
<tag name="unit" value="0.2 Hz"/>
</elem>
<elem name ="codephase" type="uint24" multiplicity="1">
<comment>Whole and fractional parts of code phase. Value is integer encoded with scale factor 2^-10</comment>
<tag name="unit" value="2^-10 code chips"/>
</elem>
</struct>
<!-- CodephaseMeasurement -->
<struct name="CodephaseMeasurement" type="CodephaseMeasurementMin" pack="true">
<comment>Measurement of a single satellite codephase including mpathIndicator and rmsErr.</comment>
<elem name ="mpathIndicator" type="uint8" multiplicity="1">
<comment>Multipath indicator. Default value is 0.</comment>
</elem>
<elem name ="rmsErr" type="uint8" multiplicity="1">
<comment>Pseudo range RMS Error value indexed 0..63, default is 0</comment>
<tag name="unit" value="2.5 degrees"/>
</elem>
</struct>
<!-- Observation Data types-->
<struct name="GpsCodePhaseObs8" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.GPS_CODEPHASE_8">
<comment>
Eight standard GPS code phase measurements: 9 + (9 x 8) = 81 bytes. Mark
the end of the unused or invalid measurements with id=255 (0xFF). They will be ignored.
</comment>
<array name ="CodephaseMeasurement8" type="CodephaseMeasurement" size="8"/>
<elem name ="measurements" type="CodephaseMeasurement8" multiplicity="1">
</elem>
</struct>
<struct name="GpsCodePhaseObsMin6" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.GPS_CODEPHASE_MIN6">
<comment>
Six minimum size GPS code phase measurements: 9 + (7 x 6) = 51 bytes.
Mark the end of the unused or invalid measurements with id=255 (0xFF). They will be ignored.
</comment>
<array name ="CodephaseMeasurementMin6" type="CodephaseMeasurementMin" size="6"/>
<elem name ="measurements" type="CodephaseMeasurementMin6" multiplicity="1">
</elem>
</struct>
<struct name="GpsCodePhaseObsMin8" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.GPS_CODEPHASE_MIN8">
<comment>
Eight minimum size GPS code phase measurements: 9 + (7 x 8) = 65 bytes.
Mark the end of the unused or invalid measurements with id=255 (0xFF). They will be ignored.
</comment>
<array name ="CodephaseMeasurementMin8" type="CodephaseMeasurementMin" size="8"/>
<elem name ="measurements" type="CodephaseMeasurementMin8" multiplicity="1">
</elem>
</struct>
<struct name="PseudorangeObservation" type="ObservationEpoch" rttkey="HPE.ObservationType.GNSS_PSEUDORANGE">
<comment>GNSS observation data in generic format suited for variable sized input.</comment>
<elem name ="id" type="SatelliteId" multiplicity="1"/>
<elem name ="prr" type="float64" multiplicity="1">
<comment>Pseudorange rate measurement in meters per second.</comment>
<tag name="unit" value="meters per second"/>
</elem>
<elem name ="pr" type="float64" multiplicity="1">
<comment>Pseudorange measurement in meters.</comment>
<tag name="unit" value="meters"/>
</elem>
<elem name ="prrUncert" type="float32" multiplicity="1">
<comment>Pseudorange rate measurement uncertainty in meters per second. This is the one standard deviation confidence (68%) uncertainty.</comment>
<tag name="unit" value="meters per second"/>
</elem>
<elem name ="prUncert" type="float32" multiplicity="1">
<comment>Pseudorange measurement uncertainty in meters. This is the one standard deviation confidence (68%) uncertainty.</comment>
<tag name="unit" value="meters"/>
</elem>
<elem name ="cn0" type="uint8" multiplicity="1">
<comment>Carrier noise ratio.</comment>
<tag name="unit" value="ratio"/>
</elem>
<elem name ="mpathIndicator" type="uint8" multiplicity="1">
<comment>Multipath indicator. Default value is 0.</comment>
</elem>
</struct>
</namespace>
</specification>
HPE/V1.2/HpeUsage.xid.xml 0 → 100644
<?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="HpeUsage.xid.xml">
<title>HPE Usage Messages</title>
<comment>This file the usage messages produced by the HPE.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/Tensor/V1.0.0/Logging.xid.xml" local="Logging.xid.xml" />
<namespace name="HPE">
<using namespace="Tensor"/>
<using namespace="Logging"/>
<!--Initialization Report Msg-->
<struct name="InitializationReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/initrpt"'>
<comment>
Message captures HPE initialization data.
</comment>
<elem name="state" type="StateInfo" multiplicity="1">
<comment>
State information.
</comment>
</elem>
</struct>
<!--Observation Report Msg-->
<struct name="ObservationReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/obsrpt"'>
<comment>
Message captures HPE observation data for playback purposes and debugging.
</comment>
<elem name="observations" type="ObservationSet" multiplicity="1">
<comment>
Observation Data provided by the caller.
</comment>
</elem>
<elem name="refdata" type="ReferenceDataSet" multiplicity="0..1">
<comment>
Contains reference data provided by the caller.
</comment>
</elem>
<elem name="directive" multiplicity="0..*" type="Tensor.NameValue">
<comment>
A set of directives to influence processing. Unknown directives are ignored.
</comment>
</elem>
</struct>
<!--TaskReport Msg-->
<struct name="TaskReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/taskrpt"'>
<comment>
Message reports processing task result data. Tasks are any computational elem
within the HPE including calculators, converters, estimators.
</comment>
<elem name="taskid" type="string" multiplicity="1">
<comment>
The unique tasks identifier. A source may have multiple tasks, this field assigns
an identifier that uniquely characterizes what the task was that was accomplished.
</comment>
</elem>
<elem name="start" type="datetime" multiplicity="1">
<comment>
The start time at which the processor is used.
</comment>
</elem>
<elem name="duration" type="uint16" multiplicity="1">
<tag name="unit" value="msec"/>
<comment>
The duration of the processing in msec. This is not meant to be a high
resolution duration monitoring, implement a metric counter for precise timing data.
</comment>
</elem>
<elem name="status" type="ProcessingStatus" multiplicity="1">
<comment>The result of the processor use, typically success or failure.</comment>
</elem>
</struct>
<!--Position Report Msg-->
<struct name="PositionReport" type="Logging.UsageMsg" rttkey='"tpf://hpe/posrpt"'>
<comment>
Usage message reports position information produced by HPE.
</comment>
<elem name="position" type="HPE.Spheroid" multiplicity="1">
<comment>The 2D/3D position reported. </comment>
</elem>
<elem name="speed" type="int16" multiplicity="1">
<tag name="unit" value="cm/sec"/>
<comment>The observed speed. O if not known.</comment>
</elem>
<elem name="heading" type="int16" multiplicity="1">
<tag name="unit" value="degrees"/>
<comment>Observed heading relative true north (azimuth).</comment>
</elem>
<elem name="veracity" type="byte" multiplicity="1">
<comment>
Veracity defines the validity of the measurement in the range between 0 and 100.
A high score means the estimate is deemed valid and more reliable than a lower score.
If no veracity scoring is performed, this will have a value of 255
</comment>
</elem>
<elem name="confidence" type="byte" multiplicity="1">
<comment>The estimate confidence. Valid range is 0 to 100</comment>
</elem>
<elem name="calctype" type="string" multiplicity="1">
<comment>
Positioning calculation stereo type specifier (hybrid, cellular, slam, etc.). If not defined set to "".
</comment>
</elem>
<elem name="obstype" type="ObservationType" multiplicity="1">
<comment>The last observation type used to create the estimate.</comment>
</elem>
</struct>
</namespace>
</specification>
HPE/V1.2/HpeWiFi.xid.xml 0 → 100644
<?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="HpeWiFi.xid.xml">
<title>HPE Wi-Fi Data Definition</title>
<comment>File contains data definitions observation datatypes.</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<namespace name="HPE.WiFi">
<using namespace="Tensor"/>
<using namespace="HPE"/>
<array name="SSID" type="int8" size="33">
<comment>ssid string of wifi access point</comment>
</array>
<struct name="WiFiRssi" type="ObservationEpoch" pack="true" rttkey="HPE.ObservationType.WIFI_RSS">
<comment>Wi-Fi RSSI observation</comment>
<elem name ="rssi" type="uint8" multiplicity="1">
<tag name="unit" value="-dBm"/>
<comment>RSS signal measured value(used as negative). </comment>
</elem>
<elem name ="macaddr" type="mac48" multiplicity="1">
<comment>Access point mac address</comment>
</elem>
</struct>
<struct name="WiFiRssiExt" type="WiFiRssi" rttkey="HPE.ObservationType.WIFI_RSS_EXT">
<comment>Extension of the WifiRssi data structure</comment>
<elem name="ssid" type="SSID" multiplicity="1">
<comment>ssid of the wifi access point</comment>
</elem>
<elem name="freq" type="float32" multiplicity="1">
<comment>Radio frequency of the Wifi Access point</comment>
</elem>
<elem name="uncert" type="float32" multiplicity="1">
<comment> uncertainty of the rssi measurements</comment>
</elem>
</struct>
</namespace>
</specification>
ILP/V1.2/ApiBase.xid.xml 0 → 100644
<?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="ApiBase.xid.xml">
<title>ILP Services API Base Definitions</title>
<comment>
This document defines the common types API service interface for the ILP and Simultaneous Localization
and Mapping (SLAM) services definitions. The service provides access to ILP and SLAM technologies for 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/Tensor/V1.0.0/Common.xid.xml" local="Definitions.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
<namespace name="ILP">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!--
*******************************
*InputBase Type Definition
*******************************
-->
<struct name="InputBase" >
<comment>Base input fields for operations supporting asynchronous transaction information.</comment>
<elem name="directive" multiplicity="0..*" type="NameValue">
<comment>
A set of directives to influence processing.
</comment>
</elem>
<elem name="devid" multiplicity="1" type="string">
<comment>
Required device identifier, that provides a consistent multi-transaction identifier
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
in the system logs, providing traceability. Identifier should be unique.
</comment>
</elem>
<elem name="etid" multiplicity="0..1" type="string">
<comment>
Optional external transaction identifier for the caller to uniquely identify and track
the transaction and corresponding results. These identifiers will appear in the
ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
the ILP system.
</comment>
</elem>
</struct>
<!--
*******************************
*OutputBase Type Definition
*******************************
-->
<struct name="OutputBase" >
<comment>Base output fields common to operations supporting asynchronous returning transaction information.</comment>
<elem name="devid" multiplicity="0..1" type="string">
<comment>
Device identifier provided at operation input, provides a consistent identifier
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
in the system logs, providing traceability.
</comment>
</elem>
<elem name="etid" multiplicity="0..1" type="string">
<comment>
Optional external transaction identifier for the caller to uniquely identify and track
the transaction and corresponding results. These identifiers appear in the
ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
the ILP system.
</comment>
</elem>
<elem name="resultcode" type="ResultCode" multiplicity="1" >
<comment>Result of the operation.</comment>
</elem>
<elem name="errinfo" type="Tensor.string" multiplicity="0..1">
<comment>Error information if result was not success.</comment>
</elem>
</struct>
</namespace>
</specification>
ILP/V1.2/IlpApiBase.xid.xml 0 → 100644
<?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="IlpApiBase.xid.xml">
<title>ILP Hybrid Positioning Services API Base Definitions</title>
<comment>
This document defines the common types API 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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
<namespace name="ILP">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!--
*******************************
*IlpInputBase Type Definition
*******************************
-->
<struct name="IlpInputBase" >
<comment>Base input fields for operations supporting asynchronous transaction information.</comment>
<elem name="idDevice" multiplicity="1" type="string">
<comment>
Required device identifier, that provides a consistent multi-transaction identifier
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
in the system logs, providing traceability. Identifier should be unique.
</comment>
</elem>
<elem name="idTransaction" multiplicity="0..1" type="string">
<comment>
Optional transaction identifier for the caller to uniquely identify and track
the transaction and corresponding results. These identifiers will appear in the
ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
the ILP system.
</comment>
</elem>
<!-- THis is future, don't uncomment until design issues resolved. M. Mathews/s. Hines 161130
<elem name="urlCallback" multiplicity="0..1" type="string">
<tag key="life-cycle" value="future" />
<comment>
Optional asynchronous callback used to callback client servers during long operations. Not all
interfaces may support this.
</comment>
</elem>
-->
</struct>
<!--
*******************************
*IlpOutputBase Type Definition
*******************************
-->
<struct name="IlpOutputBase" >
<comment>Base output fields common to operations supporting asynchronous returning transaction information.</comment>
<elem name="idDevice" multiplicity="1" type="string">
<comment>
Device identifier provided at operation input, provides a consistent identifier
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
in the system logs, providing traceability.
</comment>
</elem>
<elem name="idTransaction" multiplicity="0..1" type="string">
<comment>
Optional transaction identifier for the caller to uniquely identify and track
the transaction and corresponding results. These identifiers appear in the
ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
the ILP system.
</comment>
</elem>
<!-- THis is future, don't uncomment until design issues resolved. M. Mathews/s. Hine 161130
<elem name="urlCallback" multiplicity="0..1" type="string">
<tag key="life-cycle" value="future" />
<comment>
Optional asynchronous callback used to callback client servers during long operations. Not all
interfaces may support this.
</comment>
</elem>
-->
</struct>
</namespace>
</specification>
ILP/V1.2/IlpAssistanceApi.xid.xml 0 → 100644
<?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="IlpAssistanceApi.xid.xml">
<title>ILP Assistance Services</title>
<comment>
This document defines the positioning assistance service interface for the IoT Location Platform (ILP).
The service provides assistance data supporting GNSS and other positioning technologies 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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
<import ref="https://xid.location.studio/ILP/V1.2/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" />
<namespace name="ILP">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!--
*******************************************************
GnssData input/ouput structure declarations.
*******************************************************
-->
<!-- GnssDataInput structure -->
<struct name="GnssDataInput" type="IlpInputBase">
<comment>ILP.Assistance.GnssData input request data.</comment>
<!-- Define internal data structure -->
<struct name="RequestSpec">
<comment>Specifies the data request for each constellation type.</comment>
<elem name ="constellation" type="HPE.Gnss.Constellation" multiplicity="1">
<comment>Specifies the constellation of interest.</comment>
</elem>
<elem name="directive" multiplicity="0..*" type="NameValue">
<comment>
A set of directives to influence processing.
</comment>
</elem>
<elem name="minId" multiplicity="0..1" type ="uint8" default="0">
<comment>
Specifies the minimum satellite ID to return constellation data.
</comment>
</elem>
<elem name="maxId" multiplicity="0..1" type ="uint8" default="255">
<comment>
Specifies the maximum satellite ID to return constellation data.
</comment>
</elem>
<elem name="AssistData" multiplicity="1..*" type ="HPE.Gnss.AssistanceData">
<comment>
Specifies the types of constellation assistance data to return.
</comment>
</elem>
</struct>
<!-- Define input elements.-->
<elem name="epoch" multiplicity="0..1" type="datetime">
<comment>
Optional epoch for which the data is valid. Leave unspecified if the current epoch is desired.
</comment>
</elem>
<elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
<comment>
ConstellationData encoding format for the response. This field is carried into
GetAssistanceData_output.encCon and GetGnssAlmanacs_output.conData will be encoded
in this format. If not specified the "native" format of the protocol is used.
</comment>
</elem>
<elem name="location" multiplicity="0..1" type="Shape">
<comment>
Optional specification of the location to compute assistance data. If not specified
all available asistance data will be provided.
</comment>
</elem>
<elem name="elmask" multiplicity="0..1" type="int8" default="-90">
<comment>
Optional, specifies the elevation cutoff mask relative to the current
location in degrees. If not specified or -90, all values within the specified satellite ID ranges are returned.
</comment>
<tag name="unit" value="degrees"/>
</elem>
<elem name="Request" multiplicity="1..*" type="RequestSpec">
<comment>Specifies the requested data. One specification is required, multiple can be processed simultaneously.</comment>
</elem>
</struct>
<!-- GnssDataOutput structure -->
<struct name="GnssDataOutput" type="IlpOutputBase">
<comment>ILP.Assistance.GnssData output structure. </comment>
<elem name="resultcode" multiplicity="1" type="ResultCode">
<comment>
Result of GnssData operation.
If resultcode is not success, encCon and constellation data will not be present.
</comment>
</elem>
<elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
<comment>
Constellation Data encoding format. Data can be provided in a different encoding format
than the native protocol format. This is carried over from input.
If not present, the data is in the native protocol format (e.g. XMF, JSON).
</comment>
</elem>
<elem name="assistdata" multiplicity="0..*" type ="HPE.Gnss.ConstellationData" encoding="encoding">
<comment>
The list of ConstellationData encoded in the format specified by encoding.
</comment>
</elem>
</struct>
<!--
*******************************************************
ILP GNSS Assistance Data Service Interface.
*******************************************************
-->
<interface name="Assistance">
<comment>Assistance data interface functions.</comment>
<operation name="Gnss">
<comment>Returns caller requested GNSS assistance data.</comment>
<input name="Input" type="GnssDataInput" sid="0x1018"/>
<output name="Result" type="GnssDataOutput" sid="0x1019"/>
</operation>
</interface>
</namespace>
</specification>
ILP/V1.2/IlpPositioningApi.xid.xml 0 → 100644
<?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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
<import ref="https://xid.location.studio/ILP/V1.2/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>
ILP/V1.2/IlpSubmissionApi.xid.xml 0 → 100644
<?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="IlpSubmissionApi.xid.xml">
<title>ILP Submission API</title>
<comment>
This document defines a lightweight Observation Submission API for submitting ILP compatible observation
data without invoking the full get position operation.
</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.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
<import ref="https://xid.location.studio/ILP/V1.2/IlpApiBase.xid.xml" local="IlpApiBase.xid.xml" />
<namespace name="ILP">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!-- SubmitInput structure definition.
Note: all the tags are defined. These have to
match CalculateInput tags of the same name.
-->
<struct name="PositionInfo" type="IlpInputBase" >
<comment>Used as ILP.Submission.PositionInfo input.</comment>
<elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
<comment>
Optional position information.\n
At least one of observations or state is required,
otherwise there is insufficient data to process.
</comment>
</elem>
<elem name="directive" multiplicity="0..*" type="NameValue" ord="87">
<comment>
A set of directives to influence processing.
</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.
</comment>
</elem>
<elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
<comment>
Optional 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>
<!--
*******************************************************
Observation Submission API
*******************************************************
-->
<interface name="Submission">
<comment>Interface for submitting data to ILP. </comment>
<operation name="PositionInfo">
<comment>
Interaction submits position and observation data.\n
There is no response besides bearer response codes.
</comment>
<input name="Input" type="PositionInfo" sid="0x101E"/>
</operation>
</interface>
</namespace>
</specification>
README.md
......@@ -5,9 +5,41 @@ This is a public repo containing published XID (Xtensible Interface Definition)
----------
## State ##
* *In Process* means these are currently being edited
* *Stable* means they are not changing (but can have documentation changes)
* *Decrecated* means it is going away soon
* *Retired* means it is gone (no systems support the API)
### In Process ###
* HPE/V1.2/*
* ILP/V1.2/*
* ILP/SLAM/V1.0.0_alpha/*
### Stable ###
* schema/V1.0.0/*
* Tensor/V1.0.0/*
* HPE/V1.1.1/*
* HPE/CommonDefs/V1.1.1/*
* ILP/V1.1.1/*
### Decrecated ###
N/A
### Retired ###
N/A
---
---
## Naming conventions ##
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 :
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 :
**[filename].[xid|cid].[xml|json|xmf]**
......@@ -19,6 +51,11 @@ XSD Schemas for the XID/CID should be stored separately and versioned consistent
**/schema/[version]/[specification].xsd**
### [version] ###
The [version] specifier should be V{major}.{minor}; for historical reasons the original XIDs have V{major}.{minor}.{bug}
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}.
\<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.
## Process ##
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!