summaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2013-12-27 14:02:14 -0500
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2013-12-27 14:02:14 -0500
commite6d46d95d3165ae944c1b235b94002a09a83fde9 (patch)
tree9240fa9ba705a4868105f8b373b5c3ee2c39eb6d /README.mkd
parent9dafed6b7fe2fe45f44aa8c614d51388f84bb696 (diff)
Sketch out the API and add some notes.
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.mkd b/README.mkd
index a8497071..530ebad5 100644
--- a/README.mkd
+++ b/README.mkd
@@ -1,5 +1,16 @@
-ISO 15765-2 Support Library in C
-============
+ISO-TP (ISO 15765-2) Support Library in C
+================================
+
+## API
+
+ IspTpHandler handler = isotp_init(42, NULL, NULL, NULL);
+ isotp_send(const uint8_t* payload, uint16_t payload_size);
+ while(true) {
+ isotp_handle_can_frame(42, data, 8);
+ }
+ isotp_destroy(&handler);
+
+// TODO should handlers take a context? depends on how we want to use this
## Testing