From 9ad46d2fd83d6782ccb2500e19c10000703ac16a Mon Sep 17 00:00:00 2001 From: pbosetti Date: Thu, 27 Jun 2024 07:50:45 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20pbosetti?= =?UTF-8?q?/mads=5Fplugin@37cf55b769472e981d4894fb4b985b75200ccf7e=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 129 +++++++++++++++++++++++++++---------------- search/all_0.js | 2 +- search/all_1.js | 2 +- search/all_10.html | 37 +++++++++++++ search/all_10.js | 4 ++ search/all_2.js | 2 +- search/all_3.js | 2 +- search/all_4.js | 3 +- search/all_5.js | 3 +- search/all_6.js | 5 +- search/all_7.js | 5 +- search/all_8.js | 2 +- search/all_9.js | 3 +- search/all_a.js | 5 +- search/all_b.js | 7 +-- search/all_c.js | 13 ++--- search/all_d.js | 9 ++- search/all_e.js | 2 +- search/all_f.js | 2 +- search/pages_0.js | 2 +- search/searchdata.js | 4 +- 21 files changed, 158 insertions(+), 85 deletions(-) create mode 100644 search/all_10.html create mode 100644 search/all_10.js diff --git a/index.html b/index.html index a1ed18c..aa05fea 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ -plugin: Plugins! +plugin: Availabe plugins @@ -63,58 +63,91 @@
-
Plugins!
+
Availabe plugins
-

Build status

-

This example project explores how to develop a plugin system for a C++ application. It is based on the [pugg plugin system]().

+

-Building

-

To build the project, you need to have CMake installed. Then, you can run the following commands:

-
mkdir build
-
ccmake -Bbuild -DCMAKE_BUILD_TYPE=Release
-
cmake --build build -t install
-

This creates three plugins in the form of executable files that also export symbols, so that they can be externally loaded by the main application. The plugins are named echo.plugin, twice.plugin, and echoj.plugin.

-

The latter plugin is a template for complete plugins, and it is pretty extensible. Indeed, it accepts a JSON object as settings, a JSON object as input, and produces a JSON object as output. The other two plugins are simple examples of how to implement a plugin.

-

Plugins are named Filters, for they are expected to act as filters, taking an input and producing an output. The plugins must be implemented as derived classes of the templated class Filter (see src/filter.hpp).

-

If needed, this project will be extended by adding base classes for other types of plugins, such as Sources (output only) and Sinks (input only).

+Templates +

The available templates are:

+
    +
  • template_source.cpp for implementing source plugins
    • +
  • template_sink.cpp for implementing sink plugins
    • +
  • template_filter.cpp for implementing filter plugins
    • +
+

Use these files as a starting point for your own plugins.

-Executing

-

The install step creates and populates the usr directory in the project root folder. You can run the executable that loads the plugin with the following command:

-
cd usr
-
bin/loaderj bin/echoj.plugin
-

Note that on MacOS only the echoj.plugin file is actually an executable file that exports symbols. It is not a shared library, but it is a plugin that can also be directly executed (using its internal main()) as:

-
bin/echoj.plugin
-

This is a very flexible way for implementing standalone apps that can also be used as plugins within the Miroscic framework of distributed agents.

-

On Windows and Linux, the plugin is a shared library that can only be loaded by the loader executable. Beside the plugin, an equivalent executable is also generated.

+Example plugins +

The followings are example plugins of little practucalu use, but they are good for learning the basics of plugin development.

+
    +
  • clock: a source that provides clock values
    • +
  • echoj: a filter that echoes the input message
    • +
  • random: a source that provides random values
    • +
  • to_console: a sink that prints the input message to the console
    • +
  • twice: a filter that duplicates the input message
    • +

-Plugin Versioning

-

The plugin system uses an internal version number Filter::version to check compatibility between the main application and the plugins. To invalidate a previously released plugin, simply imcrease the version number in the base class.

-

-Derived classes

-

To create a new plugin, fork this repository and implement a derived class of Filter or Source in a new file. At the end of the new derived class definition, add the macros that set up the plugin driver: if it is a source, add

