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
|
<?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"?>
<node name="/org/genivi/demonstrator" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="introspect.xsd">
<interface name="org.genivi.demonstrator.FuelStopAdvisor">
<version>1.0.0 (11-08-2014)</version>
<doc>
<line>FuelStopAdvisor = This interface offers functionalities to access the fuel stop advisor features</line>
<line>This interface is defined for the FSA demonstrator and not included into the GENIVI compliance</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="SetUnits">
<doc>
<line>SetUnits = This method sets the calculation unit for a given value</line>
</doc>
<arg name="data" type="a{ii}" direction="in">
<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>key = enum(INVALID,ODOMETER,FUEL_LEVEL,DISTANCE,INSTANT_FUEL_CONSUMPTION_PER_DISTANCE,AVERAGE_FUEL_CONSUMPTION_PER_DISTANCE,AVERAGE_SPEED,TANK_DISTANCE,ENHANCED_TANK_DISTANCE,...,ALL)</line>
<line>for each key, the value of type 'q' expresses the unit used, METRIC or NON_METRIC</line>
<line>see details for each key into the getters</line>
</doc>
</arg>
</method>
<method name="GetInstantData">
<doc>
<line>GetInstantData = This method returns a given set of global (not related to a trip number) trip computer data (e.g. odometer, fuel level, tank distance... )</line>
</doc>
<arg name="data" type="a{i(yv)}" 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>key = enum(INVALID,ODOMETER,FUEL_LEVEL,TANK_DISTANCE,ENHANCED_TANK_DISTANCE,...,ALL)</line>
<line>key = ODOMETER, value = value of type 'u', that expresses the total distance counter in: METRIC->tenth of kilometers NON_METRIC->tenth of miles</line>
<line>key = FUEL_LEVEL, value = value of type 'q', that expresses fuel level in: METRIC->tenth of liters NON_METRIC->hundreth of gallon</line>
<line>key = TANK_DISTANCE, value = value of type 'q', that expresses the tank distance since the last reset of the trip computer in METRIC->kilometers or in NON_METRIC->miles</line>
<line>key = ENHANCED_TANK_DISTANCE, value = value of type 'q', that expresses the tank distance since the last reset of the trip computer in METRIC->kilometers or in NON_METRIC->miles</line>
</doc>
</arg>
</method>
<method name="GetSupportedTripNumbers">
<doc>
<line>GetSupportedTripNumbers = This method returns the number of supported trips</line>
</doc>
<arg name="tripNumbers" type="y" direction="out">
<doc>
<line>tripNumbers = value of 'y'</line>
</doc>
</arg>
</method>
<method name="GetTripData">
<doc>
<line>GetTripData = This method returns the data of a given trip number</line>
</doc>
<arg name="number" type="y" direction="in">
<doc>
<line>number= value of type 'y' that expresses the trip number (start number is 0)</line>
</doc>
</arg>
<arg name="tripData" type="a{i(yv)}" 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>key = enum(INVALID,DISTANCE,TIME,INSTANT_FUEL_CONSUMPTION_PER_DISTANCE,AVERAGE_FUEL_CONSUMPTION_PER_DISTANCE,AVERAGE_SPEED,...,ALL)</line>
<line>key = DISTANCE, value = value of type 'q', that expresses the distance since the last reset of the trip computer in METRIC->tenth of kilometers or in NON_METRIC->tenth of miles </line>
<line>key = TIME, value = value of type 'u', that expresses the elapsed time since the last reset of the trip computer in seconds</line>
<line>key = INSTANT_FUEL_CONSUMPTION_PER_DISTANCE, value = value of type 'q', that expresses the instant fuel consumption per distance in METRIC->tenth of liters per 100 kilometers or the instant distance per fuel consumption in NON_METRIC->tenth of miles per gallon</line>
<line>key = AVERAGE_FUEL_CONSUMPTION_PER_DISTANCE, value = value of type 'q', that expresses the average fuel consumption per distance since the last reset of the trip computer in METRIC->tenth of liters per 100 kilometers or the average distance per fuel consumption in NON_METRIC->tenth of miles per gallon</line>
<line>key = AVERAGE_SPEED, value = value of type 'q', that expresses the average speed since the last reset of the trip computer in METRIC->tenth of kilometers per hour or in NON_METRIC->tenth of miles per hour</line>
</doc>
</arg>
</method>
<method name="ResetTripData">
<doc>
<line>ResetTripData = This method resets the data of a given trip</line>
</doc>
<arg name="number" type="y" direction="in">
<doc>
<line>number= value of type 'y' that expresses the trip number</line>
</doc>
</arg>
</method>
<signal name="TripDataResetted">
<doc>
<line>TripDataReset = This signal is emitted to notifiy a client application that the data of the given trip number has been resetted</line>
</doc>
<arg name="number" type="y">
<doc>
<line>number= value of type 'y' that expresses the trip number</line>
</doc>
</arg>
</signal>
<signal name="TripDataUpdated">
<doc>
<line>TripDataUpdated = This signal is emitted to notifiy a client application that the data has been updated</line>
</doc>
<arg name="number" type="y">
<doc>
<line>number= value of type 'y' that expresses the trip number</line>
</doc>
</arg>
</signal>
<method name="SetFuelAdvisorSettings">
<doc>
<line>SetFuelAdvisorSettings = This method configures the fuel stop advisor settings</line>
</doc>
<arg name="advisorMode" type="b" direction="in">
<doc>
<line>advisorMode = flag. TRUE means that the advisor is activated</line>
</doc>
</arg>
<arg name="distanceThreshold" type="y" direction="in">
<doc>
<line>distanceThreshold= value of type 'y' that expresses the distance threshold in METRIC->kilometers or in NON_METRIC->miles</line>
</doc>
</arg>
</method>
<method name="GetFuelAdvisorSettings">
<doc>
<line>GetFuelAdvisorSettings = This method get the fuel stop advisor settings</line>
</doc>
<arg name="advisorMode" type="b" direction="out">
<doc>
<line>advisorMode = flag. TRUE means that the advisor is activated</line>
</doc>
</arg>
<arg name="distanceThreshold" type="y" direction="out">
<doc>
<line>distanceThreshold= value of type 'y' that expresses the distance threshold in METRIC->kilometers or in NON_METRIC->miles</line>
</doc>
</arg>
<arg name="destinationCantBeReached" type="b" direction="out">
<doc>
<line>destinationCantBeReached = TRUE means that there's a risk of not reaching the destination </line>
</doc>
</arg>
</method>
<method name="SetRouteHandle">
<doc>
<line>SetRouteHandle = This method configures the route handle for the enhanced tank distance</line>
</doc>
<arg name="routeHandle" type="u" direction="in">
<doc>
<line>routeHandle = Route handle. Range[0x0:0x7fffffff]. </line>
</doc>
</arg>
</method>
<method name="ReleaseRouteHandle">
<doc>
<line>ReleaseRouteHandle = This method release the route handle for the enhanced tank distance</line>
</doc>
<arg name="routeHandle" type="u" direction="in">
<doc>
<line>routeHandle = Route handle. Range[0x0:0x7fffffff].</line>
</doc>
</arg>
</method>
<signal name="FuelStopAdvisorWarning">
<doc>
<line>FuelStopAdvisorWarning = This signal is emitted to notify a client application whether there's a risk of not reaching the destination</line>
</doc>
<arg name="destinationCantBeReached" type="b">
<doc>
<line>destinationCantBeReached = TRUE means that there's a risk of not reaching the destination </line>
</doc>
</arg>
</signal>
</interface>
</node>
|
