diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-12-18 15:20:13 +0100 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-12-18 17:40:02 +0100 |
| commit | 1b3411359d6a0e53f12811436a5410104816da34 (patch) | |
| tree | 0f00b876b61eea6ffc46ed6e4d0f20914c399e1d /docs/part-1 | |
| parent | 7ecafda0fb26647381f45b45f5b7d1ed0d252165 (diff) | |
Update documentation
Change-Id: I82edfc5111805cf5e2affad1a6366d1144006fbf
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/part-1')
| -rw-r--r-- | docs/part-1/3-Plugins.md | 11 | ||||
| -rw-r--r-- | docs/part-1/4-SignalComposerAPI.md | 16 |
2 files changed, 26 insertions, 1 deletions
diff --git a/docs/part-1/3-Plugins.md b/docs/part-1/3-Plugins.md index cbc7284..50ece7b 100644 --- a/docs/part-1/3-Plugins.md +++ b/docs/part-1/3-Plugins.md @@ -1,6 +1,15 @@ # Plugins -Plugins are C/C++ shared library that is loaded by the binding to execute some +Plugins are C/C++ shared library loaded by the binding to execute some simple routine. Routine could be on reception of a new signal or at sources initialization time or signal subscription with the respective JSON field **onReceived**, **init** and **getSignals**. + +A default plugin (builtin) is provided with 2 functions: + +- **defaultOnReceived**: set and record a new signal value and its timestamp + in the signal composer service. It simply tooks the incoming event JSON object + and search for *key* **value** and **timestamp** then call function + `setSignalValue`. +- **setSignalValueWrap**: a **lua2c** function the could be called from any LUA + script to record a new signal value. diff --git a/docs/part-1/4-SignalComposerAPI.md b/docs/part-1/4-SignalComposerAPI.md index dc47f01..246b62f 100644 --- a/docs/part-1/4-SignalComposerAPI.md +++ b/docs/part-1/4-SignalComposerAPI.md @@ -19,6 +19,22 @@ ON-EVENT signal-composer/257b343e-8ea9-4cd7-8f9e-1904fa77f8f2({"event":"signal-c Unsubscribe happens the same way. When no more signals are holded by the client then it unsubscribe from the *AGL Application Framework* event handle. +## addObjects + +Let you add sources or signals objects to the signal composer service after +its initialization phase. Use this verb and specify the file as argument, you +could use only the file name or the file name with its absolute path. + +```json +signal-composer addObjects {"file": "sig_doors.json"} +ON-REPLY 1:signal-composer/addObjects: {"jtype":"afb-reply","request":{"status":"success","uuid":"00d7a519-816e-486a-8163-3afb1face4fa"}} +signal-composer addObjects {"file": "/tmp/sig_doors.json"} +ON-REPLY 2:signal-composer/addObjects: {"jtype":"afb-reply","request":{"status":"success"}} +``` + +You can follow the activity using the service log journal and check that the +correct number of objects has been added. + ## get You can get a signal value be requesting the API with the verb *get*: |