logo
You are in: MQTT Driver Configuration Section  Home   Products & Services   Links   Contacts   Legal   What's new? 


MQTT Driver Configuration Section



sparkplug-mqtt-350x154.png



The information in this document applies to latest revision.

This driver is made by two modules: mqtt_client_driver.dll and mqtt_client.exe

Manual configuration:

Step 1:


Configuring MQTT Topics

Open a command shell windows and run the command, that will create the file configuration_file.sql in C:\scada\project:

cd C:\scada\bin

mqtt_client.exe -a broker_host_name -p # -e configuration_file.sql -q user -r pwd -l 1 -t 1883

The MQTT payload has to be encoded with Sparkplug B

Example:

C:\scada\bin>mqtt_client.exe -a broker.hivemq.com -p # -e configuration_file.sql -q user -r pwd -l 1 -t 1883

Step 2:


Creation of protocol configuration database

Go to C:\scada\bin and run protocol_configurator.exe

Import the C:\scada\project\configuration_file.sql, selecting the C:\scada\project\configuration_file.sql with the menu: File->Import->Database from SQL file

At the question: Do you want to create a new database file to hold the imported data?

Answer: Yes

The database name should be your broker_host_name with extension .db

Save it in C:\scada\project

If you do not use broker_host_name.db name, the Step 3 will fail.

Example: broker.hivemq.com.db

Wait for few seconds the Import Completed confirmation Window

Step 3:


Creation of the new SCADA points

1 - Select the menu: Configure\Configure Units

2 - Press button New

3 - Fill in the edit field Name: MQTT

4 - Select Type mqtt_client_driver, flag Unit Enabled and press Configure button

5 - Fill in broker host name, subscribe topic name, number of Items.
6 - Press button Apply and wait that the Apply button returns active and then press Exit

7 - Restart monitor.exe

ConfigureUnits-rev167.png
1
Immagine03.png
2
MQTTNewItem.png
3
MQTTUnitConfiguration.png
4
MQTTClientConfiguration.png
5
MQTTUnitConfiguration.png
6
RestartMonitor_rev167.png
7

Step 4:


Configure each sample point

8 - Select the menu: Configure\Configure Sample Points

9 - Set Comment, Type, Units and the limits of each new point. Press button Apply

- Set type M_SP_TB_1 for digital MQTT point (i.e VT_BOOL type or any scada point that evaluate to 0 and 1)

- Set type M_ME_TC_1 for analog MQTT point

ConfigureSamplePoints_rev167.png
8
Immagine09.png
9

Step 5:


HMI configuration with HMI designer

10 - Run the process C:\scada\bin\hmi_designer.exe

11 - Open the XML designer file in C:\scada\project\hmi0.ui

11.1 - Or create from scratch your HMI (dialog) and save it as hmi0.ui in C:\scada\project

11.2 - It is possible to create from scratch your HMI (dialog) and save it as hmi1.ui or hmi2.ui upto hmi9.ui in C:\scada\project

12 - Use the following widget classes

Widget Class
SINGLE POINT LED PSinglePointLed
DOUBLE POINT LED PDoublePointLed
SINGLE POINT LED SinglePointLed
DOUBLE POINT LED DoublePointLed
SWITCH PSwitch
THERMOMETER QwtThermo
LCD NUMBER PLCDNumber
COMMAND BUTTON QPushButton
TANK PTank
THERMOMETER PThermometer
EDIT FIELD QLineEdit
BREAKER Breaker



13 - Widget names MUST contain the underscore _ as separator between sample point SCADA name and widget ID

For example the widget with SCADA name MQTTSample09 and ID 1 has full name: MQTTSample09_1

Please see next image 1

widget_names_mandatory_underscore.png
1
14 - To enable the inspect popup window, please follow the procedure:

You have to connect the signals RightClicked(QString&,QString&) of the widgets with the slot RightClicked(QString&,QString&) of the HMI dialog (here Form1)
Signal-Slot-Popup-0001.png
Step 1
Signal-Slot-Popup-0002.png
Step 2
Signal-Slot-Popup-0003.png
Step 3
Signal-Slot-Popup-0004.png
Step 4
Signal-Slot-Popup-0005.png
Step 5
Signal-Slot-Popup-0006.png
Step 6
Signal-Slot-Popup-0007.png
Step 7
Signal-Slot-Popup-0008.png
Step 8
Signal-Slot-Popup-0009.png
Step 9
signals-slots-connections.png
Final result
Signal-Slot-Popup-0010.png
Working popup on HMI


15 - To enable commands, please follow the procedure:

Signal-Slot-01.png
Step 1
Signal-Slot-02.png
Step 2
Signal-Slot-03.png
Step 3
Signal-Slot-04.png
Step 4
Signal-Slot-05.png
Step 5
Signal-Slot-06.png
Step 6
Signal-Slot-07.png
Step 7
Signal-Slot-08.png
Step 8
Signal-Slot-09.png
Step 9





© 2002-2024 Enscada  

Locations of visitors to this page