Merge pull request #5 from openDAQ/demo

Removing previous MQTT streaming server approach
Brief:
- Removing: ref-dev-mqtt-pub/ref-dev-mqtt-sub examples, mqtt_streaming_server_module;
- Renaming: mqtt_streaming_client_module -> mqtt_streaming_module;
- Renaming: ref-dev-mqtt-raw-sub -> raw-mqtt-sub;
- Renaming: ref-dev-mqtt-fb-pub -> ref-dev-mqtt-pub;
- README.md updating;

Author: viacheslauK

CMakeLists.txt

@@ -62,8 +62,7 @@ endif()
 
 add_subdirectory(external)
 add_subdirectory(mqtt_streaming_protocol)
-add_subdirectory(mqtt_streaming_server_module)
-add_subdirectory(mqtt_streaming_client_module)
+add_subdirectory(mqtt_streaming_module)
 
 if(OPENDAQ_DEVICE_EXAMPLE_ENABLE_EXAMPLE_APPS)
     message(STATUS "Example applications have been enabled")

README.md

@@ -168,17 +168,17 @@ There are 3 example C++ application:
   ```bash
  ./custom-mqtt-sub --address broker.emqx.io examples/custom-mqtt-sub/public-example0.json
  ```  
- - **ref-dev-mqtt-raw-sub**  - demonstrates how to work with the raw MQTT FB. The application creates an MQTT device and a raw MQTT FB to receive MQTT messages and create openDAQ signals to send the data as binary packets. The application also creates packet readers for all FB signals and prints the binary packets as strings to standard output. The SignalList property of the raw MQTT FB is filled from the application arguments. Usage:
+ - **raw-mqtt-sub**  - demonstrates how to work with the raw MQTT FB. The application creates an MQTT device and a raw MQTT FB to receive MQTT messages and create openDAQ signals to send the data as binary packets. The application also creates packet readers for all FB signals and prints the binary packets as strings to standard output. The SignalList property of the raw MQTT FB is filled from the application arguments. Usage:
  ```bash
- ./ref-dev-mqtt-raw-sub --address broker.emqx.io /agvstate /mirip/UNet3AC2/sensor/data
+ ./raw-mqtt-sub --address broker.emqx.io /agvstate /mirip/UNet3AC2/sensor/data
  ```
- - **ref-dev-mqtt-fb-pub** - demonstrates how to work with the *publisher MQTT FB*. The application creates an *openDAQ ref-device* with four channels, an *MQTT device*, and a *publisher MQTT FB* to publish JSON MQTT messages with the channels’ data. The properties of the *publisher MQTT FB* are set according to the selected mode, which can be specified via the *--mode* option. Posible values are:
+ - **ref-dev-mqtt-pub** - demonstrates how to work with the *publisher MQTT FB*. The application creates an *openDAQ ref-device* with four channels, an *MQTT device*, and a *publisher MQTT FB* to publish JSON MQTT messages with the channels’ data. The properties of the *publisher MQTT FB* are set according to the selected mode, which can be specified via the *--mode* option. Posible values are:
     - 0 - One MQTT message per signal / one message per sample / one topic per signal / one timestamp for each sample;
     - 1 - One MQTT message per signal / one message containing several samples / one topic per signal / one timestamp per sample (array of samples);
     - 2 - One MQTT message for several signals (from 1 to N) / one message per sample for each signal / one topic for all signals / separate timestamps for each signal;
     - 3 - One MQTT message for all signals / one message per sample containing all signals / one topic for all signals / one shared timestamp for all signals.
 ```bash
- ./ref-dev-mqtt-fb-pub --address broker.emqx.io --mode 1
+ ./ref-dev-mqtt-pub --address broker.emqx.io --mode 1
  ```
 Published messages can be observed using third-party tools (see the **External MQTT tools** section).
 For all applications, by default, the IP address *127.0.0.1* is used for the broker connection. It can be set via the *--address* option, for example:
