Teltonika Networks Wiki

Changes

Domnev (view source)

Revision as of 08:14, 13 September 2023

1,170 bytes added ,  08:14, 13 September 2023
no edit summary
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.4'''] firmware version .</p>
+
<p style="color:red">The information on this page is updated in accordance with the [https://wiki.teltonika-networks.com/view/FW_%26_SDK_Downloads'''00.07.4'''] firmware version .</p>
−
==Introduction==
+
__TOC__
−
This article contains instructions on how to set up BACnet on Teltonika Networks devices.
+
==Summary==
 +
In this guide, the MQTT Serial Gateway function will be configured using third-party MQTT Broker services (in this example, ''Flespi.io'').
   −
==Configuration overview and prerequisites==
+
==Configuration overview & prerequisites==
 +
*Two devices with serials ports - one acts as Modbus RTU Master, another as Modbus RTU Slave;
 +
*Flespi.io account to act as an MQTT Broker/Publisher/Subscriber (for first configuration example);
   −
Before we begin, let's take a look at the configuration that we are attempting to achieve and the prerequisites that make it possible.
+
[[File:MQTT Serial gateway topology v2.png|border|center|class=tlt-border|847x279px]]
   −
'''Prerequisites''':
+
RUT2 will act as a Modbus RTU slave and RUT1 as a Modbus RTU Master. On RUT1, MQTT Serial Gateway will be configured to transfer Modbus data over MQTT. Flespi.io platform will serve as an MQTT Broker
−
* Two RUT955;
  −
* BACnet controller;
  −
* Server;
  −
* An end device (PC, Laptop) 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.
+
==RUT2 configuration==
−
[[File:Networking rut9 manual webui basic advanced mode.gif|border|center|class=tlt-border|1102x52px]]
+
===Configuring Modbus RTU Slave===
−
 
  −
'''Note''': It is a additional software that can be installed from the '''Services → [[RUT955_Package_Manager|Package Manager]]''' page.
  −
 
  −
== BACnet ==
  −
[[File:BACnet Topology 1.png|border|center|class=tlt-border|576x221px]]
  −
=== BACnet ===
   
----
 
----
−
Install the BACnet package on RUT955 and navigate to '''Services → BACnet''' and '''enable''' the '''instance'''. Everything else can be left as default or changed according to your needs.
+
Go to Services → Modbus → Modbus RTU Slave and create a new instance.
 +
# Enter the '''desired instance name''';
 +
# Select the '''desired serial interface'''.
   −
[[File:BACnet enable instance.png|border|center|class=tlt-border|818x210px]]
+
[[File:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
   −
=== Server ===
+
==RUT1 configuration==
 +
===Configuring MQTT Gateway===
 
----
 
----
−
For the server, Yet Another BACnet Explorer (YABE) is used. YABE is an open-source BACnet Explorer that is designed to be lightweight, fast, and easy to use.
+
Go to '''Services → Modbus → MQTT Gateway''' and there:
−
 
  −
Open the software and '''click''' on the '''green plus sign''' to add a new device. Then a new window will pop up, there select '''local endpoint IP address ''' and click '''start'''. Everything else cane be left as default or changed according to your needs.
     −
[[File:Yabe configuration add device fixed.png|border|center|class=tlt-border|639x203px]]
+
# '''Enable''' the '''instance''';
 +
# '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
 +
# '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
 +
# '''Enter Password'''.
   −
Select newly created communication node and right - click on it to send '''WhoIs''' request (application  might send these automatically).
+
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
   −
[[File:Yabe whois.png|border|center|class=tlt-border|364x126px]]
+
'''Note''': ''Everything else can be left as default or changed according to your needs.''
   −
=== Results ===
+
===Configuring Serial Gateway===
 
----
 
----
−
In case of success you see the connected BACnet device and its parameters.
+
Under the MQTT Gateway configuration, create the Serial Gateway:
 +
# Enter the '''desired device ID''';
 +
# Select the '''desired serial interface'''.
   −
[[File:Yabe successful connection.png|border|center|class=tlt-border|914x530px]]
+
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
   −
== BACnet/IP configuration ==
+
===Configuring Flespi.io MQTT Broker===
−
This is the most commonly used type of BACnet, which is designed to work over Ethernet networks using the Internet Protocol (IP). It supports both IPv4 and IPv6 addressing.
  −
 
  −
[[File:BACnet Topology 2.png|border|center|class=tlt-border|619x230px]]
  −
 
  −
For this configuration you must have a Public IP address. You can read up more on this in our article on '''[[Private and Public IP Addresses]]'''.
  −
 
  −
=== Router 1 ===
   
----
 
----
 +
'''Log in''' or '''create an account''' on '''https://flespi.io''';
   −
