summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-29 21:52:34 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-29 21:53:27 -0400
commit68ce7c57c76496efb28c385428b0e2d797d8df74 (patch)
tree688a88b4f13d1a63ac6d16e80fbaf1c4bd829409 /README.md
parent1e8b40f719ac43ea53e414e311d9387757630de6 (diff)
Add a command to enable/disable pre-defined OBD-II requests.
See openxc/vi-firmware#303.
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index e127543f..4b0c32bc 100644
--- a/README.md
+++ b/README.md
@@ -349,6 +349,27 @@ messages will be in the new format.
{ "command_response": "payload_format", "status": true}
+#### Automatic Pre-Defined OBD-II PID Requests
+
+The `predefined_obd2` command enables and disables the querying for and
+translating of a set of pre-defined OBD-II PIDs from the attached vehicle. When
+enabled, the VI will query the vehicle to see if these PIDs are claimed to be
+supported and for those that are, it will set up recurring requests. The
+responses will be output as simple vehicle messages, with the names defined in
+the "Signals Defined from Diagnostic Messages" section below.
+
+**Request**
+
+ { "command": "predefined_obd2",
+ "enabled": true
+ }
+
+**Response**
+
+f the predefined requests were enabled or disabled successfully, the `status` in
+the response will be `true`.
+
+ { "command_response": "predefined_obd2", "status": true}
### Trace File Format
@@ -451,7 +472,7 @@ manufacturers may support custom message names.
* numerical, -179.0 to 179.0 degrees with standard GPS accuracy
* 1Hz
-### Signals from Diagnostics Messages
+### Signals from Diagnostic Messages
This set of signals is often retreived from OBD-II requests. The units can be
found in the [OBD-II standard](http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).