summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3ae3775bbae005da22ad7a742bf6c3b589b0882b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# OpenXC Message Format Specification

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
engine timing CAN signals may be summarized in an "engine performance" metric on
the abstract side of the interface.

## Single Valued

The expected format of a single valued message is:

{% highlight javascript %}
{"name": "steering_wheel_angle", "value": 45}
{% endhighlight %}

## Evented

The expected format of an event message is:

{% highlight javascript %}
{"name": "button_event", "value": "up", "event": "pressed"}
{% endhighlight %}

This format is good for something like a button event, where there are two
discrete pieces of information in the measurement.