summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2013-09-26 09:24:31 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2013-09-26 09:24:31 -0400
commit9bce073224cd7fb47327743ddc786199887556dc (patch)
treed40474e299fc7d71dbbc3c636e4bb0b47b9d4477 /README.md
parentd121ae6f20376dc6fa75ef1140d7767f4ae236af (diff)
Document the RAW message format, including the bus attribute.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
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
=======