==== BACnet ====
+
#Navigate to '''MQTT Board''' on the '''left side''' menu;                                       
−
----
+
#On the right-hand panel, top right corner, next to the name of the MQTT board, '''press the cogwheel-looking icon''' to open ''Connection Settings'';
−
Install the BACnet package on RUT955 and navigate to '''Services → BACnet''' → '''enable''' the '''instance'''. Everything else can be left as default or changed according to your needs.
+
#In the opened window, press '''"Get flespi token"''' to generate a username;
 +
#Enter the '''Client name''';
 +
#Copy the Host address;
 +
#Copy '''Username''';
 +
#Create a '''password'''.
   −
[[File:BACnet enable instance.png|border|center|class=tlt-border|818x210px]]
+
Once done, save all the changes.
 +
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
   −
==== Firewall ====
+
===Message format for MQTT publisher===
 
----
 
----
−
The configuration will also require you to add port forward rule in the firewall configuration. To do that, open Router1 WebUI and navigate to '''Network → Firewall → Port Forwards'''. Create a port forward rule to forward UDP packets from Router2 WAN to Router1 LAN address port.
+
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
−
 
  −
[[File:Router1 firewall port forward.png|border|center|class=tlt-border|797x617px]]
  −
 
  −
# '''Enable''' instance
  −
# '''Name''' - enter desired name
  −
# '''Protocol''' - UDP
  −
# '''Source zone''' - WAN
  −
# '''External port''' - YABE port
  −
# '''Internal zone''' - LAN
  −
# '''Internal IP address''' - PC LAN IP
  −
# '''Internal port''' - YABE port
     −
'''Note''': When YABE sends registration packets you will need to find out which port YABE is using (One way is to look through the traffic with wireshark on your PC or TCP dump on router 1 or router 2)
+
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
   −
If you restart YABE software or delete and create new communication device, YABE might use different port number, and you will need to change port forward configured in router connected to your PC.
+
The table below explains what each option means:
   −
=== Router 2 ===
+
{| class="wikitable"
 +
|1.  Format version
 +
|'''1'''
 +
|-
 +
|2. Cookie
 +
|from '''0''' to '''2<sup>64</sup> -1'''
 +
|-
 +
|3. Serial device ID
 +
|a string used to identify a serial device. Must match with <u>Device ID</u> field in MQTT Gateway page Serial gateway configuration section
 +
|-
 +
|4. Timeout
 +
|timeout for Modbus connection, in seconds. Range [1..999].
 +
|-
 +
|5. Slave ID
 +
|Indicates to which slave request is sent
 +
|-
 +
|6. Modbus function
 +
|Modbus task type that will be executed. Possible values are:
 +
        <ul>
 +
            <li><b>1</b> - read coils;</li>
 +
            <li><b>2</b> - read input coils;</li>
 +
            <li><b>3</b> - read holding registers;</li>
 +
            <li><b>4</b> - read input registers;</li>
 +
            <li><b>5</b> - set single coil;</li>
 +
            <li><b>6</b> - write to a single holding register;</li>
 +
            <li><b>15</b> - set multiple coils;</li>
 +
            <li><b>16</b> - write to multiple holding registers.</li>
 +
        </ul>
 +
|-
 +
|7. First register
 +
|number (not address) of the first register/coil/input (in range [1..65536]) from which the registers/coils/inputs will be read/written to.
 +
|-
 +
|8. Registry count
 +
| <li><b>1</b> - <u>coil count</u> (in range [1..2000]); must not exceed the boundary (first coil number + coil count <= 65537);</li>
 +
            <li><b>2</b> - <u>input count</u> (in range [1..2000]); must not exceed the boundary (first input number + input count <= 65537);</li>
 +
            <li><b>3</b> - <u>holding register count</u> (in range [0..125]); must not exceed the boundary (first register number + holding register count <= 65537);</li>
 +
            <li><b>4</b> - <u>input register count</u> (in range [0..125]); must not exceed the boundary (first register number + input register count <= 65537);</li>
 +
            <li><b>5</b> - <u>coil value</u> (in range [0..1]);</li>
 +
            <li><b>6</b> - <u>holding register value</u> (in range [0..65535]);</li>
 +
            <li><b>15</b> - <u>coil count</u> (in range [1..1968]); must not exceed the boundary (first coil number + coil count <= 65537); and <u>coil values</u> separated with commas, without spaces (e.g., <i>1,2,3,654,21,789</i>); there must be exactly as many values as specified (with coil count); each value must be in the range of [0..1].
 +
|}
 +