-
INSTALL_SOURCE_DRIVER(MySourceClassName, json)
-
INSTALL_SOURCE_DRIVER
#define INSTALL_SOURCE_DRIVER(klass, type)
Call this macro after defining a source class to install it into the kernel.
Definition: common.hpp:19
-

If it is a filter, add

-
INSTALL_FILTER_DRIVER(MyFilterClassName, json, json)
-
INSTALL_FILTER_DRIVER
#define INSTALL_FILTER_DRIVER(klass, type_in, type_out)
Call this macro after defining a filter class to install it into the kernel.
Definition: common.hpp:38
-

If it is a sink, add

-
INSTALL_SINK_DRIVER(MySinkClassName, json)
-
INSTALL_SINK_DRIVER
#define INSTALL_SINK_DRIVER(klass, type)
Call this macro after defining a source class to install it into the kernel.
Definition: common.hpp:57
-

Finally, create a new target in the CMakeLists.txt file that compiles the new plugin. Something like:

-
add_plugin(webcam LIBS LibsNeeded)
-

-HTTPS Client Certificates

-

To connect with the Siemens Edge device, we need a SSL client certificate. To configure it, follow the next steps:

-
    -
  1. on the Siemens Edge miniweb interface, create a new certificate in .p12 format (if it is not exsiting yet)
    2. -
  2. download the certificate in this project root folder: when exporting, check the "Export key" option and give a passphrase
    3. -
  3. now the encripted certificate must be extracted in two separate files: the certificate itself and the private key. To do so, run the following commands (which will ask you the same passphrase used in the previous step):
    4. -
-
openssl pkcs12 -in amwcapture.p12 -clcerts -nokeys -out amwcapture.crt -legacy
-
openssl pkcs12 -in amwcapture.p12 -nocerts -nodes -out amwcapture.key -legacy
-

The executable will look for these two files in the current working directory.

-
+Plugins of actual use +

+MQTT

+

This acts as a source plugin, which reads messages from an MQTT broker and sends them to the MADS broker.

+

Note that the plugin only subscribes to the topic as specified in the configuration file and does not publish any messages.

+

The frequency of messages depends on when they are received from the MQTT broker. The plugin will send the messages to the MADS broker as soon as they are received.

+

+Parameters

+

The accepted parameters are:

+
[mqtt]
+
broker_host = "localhost"
+
broker_port = 1883
+
topic = "capture/#"
+

+Notes

+

The MQTT broker must be running on the same address that has been set into the Siemens MindSphere settings. The root publishing topic (e.g. capture) is defined in the settings of the Siemens MindSphere application, while each acquisition procedure defined in the Edge internal webapp will append a unique identifier to the root topic (e.g. capture/mads). So, you typically want to subscribe to capture/# to get all the messages.

+

+Serial Reader

+

This acts as a source plugin, which reads messages from a serial port (typically connected to an Arduino) and sends them to the MADS broker.

+

The frequency of messages depends on the configuration of the Arduino board. The plugin will send the messages to the MADS broker as soon as they are received from the Arduino board. In turn, this frequency can be set in the configuration file (cfg_cmd parameter).

+

+Parameters

+

The accepted parameters are:

+
[serial_reader]
+
port="/dev/ttyACM0"
+
baudrate=115200
+
# Arduino config serial command
+
cfg_cmd = "40p"
+

+Notes

+

The cfg_cmd parameter is used to configure the Arduino board. The default value is 40p, which sets the Arduino board to send a message every 40 ms.

+

+Running average

+

This acts as a filter plugin, which calculates the running average of the input values.

+

+Parameters

+

The accepted parameters are:

+
[running_avg]
+
sub_topic = ["serial_reader"]
+
capa = 10 # running window size
+
field = "data" # agerage all values in the dictionary "data"
+
out_field = "avg" # output field
+

+Notes

+

It searches for a field in the message payload having the name specified in the field parameter. the data field must be a dictionary. of numerical values, e.g.:

+
{
+
"data": {
+
"value1": 1,
+
"value2": 2,
+
"value3": 3
+
}
+
}
+

The plugin will calculate the average of all the values in the dictionary and store it in a new field, whose name is specified in the out_field parameter:

