Changes

Modbus and Bluetooth data sending to Node-RED (view source)

Revision as of 16:41, 20 February 2023

2,836 bytes added ,  16:41, 20 February 2023
→‎Device configuration
Line 3: Line 3:  
<span style="color: red;">The information in this page is updated in accordance with the <span style="color: #0054A6;"><b>RUTXXX_R_00_07_03</b></span> firmware version.</span>
 
<span style="color: red;">The information in this page is updated in accordance with the <span style="color: #0054A6;"><b>RUTXXX_R_00_07_03</b></span> firmware version.</span>
   −
Node-RED is a flow-based programming tool developed by IBM Emerging Technology and written in Node.js. It provides a browser-based editor for wiring together hardware devices, APIs, and online services using a visual programming interface.
+
Node-RED is a flow-based programming tool developed by IBM Emerging Technology and written in Node.js. It provides a browser-based editor for wiring together hardware devices, APIs, and online services using a visual programming interface. More information about Node-RED could be found [https://nodered.org/ here].
    
This article provides an extensive configuration example with details on how to use Node-RED with Teltonika Routers via MQTT and HTTP protocols.
 
This article provides an extensive configuration example with details on how to use Node-RED with Teltonika Routers via MQTT and HTTP protocols.
Line 18: Line 18:  
There are a couple of different use cases with Node-RED and Teltonika devices:
 
There are a couple of different use cases with Node-RED and Teltonika devices:
   −
# MQTT gateway using either Node-RED or Teltonika device as MQTT broker.
+
# [[Modbus_and_Bluetooth_data_sending_to_Node-RED#MQTT_Gateway | MQTT gateway using either Node-RED or Teltonika device as MQTT broker.]]
−
# Modbus data to server using either Node-RED or Teltonika device as MQTT broker.
+
# [[Modbus_and_Bluetooth_data_sending_to_Node-RED#Modbus_Data_to_Server_via_MQTT_protocol | Modbus data to server using either Node-RED or Teltonika device as MQTT broker.]]
−
# Bluetooth data to server using Teltonika device as MQTT broker.
+
# [[Modbus_and_Bluetooth_data_sending_to_Node-RED#Bluetooth_Data_to_Server_via_MQTT_protocol | Bluetooth data to Node-RED server.]]
−
# HTTP data to Node-RED server.
+
# [[Modbus_and_Bluetooth_data_sending_to_Node-RED#Modbus_Data_to_Server_via_HTTP_protocol | HTTP data to Node-RED server.]]
−
# MQTT gateway using MQTT Explorer.
      
==Node-RED installation and setup==
 
==Node-RED installation and setup==
Line 43: Line 42:  
[[File:Server is running node red terminal.png|border|600px|class=tlt-border]]
 
[[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:
+
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]]
 
[[File:Use server address in web browser.png|border|500px|class=tlt-border]]
   Line 54: Line 53:  
==MQTT Gateway==
 
==MQTT Gateway==
   −
MQTT Gateway allows to query the device from MQTT Clients, in this section we will configure it to work with the Node-RED.
+
MQTT Gateway allows to query the device from MQTT Clients, in this section we will configure it to work with the Node-RED.  
    
===Using Teltonika device as an MQTT broker===
 
===Using Teltonika device as an MQTT broker===
 
----
 
----
 +
 +
Here is connection topology for this use case:
 +
 +
[[File:Nodered configurationexample topo5gw.png|border|700px|class=tlt-border]]
 +
 
Router setup when using the router as a broker consists of two parts. First, we are going to set up a local broker. In order to do so, navigate to '''Services -> MQTT -> Broker''' and enable the broker.
 
Router setup when using the router as a broker consists of two parts. First, we are going to set up a local broker. In order to do so, navigate to '''Services -> MQTT -> Broker''' and enable the broker.
   Line 63: Line 67:     
Once done, navigate to '''Services -> Modbus -> MQTT Gateway'''. Follow these steps for the configuration:
 
Once done, navigate to '''Services -> Modbus -> MQTT Gateway'''. Follow these steps for the configuration:
−
*'''Enable''': on
+
# '''Enable''': on
−
*'''Host''': since we are using a local broker on the router – input 127.0.0.1
+
# '''Host''': since we are using a local broker on the router – input 127.0.0.1
−
*Leave everything else as default, or adjust according to your needs
+
 
 +
Leave everything else as default, or adjust according to your needs
    
[[File:MQTT gateway settings node red local router.png|border|500px|class=tlt-border]]
 
[[File:MQTT gateway settings node red local router.png|border|500px|class=tlt-border]]
Line 81: Line 86:  
In the next screen configure settings accordingly:
 
In the next screen configure settings accordingly:
   −
*'''Name''': RUT_broker for this example
+
# '''Name''': RUT_broker for this example
−
*'''Server''': 192.168.10.1 (Router's LAN IP address)
+
# '''Server''': 192.168.10.1 (Router's LAN IP address)
−
*'''Port''': Default port 1883
+
# '''Port''': Default port 1883
−
*Leave everything else as default or adjust to your needs
+
# Press '''Update'''
    
[[File:Mqtt broker on our router settings.png|border|500px|class=tlt-border]]
 
[[File:Mqtt broker on our router settings.png|border|500px|class=tlt-border]]
 
----
 
----
 
Now we are going to go back to MQTT-out node configuration and adjust settings as shown below:
 
Now we are going to go back to MQTT-out node configuration and adjust settings as shown below:
−
*'''Server''': RUT_broker
+
 
−
*'''Topic''': request
+
# '''Server''': RUT_broker
 +
# '''Topic''': request
 +
# Press '''Done'''
    
[[File:Mqtt out request node red.png|border|500px|class=tlt-border]]
 
[[File:Mqtt out request node red.png|border|500px|class=tlt-border]]
Line 96: Line 103:  
----
 
----
   −
*'''MQTT-in node''' - configure settings as shown below:
+
'''MQTT-in node''' - configure settings as shown below:
   −
*'''Server''': RUT_broker
+
# '''Server''': RUT_broker
−
*'''Action''': Subscribe to single topic
+
# '''Action''': Subscribe to single topic
−
*'''Topic''': response
+
# '''Topic''': response
−
*'''QoS''': 0
+
# '''QoS''': 0
−
*'''Output''': auto-detect
+
# '''Output''': auto-detect
 +
# Press '''Done'''
    
[[File:Mqtt in response node red.png|border|500px|class=tlt-border]]
 
[[File:Mqtt in response node red.png|border|500px|class=tlt-border]]
Line 116: Line 124:  
There is no need to configure '''debug''' node. Here is how the finished flowchart should look like:
 
There is no need to configure '''debug''' node. Here is how the finished flowchart should look like:
   −
[[File:Flowchart nodered local broker on router.png|border|500px|class=tlt-border]]
+
[[File:Flowchart nodered local broker on router.png|border|400px|class=tlt-border]]
    
----
 
----
Line 132: Line 140:  
===Using Node-RED as an MQTT broker===
 
===Using Node-RED as an MQTT broker===
 
----
 
----
 +
 +
Here we are using Node-RED as MQTT Broker, so we are going to do necessary changes in order for this functionality to work.
 +
 +
Here is the connection topology for this use case:
 +
 +
[[File:Nodered configurationexample topo1.png|border|700px|class=tlt-border]]
 +
 
====Adjusting Node-RED configuration====
 
====Adjusting Node-RED configuration====
   −
If you would like to use Node-RED as a broker, there are a couple of changes needed to be made. Similarly as shown before, click on '''MQTT Subscriber''' node and click edit in the Server section. Input '''127.0.0.1''' in order to use Node-RED broker and press Done.
+
If you would like to use Node-RED as a broker, there are a couple of changes needed to be made. Similarly as shown before, click on '''MQTT Subscriber''' node and click edit in the Server section. Input name '''(1)''' and address '''127.0.0.1''' '''(2)''' in order to use Node-RED broker and press '''Done'''.
    
[[File:Local broker settings nodered.png|border|500px|class=tlt-border]]
 
[[File:Local broker settings nodered.png|border|500px|class=tlt-border]]
Line 146: Line 161:  
Navigate to '''Services -> Modbus -> MQTT Gateway'''. Change the host IP to your Linux Virtual Machine IP address (192.168.10.139 in this example):
 
Navigate to '''Services -> Modbus -> MQTT Gateway'''. Change the host IP to your Linux Virtual Machine IP address (192.168.10.139 in this example):
   −
[[File:Using local node red broker just change the IP address of broker.png|border|400px|class=tlt-border]]
+
[[File:Using local node red broker just change the IP address of broker.png|border|500px|class=tlt-border]]
    
To test the configuration, '''deploy''' the nodes again and send the message by clicking on the '''inject''' node.
 
To test the configuration, '''deploy''' the nodes again and send the message by clicking on the '''inject''' node.
 +
 +
===MQTT gateway using MQTT explorer and Node-RED broker===
 +
----
 +
In this example, we are going to use the same Node-RED broker configured in previous parts of this article, only this time we are going to use [http://mqtt-explorer.com/ MQTT Explorer] app to Publish and Subscribe to Modbus data.
 +
 +
Here's connection topology for this use case:
 +
 +
[[File:Nodered configurationexample topo6.png|border|800px|class=tlt-border]]
 +
 +
====Device setup====
 +
----
 +
Navigate to '''Services -> Modbus -> MQTT Gateway'''. Follow these steps for the configuration:
 +
# '''Enable''': on
 +
# '''Host''': input '''192.168.10.139''', or if you would like to use local broker on the device - input '''127.0.0.1'''
 +
Leave everything else as default, or adjust according to your needs
 +
 +
[[File:MQTT gateway settings node red local router.png|border|500px|class=tlt-border]]
 +
 +
====MQTT explorer setup and testing====
 +
----
 +
Open MQTT Explorer application and in the default screen input the '''Host IP (1)'''  of MQTT Broker, then press '''Connect (2)'''.
 +
 +
[[File:Mqtt explorer server connection to broker example.png|border|600px|class=tlt-border]]
 +
 +
Once done, locate Publish section on the right side. You can use the same settings as in previous sections of MQTT Gateway:
 +
 +
# '''Topic:''' request
 +
# '''Data:''' 0 65432 0 192.168.10.1 502 5 1 3 6 2
 +
 +
[[File:Publish from mqtt explorer node red example.png|border|500px|class=tlt-border]]
 +
 +
If everything is set up correctly, then you should be able to see response from the router:
 +
 +
[[File:Mqtt explorer response from router.png|border|400px|class=tlt-border]]
    
==Modbus Data to Server via MQTT protocol==
 
==Modbus Data to Server via MQTT protocol==
    
In this section, we are going to upload Modbus data to server on Node-RED. First of all, we are going to need Modbus data source, in this example we are using the same device as Modbus TCP Slave and Master.
 
In this section, we are going to upload Modbus data to server on Node-RED. First of all, we are going to need Modbus data source, in this example we are using the same device as Modbus TCP Slave and Master.
 +
 +
Here's connection topology for this use case:
 +
 +
[[File:Nodered configurationexample topo2.png|850px|class=tlt-border]]
    
===Device configuration===
 
===Device configuration===
Line 158: Line 211:  
To start with, navigate to '''Services -> Modbus -> Modbus TCP slave'''. Press '''enable''' to enable the instance and you can leave everything else as '''default''':
 
To start with, navigate to '''Services -> Modbus -> Modbus TCP slave'''. Press '''enable''' to enable the instance and you can leave everything else as '''default''':
   −
[[File:Networking rutos manual modbus modbus tcp slave v2.png|border|800px|class=tlt-border]]
+
[[File:Nodered modbusenable.png|border|600px|class=tlt-border]]
    
Next, navigate to '''Services -> Modbus -> Modbus TCP master'''. Adjust settings here accordingly:
 
Next, navigate to '''Services -> Modbus -> Modbus TCP master'''. Adjust settings here accordingly:
   −
*'''Enabled''': on
+
# '''Enabled''': on
−
*'''Name''': Local_slave (input any preferred name)
+
# '''Name''': Local_slave (input any preferred name)
−
*'''Slave ID''': 1
+
# '''Slave ID''': 1
−
*'''IP address''': 127.0.0.1 (since we are using local TCP slave - input the IP address if you are using external device as Modbus Slave)
+
# '''IP address''': 127.0.0.1 (since we are using local TCP slave - input the IP address of your slave if you are using external device as Modbus Slave)
−
*'''Port''': 502
+
# '''Port''': 502
 +
 
 +
[[File:Nodered tcpmaster config.png|border|600px|class=tlt-border]]
    
Add new request and adjust settings according to your needs. For this example, we are going to pull device name from the registers, so our configuration looks like this:
 
Add new request and adjust settings according to your needs. For this example, we are going to pull device name from the registers, so our configuration looks like this:
   −
*'''Name''': test (input any preferred name)
+
# '''Name''': test (input any preferred name)
−
*'''Data type''': ASCII (to get a string of text)
+
# '''Data type''': ASCII (to get a string of text)
−
*'''Function''': Read holding registers (3)
+
# '''Function''': Read holding registers (3)
−
*'''First register number''': 72
+
# '''First register number''': 72
−
*'''Register count/values''': 3
+
# '''Register count/values''': 3
−
*'''Brackets''': use brackets
+
# '''Brackets''': use brackets
−
*Press enable to enable the Modbus request
+
 
 +
Press enable to enable the Modbus request.
   −
[[File:Tcp master nodered.png|border|1000px|class=tlt-border]]
+
[[File:Tcp master nodered.png|border|1050px|class=tlt-border]]
    
----
 
----
Line 184: Line 240:  
To finish up the device configuration, navigate to '''Services -> Data to server.''' Add new data sender and configure settings accordingly:
 
To finish up the device configuration, navigate to '''Services -> Data to server.''' Add new data sender and configure settings accordingly:
   −
*'''Enable''': on
+
# '''Enable''': on
−
*'''Name''': Data_to_node (input any preferred name)
+
# '''Name''': Data_to_node (input any preferred name)
−
*'''Data source''': MODBUS data
+
# '''Data source''': MODBUS data
−
*'''Protocol''': MQTT
+
# '''Protocol''': MQTT
−
*'''JSON format''': {"Router name": %a} - adjust this according to your needs
+
# '''JSON format''': {"Router name": %a} - adjust this according to your needs
−
*'''Segment count''': All
+
# '''URL/Host/Connection string''': 192.168.10.139 (virtual machine address)
−
*'''URL/Host/Connection string''': 192.168.10.139 (virtual machine address)
+
# '''Port''': 1883
−
*'''Port''': 1883
+
# '''Topic''': rutx (input any preferred topic, make sure to subscribe on the same topic)
−
*'''Keepalive''': 60
  −
*'''Topic''': rutx (input any preferred topic, make sure to subscribe on the same topic)
     −
[[File:Data sender settings to node red with node red broker.png|border|1000px|class=tlt-border]]
+
[[File:Data sender settings to node red with node red broker.png|border|800px|class=tlt-border]]
    
===Node-RED setup===
 
===Node-RED setup===
Line 204: Line 258:     
Adjust MQTT Subscriber node settings accordingly:
 
Adjust MQTT Subscriber node settings accordingly:
−
* '''Server''': Local (from previous example)
+
# '''Server''': Local (from previous example)
−
* '''Action''': Subscribe to single topic
+
# '''Action''': Subscribe to single topic
−
* '''Topic''': rutx
+
# '''Topic''': rutx
−
* Leave everything else as default
+
 
 +
Leave everything else as default.
    
[[File:Server local subscriber node red.png|border|500px|class=tlt-border]]
 
[[File:Server local subscriber node red.png|border|500px|class=tlt-border]]
Line 219: Line 274:  
==Bluetooth Data to Server via MQTT protocol==
 
==Bluetooth Data to Server via MQTT protocol==
   −
In this section, we are going to upload Bluetooth data to server on Node-RED. The configuration is going to be similar to Modbus data to server.  
+
In this section, we are going to upload Bluetooth data to server on Node-RED. The configuration is going to be similar to Modbus data to server. More information about Bluetooth functionality ant usage with beacons could be found in [[Teltonika EYE device pairing and data sender configuration example]].
 +
 
 +
Here's connection topology for this use case:
 +
 
 +
[[File:Nodered configurationexample topo3.png|border|800px|class=tlt-border]]
    
===Device configuration===
 
===Device configuration===
Line 229: Line 288:  
After that, navigate to '''Services -> Data to server.''' Add new data sender and configure settings accordingly:
 
After that, navigate to '''Services -> Data to server.''' Add new data sender and configure settings accordingly:
   −
*'''Enable''': on
+
# '''Enable''': on
−
*'''Name''': BT_data (input any preferred name)
+
# '''Name''': BT_data (input any preferred name)
−
*'''Data source''': Bluetooth data
+
# '''Data source''': Bluetooth data
−
*'''Protocol''': MQTT
+
# '''Protocol''': MQTT
−
*'''JSON format''': {"Data": "%b", "Hour": "%d"} - adjust this according to your needs
+
# '''JSON format''': {"Data": "%b", "Hour": "%d"} - adjust this according to your needs
−
*'''Segment count''': All
+
# '''URL/Host/Connection string''': 192.168.10.139 (virtual machine address)
−
*'''URL/Host/Connection string''': 192.168.10.139 (virtual machine address)
+
# '''Port''': 1883
−
*'''Port''': 1883
+
# '''Topic''': beacon (input any preferred topic, make sure to subscribe on the same topic)
−
*'''Keepalive''': 60
  −
*'''Topic''': beacon (input any preferred topic, make sure to subscribe on the same topic)
     −
[[File:Bluetooth data sender settings rutx11.png|border|600px|class=tlt-border]]
+
[[File:Bluetooth data sender settings rutx11.png|border|800px|class=tlt-border]]
    
===Node-RED setup===
 
===Node-RED setup===
Line 251: Line 308:     
In this section, we will adjust the configuration in order to get the data via HTTP protocol.
 
In this section, we will adjust the configuration in order to get the data via HTTP protocol.
 +
 +
Here's connection topology for this use case:
 +
 +
[[File:Nodered configurationexample topo4.png|border|800px|class=tlt-border]]
    
===Device configuration===
 
===Device configuration===
Line 256: Line 317:  
Look into Modbus data to server via MQTT section for Modbus Slave and Master setup. Navigate to navigate to '''Services -> Data to server.''' Add new data sender and configure settings accordingly:
 
Look into Modbus data to server via MQTT section for Modbus Slave and Master setup. Navigate to navigate to '''Services -> Data to server.''' Add new data sender and configure settings accordingly:
   −
*'''Enable''': on
+
# '''Enable''': on
−
*'''Name''': tcp (input any preferred name)
+
# '''Name''': tcp (input any preferred name)
−
*'''Data source''': MODBUS data
+
# '''Data source''': MODBUS data
−
*'''Protocol''': HTTP(S)
+
# '''Protocol''': HTTP(S)
−
*'''JSON format''': {"Data": %a} - adjust this according to your needs
+
# '''JSON format''': {"Data": %a} - adjust this according to your needs
−
*'''Segment count''': 1
+
# '''URL/Host/Connection string''': 192.168.10.139:8080 (virtual machine address and port number)
−
*'''URL/Host/Connection string''': 192.168.10.139:8080 (virtual machine address and port number)
      
[[File:Modbus data http to node red.png|border|800px|class=tlt-border]]
 
[[File:Modbus data http to node red.png|border|800px|class=tlt-border]]
Line 269: Line 329:  
----
 
----
 
For this configuration we are going to need two nodes: '''TCP''' and '''debug'''. Drag in both nodes and click on TCP node. Adjust settings accordingly:
 
For this configuration we are going to need two nodes: '''TCP''' and '''debug'''. Drag in both nodes and click on TCP node. Adjust settings accordingly:
−
*'''Type''': Listen on port '''8080'''
+
# '''Type''': Listen on port '''8080'''
−
*'''Output''': stream of '''String''' payload
+
# '''Output''': stream of '''String''' payload
    
[[File:Tcp listening on port 8080 node settings.png|border|500px|class=tlt-border]]
 
[[File:Tcp listening on port 8080 node settings.png|border|500px|class=tlt-border]]
Line 284: Line 344:  
[[File:Nodered configurationexample httpData incoming v1.png|border|400px|class=tlt-border]]
 
[[File:Nodered configurationexample httpData incoming v1.png|border|400px|class=tlt-border]]
   −
==MQTT gateway using MQTT explorer and Node-RED broker==
+
==Summary==
 +
 
 +
In this article, several use cases are discussed, such as MQTT gateway using Node-RED or Teltonika device as MQTT broker, Modbus data to server, Bluetooth data to server, HTTP data to Node-RED server, and MQTT gateway using MQTT Explorer. The article provides steps on how to install Node-RED on a Linux virtual machine, install MQTT-specific nodes, and set up a local server. The article also explains how to use the Teltonika device as an MQTT broker and set up Node-RED to work with it.
   −
In this example, we are going to use the same Node-RED broker configured in previous parts of this article, only this time we are going to use [http://mqtt-explorer.com/ MQTT Explorer] app to Publish and Subscribe to Modbus data.'
+
==References==
   −
===Device setup===
+
[https://nodered.org/ Node-RED]
−
----
+
 
−
Navigate to '''Services -> Modbus -> MQTT Gateway'''. Follow these steps for the configuration:
+
[[Modbus TCP Master MQTT Gateway]]
−
*'''Enable''': on
  −
*'''Host''': if you are using local broker on the device - input '''127.0.0.1''', otherwise input your MQTT broker address
  −
*Leave everything else as default, or adjust according to your needs
     −
[[File:MQTT gateway settings node red local router.png|border|500px|class=tlt-border]]
+
[[Teltonika EYE device pairing and data sender configuration example]]
   −
===MQTT explorer setup and testing===
+
[http://mqtt-explorer.com/ MQTT Explorer]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/102468...103701"

Navigation menu