diff options
author | Romain Forlot <romain.forlot@iot.bzh> | 2017-09-19 16:43:41 +0200 |
---|---|---|
committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-12-14 11:00:25 +0100 |
commit | e11314b2e9fef34f569bb7b042b432aed661cdc0 (patch) | |
tree | aaaae4d5820238e53a555f290a0a1ea8faa28b9e /docs/part-1/1-Architecture.md | |
parent | f4fba8a2744991ff8c5cb8af4a67c7d9456f1057 (diff) |
Added documentation
Change-Id: Iaa6bb0470652d3d0dc97c6320dbf210567ccec80
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/part-1/1-Architecture.md')
-rw-r--r-- | docs/part-1/1-Architecture.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/part-1/1-Architecture.md b/docs/part-1/1-Architecture.md new file mode 100644 index 0000000..a907882 --- /dev/null +++ b/docs/part-1/1-Architecture.md @@ -0,0 +1,44 @@ +# Signal Composer + +## Architecture + +Here is a quick picture about the signaling architecture : + +![GlobalArchitecture] + +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, which are : + - Transport Layer plug-in that read/write 1 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. signal made from gps latitude and + longitude that calcul the heading of vehicle). It is modular and each signal source should be + handled by specific plugins which take care of get the underlying event from **low level** or + define signaling composition with simple or complex operation to output value from **raw** signals + +There are three main parts with **Signal Composer**: + +- Configuration files which could be splitted in differents files. That will define: + - metadata with name of **signal composer** api name + - additionnals configurations files + - plugins used if so, **low level** signals sources + - signals definitions +- Dedicated plugins +- Signal composer API + +## Terminology + +Here is a little terminology guide to set the vocabulary: + +- **sources** +- **signals** +- **api** +- **event** +- **callbacks** +- **action** +- **virtual signals** +- **raw signals** + +[GlobalArchitecture]: pictures/Global_Signaling_Architecture.png "Global architecture" |