aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..a7897207
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,9 @@
+# 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