From 9bce073224cd7fb47327743ddc786199887556dc Mon Sep 17 00:00:00 2001
From: Christopher Peplin <chris.peplin@rhubarbtech.com>
Date: Thu, 26 Sep 2013 09:24:31 -0400
Subject: Document the RAW message format, including the bus attribute.

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8837b522..81574a5c 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,22 @@ manufacturers may support custom message names.
 * longitude
     * numerical
 
+## Raw CAN Message format
+
+An OpenXC vehicle interface may also output raw CAN messages. Each CAN message
+is sent as a JSON object, separated by newlines. The format of each object is:
+
+    {"bus": 1, "id": 1234, "value": "0x12345678"}
+
+**bus** - the numerical identifier of the CAN bus where this message originated,
+  most likely 1 or 2 (for a vehicle interface with 2 CAN controllers).
+
+**id** - the CAN message ID
+
+**data** - up to 8 bytes of data from the CAN message's payload, represented as
+  a hexidecimal number in a string. Many JSON parser cannot handle 64-bit
+  integers, which is why we are not using a numerical data type.
+
 License
 =======
 
-- 
cgit