summaryrefslogtreecommitdiff
path: root/enhanced-position-service/api/genivi-positioning-enhancedposition.xml
diff options
context:
space:
mode:
Diffstat (limited to 'enhanced-position-service/api/genivi-positioning-enhancedposition.xml')
-rw-r--r--enhanced-position-service/api/genivi-positioning-enhancedposition.xml103
1 files changed, 12 insertions, 91 deletions
diff --git a/enhanced-position-service/api/genivi-positioning-enhancedposition.xml b/enhanced-position-service/api/genivi-positioning-enhancedposition.xml
index 853cb11..1e99d5e 100644
--- a/enhanced-position-service/api/genivi-positioning-enhancedposition.xml
+++ b/enhanced-position-service/api/genivi-positioning-enhancedposition.xml
@@ -35,9 +35,9 @@
</arg>
</method>
- <method name="GetData">
+ <method name="GetPositionInfo">
<doc>
- <line>GetData = This method returns a given set of positioning data (e.g. Position, Course, Accuracy, Status, ... )</line>
+ <line>GetPositionInfo = This method returns a given set of positioning data (e.g. Position, Course, Accuracy, Status, ... )</line>
</doc>
<arg name="valuesToReturn" type="aq" direction="in">
@@ -74,29 +74,7 @@
<line>key = SIGMA_ALTITUDE, value = value of type 'd', that represents the standard error estimate of the altitude in m</line>
<line>key = SIGMA_HEADING, value = value of type 'd', that represents the standard error estimate of the heading in degrees</line>
<line>key = GNSS_FIX_STATUS, value = value of type 'q', that represents an enum(NO_FIX(0x01),TIME_FIX(0x01),2D_FIX(0x02),3D_FIX(0x03), ... )</line>
- <line>key = DR_STATUS, value = value of type 'b', where TRUE means that a dead-reckoning algorithm has been used to calculate the current position</line>
- </doc>
- </arg>
- </method>
-
- <method name="GetPosition">
- <doc>
- <line>GetPosition = This method returns the current position</line>
- </doc>
-
- <arg name="position" type="a{qv}" direction="out">
- <doc>
- <line>position = dictionary[key,value]</line>
- <line>dictionary = array of tuples (key,value)</line>
- <line>Invalid data is not be returned to the client application</line>
- <line>key = enum(INVALID,TIMESTAMP,LATITUDE,LONGITUDE,ALTITUDE,HEADING,SPEED,CLIMB,...)</line>
- <line>key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms</line>
- <line>key = LATITUDE, value = value of type 'd', that expresses the WGS84 latitude of the current position in degrees. Range [-90:+90]. Example: 48.053250</line>
- <line>key = LONGITUDE, value = value of type 'd', that expresses the WGS84 longitude of the current position in degrees. Range [-180:+180]. Example: 8.324500</line>
- <line>key = ALTITUDE, value = value of type 'd', that expresses the altitude above the sea level of the current position in meters</line>
- <line>key = HEADING, value = value of type 'd', that expresses the course angle in degree. Range [0:360]. 0 = north, 90 = east, 180 = south, 270 = west</line>
- <line>key = SPEED, value = value of type 'd', that expresses speed measured in m/s. A negative value indicates that the vehicle is moving backwards</line>
- <line>key = CLIMB, value = value of type 'd', that expresses the road gradient in degrees. Range [-180:+180]. A positive value means upwards. </line>
+ <line>key = DR_STATUS, value = value of type 'b', where TRUE means that a dead-reckoning algorithm has been used to calculate the current position</line>
</doc>
</arg>
</method>
@@ -113,25 +91,6 @@
</arg>
</signal>
- <method name="GetRotationRate">
- <doc>
- <line>GetRotationRate = This method returns the rotation rate</line>
- </doc>
- <arg name="rotationRate" type="a{qv}" direction="out">
- <doc>
- <line>rotationRate = dictionary[key,value]</line>
- <line>dictionary = array of tuples (key,value)</line>
- <line>If you request for a specific value which is invalid, it's not returned in the dictionary.</line>
- <line>The vehicle axis system is defined by ISO 8855: In short, the X-axis pointing is forwards, the Y-axis is pointing left, the Z-axis is pointing upwards</line>
- <line>key = enum(INVALID,TIMESTAMP,ROLL_RATE,PITCH_RATE,YAW_RATE, ... )</line>
- <line>key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms</line>
- <line>key = ROLL_RATE, value = value of type 'd', rotation rate around the X-axis in degrees/s. Range [-100:+100]</line>
- <line>key = PITCH_RATE, value = value of type 'd', rotation rate around the Y-axis in degrees/s. Range [-100:+100]</line>
- <line>key = YAW_RATE, value = value of type 'd', rotation rate around the Z-axis in degrees/s. Range [-100:+100]</line>
- </doc>
- </arg>
- </method>
-
<signal name="RotationRateUpdate">
<doc>
<line>RotationRateUpdated = This signal is emitted when the rotation rate changes</line>
@@ -144,35 +103,26 @@
</arg>
</signal>
- <method name="GetGNSSAccuracy">
+ <signal name="GNSSAccuracyUpdate">
<doc>
- <line>GetAccuracy = This method returns GNSS accuracy indicators</line>
+ <line>GNSSAccuracyUpdate = This signal is emitted when the GNSS accuracy changes</line>
</doc>
- <arg name="accuracy" type="a{qv}" direction="out">
+ <arg name="changedValues" type="aq">
<doc>
- <line>accuracy = dictionary[key,value]</line>
- <line>dictionary = array of tuples (key,value)</line>
- <line>If you request for a specific value which is invalid, it's not returned in the dictionary.</line>
- <line>key = enum(INVALID,TIMESTAMP,PDOP,HDOP,VDOP,USED_SATELLITES,SIGMA_LONGITUDE,TRACKED_SATELLITES,VISIBLE_SATELLITES,... )</line>
- <line>key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms</line>
- <line>key = PDOP, value = value of type 'd', that represents the positional (3D) dilution of precision</line>
- <line>key = HDOP, value = value of type 'd', that represents the horizontal (2D) dilution of precision</line>
- <line>key = VDOP, value = value of type 'd', that represents vertical (altitude) dilution of precision</line>
- <line>key = USED_SATELLITES, value = value of type 'y', that represents the number of used satellites</line>
- <line>key = TRACKED_SATELLITES, value = value of type 'y', that represents the number of tracked satellites</line>
- <line>key = VISIBLE_SATELLITES, value = value of type 'y', that represents the number of visible satellites</line>
+ <line>changedValues = array[value]</line>
+ <line>value = enum(INVALID,TIMESTAMP,PDOP,HDOP,VDOP,USED_SATELLITES,TRACKED_SATELLITES,VISIBLE_SATELLITES, ... )</line>
</doc>
</arg>
- </method>
+ </signal>
- <signal name="GNSSAccuracyUpdate">
+ <signal name="StatusUpdate">
<doc>
- <line>GNSSAccuracyUpdate = This signal is emitted when the GNSS accuracy changes</line>
+ <line>StatusUpdate = This signal is emitted when the status of this service changes</line>
</doc>
<arg name="changedValues" type="aq">
<doc>
<line>changedValues = array[value]</line>
- <line>value = enum(INVALID,TIMESTAMP,PDOP,HDOP,VDOP,USED_SATELLITES,TRACKED_SATELLITES,VISIBLE_SATELLITES, ... )</line>
+ <line>key = enum(INVALID,TIMESTAMP,GNSS_FIX_STATUS,DR_STATUS, ... )</line>
</doc>
</arg>
</signal>
@@ -196,35 +146,6 @@
</arg>
</method>
- <method name="GetStatus">
- <doc>
- <line>GetStatus = This method returns the status of this service</line>
- </doc>
- <arg name="status" type="a{qv}" direction="out">
- <doc>
- <line>status = dictionary[key,value]</line>
- <line>dictionary = array of tuples (key,value)</line>
- <line>If you request for a specific value which is invalid, it's not returned in the dictionary.</line>
- <line>key = enum(INVALID,TIMESTAMP,GNSS_FIX_STATUS,DR_STATUS, ... )</line>
- <line>key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms</line>
- <line>key = GNSS_FIX_STATUS, value = value of type 'q', that represents an enum(NO_FIX(0x01),TIME_FIX(0x01),2D_FIX(0x02),3D_FIX(0x03), ... )</line>
- <line>key = DR_STATUS, value = value of type 'b', where TRUE means that a dead-reckoning algorithm has been used to calculate the current position</line>
- </doc>
- </arg>
- </method>
-
- <signal name="StatusUpdate">
- <doc>
- <line>StatusUpdate = This signal is emitted when the status of this service changes</line>
- </doc>
- <arg name="changedValues" type="aq">
- <doc>
- <line>changedValues = array[value]</line>
- <line>key = enum(INVALID,TIMESTAMP,GNSS_FIX_STATUS,DR_STATUS, ... )</line>
- </doc>
- </arg>
- </signal>
-
<method name="GetTime">
<doc>
<line>GetTime = This method returns UTC time and date</line>