aboutsummaryrefslogtreecommitdiffstats
path: root/docs/1-Architecture.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-06-19 16:14:48 +0000
committerRomain Forlot <romain.forlot@iot.bzh>2017-06-19 16:30:26 +0000
commitc70baaeb249f0e1dc5c9e14344e60afe68d64698 (patch)
tree5f9cb0fe6b33405556081d878a9f39be0e9f5d2a /docs/1-Architecture.md
parent686079f69c60571219ad5c77b2e024fb58d6e446 (diff)
Update documentation.
Change-Id: I0dfdb6d9461073ed021663aed4d2f36040fb1356 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/1-Architecture.md')
-rw-r--r--docs/1-Architecture.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/1-Architecture.md b/docs/1-Architecture.md
index 487c467..d92fea9 100644
--- a/docs/1-Architecture.md
+++ b/docs/1-Architecture.md
@@ -1,6 +1,8 @@
# AGL VIWI HIGH-CAN binding architecture
-This binding is intended to act between low-level binding(s) and clients. It builds ViWi resources as defined in a json configuration file, and implements subscribe/unsubscribe/get verbs for the clients. Each ViWi resource can be composed of several elements, for which subscriptions will be made to the low-level binding with configurable frequencies or filters.
+This binding is intended to act between low-level binding(s) and clients. It builds ViWi resources as defined in a json configuration file. It implements subscribe/unsubscribe/get verbs for the clients accordingly with protocol specification.
+
+Each ViWi resource can be composed of several elements, for which subscriptions will be made to the low-level binding with configurable frequencies or filters.
![ViWi High Level binding architecture](images/high-level-arch.png)
@@ -12,7 +14,7 @@ ViWi (Volkswagen Infotainment Web Interface) protocol defines a serie of objects
Each object is assigned with a unique URI.
-The depth of the URI tree is limited to 3, i.e. /service/resource>/element/, for instance **/car/doors/3901a278-ba17-44d6-9aef-f7ca67c04840**.
+The depth of the URI tree is limited to 3, i.e. _/service/resource>/element/_, for instance **/car/doors/3901a278-ba17-44d6-9aef-f7ca67c04840**.
To retrieve the list of elements for a given resource, one can use the get command, for instance **get /car/doors/**.