Skip to content

Commit 8e6aeac

Browse files
committed
Add license and official signal list.
1 parent 1c602e1 commit 8e6aeac

File tree

2 files changed

+82
-0
lines changed

2 files changed

+82
-0
lines changed

LICENSE

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Copyright (c) 2012 Ford Motor Company
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
* Redistributions of source code must retain the above copyright
7+
notice, this list of conditions and the following disclaimer.
8+
* Redistributions in binary form must reproduce the above copyright
9+
notice, this list of conditions and the following disclaimer in the
10+
documentation and/or other materials provided with the distribution.
11+
* Neither the name of the <organization> nor the
12+
names of its contributors may be used to endorse or promote products
13+
derived from this software without specific prior written permission.
14+
15+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18+
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
19+
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# OpenXC Message Format Specification
22

3+
This specification is a part of the [OpenXC platform][OpenXC].
4+
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.
7+
38
There are two valid message types - single valued and evented.
49

510
There may not be a 1:1 relationship between input and output signals - i.e. raw
@@ -20,3 +25,56 @@ The expected format of an event message is:
2025

2126
This format is good for something like a button event, where there are two
2227
discrete pieces of information in the measurement.
28+
29+
## Official Signals
30+
31+
These signal names are a part of the OpenXC specification, although some
32+
manufacturers may support custom message names.
33+
34+
* steering_wheel_angle
35+
* numerical, degrees
36+
* torque_at_transmission
37+
* numerical, Nm
38+
* engine_speed
39+
* numerical, RPM
40+
* vehicle_speed, numerical, Kph
41+
* accelerator_pedal_position
42+
* percentage
43+
* parking_brake_status
44+
* boolean, (true == brake engaged)
45+
* brake_pedal_status
46+
* boolean (True == pedal pressed)
47+
* transmission_gear_position
48+
* states: first, second, third, fourth, fifth, sixth, seventh, eighth,
49+
reverse, neutral
50+
* odometer
51+
* Numerical, km
52+
* ignition_status
53+
* states: off, accessory, run, start
54+
* fuel_level
55+
* percentage
56+
* fuel_consumed_since_restart
57+
* numerical, liters (goes to 0 every time the
58+
vehicle interfaces power cycles)
59+
* door_status
60+
* Value is State: driver, passenger, rear_left, rear_right.
61+
* Event is boolean: true == ajar
62+
* headlamp_status
63+
* boolean, true is on
64+
* high_beam_status
65+
* boolean, true is on
66+
* windshield_wiper_status
67+
* boolean, true is on
68+
* latitude
69+
* numerical
70+
* longitude
71+
* numerical
72+
73+
License
74+
=======
75+
76+
Copyright (c) 2012-2013 Ford Motor Company
77+
78+
Licensed under the BSD license.
79+
80+
[OpenXC]: http://openxcplatform.com

0 commit comments

Comments
 (0)