X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=13622d683ac059b2600865b6b64e46f8541d9369;hb=8e6aeac288787abbe415c90c8ef490a90b2a6c46;hp=ceb7ec3548052ecae993dc9254a9076e8365f4bd;hpb=1c602e1df648f8ef2665278251316d1ee31cecd2;p=apps%2Flow-level-can-service.git

diff --git a/README.md b/README.md
index ceb7ec3..13622d6 100644
--- a/README.md
+++ b/README.md
@@ -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