aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-03-27 11:52:14 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-03-27 11:52:14 -0400
commit5e0b413db0e57659bd6e654566d9aad5fc00e1e8 (patch)
treeb2a0cd4d06a81e60b3a202b0dc0961771d2fc96e
parent4a95199ecb9411d75fbf9038fe9490f153476fa8 (diff)
Clarify that 'newline' in trace file may or may not have \r.
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0ad8942d..f26c5d1b 100644
--- a/README.md
+++ b/README.md
@@ -34,8 +34,7 @@ discrete pieces of information in the measurement.
## 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:
+The format for a raw CAN message:
{"bus": 1, "id": 1234, "value": "0x12345678"}
@@ -217,7 +216,8 @@ MAC address of an included Bluetooth module) into into the outgoing data stream.
## Trace File Format
An OpenXC vehicle trace file is a plaintext file that contains JSON objects,
-separated by newlines.
+separated by newlines (which may be either `\r\n` or `\n`, depending on the
+platform the trace file was recorded).
The first line may be a metadata object, although this is optional: