summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-09-19 23:29:55 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2017-12-14 11:00:25 +0100
commitb68f95e384aa35b54e453b5e7d09dabf8d82340c (patch)
tree484d64cedb2212a1a8729e6ed36d25627f37875c
parent6bddf7ebf961762b1248cb58c0245e28f81b8d91 (diff)
Detailled transport layer architecture.
Change-Id: Id2e5622aeee5e670043fac26b10f012d09a7fea0 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
-rw-r--r--docs/part-1/1-Architecture.md14
-rw-r--r--docs/part-1/pictures/Global_Signaling_Architecture.pngbin182698 -> 195325 bytes
2 files changed, 12 insertions, 2 deletions
diff --git a/docs/part-1/1-Architecture.md b/docs/part-1/1-Architecture.md
index 9d1e328..daf1e37 100644
--- a/docs/part-1/1-Architecture.md
+++ b/docs/part-1/1-Architecture.md
@@ -10,9 +10,9 @@ Key here are on both layer, **low** and **high**.
- **Low level** are in charge of handle a data exchange protocol to
decode/encode and retransmit with an AGL compatible format, most convenient
- way using **Application Framework** event. These are divised in two parts,
+ way using **Application Framework** event. These are divided in two parts,
which are :
- - Transport Layer plug-in that read/write 1 protocol.
+ - Transport Layer plug-in that are able to read/write a protocol.
- Decoding/Encoding part that expose signals and a way to access them.
- **High level signal composer** gathers multiple **low level** signaling
sources and creates new virtuals signals from the **raw** signals defined (eg.
@@ -22,6 +22,15 @@ Key here are on both layer, **low** and **high**.
define signaling composition with simple or complex operation to output value
from **raw** signals
+A transport plug-in is a shared library that shared a common API to be compatible with **low level** services that is:
+
+- **open/close**: method to open a handle which could be a socket, file or
+ device by example.
+- **read/write**: method to read and write a stream of data.
+
+Configuration is made by sending a special packet using a write method to the
+handle. In brief, this could be compared to the layer 1 and 2 of [OSI model].
+
There are three main parts with **Signal Composer**:
- Configuration files which could be splitted in differents files. That will
@@ -47,4 +56,5 @@ Here is a little terminology guide to set the vocabulary:
calculated by a **callbacks**
- **raw signals**: an event generated by a **low level** binding
+[OSI model]: https://en.wikipedia.org/wiki/OSI_model
[GlobalArchitecture]: pictures/Global_Signaling_Architecture.png "Global architecture"
diff --git a/docs/part-1/pictures/Global_Signaling_Architecture.png b/docs/part-1/pictures/Global_Signaling_Architecture.png
index 7934d3f..5cfba98 100644
--- a/docs/part-1/pictures/Global_Signaling_Architecture.png
+++ b/docs/part-1/pictures/Global_Signaling_Architecture.png
Binary files differ