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
|
# OpenXC Message Format Specification
This specification is a part of the [OpenXC platform][OpenXC].
An OpenXC vehicle interface sends generic vehicle data over one or more output
interfaces (e.g. USB or Bluetooth) as JSON objects, separated by newlines.
There are two valid message types - single valued and evented.
There may not be a 1:1 relationship between input and output signals - i.e. raw
engine timing CAN signals may be summarized in an "engine performance" metric on
the abstract side of the interface.
## Single Valued
The expected format of a single valued message is:
{"name": "steering_wheel_angle", "value": 45}
## Evented
The expected format of an event message is:
{"name": "button_event", "value": "up", "event": "pressed"}
This format is good for something like a button event, where there are two
discrete pieces of information in the measurement.
## Official Signals
These signal names are a part of the OpenXC specification, although some
manufacturers may support custom message names.
* steering_wheel_angle
* numerical, degrees
* torque_at_transmission
* numerical, Nm
* engine_speed
* numerical, RPM
* vehicle_speed, numerical, Kph
* accelerator_pedal_position
* percentage
* parking_brake_status
* boolean, (true == brake engaged)
* brake_pedal_status
* boolean (True == pedal pressed)
* transmission_gear_position
* states: first, second, third, fourth, fifth, sixth, seventh, eighth,
reverse, neutral
* gear_lever_position
* states: neutral, park, reverse, drive, sport, low, first, second, third,
fourth, fifth, sixth
* odometer
* Numerical, km
* ignition_status
* states: off, accessory, run, start
* fuel_level
* percentage
* fuel_consumed_since_restart
* numerical, liters (goes to 0 every time the
vehicle interfaces power cycles)
* door_status
* Value is State: driver, passenger, rear_left, rear_right.
* Event is boolean: true == ajar
* headlamp_status
* boolean, true is on
* high_beam_status
* boolean, true is on
* windshield_wiper_status
* boolean, true is on
* latitude
* numerical
* longitude
* numerical
## Raw CAN Message format
An OpenXC vehicle interface may also output raw CAN messages. Each CAN message
is sent as a JSON object, separated by newlines. The format of each object is:
{"bus": 1, "id": 1234, "value": "0x12345678"}
**bus** - the numerical identifier of the CAN bus where this message originated,
most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
**id** - the CAN message ID
**data** - up to 8 bytes of data from the CAN message's payload, represented as
a hexidecimal number in a string. Many JSON parser cannot handle 64-bit
integers, which is why we are not using a numerical data type.
License
=======
Copyright (c) 2012-2013 Ford Motor Company
Licensed under the BSD license.
[OpenXC]: http://openxcplatform.com
|
