README.md

   1 # OpenXC Message Format Specification
   2
   3 There are two valid message types - single valued and evented.
   4
   5 There may not be a 1:1 relationship between input and output signals - i.e. raw
   6 engine timing CAN signals may be summarized in an "engine performance" metric on
   7 the abstract side of the interface.
   8
   9 ## Single Valued
  10
  11 The expected format of a single valued message is:
  12
  13 {% highlight javascript %}
  14 {"name": "steering_wheel_angle", "value": 45}
  15 {% endhighlight %}
  16
  17 ## Evented
  18
  19 The expected format of an event message is:
  20
  21 {% highlight javascript %}
  22 {"name": "button_event", "value": "up", "event": "pressed"}
  23 {% endhighlight %}
  24
  25 This format is good for something like a button event, where there are two
  26 discrete pieces of information in the measurement.