1 # OpenXC Message Format Specification
3 This specification is a part of the [OpenXC platform][OpenXC].
5 An OpenXC vehicle interface sends generic vehicle data over one or more output
6 interfaces (e.g. USB or Bluetooth) as JSON objects, separated by newlines.
8 There are two valid message types - single valued and evented.
10 There may not be a 1:1 relationship between input and output signals - i.e. raw
11 engine timing CAN signals may be summarized in an "engine performance" metric on
12 the abstract side of the interface.
16 The expected format of a single valued message is:
18 {"name": "steering_wheel_angle", "value": 45}
22 The expected format of an event message is:
24 {"name": "button_event", "value": "up", "event": "pressed"}
26 This format is good for something like a button event, where there are two
27 discrete pieces of information in the measurement.
29 ## Raw CAN Message format
31 An OpenXC vehicle interface may also output raw CAN messages. Each CAN message
32 is sent as a JSON object, separated by newlines. The format of each object is:
34 {"bus": 1, "id": 1234, "value": "0x12345678"}
36 **bus** - the numerical identifier of the CAN bus where this message originated,
37 most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
39 **id** - the CAN message ID
41 **data** - up to 8 bytes of data from the CAN message's payload, represented as
42 a hexidecimal number in a string. Many JSON parser cannot handle 64-bit
43 integers, which is why we are not using a numerical data type.
45 ## Diagnostic Messages
49 A request to add or update a diagnostic request is sent to a vehicle interface
50 with this command format:
52 { "command": "diagnostic_request",
59 "parse_payload": true,
67 **bus** - the numerical identifier of the CAN bus where this request should be
68 sent, most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
70 **id** - the CAN arbitration ID for the request.
72 **mode** - the OBD-II mode of the request - 1 through 15 (1 through 9 are the
75 **pid** - (optional) the PID for the request, if applicable.
77 **payload** - (optional) up to 7 bytes of data for the request's payload
78 represented as a hexidecimal number in a string. Many JSON parser cannot
79 handle 64-bit integers, which is why we are not using a numerical data type.
81 **parse_payload** - (optional, false by default) if true, the complete payload in the
82 response message will be parsed as a number and returned in the 'value' field of
83 the response. The 'payload' field will be omitted in responses with a
86 **factor** - (optional, 1.0 by default) if `parse_payload` is true, the value in
87 the payload will be multiplied by this factor before returning. The `factor`
88 is applied before the `offset`.
90 **offset** - (optional, 0 by default) if `parse_payload` is true, this offset
91 will be added to the value in the payload before returning. The `offset` is
92 applied after the `factor`.
94 **frequency** - (optional, defaults to 0) The frequency in Hz to send this
95 request. To send a single request, set this to 0 or leave it out.
97 The `bus+id+mode+pid` key is unique, so if you send a create request with that
98 key twice, it'll overwrite the existing one (i.e. it will change the frequency,
99 the only other parameter). To cancel a recurring request, send this command with
100 the frequency set to 0.
102 TODO it'd be nice to have the OBD-II PIDs built in, with the proper conversion
103 functions - that may need a different output format
105 If you're just requesting a PID, you can use this minimal field set for the
108 {"bus": 1, "id": 1234, "mode": 1, "pid": 5}
117 "negative_response_code": 17,
119 "parsed_payload": 4660}
121 **bus** - the numerical identifier of the CAN bus where this response was
124 **id** - the CAN arbitration ID for this response.
126 **mode** - the OBD-II mode of the original diagnostic request.
128 **pid** - (optional) the PID for the request, if applicable.
130 **success** - true if the response received was a positive response. If this
131 field is false, the remote node returned an error and the
132 `negative_response_code` field should be populated.
134 **negative_response_code** - (optional) If requested node returned an error,
135 `success` will be `false` and this field will contain the negative response
138 Finally, the `payload` and `value` fields are mutually exclusive:
140 **payload** - (optional) up to 7 bytes of data returned in the response,
141 represented as a hexadecimal number in a string. Many JSON parser cannot
142 handle 64-bit integers, which is why we are not using a numerical data type.
144 **value** - (optional) if the response had a payload, this may be the
145 payload interpreted as an integer and transformed with a factor and offset
146 provided with the request.
148 The response to a simple PID request would look like this:
150 {"bus": 1, "id": 1234, "mode": 1, "pid": 5, "payload": "0x2"}
152 TODO again, it'd be nice to have the OBD-II PIDs built in, with the proper
153 conversion functions so the response here included the actual transformed value
154 of the pid and a human readable name
158 An OpenXC vehicle trace file is a plaintext file that contains JSON objects,
159 separated by newlines.
161 The first line may be a metadata object, although this is optional:
166 "vehicle_interface_id": "7ABF",
170 "trim": "V6 Premium",
173 "description": "highway drive to work",
174 "driver_name": "TJ Giuli",
175 "vehicle_id": "17N1039247929"
179 The following lines are OpenXC messages with a `timestamp` field added, e.g.:
181 {"timestamp": 1385133351.285525, "name": "steering_wheel_angle", "value": 45}
183 The timestamp is in [UNIX time](http://en.wikipedia.org/wiki/Unix_time)
184 (i.e. seconds since the UNIX epoch, 00:00:00 UTC, 1/1/1970).
188 These signal names are a part of the OpenXC specification, although some
189 manufacturers may support custom message names.
191 * steering_wheel_angle
192 * numerical, -600 to +600 degrees
194 * torque_at_transmission
195 * numerical, -500 to 1500 Nm
198 * numerical, 0 to 16382 RPM
201 * numerical, 0 to 655 km/h (this will be positive even if going in reverse
202 as it's not a velocity, although you can use the gear status to figure out
205 * accelerator_pedal_position
208 * parking_brake_status
209 * boolean, (true == brake engaged)
210 * 1Hz, but sent immediately on change
212 * boolean (True == pedal pressed)
213 * 1Hz, but sent immediately on change
214 * transmission_gear_position
215 * states: first, second, third, fourth, fifth, sixth, seventh, eighth,
217 * 1Hz, but sent immediately on change
218 * gear_lever_position
219 * states: neutral, park, reverse, drive, sport, low, first, second, third,
221 * 1Hz, but sent immediately on change
224 0 to 16777214.000 km, with about .2m resolution
227 * states: off, accessory, run, start
228 * 1Hz, but sent immediately on change
232 * fuel_consumed_since_restart
233 * numerical, 0 - 4294967295.0 L (this goes to 0 every time the vehicle
234 restarts, like a trip meter)
237 * Value is State: driver, passenger, rear_left, rear_right.
238 * Event is boolean: true == ajar
239 * 1Hz, but sent immediately on change
241 * boolean, true is on
242 * 1Hz, but sent immediately on change
244 * boolean, true is on
245 * 1Hz, but sent immediately on change
246 * windshield_wiper_status
247 * boolean, true is on
248 * 1Hz, but sent immediately on change
250 * numerical, -89.0 to 89.0 degrees with standard GPS accuracy
253 * numerical, -179.0 to 179.0 degrees with standard GPS accuracy
259 Copyright (c) 2012-2013 Ford Motor Company
261 Licensed under the BSD license.
263 [OpenXC]: http://openxcplatform.com