diff options
author | Christopher Peplin <chris.peplin@rhubarbtech.com> | 2014-09-20 21:47:09 -0400 |
---|---|---|
committer | Christopher Peplin <chris.peplin@rhubarbtech.com> | 2014-09-20 21:48:49 -0400 |
commit | 625dae730013a4c59a1bd0bacc1f743676274e24 (patch) | |
tree | cc1316839151028e49714d3999c2f9e27ef196ee /README.md | |
parent | ee93c3b20add6fb1bfda64a70c8d8325e3c138d7 (diff) |
Add passthrough command and refactor commands in binary format.
The ControlCommand is now more like a VehicleMessage - it has a 'type'
and many optional fields pointing to the various types. If the type is
diagnostic, the client should look at the diagnostic_request field.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
@@ -279,6 +279,33 @@ MAC address of an included Bluetooth module) into into the outgoing data stream. { "command_response": "device_id", "message": "0012345678"} +#### 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. + +**Request** + + { "command": "passthrough" + "bus": 1, + "mode": + } + +**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. + + { "command_response": "passthrough", "status": true} + ### Trace File Format An OpenXC vehicle trace file is a plaintext file that contains JSON objects, |