+
{
+
"avg": {
+
"value1": 1,
+
"value2": 2,
+
"value3": 3
+
}
+
}
+
diff --git a/search/all_0.js b/search/all_0.js index c0f66ad..9c063d9 100644 --- a/search/all_0.js +++ b/search/all_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['blob_5fformat_0',['blob_format',['../classSource.html#a119129cc44d86a108285b52b7c496212',1,'Source']]] + ['availabe_20plugins_0',['Availabe plugins',['../index.html',1,'']]] ]; diff --git a/search/all_1.js b/search/all_1.js index fb3a83b..015ee03 100644 --- a/search/all_1.js +++ b/search/all_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['common_2ehpp_1',['common.hpp',['../common_8hpp.html',1,'']]] + ['blob_5fformat_1',['blob_format',['../classSource.html#a119129cc44d86a108285b52b7c496212',1,'Source']]] ]; diff --git a/search/all_10.html b/search/all_10.html new file mode 100644 index 0000000..3bf1196 --- /dev/null +++ b/search/all_10.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/search/all_10.js b/search/all_10.js new file mode 100644 index 0000000..41b7531 --- /dev/null +++ b/search/all_10.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_33',['write',['../classSerialPort.html#a1b4627dc37646df3be8b532372d0b399',1,'SerialPort::write(const char *buf, size_t nBytes)'],['../classSerialPort.html#ac9c4df34bd033c9fead180e235e1fe06',1,'SerialPort::write(const std::string &string)']]] +]; diff --git a/search/all_2.js b/search/all_2.js index cd7e567..dff9636 100644 --- a/search/all_2.js +++ b/search/all_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['dummy_2',['dummy',['../classFilter.html#a29bce8d312ef763d7beb39f13851d9d3',1,'Filter::dummy()'],['../classSink.html#a21eb67669b967111d8f92f3fd9524d48',1,'Sink::dummy()'],['../classSource.html#a504d988ace793cf47a4301151ebdf570',1,'Source::dummy()']]] + ['common_2ehpp_2',['common.hpp',['../common_8hpp.html',1,'']]] ]; diff --git a/search/all_3.js b/search/all_3.js index 5edf768..7e9d3b3 100644 --- a/search/all_3.js +++ b/search/all_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['error_3',['error',['../classFilter.html#a4f5237964d639b9f3c43a4a1d540174d',1,'Filter::error()'],['../classSink.html#a5d3da423ff6979ec8150a43fadfbd5ab',1,'Sink::error()'],['../classSource.html#aeb408a2891887138206fd602bf2357cb',1,'Source::error()']]] + ['dummy_3',['dummy',['../classFilter.html#a29bce8d312ef763d7beb39f13851d9d3',1,'Filter::dummy()'],['../classSink.html#a21eb67669b967111d8f92f3fd9524d48',1,'Sink::dummy()'],['../classSource.html#a504d988ace793cf47a4301151ebdf570',1,'Source::dummy()']]] ]; diff --git a/search/all_4.js b/search/all_4.js index 986861d..52ff255 100644 --- a/search/all_4.js +++ b/search/all_4.js @@ -1,5 +1,4 @@ var searchData= [ - ['filter_4',['Filter',['../classFilter.html',1,'']]], - ['filter_3c_20json_2c_20json_20_3e_5',['Filter< json, json >',['../classFilter.html',1,'']]] + ['error_4',['error',['../classFilter.html#a4f5237964d639b9f3c43a4a1d540174d',1,'Filter::error()'],['../classSink.html#a5d3da423ff6979ec8150a43fadfbd5ab',1,'Sink::error()'],['../classSource.html#aeb408a2891887138206fd602bf2357cb',1,'Source::error()']]] ]; diff --git a/search/all_5.js b/search/all_5.js index 777d3af..54470b6 100644 --- a/search/all_5.js +++ b/search/all_5.js @@ -1,4 +1,5 @@ var searchData= [ - ['get_5foutput_6',['get_output',['../classMQTTBridge.html#a5a94e80b54015e4200d76eea11fdddf7',1,'MQTTBridge::get_output()'],['../classRandom.html#a0d0abc75765b1ad5504ef6a7ff5873bf',1,'Random::get_output()'],['../classSerialReader.html#a7c0a2f303b640862cb3f0feef2bd4430',1,'SerialReader::get_output()'],['../classPluginClassName.html#aa7145bf08e4b7a4a38ad079db66dd2cf',1,'PluginClassName::get_output()'],['../classSource.html#ae53b4ab2f47b84e811232e0301682bb8',1,'Source::get_output()']]] + ['filter_5',['Filter',['../classFilter.html',1,'']]], + ['filter_3c_20json_2c_20json_20_3e_6',['Filter< json, json >',['../classFilter.html',1,'']]] ]; diff --git a/search/all_6.js b/search/all_6.js index 21abdfd..117f3b4 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -1,7 +1,4 @@ var searchData= [ - ['info_7',['info',['../classFilter.html#afdb37ae1a5382b33d14d2b6cd725ce96',1,'Filter::info()'],['../classMQTTBridge.html#a3b61cdabab81977c353c68f1e8b9a6f4',1,'MQTTBridge::info()'],['../classRandom.html#a16db0a2cbd601f40faaf81e51277885b',1,'Random::info()'],['../classRunningAverage.html#a246a9741870901734a7e3db5d5ffb797',1,'RunningAverage::info()'],['../classSerialReader.html#ae9e404b161358edd22852e653c23079d',1,'SerialReader::info()'],['../classPluginClassName.html#ac27d630e667fb497ef6b86c72feaa439',1,'PluginClassName::info() override'],['../classPluginClassName.html#ac27d630e667fb497ef6b86c72feaa439',1,'PluginClassName::info() override'],['../classPluginClassName.html#ac27d630e667fb497ef6b86c72feaa439',1,'PluginClassName::info() override'],['../classToConsole.html#a10c404eb15c5c7c6263b9c5a1ae0520d',1,'ToConsole::info()'],['../classSink.html#acde447f8670f585d14ab2c7d4eaa4369',1,'Sink::info()'],['../classSource.html#a7db86c9293679009397ebf1a1f848c5a',1,'Source::info()']]], - ['install_5ffilter_5fdriver_8',['INSTALL_FILTER_DRIVER',['../common_8hpp.html#ac2ca73400d23bb4f12e23a64071588db',1,'common.hpp']]], - ['install_5fsink_5fdriver_9',['INSTALL_SINK_DRIVER',['../common_8hpp.html#a1bbc82f63035c765ea291fb1051afad4',1,'common.hpp']]], - ['install_5fsource_5fdriver_10',['INSTALL_SOURCE_DRIVER',['../common_8hpp.html#ab7463bc9c9b40ff018d92b01c237c452',1,'common.hpp']]] + ['get_5foutput_7',['get_output',['../classMQTTBridge.html#a5a94e80b54015e4200d76eea11fdddf7',1,'MQTTBridge::get_output()'],['../classRandom.html#a0d0abc75765b1ad5504ef6a7ff5873bf',1,'Random::get_output()'],['../classSerialReader.html#a7c0a2f303b640862cb3f0feef2bd4430',1,'SerialReader::get_output()'],['../classPluginClassName.html#aa7145bf08e4b7a4a38ad079db66dd2cf',1,'PluginClassName::get_output()'],['../classSource.html#ae53b4ab2f47b84e811232e0301682bb8',1,'Source::get_output()']]] ]; diff --git a/search/all_7.js b/search/all_7.js index b21070c..d568d1d 100644 --- a/search/all_7.js +++ b/search/all_7.js @@ -1,4 +1,7 @@ var searchData= [ - ['kind_11',['kind',['../classFilter.html#a91a969919077f3ecade055db183676ea',1,'Filter::kind()'],['../classMQTTBridge.html#ae45137d601ae33fc2243b1c7e87ff093',1,'MQTTBridge::kind()'],['../classRandom.html#ab869aa17bf013400174f975035d14246',1,'Random::kind()'],['../classRunningAverage.html#a292611672634dd7c9b0f2cc9d3d28671',1,'RunningAverage::kind()'],['../classSerialReader.html#ae1138bfd9e1975c7ba9783a6dc837eed',1,'SerialReader::kind()'],['../classPluginClassName.html#a845be7bd37476f0b1665154aad592848',1,'PluginClassName::kind() override'],['../classPluginClassName.html#a845be7bd37476f0b1665154aad592848',1,'PluginClassName::kind() override'],['../classPluginClassName.html#a845be7bd37476f0b1665154aad592848',1,'PluginClassName::kind() override'],['../classToConsole.html#ad30dc162c3339cdf4f894979f899eda8',1,'ToConsole::kind()'],['../classSink.html#ab890a163c212e897ae04c6ad3d1d72c2',1,'Sink::kind()'],['../classSource.html#afc952efdbef1cbee52db276b276defa0',1,'Source::kind()']]] + ['info_8',['info',['../classFilter.html#afdb37ae1a5382b33d14d2b6cd725ce96',1,'Filter::info()'],['../classMQTTBridge.html#a3b61cdabab81977c353c68f1e8b9a6f4',1,'MQTTBridge::info()'],['../classRandom.html#a16db0a2cbd601f40faaf81e51277885b',1,'Random::info()'],['../classRunningAverage.html#a246a9741870901734a7e3db5d5ffb797',1,'RunningAverage::info()'],['../classSerialReader.html#ae9e404b161358edd22852e653c23079d',1,'SerialReader::info()'],['../classPluginClassName.html#ac27d630e667fb497ef6b86c72feaa439',1,'PluginClassName::info() override'],['../classPluginClassName.html#ac27d630e667fb497ef6b86c72feaa439',1,'PluginClassName::info() override'],['../classPluginClassName.html#ac27d630e667fb497ef6b86c72feaa439',1,'PluginClassName::info() override'],['../classToConsole.html#a10c404eb15c5c7c6263b9c5a1ae0520d',1,'ToConsole::info()'],['../classSink.html#acde447f8670f585d14ab2c7d4eaa4369',1,'Sink::info()'],['../classSource.html#a7db86c9293679009397ebf1a1f848c5a',1,'Source::info()']]], + ['install_5ffilter_5fdriver_9',['INSTALL_FILTER_DRIVER',['../common_8hpp.html#ac2ca73400d23bb4f12e23a64071588db',1,'common.hpp']]], + ['install_5fsink_5fdriver_10',['INSTALL_SINK_DRIVER',['../common_8hpp.html#a1bbc82f63035c765ea291fb1051afad4',1,'common.hpp']]], + ['install_5fsource_5fdriver_11',['INSTALL_SOURCE_DRIVER',['../common_8hpp.html#ab7463bc9c9b40ff018d92b01c237c452',1,'common.hpp']]] ]; diff --git a/search/all_8.js b/search/all_8.js index 5da7de9..a8998ed 100644 --- a/search/all_8.js +++ b/search/all_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['load_5fdata_12',['load_data',['../classFilter.html#ad9477371843930c37fd8d6a371c473f1',1,'Filter::load_data()'],['../classRunningAverage.html#ab08fe6e22b19fe33def4d9db5cd9e107',1,'RunningAverage::load_data()'],['../classPluginClassName.html#ac467a1b6715d8d024fe2df9692f38038',1,'PluginClassName::load_data(json const &input) override'],['../classPluginClassName.html#ac467a1b6715d8d024fe2df9692f38038',1,'PluginClassName::load_data(json const &input) override'],['../classToConsole.html#a890d359dee6f18ab64cb88b9a353c9fe',1,'ToConsole::load_data()'],['../classSink.html#a5aa49f6c4eb8470f4752f360a8c63052',1,'Sink::load_data()']]] + ['kind_12',['kind',['../classFilter.html#a91a969919077f3ecade055db183676ea',1,'Filter::kind()'],['../classMQTTBridge.html#ae45137d601ae33fc2243b1c7e87ff093',1,'MQTTBridge::kind()'],['../classRandom.html#ab869aa17bf013400174f975035d14246',1,'Random::kind()'],['../classRunningAverage.html#a292611672634dd7c9b0f2cc9d3d28671',1,'RunningAverage::kind()'],['../classSerialReader.html#ae1138bfd9e1975c7ba9783a6dc837eed',1,'SerialReader::kind()'],['../classPluginClassName.html#a845be7bd37476f0b1665154aad592848',1,'PluginClassName::kind() override'],['../classPluginClassName.html#a845be7bd37476f0b1665154aad592848',1,'PluginClassName::kind() override'],['../classPluginClassName.html#a845be7bd37476f0b1665154aad592848',1,'PluginClassName::kind() override'],['../classToConsole.html#ad30dc162c3339cdf4f894979f899eda8',1,'ToConsole::kind()'],['../classSink.html#ab890a163c212e897ae04c6ad3d1d72c2',1,'Sink::kind()'],['../classSource.html#afc952efdbef1cbee52db276b276defa0',1,'Source::kind()']]] ]; diff --git a/search/all_9.js b/search/all_9.js index 50d9fec..c6b5443 100644 --- a/search/all_9.js +++ b/search/all_9.js @@ -1,5 +1,4 @@ var searchData= [ - ['mfiledesc_13',['mFileDesc',['../classSerialPort.html#a67cd62f1d1bd222989abc83d11d4ac47',1,'SerialPort']]], - ['mqttbridge_14',['MQTTBridge',['../classMQTTBridge.html',1,'']]] + ['load_5fdata_13',['load_data',['../classFilter.html#ad9477371843930c37fd8d6a371c473f1',1,'Filter::load_data()'],['../classRunningAverage.html#ab08fe6e22b19fe33def4d9db5cd9e107',1,'RunningAverage::load_data()'],['../classPluginClassName.html#ac467a1b6715d8d024fe2df9692f38038',1,'PluginClassName::load_data(json const &input) override'],['../classPluginClassName.html#ac467a1b6715d8d024fe2df9692f38038',1,'PluginClassName::load_data(json const &input) override'],['../classToConsole.html#a890d359dee6f18ab64cb88b9a353c9fe',1,'ToConsole::load_data()'],['../classSink.html#a5aa49f6c4eb8470f4752f360a8c63052',1,'Sink::load_data()']]] ]; diff --git a/search/all_a.js b/search/all_a.js index 8c16ede..230d5e7 100644 --- a/search/all_a.js +++ b/search/all_a.js @@ -1,6 +1,5 @@ var searchData= [ - ['pluginclassname_15',['PluginClassName',['../classPluginClassName.html',1,'']]], - ['plugins_21_16',['Plugins!',['../index.html',1,'']]], - ['process_17',['process',['../classFilter.html#a2579e37b989e96ceab3fe1809269a1ba',1,'Filter::process()'],['../classRunningAverage.html#a90b927f75b99e017195d0165a8635351',1,'RunningAverage::process()'],['../classPluginClassName.html#aad7f395bde575ad2babae1b9560ad767',1,'PluginClassName::process()']]] + ['mfiledesc_14',['mFileDesc',['../classSerialPort.html#a67cd62f1d1bd222989abc83d11d4ac47',1,'SerialPort']]], + ['mqttbridge_15',['MQTTBridge',['../classMQTTBridge.html',1,'']]] ]; diff --git a/search/all_b.js b/search/all_b.js index 9ac3e7d..c5979f0 100644 --- a/search/all_b.js +++ b/search/all_b.js @@ -1,8 +1,5 @@ var searchData= [ - ['random_18',['Random',['../classRandom.html',1,'']]], - ['read_19',['read',['../classSerialPort.html#a7d255c80fa0495407c002e0b72f2bc6f',1,'SerialPort']]], - ['readline_20',['readLine',['../classSerialPort.html#ad29d367d78413099faed9996623fc674',1,'SerialPort::readLine(char *line, size_t nmax)'],['../classSerialPort.html#aa675e6546852ddb78f0248e840457f8f',1,'SerialPort::readLine(std::string &line)']]], - ['return_5ftype_21',['return_type',['../common_8hpp.html#a8158a2d869c53eb8f38c869b380a1209',1,'common.hpp']]], - ['runningaverage_22',['RunningAverage',['../classRunningAverage.html',1,'']]] + ['pluginclassname_16',['PluginClassName',['../classPluginClassName.html',1,'']]], + ['process_17',['process',['../classFilter.html#a2579e37b989e96ceab3fe1809269a1ba',1,'Filter::process()'],['../classRunningAverage.html#a90b927f75b99e017195d0165a8635351',1,'RunningAverage::process()'],['../classPluginClassName.html#aad7f395bde575ad2babae1b9560ad767',1,'PluginClassName::process()']]] ]; diff --git a/search/all_c.js b/search/all_c.js index 2e52130..9ac3e7d 100644 --- a/search/all_c.js +++ b/search/all_c.js @@ -1,11 +1,8 @@ var searchData= [ - ['serialport_23',['SerialPort',['../classSerialPort.html',1,'SerialPort'],['../classSerialPort.html#a10f6750809ba706417ed399bdad69754',1,'SerialPort::SerialPort()']]], - ['serialreader_24',['SerialReader',['../classSerialReader.html',1,'']]], - ['server_5fname_25',['server_name',['../classFilter.html#aa1b65e7624a0cb08746857acd04fb953',1,'Filter::server_name()'],['../classSink.html#a665f1c561735d2eda9ff24601d9ed41e',1,'Sink::server_name()'],['../classSource.html#abd593f10b24f9a9d0dfc4e56b5a74bf6',1,'Source::server_name()']]], - ['set_5fparams_26',['set_params',['../classSource.html#a43b4922fb8d1a363a447ea3b530f3871',1,'Source::set_params()'],['../classSink.html#ad188b670f9780066b344bd2b3ca00bf9',1,'Sink::set_params()'],['../classToConsole.html#a3a95379b792147044099f41dee806e6e',1,'ToConsole::set_params()'],['../classPluginClassName.html#a0493b6a2dcaaae2fac1b6df9e59d532b',1,'PluginClassName::set_params(void const *params) override'],['../classPluginClassName.html#a0493b6a2dcaaae2fac1b6df9e59d532b',1,'PluginClassName::set_params(void const *params) override'],['../classPluginClassName.html#a0493b6a2dcaaae2fac1b6df9e59d532b',1,'PluginClassName::set_params(void const *params) override'],['../classSerialReader.html#a164ef33b1f6b3bde055c8a7838450737',1,'SerialReader::set_params()'],['../classRunningAverage.html#abb4b495d95200dbe387138f41e27aa53',1,'RunningAverage::set_params()'],['../classRandom.html#a5e1051959b72bfd008b4781927cd7973',1,'Random::set_params()'],['../classMQTTBridge.html#a2e35316b229ad97832684fb84160d224',1,'MQTTBridge::set_params()'],['../classFilter.html#a4228450b2102ca29c20c305d6c98178d',1,'Filter::set_params()']]], - ['sink_27',['Sink',['../classSink.html',1,'']]], - ['sink_3c_20json_20_3e_28',['Sink< json >',['../classSink.html',1,'']]], - ['source_29',['Source',['../classSource.html',1,'']]], - ['source_3c_20json_20_3e_30',['Source< json >',['../classSource.html',1,'']]] + ['random_18',['Random',['../classRandom.html',1,'']]], + ['read_19',['read',['../classSerialPort.html#a7d255c80fa0495407c002e0b72f2bc6f',1,'SerialPort']]], + ['readline_20',['readLine',['../classSerialPort.html#ad29d367d78413099faed9996623fc674',1,'SerialPort::readLine(char *line, size_t nmax)'],['../classSerialPort.html#aa675e6546852ddb78f0248e840457f8f',1,'SerialPort::readLine(std::string &line)']]], + ['return_5ftype_21',['return_type',['../common_8hpp.html#a8158a2d869c53eb8f38c869b380a1209',1,'common.hpp']]], + ['runningaverage_22',['RunningAverage',['../classRunningAverage.html',1,'']]] ]; diff --git a/search/all_d.js b/search/all_d.js index b3ee2ae..2e52130 100644 --- a/search/all_d.js +++ b/search/all_d.js @@ -1,4 +1,11 @@ var searchData= [ - ['toconsole_31',['ToConsole',['../classToConsole.html',1,'']]] + ['serialport_23',['SerialPort',['../classSerialPort.html',1,'SerialPort'],['../classSerialPort.html#a10f6750809ba706417ed399bdad69754',1,'SerialPort::SerialPort()']]], + ['serialreader_24',['SerialReader',['../classSerialReader.html',1,'']]], + ['server_5fname_25',['server_name',['../classFilter.html#aa1b65e7624a0cb08746857acd04fb953',1,'Filter::server_name()'],['../classSink.html#a665f1c561735d2eda9ff24601d9ed41e',1,'Sink::server_name()'],['../classSource.html#abd593f10b24f9a9d0dfc4e56b5a74bf6',1,'Source::server_name()']]], + ['set_5fparams_26',['set_params',['../classSource.html#a43b4922fb8d1a363a447ea3b530f3871',1,'Source::set_params()'],['../classSink.html#ad188b670f9780066b344bd2b3ca00bf9',1,'Sink::set_params()'],['../classToConsole.html#a3a95379b792147044099f41dee806e6e',1,'ToConsole::set_params()'],['../classPluginClassName.html#a0493b6a2dcaaae2fac1b6df9e59d532b',1,'PluginClassName::set_params(void const *params) override'],['../classPluginClassName.html#a0493b6a2dcaaae2fac1b6df9e59d532b',1,'PluginClassName::set_params(void const *params) override'],['../classPluginClassName.html#a0493b6a2dcaaae2fac1b6df9e59d532b',1,'PluginClassName::set_params(void const *params) override'],['../classSerialReader.html#a164ef33b1f6b3bde055c8a7838450737',1,'SerialReader::set_params()'],['../classRunningAverage.html#abb4b495d95200dbe387138f41e27aa53',1,'RunningAverage::set_params()'],['../classRandom.html#a5e1051959b72bfd008b4781927cd7973',1,'Random::set_params()'],['../classMQTTBridge.html#a2e35316b229ad97832684fb84160d224',1,'MQTTBridge::set_params()'],['../classFilter.html#a4228450b2102ca29c20c305d6c98178d',1,'Filter::set_params()']]], + ['sink_27',['Sink',['../classSink.html',1,'']]], + ['sink_3c_20json_20_3e_28',['Sink< json >',['../classSink.html',1,'']]], + ['source_29',['Source',['../classSource.html',1,'']]], + ['source_3c_20json_20_3e_30',['Source< json >',['../classSource.html',1,'']]] ]; diff --git a/search/all_e.js b/search/all_e.js index 7b392a1..b3ee2ae 100644 --- a/search/all_e.js +++ b/search/all_e.js @@ -1,4 +1,4 @@ var searchData= [ - ['version_32',['version',['../classFilter.html#a7110a1aae1ae96563c00c8f0592d929e',1,'Filter::version()'],['../classSink.html#a0278f800369c014f12c4552429487446',1,'Sink::version()']]] + ['toconsole_31',['ToConsole',['../classToConsole.html',1,'']]] ]; diff --git a/search/all_f.js b/search/all_f.js index 41b7531..7b392a1 100644 --- a/search/all_f.js +++ b/search/all_f.js @@ -1,4 +1,4 @@ var searchData= [ - ['write_33',['write',['../classSerialPort.html#a1b4627dc37646df3be8b532372d0b399',1,'SerialPort::write(const char *buf, size_t nBytes)'],['../classSerialPort.html#ac9c4df34bd033c9fead180e235e1fe06',1,'SerialPort::write(const std::string &string)']]] + ['version_32',['version',['../classFilter.html#a7110a1aae1ae96563c00c8f0592d929e',1,'Filter::version()'],['../classSink.html#a0278f800369c014f12c4552429487446',1,'Sink::version()']]] ]; diff --git a/search/pages_0.js b/search/pages_0.js index 2d78895..12b120e 100644 --- a/search/pages_0.js +++ b/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['plugins_21_68',['Plugins!',['../index.html',1,'']]] + ['availabe_20plugins_68',['Availabe plugins',['../index.html',1,'']]] ]; diff --git a/search/searchdata.js b/search/searchdata.js index e0cf101..149f845 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,13 +1,13 @@ var indexSectionsWithContent = { - 0: "bcdefgiklmprstvw", + 0: "abcdefgiklmprstvw", 1: "fmprst", 2: "c", 3: "begiklprsw", 4: "dmv", 5: "r", 6: "i", - 7: "p" + 7: "a" }; var indexSectionNames =