diff options
Diffstat (limited to 'docs/part-1/2-Configuration.md')
| -rw-r--r-- | docs/part-1/2-Configuration.md | 58 |
1 files changed, 38 insertions, 20 deletions
diff --git a/docs/part-1/2-Configuration.md b/docs/part-1/2-Configuration.md index 1bee688..5e0ca2d 100644 --- a/docs/part-1/2-Configuration.md +++ b/docs/part-1/2-Configuration.md @@ -1,14 +1,19 @@ # Configuration -Configuration defines all in **Signal composer** each signals and sources has to be defined in it. -At start, configuration will be searched in default binding configuration directory which should be -_/var/lib/afm/applications/signal-composer/1.0/etc/_. Binding search for a file name as _init-daemon*.json_. Others files could be used to split sections and don't have 1 big fat definitions file. +Configuration defines all in **Signal composer** each signals and sources has +to be defined in it. At start, configuration will be searched in default +binding configuration directory which should be _/var/lib/afm/applications/signal-composer/1.0/etc/_. +Binding search for a file name as _init-daemon*.json_. Others files could be +used to split sections and don't have 1 big fat definitions file. Saying that you have 4 sections to define: -- **metadata**: Main parts and the only one that can't be in a separates configuration. This must appears in the main configuration file. -- **plugins** (optionnal): Declare plugins that will be used by *sources* and *signals* for the subscription and composition. -- **sources**: Declare **low level** signals sources (eg. low-can, gps, mraa, ...). +- **metadata**: Main parts and the only one that can't be in a separates + configuration. This must appears in the main configuration file. +- **plugins** (optionnal): Declare plugins that will be used by *sources* and + *signals* for the subscription and composition. +- **sources**: Declare **low level** signals sources (eg. low-can, gps, mraa, + ...). - **signals**: Declare signals, virtuals and raw. ## Metadata @@ -16,30 +21,34 @@ Saying that you have 4 sections to define: Here we define some metadata about **signal composer** binding. Fields to configure are : -- **label**: self-explanatory +- **uid**: self-explanatory - **version** (optionnal): self-explanatory -- **api**: name that the binding will be initialized to and later be accessible by **Application Framework** +- **api** (optionnal): name that the binding will be initialized to and later + be accessible by **Application Framework** - **info** (optionnal): self-explanatory - **require** (optionnal): list of required external apis. -- **files** (optionnal): list of additionnals files. **ONLY NAME** or part of it without extension. These - files are loaded to find sections: *plugins*, *sources* and *signals*. ## Plugins -This section is the only which is optionnal, it is needed if you develop specifics C/C++ plugins -to be used with signal-composer. LUA and API consumption does not need plugins. +This section is the only which is optionnal, it is needed if you develop +specifics C/C++ plugins to be used with signal-composer. LUA and API +consumption does not need plugins. -Default path to search for a plugin is in the binding library directory in a subdirectory _plugins_ -_/var/lib/afm/applications/signal-composer/1.0/lib/plugins_. Else you could use the environment variable _CONTROL_PLUGIN_PATH_ with a semicolon separated list of -directory. +Default path to search for a plugin is in the binding library directory +in a subdirectory _plugins_ _/var/lib/afm/applications/signal-composer/1.0/lib/plugins_. +Else you could use the environment variable _CONTROL_PLUGIN_PATH_ with a +semicolon separated list of directory. Fields are: -- **label**: Define the plugin name. This is that label that will be used on **sources** and - **signals** callbacks. -- **version** (optionnal): self-explanatory +- **uid**: Define the plugin name. This is that label that will be used on + **sources** and **signals** callbacks. +- **ldpath** (optionnal): path to the plugin directory - **info** (optionnal): self-explanatory - **basename**: shared library file name **without** the extension. +- **files** (optionnal): list of additionnals files. **ONLY NAME** or part of + it, without extension. Don't mix up section object with this key, either one + or the other but avoid using both ## Sources @@ -49,13 +58,18 @@ thinning,... and create new virtuals signals composed with basic raw signals. A source is defined with following fields: +- **uid**: An unique identifier name for thatuid source API. - **api**: Name of the source API. - **info** (optionnal): self-explanatory - **init** (optionnal): an **action** to take to initialize a source. May you have to call a verb from that API, of create a files etc. - **getSignals** (optionnal); an **action** to take to get signals from that - source. These callback will be used for each signals defined later in the **signals** section. Dedicated arguments for each signal could be defined in + source. These callback will be used for each signals defined later in the + **signals** section. Dedicated arguments for each signal could be defined in **signals**. +- **files** (optionnal): list of additionnals files. **ONLY NAME** or part of + it, without extension. Don't mix up section object with this key, either one + or the other but avoid using both ## Signals @@ -63,13 +77,14 @@ A signal definition could be either a **raw** one or a **virtual** one. A **virtual signal** is a set of existing **raw signals** associated to an **action** on reception which will compute the value of the signal. -- **id**: Unique identifier used inside **signal composer**, used to compose +- **uid**: Unique identifier used inside **signal composer**, used to compose virtual signals. - **event**: specify a **raw signal** coming from **low level** sources. Couldn't be used with **depends** field, only one of them is possible. - **depends**: specify others signals **id** that compose it (eg: heading is composed with longitude+latitude signals.). Couldn't be used with **event** field at same time. +- **retention** (optionnal): retention duration in seconds - **unit** (optionnal): Unit used to exprime the signal - **frequency** (optionnal): Frequency maximum at which the signal could be requested or sent. This is a thinning made at **high level** so not best @@ -79,3 +94,6 @@ A signal definition could be either a **raw** one or a **virtual** one. A filtering capabilities at subscription and to be able to customize in general a subcription request by signal if needed. - **onReceived**: an **action** to take when this signal is received! +- **files** (optionnal): list of additionnals files. **ONLY NAME** or part of + it, without extension. Don't mix up section object with this key, either one + or the other but avoid using both |