added trip meter property
[profile/ivi/automotive-message-broker.git] / docs / runningstatus.txt
1 Running Status hierarchy
2 =================
3
4 Service         org.automotive
5 Object path     /org/automotive/runningStatus/*
6
7 Interface:      org.automotive.vehiclePowerMode
8 Object path:    /org/automotive/runningStatus/vehiclePowerMode
9 Properties:     
10
11                 byte VehiclePowerMode [readonly]
12                         
13                         Off = 0,
14                         Accessory1 = 1,
15                         Accessory2 = 2,
16                         Run = 3
17
18 Interface:      org.automotive.vehicleSpeed
19 Object path:    /org/automotive/runningStatus/vehicleSpeed
20 Properties:     
21
22                 uint16 VehicleSpeed [readonly]
23                 
24                         Velocity of vehicle in kph.
25
26 Interface:      org.automotive.engineSpeed    
27 Object path:    /org/automotive/runningStatus/engineSpeed    
28 Properties:     
29
30                 uint16 EngineSpeed [readonly]
31                 
32                         Engine speed in revolutions per minute (RPM)
33                         
34 Interface:      org.automotive.tripMeter
35 Object path:    /org/automotive/runningStatus/tripMeter
36 Properties:     
37
38                 uint32 A [readwrite]
39                 
40                         Distance from trip meter(s) in km.  This can be only set to "0".
41
42                 uint32 B [readwrite]
43                 uint32 C [readwrite]
44                         
45 Interface:      org.automotive.transmission
46 Object path:    /org/automotive/runningStatus/transmission
47 Properties:     
48
49                 byte ShiftPosition [readonly]
50                 
51                         Neutral = 0,
52                         1st = 1,
53                         2nd = 2,
54                         3rd = 3,
55                         4th = 4,
56                         5th = 5,
57                         6th = 6,
58                         7th = 7,
59                         8th = 8,
60                         9th = 9,
61                         10th = 10,
62                         Drive = 96,
63                         Reverse = 128,
64                         Park = 255
65
66                 byte GearPosition [readonly]
67
68                         Neutral = 0,
69                         1st = 1,
70                         2nd = 2,
71                         3rd = 3,
72                         4th = 4,
73                         5th = 5,
74                         6th = 6,
75                         7th = 7,
76                         8th = 8,
77                         9th = 9,
78                         10th = 10,
79                         CVT = 64,
80                         Reverse = 128
81
82                 byte Mode [readonly]
83
84                         0 = normal,
85                         1 = sports,
86                         2 = economy,
87                         3 = oem custom,
88                         4 = oem custom2
89                         ...
90                         255 =
91                                                 
92 Interface:      org.automotive.cruiseControlStatus
93 Object path:    /org/automotive/runningStatus/cruiseControlStatus
94 Properties:     
95
96                 bool Activated [readonly]
97
98                         true = engaged, false not engaged
99
100                 uint16 Speed [readonly]
101                         
102                         Speed in kph.
103                 
104                         
105 Interface:      org.automotive.wheelBrake
106 Object path:    /org/automotive/runningStatus/wheelBrake
107 Properties:
108
109                 bool WheelBrake [readonly]
110                 
111                         Engaged = true
112                         Idle = false
113                         
114 Interface:      org.automotive.lightstatus
115 Object path:    /org/automotive/runningStatus/lightstatus
116 Properties:
117
118                 bool Head       [readonly]
119                 bool RightTurn  [readonly]
120                 bool LeftTurn   [readonly]
121                 bool Brake      [readonly]
122                 bool Fog        [readonly]
123                 bool Hazard     [readonly]
124                 bool Parking    [readonly]
125                 bool HighBeam   [readonly]
126                         
127 Interface:      org.automotive.interiorLightStatus
128 Object path:    /org/automotive/runningStatus/interiorLightStatus
129 Properties:     
130
131                 bool Driver     [readonly]
132                 bool Passenger  [readonly]
133                 bool Center     [readonly]
134
135                         
136 Interface:      org.automotive.horn
137 Object path:    /org/automotive/runningStatus/horn
138 Properties:     
139                 bool Horn [readonly]
140                         
141                         On = true / Off = false
142                         
143 Interface:      org.automotive.chime
144 Object path:    /org/automotive/runningStatus/chime
145 Properties:
146
147                 bool Chime [readonly]
148                 
149                         On = true / Off = false
150                         
151 Interface:      org.automotive.fuel
152 Object path:    /org/automotive/runningStatus/fuel
153 Properties:     
154
155                 byte Level [readonly]
156                 
157                         Remaining percentage of fuel.
158                         
159                 uint16 Range [readonly]
160                 
161                         Estimated fuel range with available fuel in km
162
163                 uint16 InstantConsumption [readonly]
164
165                         Fuel consumption in meters per liter of fuel.
166
167                 uint16 AverageConsumption [readonly]
168
169                         Average fuel consumption in meters per liter of fuel since last reset
170                         
171 Interface:      org.automotive.engineOil
172 Object path:    /org/automotive/runningStatus/engineOil
173 Properties:     
174
175                 byte Remaining [readonly]
176                 
177                         Remaining Oil life remaining; percentage
178
179                 byte Temperature [readonly]
180
181                         Engine Oil Temperature in degrees C
182
183                 uint16 Pressure [readonly]
184
185                         Engine Oil Pressure in kPa 
186                         
187
188 Interface:      org.automotive.engineCoolant
189 Object path:    /org/automotive/runningStatus/engineCoolant
190 Properties:     
191
192                 byte Level [readonly]
193                 
194                         Level of Engine Coolant (percentage of full)
195
196                 byte Temperature [readonly]
197
198                         Temperature of Engine Coolant in degrees C
199                         
200 Interface:      org.automotive.acceleration
201 Object path:    /org/automotive/runningStatus/acceleration
202 Properties:     
203
204                 double X [readonly]
205                 
206                         lateral acceleration as 1/1000 G
207
208                 double Y [readonly]
209         
210                         longitudinal acceleration as 1/1000 G
211                 
212                 double Z [readonly]
213
214                         vertical accelaration as 1/1000 G
215
216
217                 
218 Interface:      org.automotive.steeringWheelAngle
219 Object path:    /org/automotive/runningStatus/steeringWheelAngle
220 Properties:
221
222                 uint16 SteeringWheelAngle [readonly]
223                 
224                         Angle of the steering wheel (0-360)
225                         
226                                 
227