diff options
author | Romain Forlot <romain.forlot@iot.bzh> | 2018-02-07 08:53:43 +0100 |
---|---|---|
committer | Romain Forlot <romain.forlot@iot.bzh> | 2018-02-07 08:53:43 +0100 |
commit | a392191f554dce49f60b34acf40f658d9604b304 (patch) | |
tree | 82081a78a0978e19d22514118881f0340a7b0217 /docs | |
parent | a867920cecd7cef26e39529ba67cf70ac02baaf6 (diff) |
Update documentation
Change-Id: I878fcf9304f56e4712a733018318b0c7caf7555b
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/part-1/1-Architecture.md | 22 | ||||
-rw-r--r-- | docs/part-1/4-SignalComposerAPI.md | 8 |
2 files changed, 11 insertions, 19 deletions
diff --git a/docs/part-1/1-Architecture.md b/docs/part-1/1-Architecture.md index 57a2927..cb832a2 100644 --- a/docs/part-1/1-Architecture.md +++ b/docs/part-1/1-Architecture.md @@ -8,19 +8,19 @@ Here is a quick picture about the signaling architecture : Key here are on both layers, **low** and **high**. -- **Low levels** are in charge of handling data exchange protocol to - decode/encode and retransmit with an AGL compatible format, most convenient - way using **Application Framework** events. These are divided into two parts, - which are : - - Transport Layer plug-in that is able to read/write a protocol. - - Decoding/Encoding part that exposes 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 computes the heading of - vehicle). It is modular and each signal source should be handled by specific +- **Low levels** binding used as _AGL service_, handle data exchange protocol to + decode/encode and retransmit with an AGL compatible format using **Application + Framework** events. These are divided into two parts, which are : + - A transport Layer binding's plug-in that is able to read/write a from a device. + - Decoding/Encoding parts that expose signals. +- **High level signal composer** binding gathers multiple **low level** signaling + sources. Then from these sources, it exposes theirs **raw** signals or more interesting + can creates new virtuals signals from them. Example: + A signal made from gps latitude and longitude that computes the heading of + vehicle. This 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 + from **raw** signals. A transport plug-in is a shared library that shares a common API to be compatible with **low level** services that is: diff --git a/docs/part-1/4-SignalComposerAPI.md b/docs/part-1/4-SignalComposerAPI.md index 5b6af49..aedcd7c 100644 --- a/docs/part-1/4-SignalComposerAPI.md +++ b/docs/part-1/4-SignalComposerAPI.md @@ -61,11 +61,3 @@ binding, by default **last** is used: Verb **list** will output the list of defined signals. -## loadConf - -Verb **loadConf** let you add new files to be able to add new **sources** or -**signals**. - -```json -signal-composer loadConf {"file": "/path/to/your/json/file.json"} -``` |