summaryrefslogtreecommitdiff
path: root/enhanced-position-service/api/franca/EnhancedPositionTypes.fidl
blob: 2d9707532533ea54d4ccc2ea791907e8ea3ce7a9 (plain)
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
/*  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/.
*/

package org.genivi.positioning.EnhancedPositionService

import org.genivi.positioning.EnhancedPositionService.EnhancedPositionServiceTypes.* from "EnhancedPositionServiceTypes.fidl"

typeCollection EnhancedPositionTypes {
	version {
		 major 0 
		 minor 1 
	}
	
	enumeration DataType extends BasicEnum {
		TIMESTAMP       = 0x0001
		LATITUDE        = 0x0020
		LONGITUDE       = 0x0021
		ALTITUDE        = 0x0022
		HEADING         = 0x0030
		SPEED           = 0x0031
		CLIMB           = 0x0032
		ROLL_RATE       = 0x0060
		PITCH_RATE      = 0x0061
		YAW_RATE        = 0x0062
		PDOP            = 0x0080
		HDOP            = 0x0081
		VDOP            = 0x0082
		SIGMA_LATITUDE  = 0x0083
		SIGMA_LONGITUDE = 0x0084
		SIGMA_ALTITUDE  = 0x0085
		SIGMA_HEADING   = 0x0086
		ALL             = 0xffff
	} 
	
	<**	  
       @description : PositioningData = array of tuples (key,value)
	      key = enumeration DataType
          key = TIMESTAMP, value = value of type 'UInt64', that represents a timestamp in ms
          key = LATITUDE, value = value of type 'Double', that expresses the latitude of the current position. Range [-90:+90]. Example: 48.053250
          key = LONGITUDE, value = value of type 'Double', that expresses the longitude of the current position. Range [-180:+180]. Example: 8.324500
          key = ALTITUDE, value = value of type 'Int32', that expresses the altitude above the sea level of the current position in meters
          key = HEADING, value = value of type 'Int32', that expresses the course angle in degree. Range [0:360]. 0 = north, 90 = east, 180 = south, 270 = west
          key = SPEED, value = value of type 'Double', that expresses speed measured in m/s. A negative value indicates that the vehicle is moving backwards
          key = CLIMB, value = value of type 'Int32', that expresses the road gradient in degrees
          key = ROLL_RATE, value = value of type 'Int32', rotation rate around the X-axis in degrees/s. Range [-100:+100]
          key = PITCH_RATE, value = value of type 'Int32', rotation rate around the Y-axis in degrees/s. Range [-100:+100]
          key = YAW_RATE, value = value of type 'Int32', rotation rate around the Z-axis in degrees/s. Range [-100:+100]
          key = PDOP, value = value of type 'Double', that represents the positional (3D) dilution of precision
          key = HDOP, value = value of type 'Double', that represents the horizontal (2D) dilution of precision
          key = VDOP, value = value of type 'Double', that represents vertical (altitude) dilution of precision
          key = SIGMA_LATITUDE, value = value of type 'Double', that represents the standard deviation for latitude in m
          key = SIGMA_LONGITUDE, value = value of type 'Double', that represents the standard deviation for longitude in m
          key = SIGMA_ALTITUDE, value = value of type 'Double', that represents the standard deviation for altitude in m
          key = SIGMA_HEADING, value = value of type 'Double', that represents the standard deviation for altitude in degrees
    **>
	map Data {
		DataType to Value
	}
	
	enumeration PositionInfoType extends BasicEnum {
		TIMESTAMP       = 0x0001
		LATITUDE        = 0x0020
		LONGITUDE       = 0x0021
		ALTITUDE        = 0x0022
		HEADING         = 0x0030
		SPEED           = 0x0031
		CLIMB           = 0x0032
	} 
	
	<**	  
       @description : PositionInfo = array of tuples (key,value)
          key = enumeration PositioningInfoKey
          key = TIMESTAMP, value = value of type 'UInt64', that represents a timestamp in ms
          key = LATITUDE, value = value of type 'Double', that expresses the latitude of the current position. Range [-90:+90]. Example: 48.053250
          key = LONGITUDE, value = value of type 'Double', that expresses the longitude of the current position. Range [-180:+180]. Example: 8.324500 
          key = ALTITUDE, value = value of type 'Int32', that expresses the altitude above the sea level of the current position in meters
          key = HEADING, value = value of type 'Int32', that expresses the course angle in degree. Range [0:360]. 0 = north, 90 = east, 180 = south, 270 = west
          key = SPEED, value = value of type 'Double', that expresses speed measured in m/s. A negative value indicates that the vehicle is moving backwards
          key = CLIMB, value = value of type 'Int32', that expresses the road gradient in degrees
    **>   
	map PositionInfo {
		PositionInfoType to Value
	}
	
	enumeration RotationRateType extends BasicEnum {
		TIMESTAMP       = 0x0001
		ROLL_RATE       = 0x0060
		PITCH_RATE      = 0x0061
		YAW_RATE        = 0x0062
	}
	
	<**	  
       @description : RotationRate = array of tuples (key,value)
          key = enumeration RotationRateType
          key = TIMESTAMP, value = value of type 'UInt64', that represents a timestamp in ms
          key = ROLL_RATE, value = rotation rate around the X-axis in degrees/s. Range [-100:+100]
          key = PITCH_RATE, value = rotation rate around the Y-axis in degrees/s. Range [-100:+100]
          key = YAW_RATE, value = rotation rate around the Z-axis in degrees/s. Range [-100:+100]
    **>
	map RotationRate {
		RotationRateType to Value
	}
	
	enumeration AccuracyInfoType extends BasicEnum {
		TIMESTAMP       = 0x0001
		PDOP            = 0x0080
		HDOP            = 0x0081
		VDOP            = 0x0082
		SIGMA_LATITUDE  = 0x0083
		SIGMA_LONGITUDE = 0x0084
		SIGMA_ALTITUDE  = 0x0085
		SIGMA_HEADING   = 0x0086
	}	
		
    <**	  
       @description : AccuracyInfo = array of tuples (key,value)
          key = enumeration AccuracyInfoType
          key = TIMESTAMP, value = value of type 't', that represents a timestamp in ms
          key = PDOP, value = value of type 'd', that represents the positional (3D) dilution of precision
          key = HDOP, value = value of type 'd', that represents the horizontal (2D) dilution of precision
          key = VDOP, value = value of type 'd', that represents vertical (altitude) dilution of precision
          key = SIGMA_LATITUDE, value = value of type 'd', that represents the standard deviation for latitude in m
          key = SIGMA_LONGITUDE, value = value of type 'd', that represents the standard deviation for longitude in m
          key = SIGMA_ALTITUDE, value = value of type 'd', that represents the standard deviation for altitude in m
          key = SIGMA_HEADING, value = value of type 'd', that represents the standard deviation for altitude in degrees
    **>    
	map AccuracyInfo {
		AccuracyInfoType to Value
	}
	
	enumeration SatelliteInfoType extends BasicEnum {
	    TIMESTAMP           = 0x0001
	    USED_SATELLITES     = 0x00c0
	    TRACKED_SATELLITES  = 0x00c1
	    VISIBLE_SATELLITES  = 0x00c2
	    SATELLITE_DETAILS   = 0x00c3
	}
	
	struct SatelliteDetails {
		UInt32 satId
		Boolean inUse
		UInt32 elevation
		UInt32 azimuth
		UInt32 snr
	}
	
	<**	
	   @description : SatelliteInfo = array of tuples (key,value)
          key = enumeration SatelliteInfoType
          key = TIMESTAMP, value = value of type 'UInt64', that represents a timestamp in ms
          key = USED_SATELLITES, value = value of type 'UInt8', that represents the number of used satellites
          key = TRACKED_SATELLITES, value = value of type 'UInt8', that represents the number of tracked satellites 
          key = VISIBLE_SATELLITES, value = value of type 'UInt8', that represents the number of visible satellites
          key = SATELLITE_DETAILS, value = value of type SatelliteDetails[], 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 
    **>
	map SatelliteInfo {
		SatelliteInfoType to Value
	}
	
	enumeration StatusKey extends BasicEnum {
		TIMESTAMP       = 0x0001
		GNSS_FIX_STATUS = 0x0070
		DR_STATUS       = 0x0071
	}
	
    <**	  
       @description : StatusInfo = array of tuples (key,value)
          key = enumeration StatusInfoKey
          key = TIMESTAMP, value = value of type 'UInt64', that represents a timestamp in ms
          key = GNSS_FIX_STATUS, value = value of type 'UInt16', that represents an enum(INVALID(0x00),NO_FIX(0x01),TIME_FIX(0x02),2D_FIX(0x03),3D_FIX(0x04), ... )
          key = DR_STATUS, value = value of type 'Boolean', where TRUE means that a dead-reckoning algorithm has been used to calculate the current position
    **>    
	map StatusInfo {
		StatusKey to Value
	}
	
	enumeration TimeInfoType extends BasicEnum {
		TIMESTAMP       = 0x0001
	    YEAR            = 0x00a0
	    MONTH           = 0x00a1
	    DAY             = 0x00a2
	    HOUR            = 0x00a3
	    MINUTE          = 0x00a4
	    SECOND          = 0x00a5
	    MS              = 0x00a6
	}

    <**	  
       @description : TimeInfo = array of tuples (key,value)
          key = enumeration TimeInfoType
          key = TIMESTAMP, value = value of type 'UInt64', that represents a timestamp in ms
          key = YEAR, value = value of type 'UInt16', 4 digits number that indicates the year. Example: 2012
          key = MONTH, value = value of type 'UInt8', 2 digits number that indicates the month. Example: 03 means March
          key = DAY, value = value of type 'UInt8', 2 digits number that indicates the day. Range [0:31]. Example: 07
          key = HOUR, value = value of type 'UInt8', 2 digits number that indicates the hour. Range [0:23].  Example: 01
          key = MINUTE, value = value of type 'UInt8', 2 digits number that represents the minutes. Range [0:59]. Example: 01
          key = SECOND, value = value of type 'UInt8', 2 digits number that represents the seconds. Range [0:59]. Example: 01
          key = MS, value = value of type 'UInt16', 3 digits number that represents the milliseconds. Range [0:999]. Example: 007
	**>
	map TimeInfo {
		TimeInfoType to Value
	}
	
}