====Examples====
 
----
 
----
 +
{| class="wikitable"
 +
|Setting relay (on) (Relay address is 202, which means 'Number of first register will be 203)
 +
|'''1 1 1 1 1 6 203 1'''
 +
|-
 +
|Getting temperature
 +
|'''1 1 1 1 1 3 6 2'''
 +
|}
 +
Modbus parameters are held within registers. The register numbers and corresponding system values can be found [[RUT955_Monitoring_via_Modbus#Get_Parameters|'''in this article''']].
   −
==== BACnet ====
+
==Testing MQTT Publisher and Subscriber on flespi.io==
 +
====Adding Flespi Subscriber====
 
----
 
----
−
Navigate to '''Services → BACnet''', there:
+
To test the Modbus Serial Gateway functionality, '''log into''' your '''Flespi account''' → '''MQTT Board''' and '''add a Subscriber''':
−
 
  −
# '''Enable''' BACnet
  −
# '''Enable''' BBMD
  −
# '''BBMD interface''' - select the interface with Public IP.
  −
# '''Enable Port forward''' - this will automatically create a port forward rule.
     −
[[File:BACnet enabled BBMD.png|border|center|class=tlt-border|746x305px]]
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
 +
#Select '''''<nowiki/>'Subscriber''''''
 +
# In the topic field enter '''''<nowiki/>'response''''''
 +
#Press '''''<nowiki/>'Subscribe'''''' button
   −
Everything else can be left as default or changed according to your needs.
+
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]          [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
−
 
+
====Adding Flespi Subscriber====
−
==== Firewall ====
   
----
 
----
−
If you would like manually creating a port forward rule, navigate to '''Network → Firewall → Port Forwards'''.
     −
[[File:BACnet firewall router2.png|border|center|class=tlt-border|864x602px]]
+
Also, you will need to '''add a Publisher''':
   −
# '''Enable''' instance
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
−
# '''Name''' - enter desired name
+
#Select '''''<nowiki/>'Publisher''''''
−
# '''Protocol''' - UDP
+
#In the topic field enter '''''<nowiki/>'request''''''
−
# '''Source zone''' - WAN
+
#In the message field enter message, for this example '''''<nowiki/>'Getting temperature'''''' is used
−
# '''External port''' - 47808
+
#Press '''''<nowiki/>'Publish'''''' button
−
# '''Internal zone''' - LAN
  −
# '''Internal IP address''' - Router LAN IP
  −
# '''Internal port''' - 47808
     −
=== Server ===
+
[[File:Flespi publisher.png|border|class=tlt-border|495x238px]]  [[File:Flespi publisher setup.png|border|class=tlt-border|494x239px]]
 +
====Flespi Subscriber output====
 
----
 
----
−
Open the software and '''click''' on the '''green plus sign''' to add a new device. Then a new window will pop up, there select '''local endpoint IP address ''' and click '''start'''. Everything else cane be left as default or changed according to your needs.
+
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
   −
[[File:Yabe configuration add device fixed.png|border|center|class=tlt-border|639x203px]]
     −
Then select the node and go to '''Meniu → Functions → IP services → Foreign device registration''' and enter public IP address of Router2 (the one connected to controller).
+
[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
−
 
  −
[[File:Yabe IP services.png|border|center|class=tlt-border|414x163px]]
  −
 
  −
=== Results ===
  −
----
  −
In case of success you see the device connected via gateway.
     −
[[File:Yabe 2 successful.png|border|center|class=tlt-border|925x501px]]
     −
== See also ==
+
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
−
[[RUT955_BACnet|BACnet]] on RUT955
     −
== External links ==
+
==See Also==
−
[https://sourceforge.net/projects/yetanotherbacnetexplorer/ Yabe]
+
*[[RUT955 Monitoring via Modbus#Get Parameters]]
 +
*[[RUT955_Modbus#MQTT_Gateway|MQTT Gateway and Modbus]]
 +
==External links==
 +
[https://flespi.io/#/ Flespi.io]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/103830...111434"