@@ -189,7 +189,7 @@ For all applications, by default, the IP address *127.0.0.1* is used for the bro
 They are located in the **examples/** directory.
 > ***Note:*** *Using the applications involves using a third-party broker. It must be started before example applications. See a **External MQTT tools** section for more details*
 
-> ***Note:*** *The **ref-dev-mqtt-fb-pub** application depends on [**RefDeviceModule**](https://github.com/openDAQ/openDAQ/tree/main/examples/modules/ref_device_module).*
+> ***Note:*** *The **ref-dev-mqtt-pub** application depends on [**RefDeviceModule**](https://github.com/openDAQ/openDAQ/tree/main/examples/modules/ref_device_module).*
 
 
 ## External MQTT tools
@@ -215,4 +215,4 @@ This command publishes a message and exits. From the subscriber's side you can s
 ```shell
 mosquitto_sub -h 127.0.0.1 -t "openDAQ/publisher" -v
 openDAQ/publisher {"Input0":2, "Input1":1.2, "Input3":3.3}
-```
+```

examples/CMakeLists.txt

@@ -1,9 +1,7 @@
 cmake_minimum_required(VERSION 3.16)
 
 if (OPENDAQ_MQTT_ENABLE_EXAMPLE_APPS)
-    add_subdirectory(ref-dev-mqtt-pub)
-    add_subdirectory(ref-dev-mqtt-sub)
-    add_subdirectory(ref-dev-mqtt-raw-sub)
+    add_subdirectory(raw-mqtt-sub)
     add_subdirectory(custom-mqtt-sub)
-    add_subdirectory(ref-dev-mqtt-fb-pub)
+    add_subdirectory(ref-dev-mqtt-pub)
 endif()

examples/ref-dev-mqtt-sub/CMakeLists.txt examples/raw-mqtt-sub/CMakeLists.txtexamples/ref-dev-mqtt-sub/CMakeLists.txt renamed to examples/raw-mqtt-sub/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.16)
 
-set(EXAMPLE_PROJECT_NAME "ref-dev-mqtt-sub")
+set(EXAMPLE_PROJECT_NAME "raw-mqtt-sub")
 
 project(${EXAMPLE_PROJECT_NAME} LANGUAGES CXX)
 

…/ref-dev-mqtt-raw-sub/src/CMakeLists.txt examples/raw-mqtt-sub/src/CMakeLists.txtexamples/ref-dev-mqtt-raw-sub/src/CMakeLists.txt renamed to examples/raw-mqtt-sub/src/CMakeLists.txt examples/ref-dev-mqtt-raw-sub/src/CMakeLists.txt renamed to examples/raw-mqtt-sub/src/CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.16)
 add_compile_definitions(MODULE_PATH="${OPENDAQ_MODULES_DIR}")
 add_compile_definitions(APP_NAME="${EXAMPLE_PROJECT_NAME}")
 
-add_executable(${EXAMPLE_PROJECT_NAME} ref-dev-mqtt-raw-sub.cpp)
+add_executable(${EXAMPLE_PROJECT_NAME} raw-mqtt-sub.cpp)
 
 target_link_libraries(${EXAMPLE_PROJECT_NAME} PRIVATE daq::opendaq
                                                       rapidjson

…qtt-raw-sub/src/ref-dev-mqtt-raw-sub.cpp …amples/raw-mqtt-sub/src/raw-mqtt-sub.cppexamples/ref-dev-mqtt-raw-sub/src/ref-dev-mqtt-raw-sub.cpp renamed to examples/raw-mqtt-sub/src/raw-mqtt-sub.cpp examples/ref-dev-mqtt-raw-sub/src/ref-dev-mqtt-raw-sub.cpp renamed to examples/raw-mqtt-sub/src/raw-mqtt-sub.cpp

@@ -1,8 +1,9 @@
 cmake_minimum_required(VERSION 3.16)
 
 add_compile_definitions(MODULE_PATH="${OPENDAQ_MODULES_DIR}")
+add_compile_definitions(APP_NAME="${EXAMPLE_PROJECT_NAME}")
 
 add_executable(${EXAMPLE_PROJECT_NAME} ref-dev-mqtt-pub.cpp)
 add_dependencies(${EXAMPLE_PROJECT_NAME} daq::ref_device_module)
 target_link_libraries(${EXAMPLE_PROJECT_NAME} PRIVATE daq::opendaq)
-target_include_directories(${EXAMPLE_PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../)
+target_include_directories(${EXAMPLE_PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../)