|
|
| Line 1: |
Line 1: |
| − | <p style="color:red">The information in this page is updated in accordance with [https://wiki.teltonika-networks.com/view/FW_%26_SDK_Downloads'''00.07.03.1'''] firmware version .</p>
| |
| − | ==Introduction==
| |
| − | This article contains instructions on how to send M-Bus data to the server using various protocols.
| |
| − |
| |
| − | ==Configuration overview and prerequisites==
| |
| − |
| |
| − | Before we begin, let's take a look at the configuration that we are attempting to achieve and the prerequisites that make it possible.
| |
| − |
| |
| − | '''Prerequisites''':
| |
| − | * TRB143;
| |
| − | * M-Bus device;
| |
| − | * Server;
| |
| − | * An end device (PC, Laptop, Tablet, Smartphone) for configuration;
| |
| − |
| |
| − | If you're having trouble finding any page or some of the parameters described here on your device's WebUI, you should turn on '''"Advanced WebUI"''' mode. You can do that by '''clicking''' the '''"Basic"''' button '''under''' '''"Mode,"''' which is located at the top-right corner of the WebUI.
| |
| − | [[File:TRB143 advanced.gif|border|center|class=tlt-border|1004x1004px]]
| |
| − |
| |
| − | ==Node-RED installation and setup==
| |
| − |
| |
| − | We are going to set up Node-RED in a Linux virtual machine. For Node-RED to work, you would need to install Node.js version 14.00 or higher. If you already have Node.js installed, verify the Node.js version using this command:
| |
| − | <pre>
| |
| − | node -v
| |
| − | </pre>
| |
| − | If you do not have Node.js installed, run these commands to install it:
| |
| − | <pre>
| |
| − | sudo apt install curl
| |
| − | curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash –
| |
| − | sudo apt-get install -y nodejs
| |
| − | </pre>
| |
| − | Once we have Node.js installed, we can install Node-RED. Use this command to install:
| |
| − | <pre>
| |
| − | sudo npm install -g –unsafe-perm node-red
| |
| − | </pre>
| |
| − | Use the command '''''node-red''''' to start a local server. Here is how the terminal should look like if the server starts correctly:
| |
| − | [[File:Server is running node red terminal.png|border|600px|class=tlt-border]]
| |
| − | ----
| |
| − | Once you have the local server running, use the local IP and port number in your internet browser. In this case, we are using 127.0.0.1:1880:
| |
| − | [[File:Use server address in web browser.png|border|500px|class=tlt-border]]
| |
| − |
| |
| − | For MQTT usage, we are going to need MQTT-specific nodes. Use the side menu to navigate to the Manage Palette section and install these nodes:
| |
| − | *node-red-contrib-aedes
| |
| − | *node-red-contrib-mqtt-broker
| |
| − |
| |
| − | [[File:Manage palette and download these mqtt nodes.png|border|500px|class=tlt-border]]
| |
| − |
| |
| − | ==Configuration==
| |
| − |
| |
| − | ===M-Bus Data to Server via MQTT===
| |
| − | ----
| |
| − | This section contains information on how to send M-Bus data to the server on Node-RED using the MQTT protocol.
| |
| | | | |
| | [[File:M-bus topology.png|border|750x750px|class=tlt-border]] | | [[File:M-bus topology.png|border|750x750px|class=tlt-border]] |
| | | | |
| − | The M-Bus meter is directly connected to TRB143. Gateway reads the M-Bus data and sends it to the server using the MQTT protocol.
| |
| − | ====Data to Server configuration====
| |
| − | ----
| |
| − | The '''[[TRB143_Data_to_Server|Data to Server]]''' feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers. This section will walk you through configuring the Data to Server to send M-Bus data to the Node-RED server. To configure Data to Server, '''access the router's WebUI''' and navigate to '''Services''', then '''Data to Server''':
| |
| | | | |
| − | # '''Enable''' instance;
| |
| − | # '''Name:''' Enter '''desired''' '''instance name''';
| |
| − | # '''Data source:''' M-bus;
| |
| − | # '''Protocol:''' MQTT;
| |
| − | # '''JSON format:''' Enter what '''data''' you would like '''to send''';
| |
| − | # '''URL/Host/Connection string:''' Enter '''address of server''';
| |
| − | # '''Port:''' Enter '''server port''';
| |
| − | # '''Topic''': Enter '''desired''' '''topic name'''
| |
| | | | |
| | [[File:Mbus data to server MQTT renewed.png|border|class=tlt-border|1094x1094px]] | | [[File:Mbus data to server MQTT renewed.png|border|class=tlt-border|1094x1094px]] |
| | | | |
| − | ====M-Bus configuration====
| |
| − | ----
| |
| − | The '''[[TRB143_M-Bus|M-Bus Settings]]''' section is used to configure the general service functionality. To set up a new M-Bus instance, go to '''Services → M-Bus:'''
| |
| | | | |
| − | # '''Enable''' M-Bus;
| |
| − | # '''ID''': Enter desired '''instance name''';
| |
| − | # '''Add''';
| |
| | | | |
| | [[File:M bus configuration correct.png|border|class=tlt-border|904x904px]] | | [[File:M bus configuration correct.png|border|class=tlt-border|904x904px]] |
| | | | |
| − | After this, you should be redirected to the configuration page for the M-Bus instance:
| |
| | | | |
| | [[File:M bus instance creation.png|border|class=tlt-border|904x904px]] | | [[File:M bus instance creation.png|border|class=tlt-border|904x904px]] |
| | | | |
| − | # '''Enable''' instance;
| + | |
| − | # '''Name''': Enter your '''desired name''';
| |
| − | #'''Period''': Enter '''desired period''';
| |
| − | At the bottom of the M-Bus instance, you should see the Request Configuration section. It is used to configure requests from M-Bus devices.
| |
| | | | |
| | [[File:HEX data type.png|border|class=tlt-border|904x904px]] | | [[File:HEX data type.png|border|class=tlt-border|904x904px]] |
| | | | |
| − | # '''Enable''' request configuration;
| + | |
| − | # '''Slave address:''' Enter '''desired slave address''';
| |
| − | # '''Data type:''' Select desired data type (this time we will be using '''HEX''');
| |
| − | # '''Save & apply''' changes.
| |
| − | ====Node-RED configuration====
| |
| − | ----
| |
| − | Below you can see the Node-Red block diagram that is used to receive data and its configuration:
| |
| − | * '''aedes broker block''' - Broker;
| |
| − | * '''MQTT in block''' - mbus;
| |
| − | * '''Debug''' - debug 2;
| |
| | [[File:Node-rs-topology.png|border|center|class=tlt-border|654x654px]] | | [[File:Node-rs-topology.png|border|center|class=tlt-border|654x654px]] |
| − | ----
| + | |
| − | Configure the aedes broker block and broker blocks accordingly:
| |
| | [[File:Node-red-broker-new.png|border|left|class=tlt-border|474x474px|left]] | | [[File:Node-red-broker-new.png|border|left|class=tlt-border|474x474px|left]] |
| | [[File:Node-red-debug-new.png|border|right|class=tlt-border|474x474px|right]] | | [[File:Node-red-debug-new.png|border|right|class=tlt-border|474x474px|right]] |
| − | <table class="nd-othertables_2" style="display: inline-table;">
| |
| − | <tr>
| |
| − | <td width=755; style="border-bottom: 1px solid white;">
| |
| − | # '''MQTT Port''': 1883;
| |
| − | # '''WS Bind''': port;
| |
| − | # '''Done''';
| |
| − | </td>
| |
| − | <td width=755; style="border-bottom: 1px solid white;">
| |
| − | # '''Output''': msg. payload;
| |
| − | # '''To''': debug window;
| |
| − | # '''Done''';
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| | | | |
| − | ----
| |
| − | Adjust the MQTT IN node:
| |
| | [[File:Node-red-subscriber-configuration.png|border|class=tlt-border|1094x1094px]] | | [[File:Node-red-subscriber-configuration.png|border|class=tlt-border|1094x1094px]] |
| | | | |
| − | # '''Edit:''' Configure MQTT-Broker node;
| + | |
| − | # '''Name''': Enter '''desired MQTT-Broker nodes name;'''
| |
| − | # '''Server''': '''127.0.0.1''' as we will be using '''Node-RED as MQTT-Broker''';
| |
| − | # '''Port''': 1883;
| |
| − | # '''Update''': Save the changes;
| |
| − | # '''Server''': Select '''MQTT-Broker''' that you have '''just created''';
| |
| − | # '''Action''': Subscribe to single topic;
| |
| − | # '''Topic''': Enter the '''topic''' that you have '''set in Data to Server configuration''';
| |
| − | # '''Qos''': 0;
| |
| − | # '''Output''': Auto-Detect;
| |
| − | # '''Update''': Save the changes;
| |
| − | ====Results====
| |
| − | ----
| |
| − | If you have taken all of the steps described above, the configuration is complete. Below you can see M-Bus data output in HEX format.
| |
| | [[File:MQTT broker HEX data.png|border|class=tlt-border|404x404px]] | | [[File:MQTT broker HEX data.png|border|class=tlt-border|404x404px]] |
| | | | |
| − | ===M-Bus Data to Server Via HTTP===
| + | |
| − | ----
| |
| − | This section contains information on how to send M-Bus data to the server on Node-RED using the HTTP(S) protocol.
| |
| | | | |
| | [[File:M-bus topology HTTP data.png|border|750x750px|class=tlt-border]] | | [[File:M-bus topology HTTP data.png|border|750x750px|class=tlt-border]] |
| | | | |
| − | The M-Bus meter is directly connected to TRB143. Gateway reads the M-Bus data and send it to the server using Hthe TTP(S) protocol.
| + | |
| − | ====Data to Server configuration====
| |
| − | ----
| |
| − | To set up Data to Server, navigate to '''Services''' '''→ Data to Server:'''
| |
| | | | |
| | [[File:Mbus HTTP data to server config.png|border|class=tlt-border|1094x1094px]] | | [[File:Mbus HTTP data to server config.png|border|class=tlt-border|1094x1094px]] |
| − | # '''Enable''' instance;
| + | |
| − | # '''Name:''' Enter '''desired''' '''instance name''';
| |
| − | # '''Data source:''' M-bus;
| |
| − | # '''Protocol:''' HTTP(S);
| |
| − | # '''JSON format:''' Enter what '''data''' you would like '''to send''';
| |
| − | # '''URL/Host/Connection string:''' Enter '''address of server''' and '''port''';
| |
| − | ====M-Bus configuration====
| |
| − | ----
| |
| − | Go to Services '''→ M-Bus →''' the '''instance''' you have created '''→ edit.''' After that, scroll down to '''Request configuration → edit.''' There, you will be able to change the data type.
| |
| | | | |
| | [[File:Mbus XML data type.png|border|class=tlt-border|954x954px]] | | [[File:Mbus XML data type.png|border|class=tlt-border|954x954px]] |
| | | | |
| − | # '''Enable''' request configuration;
| + | |
| − | # '''Slave address:''' Enter '''desired slave address;'''
| |
| − | # '''Data type:''' Select desired data type (this time we will be using '''XML''');
| |
| − | # '''Save & apply''' changes.
| |
| − | ====Node-RED configuration====
| |
| − | ----
| |
| − | Below you can see the Node-Red block diagram that is used to receive data and its configuration:
| |
| − | * '''TCP in block''' - tcp:8080;
| |
| − | * '''Debug''' - debug;
| |
| | [[File:HTTP node-red.png|border|class=tlt-border|center|514x514px]] | | [[File:HTTP node-red.png|border|class=tlt-border|center|514x514px]] |
| | ---- | | ---- |
| − | Configure TCP in and debug blocks accordingly:
| + | |
| | [[File:HTTP node-RED block config.png|border|left|class=tlt-border|474x474px|left]] | | [[File:HTTP node-RED block config.png|border|left|class=tlt-border|474x474px|left]] |
| | [[File:Node-red-debug-new.png|border|right|class=tlt-border|534x534px|right]] | | [[File:Node-red-debug-new.png|border|right|class=tlt-border|534x534px|right]] |
| − | <table class="nd-othertables_2" style="display: inline-table;">
| + | |
| − | <tr>
| |
| − | <td width=755; style="border-bottom: 1px solid white;">
| |
| − | # '''Type''': Listen on;
| |
| − | # '''Port''': 8080;
| |
| − | # '''Output''': Stream of String;
| |
| − | # '''Done''';
| |
| − | </td>
| |
| − | <td width=755; style="border-bottom: 1px solid white;">
| |
| − | # '''Output''': msg. payload;
| |
| − | # '''To''': debug window;
| |
| − | # '''Done''';
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − | ====Results====
| |
| − | ----
| |
| − | If you have taken all of the steps described above, the configuration is complete. Below you can see M-Bus data output in XML format.
| |
| | [[File:XML data Mbus.png|border|class=tlt-border|304x304px]] | | [[File:XML data Mbus.png|border|class=tlt-border|304x304px]] |
| − | ===MQTT broker===
| |
| − | ----
| |
| − | This section contains information on how to send M-Bus data to the server on Node-RED using a Teltonika router as a MQTT broker.
| |
| | | | |
| | [[File:M-bus topology TRBroker.png|border|750x750px|class=tlt-border]] | | [[File:M-bus topology TRBroker.png|border|750x750px|class=tlt-border]] |
| | | | |
| − | The M-Bus meter is directly connected to TRB143. Gateway acts as an MQTT broker; it reads the M-Bus data and sends it to the MQTT subscriber.
| |
| − | ====Data to Server configuration====
| |
| − | ----
| |
| − | To set up Data to Server, navigate to '''Services''' '''→ Data to Server:'''
| |
| | | | |
| | [[File:MQTT broker data to server config.png|border|class=tlt-border|1094x1094px]] | | [[File:MQTT broker data to server config.png|border|class=tlt-border|1094x1094px]] |
| − | # '''Enable''' instance;
| + | |
| − | # '''Name:''' Enter '''desired instance name''';
| |
| − | # '''Data source:''' M-bus;
| |
| − | # '''Protocol:''' MQTT;
| |
| − | # '''JSON format:''' Enter what '''data''' you would like '''to send''';
| |
| − | # '''URL/Host/Connection string:''' Localhost IP;
| |
| − | # '''Port:''' enter '''server port''';
| |
| − | # '''Topic''': enter '''desired topic name''';
| |
| − | ====MQTT broker configuration====
| |
| − | ----
| |
| − | The '''MQTT Broker''' is an entity that listens for connections on the specified port and relays received messages to MQTT clients. To set up MQTT Broker go to S'''ervices → MQTT → Broker:'''
| |
| | | | |
| | [[File:Mbus MQTT Broker.png|border|class=tlt-border|954x954px]] | | [[File:Mbus MQTT Broker.png|border|class=tlt-border|954x954px]] |
| − | # '''MQTT broker''': On;
| + | |
| − | # '''Local port''': 1883;
| |
| − | ====M-Bus configuration====
| |
| − | ----
| |
| − | Go to Services '''→ M-Bus →''' the '''instance''' you have created '''→ edit.''' After that, scroll down to '''Request configuration → edit.''' There, you will be able to change the data type.
| |
| | | | |
| | [[File:Mbus BIN data type.png|border|class=tlt-border|854x854px]] | | [[File:Mbus BIN data type.png|border|class=tlt-border|854x854px]] |
| − | # '''Enable''' request configuration;
| + | |
| − | # '''Slave address''': Enter '''desired slave address''';
| |
| − | # '''Data type''': Select desired data type (this time we will be using '''BIN''');
| |
| − | # '''Save & apply''' changes.
| |
| − | ====Node-RED configuration====
| |
| − | ----
| |
| − | Below you can see the Node-Red block diagram that is used to receive data and its configuration:
| |
| − | * '''MQTT in block''' - mbus;
| |
| − | * '''Debug''' - debug;
| |
| | [[File:MQTT broker node-RED.png|border|center|class=tlt-border|514x514px]] | | [[File:MQTT broker node-RED.png|border|center|class=tlt-border|514x514px]] |
| − | ----
| + | [[File:Node-red-debug-new.png|border|left|class=tlt-border|474x474px|left]]</th> |
| − | Configure debug block:
| + | |
| − | <table class="nd-othertables_2">
| |
| − | <tr>
| |
| − | <th width=790; style="border-bottom: 1px solid white;" rowspan=2>[[File:Node-red-debug-new.png|border|left|class=tlt-border|474x474px|left]]</th>
| |
| − | <th width=355; style="border-bottom: 1px solid white;></th>
| |
| − | </tr> | |
| − | <tr>
| |
| − | <td width=755; style="border-bottom: 1px solid white;">
| |
| − | | |
| − | | |
| − | | |
| − | | |
| | | | |
| | | | |
| Line 258: |
Line 69: |
| | | | |
| | | | |
| | + | [[File:Node-red-mqtt-in-TRBroker.png|border|class=tlt-border|1100x1100px]] |
| | | | |
| − | # '''Output''': msg. payload;
| |
| − | # '''To''': debug window;
| |
| − | # '''Done''';
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − | ----
| |
| − | Adjust the MQTT in node:
| |
| − | [[File:Node-red-mqtt-in-TRBroker.png|border|class=tlt-border|1100x1100px]]
| |
| − | # '''Edit:''' Configure MQTT-Broker node;
| |
| − | # '''Name''': Enter '''desired MQTT-Broker nodes name;'''
| |
| − | # '''Server''': '''127.0.0.1''' as we will be using '''Node-RED as MQTT-Broker''';
| |
| − | # '''Port''': 1883;
| |
| − | # '''Update''': Save the changes;
| |
| − | # '''Server''': Select '''MQTT-Broker''' that you have '''just created''';
| |
| − | # '''Action''': Subscribe to single topic;
| |
| − | # '''Topic''': Enter the '''topic''' that you have '''set in Data to Server configuration''';
| |
| − | # '''Qos''': 0;
| |
| − | # '''Output''': Auto-Detect;
| |
| − | # '''Update''': Save the changes;
| |
| − | ====Results====
| |
| − | ----
| |
| − | If you have taken all of the steps described above, the configuration is complete. Below you can see M-Bus data output in BIN format.
| |
| | [[File:MQTT BIN data.png|border|class=tlt-border|304x304px]] | | [[File:MQTT BIN data.png|border|class=tlt-border|304x304px]] |
| − | ==See Also==
| |
| − | * [[TRB143_M-Bus|M-Bus]]
| |
| − | * [[TRB143_Data_to_Server|Data to Server]]
| |
| − | * [[TRB143_MQTT#MQTT_Broker|MQTT Broker]]
| |
| − | ==External links==
| |
| − | [https://nodered.org/docs/getting-started/ Node-RED]
| |
