aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-03-27 11:38:33 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-03-27 11:38:33 -0400
commit4a95199ecb9411d75fbf9038fe9490f153476fa8 (patch)
treef6b7c62a4a921d18473bf354e12bfa769f19bf21
parentab912b63e81209637f77f2e3eba23c5e75309dcb (diff)
Document delimiters for both formats.
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index f67dad98..0ad8942d 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,22 @@
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.
+interfaces (e.g. USB or Bluetooth) as JSON or Protocol Buffers (protobuf).
-There are two valid message types - single valued and evented.
+This document describes the JSON format and includes a high level description of
+each type and field. Each JSON message published by a VI is delimited with a
+`\0` character.
+
+The Protocol Buffer format is specified in the file `openxc.proto`. Those are
+published using the standard length-delimited method (any protobuf library
+should support this).
+
+## Single Valued
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:
{"name": "steering_wheel_angle", "value": 45}