diff options
| -rw-r--r-- | LICENSE | 24 | ||||
| -rw-r--r-- | README.md | 58 |
2 files changed, 82 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..9a30ce45 --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +Copyright (c) 2012 Ford Motor Company +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of the <organization> nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. @@ -1,5 +1,10 @@ # 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 @@ -20,3 +25,56 @@ The expected format of an event message is: 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 +* 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 + +License +======= + +Copyright (c) 2012-2013 Ford Motor Company + +Licensed under the BSD license. + +[OpenXC]: http://openxcplatform.com |