aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-27 18:41:24 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-27 19:18:58 -0400
commit31c5f5de1980a68159b116090cee0072c47365da (patch)
tree42f0db9811e71f87d0ff6702c3baebb2ff2326b7 /README.md
parent397b27846f0ba22d62274dd0780e6870e7a67eed (diff)
Add a control command to control AF bypass status.
See openxc/vi-firmware#301.
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/README.md b/README.md
index e1523ab4..daed2935 100644
--- a/README.md
+++ b/README.md
@@ -297,11 +297,37 @@ forwarded.
**Response**
-If the bus and mode in the request were recognized, the `status` field in the
-response will be `true`. If `false`, the passthrough mode was not changed.
+If the bus in the request was valid and the passthrough mode was changed, the
+`status` field in the response will be `true`. If `false`, the passthrough mode
+was not changed.
{ "command_response": "passthrough", "status": true}
+#### Acceptance Filter Bypass
+
+The `af_bypass` command controls whether the CAN message acceptance filter is
+bypassed for each CAN controller. By default, hardware acceptance filter (AF) is
+enabled in the VI - only previously defined CAN message IDs will be received.
+Send this command with `bypass: true` to force the filters to bypassed.
+
+If `passthrough` mode is also enabled, when the AF is bypassed, the output will
+include all CAN messages received.
+
+**Request**
+
+ { "command": "af_bypass",
+ "bus": 1,
+ "bypass": true
+ }
+
+**Response**
+
+If the bus in the request was valid and the AF mode was changed, the `status`
+field in the response will be `true`. If `false`, the passthrough mode was not
+changed.
+
+ { "command_response": "af_bypass", "status": true}
+
### Trace File Format
An OpenXC vehicle trace file is a plaintext file that contains JSON objects,