diff options
| author |   Sebastien Douheret <sebastien.douheret@iot.bzh> | 2017-03-20 11:13:28 +0100 |
|---|---|---|
| committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2017-03-20 12:19:25 +0100 |
| commit | 16db388d019dba0dcae16004c5529d5ee0760b3a (patch) | |
| tree | 0f88a7af9a64a4748442d379a00299c78cef758a /docs/README.md | |
| parent | ce0d90903caa993010d0873d429eec2ffdd63189 (diff) | |
Use gitbook to manage documentation
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..eccf553 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# Low level CAN binding for AGL + +## Abstract + +This project proposes a Low Level CAN Binding for AGL, with the following features: + +* CAN messages and diagnostic messages (OBD-II) are currently supported +* Description of CAN messages is done using JSON definition following OpenXC specifications (project OpenXC/vi-firmware) +* Encoding/Decoding of CAN messages reuses OpenXC libraries +* Proposes an API to other AGL applications and services to read/write on CAN bus(es). +* Uses a publish/subscribe model with filtering for sending messages to clients for efficiency |