1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<?xml-stylesheet type="text/xsl" href="introspect.xsl"?>
<!-- SPDX-License-Identifier: MPL-2.0
Component Name: EnhancedPositionService
Compliance Level: Abstract Component
Copyright (C) 2012, BMW Car IT GmbH, Continental Automotive GmbH, PCA Peugeot Citroën, XS Embedded GmbH
License:
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
this file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->
<node name="/org/genivi/positioning/EnhancedPosition" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="introspect.xsd">
<interface name="org.genivi.positioning.EnhancedPosition">
<version>3.0.0-alpha (05-08-2014)</version>
<doc>
<line>EnhancedPosition = This interface offers functionalities to retrieve the enhanced position of the vehicle</line>
</doc>
<method name="GetVersion">
<doc>
<line>GetVersion = This method returns the API version implemented by the server application</line>
</doc>
<arg name="version" type="(qqqs)" direction="out">
<doc>
<line>version = struct(major,minor,micro,date)</line>
<line>major = when the major changes, then backward compatibility with previous releases is not granted</line>
<line>minor = when the minor changes, then backward compatibility with previous releases is granted, but something changed in the implementation of the API (e.g. new methods may have been added)</line>
<line>micro = when the micro changes, then backward compatibility with previous releases is granted (bug fixes or documentation modifications)</line>
<line>date = release date (e.g. 21-06-2011)</line>
</doc>
</arg>
</method>
<method name="GetData">
<doc>
<line>GetData = This method returns a given set of positioning data (e.g. Position, Course, Accuracy, Status, ... )</line>
</doc>
<arg name="valuesToReturn" type="aq" direction="in">
<doc>
<line>valuesToReturn= array[fieldType]</line>
<line>key = enum(INVALID,TIMESTAMP,LATITUDE,LONGITUDE,ALTITUDE,HEADING,SPEED,CLIMB,ROLL_RATE,PITCH_RATE,YAW_RATE,...,ALL)</line>
</doc>
</arg>
<arg name="data" type="a{qv}" direction="out">
<doc>
<line>data = 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>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,LATITUDE,LONGITUDE,ALTITUDE,HEADING,SPEED,CLIMB,ROLL_RATE,PITCH_RATE,YAW_RATE,PDOP,HDOP,VDOP,SIGMA_LATITUDE,SIGMA_LONGITUDE,SIGMA_ALTITUDE,SIGMA_HEADING,... ,ALL</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 = 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>
<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 = SIGMA_LATITUDE, value = value of type 'd', that represents the standard error estimate of the latitude in m</line>
<line>key = SIGMA_LONGITUDE, value = value of type 'd', that represents the standard error estimate of the longitude in m</line>
<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>
</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>
</doc>
</arg>
</method>
<signal name="PositionUpdate">
<doc>
<line>PositionUpdate = This signal is called to notifiy a client application of a position change. The update frequency is implementation specific. The maximal allowed frequency is 10Hz</line>
</doc>
<arg name="changedValues" type="aq">
<doc>
<line>changedValues = array[value]</line>
<line>value = enum(INVALID,TIMESTAMP,LATITUDE,LONGITUDE,ALTITUDE,HEADING,SPEED,CLIMB,... )</line>
</doc>
</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>
</doc>
<arg name="changedValues" type="aq">
<doc>
<line>changedValues = array[key]</line>
<line>key = enum(INVALID,TIMESTAMP,ROLL_RATE,PITCH_RATE,YAW_RATE, ... )</line>
</doc>
</arg>
</signal>
<method name="GetAccuracy">
<doc>
<line>GetAccuracy = This method returns the accuracy</line>
</doc>
<arg name="accuracy" type="a{qv}" direction="out">
<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,SIGMA_LATITUDE,SIGMA_LONGITUDE,SIGMA_ALTITUDE,SIGMA_HEADING,... )</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 = SIGMA_LATITUDE, value = value of type 'd', that represents the standard error estimate of the latitude in m</line>
<line>key = SIGMA_LONGITUDE, value = value of type 'd', that represents the standard error estimate of the longitude in m</line>
<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>
</doc>
</arg>
</method>
<signal name="AccuracyUpdate">
<doc>
<line>AccuracyUpdated = This signal is emitted when the accuracy changes</line>
</doc>
<arg name="changedValues" type="aq">
<doc>
<line>changedValues = array[value]</line>
<line>value = enum(INVALID,TIMESTAMP,PDOP,HDOP,VDOP,SIGMA_LATITUDE,SIGMA_LONGITUDE,SIGMA_ALTITUDE,SIGMA_HEADING, ... )</line>
</doc>
</arg>
</signal>
<method name="GetSatelliteInfo">
<doc>
<line>GetSatelliteInfo = This method returns information about the current satellite constellation</line>
</doc>
<arg name="satelliteInfo" type="a{qv}" direction="out">
<doc>
<line>satelliteInfo = 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,USED_SATELLITES,TRACKED_SATELLITES,VISIBLE_SATELLITES,SATELLITE_DETAILS, ...)</line>
<line>key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms</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>key = SATELLITE_DETAILS, value = value of type 'a(ubuuu)', that represents an array(struct(satId,inUse,elevation,azimuth,snr).
The satID numbering scheme shall be as defined by NMEA-0183 (v3.01 or later) for the GSV sentence:
1..32: GPS satellites (by PRN), 33..64: SBAS/WAAS satellites, 65..96: Glonass satellites
Note: Later NMEA-0183 versions probably already have Galileo support
</line>
</doc>
</arg>
</method>
<signal name="SatelliteInfoUpdate">
<doc>
<line>SatelliteInfoUpdate = This signal is emitted when information about the current satellite information is updated</line>
</doc>
<arg name="changedValues" type="aq">
<doc>
<line>changedValues = array[value]</line>
<line>key = enum(INVALID,TIMESTAMP,USED_SATELLITES,TRACKED_SATELLITES,VISIBLE_SATELLITES,SATELLITE_DETAILS, ...)</line>
</doc>
</arg>
</signal>
<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(INVALID(0x00),NO_FIX(0x01),TIME_FIX(0x02),2D_FIX(0x03),3D_FIX(0x04), ... )</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>
</doc>
<arg name="time" type="a{qv}" direction="out">
<doc>
<line>time = 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,YEAR,MONTH,DAY,HOUR,MINUTE,SECOND,MS, ... )</line>
<line>key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms</line>
<line>key = YEAR, value = value of type 'q', 4 digits number that indicates the year. Example: 2012</line>
<line>key = MONTH, value = value of type 'y', 2 digits number that indicates the month. Example: 03 means March</line>
<line>key = DAY, value = value of type 'y', 2 digits number that indicates the day. Range [0:31]. Example: 07</line>
<line>key = HOUR, value = value of type 'y', 2 digits number that indicates the hour. Range [0:23]. Example: 01</line>
<line>key = MINUTE, value = value of type 'y', 2 digits number that represents the minutes. Range [0:59]. Example: 01</line>
<line>key = SECOND, value = value of type 'y', 2 digits number that represents the seconds. Range [0:59], for leap seconds, also 60 is allowed. Example: 01</line>
<line>key = MS, value = value of type 'q', 3 digits number that represents the milliseconds. Range [0:999]. Example: 007</line>
</doc>
</arg>
</method>
</interface>
</node>
|
