aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-20 22:56:37 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-20 22:56:37 -0400
commitef7c7dc0afab46f0e2e5eb8b051e769fb7a1a6b5 (patch)
treecf63e51b4c4fad01afcad08cc281303067aaa3a4 /README.md
parentb2692a38bffa2c223f62b0aab5ce2c510fdefa30 (diff)
Simplify passthrough command to just a boolean.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/README.md b/README.md
index feb40c44..258fb532 100644
--- a/README.md
+++ b/README.md
@@ -281,22 +281,18 @@ MAC address of an included Bluetooth module) into into the outgoing data stream.
#### Passthrough CAN Mode
-The `passthrough` command controls the passthrough mode for each of the CAN
-buses. There are three passthrough modes:
-
-* `off` - Only the specified simple vehicle messages are processed and output
- from the VI.
-* `filtered` - If the CAN acceptance filter is not otherwise disabled, only the
- pre-defined CAN messages (i.e. those compiled with the firmware) will be
- output in the low-level CAN format from VI.
-* `unfiltered` - All received CAN messages will be passed through from the bus
- to the VI's output.
+The `passthrough` command controls whether low-level CAN messages are passed
+through from the CAN bus through the VI to the output stream. If the CAN
+acceptance filter is in bypass mode and passthrough is enabled, the output
+stream will include all received CAN messages. If the bypass filter is enabled,
+only those CAN messages that have been pre-defined in the firmware are
+forwarded.
**Request**
{ "command": "passthrough"
"bus": 1,
- "mode":
+ "enabled": true
}
**Response**