b6fb902d7e6b3befc012d4e18e89f2e97b4f43a3
[profile/ivi/automotive-message-broker.git] / docs / runningstatus.txt
1 Running Status hierarchy
2 =================
3
4 Service         org.automotive
5 Interface       org.automotive.runningStatus
6 Object path     /runningStatus
7
8 Properties      byte VehiclePowerMode [readonly]
9                         
10                         Off = 0,
11                         Accessory1 = 1,
12                         Accessory2 = 2,
13                         Run = 3
14                                 
15                 uint16 VehicleSpeed [readonly]
16                 
17                         Velocity of vehicle in kph.
18
19                 uint16 EngineSpeed [readonly]
20                 
21                         Engine speed in rotations per minute (RPM)
22                         
23                 uint16 FuelEconomy [readonly]
24                 
25                         Fuel Economy in grams of fuel per minute.
26                         
27                 array{uint32} TripMeter [readonly]
28                 
29                         Distance from trip meter(s) in km.
30                         
31                 byte TransmissionGearStatus [readonly]
32                 
33                         Neautral = 0,
34                         1st = 1,
35                         2nd = 2,
36                         3rd = 3,
37                         4th = 4,
38                         5th = 5,
39                         6th = 6,
40                         7th = 7,
41                         8th = 8,
42                         9th = 9,
43                         10th = 10,
44                         Drive = 64,
45                         Reverse = 128,
46                         Park = 256
47                         
48                         For transmissions with no gear (ie CVT), 'Drive' and 'Reverse' will be used.
49                         
50                 struct{bool, uint16} CruiseControlStatus [readonly]
51                 
52                         Activated/Deactivated, Speed in kph.
53                         
54                 bool WheelBrake [readonly]
55                 
56                         Engaged = true
57                         Idle = false
58                         
59                 dict{byte, bool} LightStatus [readonly]
60                 
61                         Light (uint16), On=true/Off=false
62                         Light Type:
63                         Head = 0,
64                         RightTurn = 1,
65                         LeftTurn = 2,
66                         Brake = 3,
67                         Fog = 4,
68                         Hazard = 5,
69                         Parking = 6,
70                         HighBeam = 7
71                         
72                 dict{byte, bool} InteriorLightStatus [readonly]
73                 
74                         Interior Light (uint16), On = true / Off = false
75                         Interior Light Type:
76                         Driver = 0,
77                         Passenger = 1,
78                         Center = 2
79                         
80                 bool Horn [readonly]
81                         
82                         On = true / Off = false
83                         
84                 bool Chime [readonly]
85                 
86                         On = true / Off = false
87                         
88                 byte FuelLevel [readonly]
89                 
90                         Remaining percentage of fuel.
91                         
92                 uint16 FuelRange
93                 
94                         Estimated fuel range with available fuel in km
95                         
96                 struct{ byte, byte, byte } EngineOil
97                 
98                         Remaining Oil Percentage (byte)
99                         Engine Oil Temperature (byte)
100                         Engine Oil Pressure (byte)
101                         
102                 struct{ byte, byte } EngineCoolant
103                 
104                         Level (byte)
105                         Temperature (byte)
106                         
107                 struct{ uint16, uint16, uint16 } Acceleration
108                 
109                         X, Y and Z acceleration in m/s*s
110                 
111                 struct{ uint16, uint16, byte, uint32 } VehicleOdometry
112                 
113                         x_mm (uint16)
114                         y_mm (uint16)
115                         angle (byte)
116                         timestamp (in number of seconds since unix epoch: Jan 1, 1970) (uint32)
117                         
118                 uint16 SteeringWheelAngle
119                 
120                         Angle of the steering wheel (0-360)
121                         
122                 struct{ uint16, uint16 } WheelTickSensor
123                 
124                         Left wheel rotation counter (uint16)
125                         Right wheel rotation counter (uint16)
126                         
127                                 
128