From: Christopher Peplin <chris.peplin@rhubarbtech.com>
Date: Thu, 26 Sep 2013 13:24:31 +0000 (-0400)
Subject: Document the RAW message format, including the bus attribute.
X-Git-Tag: 3.99.1~103^2~65
X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=commitdiff_plain;h=9bce073224cd7fb47327743ddc786199887556dc;p=apps%2Flow-level-can-service.git

Document the RAW message format, including the bus attribute.
---

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4022550..e40621a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # OpenXC Message Format Changelog
 
+## v0.2
+
+* Add a RAW can message format.
+
 ## v0.1
 
-* Initial release
+* Initial release.
diff --git a/README.md b/README.md
index 8837b52..81574a5 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
 =======