From 9bce073224cd7fb47327743ddc786199887556dc Mon Sep 17 00:00:00 2001 From: Christopher Peplin Date: Thu, 26 Sep 2013 09:24:31 -0400 Subject: [PATCH] Document the RAW message format, including the bus attribute. --- CHANGELOG.md | 6 +++++- README.md | 16 ++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) 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 ======= -- 2.16.6