summaryrefslogtreecommitdiffstats
path: root/docs/part-1/1-Architecture.md
blob: 9d1e3286954918f8fabd24330daf1fc7c4ef7563 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# 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:

- **api**: a binding API name
- **action**: a function called at a certain time
- **callbacks**: a function called at a certain time
- **event**: the raw event that materialize the signal
- **sources**: a binding API name
- **signals**: an event generated by the **Application Framework**
- **virtual signals**: a signal composed of **raw signals** with value
 calculated by a **callbacks**
- **raw signals**: an event generated by a **low level** binding

[GlobalArchitecture]: pictures/Global_Signaling_Architecture.png "Global architecture"