summaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-01-03 22:31:32 -0500
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-01-03 22:31:32 -0500
commitc670ab64a078ed882fbf3647334f370bae1e8cf3 (patch)
treed8629e6e5e2bf5de214b746a89cce63a935d152d /README.mkd
parent122d57e1c70b309542c1b5beb9e62d61726ccc02 (diff)
Move notes lower down in README.
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd23
1 files changed, 12 insertions, 11 deletions
diff --git a/README.mkd b/README.mkd
index 5e962f04..dd63ab8d 100644
--- a/README.mkd
+++ b/README.mkd
@@ -9,17 +9,6 @@ This library doesn't assume anything about the source of your diagnostic message
requests or underlying interface to the CAN bus. It uses dependency injection to
give you complete control.
-## OBD-II Basics
-
-TODO diagram out a request, response and error response
-
-* store the request arb id, mode, pid, and payload locally
-* send a can message
-* get all new can messages passed to it
-* Check the incoming can message to see if it matches one of the standard ECU
- response IDs, or our arb ID + 0x8
-* if it matches, parse the diagnostic response and call the callback
-
## Usage
First, create some shim functions to let this library use your lower level
@@ -167,6 +156,18 @@ You can also see the test coverage if you have `lcov` installed and the
$ BROWSER=google-chrome-stable make coverage
+## OBD-II Basics
+
+TODO diagram out a request, response and error response
+
+* store the request arb id, mode, pid, and payload locally
+* send a can message
+* get all new can messages passed to it
+* Check the incoming can message to see if it matches one of the standard ECU
+ response IDs, or our arb ID + 0x8
+* if it matches, parse the diagnostic response and call the callback
+
+
## Future Notes
you're going to request a few PIDs over and over again at some frequency