WebHMI Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== MQTT Protocol =====
MQTT today has become an intermediary in IoT communication. 
It is supported by integration controller WebHMI ([[:mqtt|About how to use MQTT on WebHMI]]) and 7bit brand products such as Synapse, AirPoint and AirGate.
==== What is MQTT? ====
It is a lightweight, open and affordable protocol. 
It was designed for severe operating conditions, so it is ideal for devices with low power and limited autonomous. Such as smartphones, sensors and other devices, the number of which is constantly growing. 
MQTT has extremely low overhead publish/subscribe model, and bidirectional capabilities of MQTT are uniquely suited to meet the demands of industrial control systems.
To understand, look at this diagram. 

{{ iot:mqtt:mqtt_diagram.png?direct |}}

There is no need in direct connection which is quite fragile and entails overhead. So, the broker is the gamechanger.  
Any device can be both publisher and subscriber. Publishing of message is triggered only by some event, e.g. time condition. After that, the data packet is received by the broker and then sent to subscribers, which subscribed to that topic which data was published. 
In that way, the subscriber can get the data about events that happened on distant objects, collected from different publishers and collect it in a database to obtain further analytics. 
Therefore, it would be suitable to apply for electricity consumption monitoring, but also measuring non-electrical quantities.
====== MQTT using WebHMI ======
WebHMI is able to communicate using MQTT. Using this protocol WebHMI can act as a subscriber and a broker.  

===== WebHMI as MQTT Broker =====
To start, firstly go to “Settings” to make sure that “MQTT Server” is turned on.

{{ iot:mqtt:server:webhmi_as_server_1.png?direct |}}

[[:mqtt|About how to use MQTT on WebHMI]]


===== WebHMI as MQTT Client (Publisher/Subscriber) =====
There is a possibility to create a WebHMI connection to subscribe or publish MQTT messages.
This allows WebHMI register mapping with certain topics on any broker. So editing register value will trigger WebHMI to publish MQTT message and vice versa: if you have an active register, receiving the message from the broker will trigger changing the value.

==== Publish to WebHMI from (the same or another) WebHMI ====
Acting as a client, WebHMI can connect to any broker, i.e. its own MQTT broker.

Let’s post something to the WebHMI MQTT Broker from a WebHMI MQTT Client.
It is convenient to stay subscribed to the topics in "MQTT.fx", but this time publish with a WebHMI.
To start publish something to broker it is necessary to become a client, so need to create a connection to it.

Click on “New connection” and configure it with:

    Device Model: MQTT
    Address: 192.168.1.1 (it is your IP of WebHMI with Broker )
    TCP Port: 1883

{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_client_connection_settings.png?direct |}}
After that, create a new register into that connection which will represent MQTT topic related to MQTT broker.
Click "New register" and fill in the following settings:
When the **connection** is created and active it means that connection is established with the **broker**, let’s create a __register__ with “Address” filled with the same topic name “__iot-test__”. 
Also it would be useful to add //Lua script alias//, e.g. “//mqtt_publish//”. It will be used in the script later.

    Connection: MQTT WebHMI Client (that one, that created before)
    Address: iot-test (any name, it is MQTT topic to subcribe and to publish)
    Script alias: mqtt_publish  
{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_client_register_settings.png?direct |}}

Go to “Value” tab to change its type to “String”     
{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_client_register_settings_value.png?direct |}}
And click "Add" button.
{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_client_register_settings_value_string.png?direct |}}

Now, it is time to change registers value manually and check the result response on another client such as Android app, PC clients such as "MQTT.fx" or another WebHMI.

Let's check the response in MQTT.fx PC client. How to configure it will be shown later.
{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_client_register_value_manual_change.png?direct |}}

In the MQTT.fx will be shown caught changes in the subscribed topics.
{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_mqttfx_subscribed_catch.png?direct |}}

===== Connect to WebHMI MQTT Broker with external client =====
==== From PC client to WebHMI ====
Using any MQTT client it is possible to be connected to WebHMI MQTT Broker.
For example, freeware MQTT client “MQTT.fx” will be used.
----
{{iot:mqtt:client:pc:mqttfx_icon_256.png?direct&200 |MQTT.fx}}
\\ 
\\ 
\\ 
[[https://mqttfx.jensd.de/|Official site download link]]
----
To do this, let’s create a new connection with the following settings:
{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_1.png?direct |IMG}}
Click on “+” in the lower left corner and set:

    Profile Type: "MQTT Broker
    Profile Name: e.g. “WebHMI”
    Broker Address: 192.168.1.21, this is the IP of the WebHMI.
    Broker Port: 1883

Press “Apply” and then “OK”.\\ 
Let’s connect to WebHMI Broker by pressing the “Connect” button.

{{ iot:mqtt:client:pc:протокол_связи_mqtt_на_webhmi_2.png?direct |IMG}}
If everything is fine than connection will be established, so that indicator became green.
==== From Android client to WebHMI ====
In the Google Play Market, there is a lot of MQTT Client apps. For example, it would be shown the connection with [[https://play.google.com/store/apps/details?id=com.app.vetru.mqttdashboard|MQTT Dashboard]].
{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app.jpg?direct&300 |}}



After first run it looks like this:
\\ 

{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_add_broker.png?direct&300 |}}

So, let’s add WebHMI Broker by click “Add first broker” button.

Fill in the following settings.
In the address form your WebHMI IP address.
In our case, it is 192.168.1.21. 



{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_add_connection.png?direct&300 |}}

Then, click the “Save” button in the bottom centre position.

Now, we have an empty connection. 
It is time to subscribe to a topic. It is also an option to publish to it.
To do this, let’s click the “+” button in the bottom centre part of the screen.



{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_add_topic.png?direct&300 |}}

To demonstrate how the function works, the "Standard" format will suffice.


{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_edit_topic.png?direct&300 |}}
Pick the “Text” type.


{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_select_topic_payload_format.png?direct&300 |}}

Fill in the “Subscribe topic” form the “iot-test” value and then press “Copy” symbol near “Publish topic” to copy the topics name to this form also.
In the end, click the “Save” icon in the bottom centre position.


{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_select_topic_payload_type.png?direct&300 |}}
To test the connection, you can try to change the register’s value and check the smartphone's screen for the result.


{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_test_receive.png?direct |}}

The text message was sent through the MQTT protocol to WebHMI broker and the sent to the Android app.


{{ iot:mqtt:client:android:протокол_связи_mqtt_на_webhmi_android_app_test_subscribe.png?direct&300 |}}
It also works in another direction and can be published from the smartphone.