Teltonika Networks Wiki

Changes

Domnev (view source)

Revision as of 08:14, 13 September 2023

1,358 bytes removed ,  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 firmware version [https://wiki.teltonika-networks.com/images/8/8f/RUT9_R_00.07.02.7_WEBUI.bin|'''RUTX_R_00.07.02.7'''].</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 configure SMS and Script alerts using I/O Juggler and SMS Utilities between two RUT955 routers.
+
==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. On a RUT1, an I/O Juggler action is created to execute a command when Input 1 is being triggered to a state of "high" by a sensor to change the output state to "high" on a RUT2 and trigger the sensor.
+
[[File:MQTT Serial gateway topology v2.png|border|center|class=tlt-border|847x279px]]
   −
[[File:IO topology.jpg|border|center|class=tlt-border|954x954px]]
+
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
   −
'''Prerequisites''':
+
==RUT2 configuration==
−
* Two RUT955 routers (one of them with SIM card inserted);
+
===Configuring Modbus RTU Slave===
−
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;
+
----
−
* Device to trigger input;
+
Go to Services → Modbus → Modbus RTU Slave and create a new instance.
 +
# Enter the '''desired instance name''';
 +
# Select the '''desired serial interface'''.
   −
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:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
−
[[File:Basic WebUI Advanced.gif|border|center|class=tlt-border|1004x1004px]]
     −
==I/O control via SMS==
+
==RUT1 configuration==
−
This section contains a detailed guide on how to configure an alert to send a SMS command to RUT2 to change the output state when RUT1 Input 1 is triggered.
+
===Configuring MQTT Gateway===
−
===RUT 2===
   
----
 
----
−
This section contains information on how to configure the RUT2 device.
+
Go to '''Services → Modbus → MQTT Gateway''' and there:
−
====SMS Utilities configuration====
  −
----
  −
The [[RUT955_Mobile_Utilities#SMS_Utilities|SMS Utilities section]] contains a list of rules that perform certain actions when they are activated by SMS messages. To setup a SMS Utilities:
  −
* Log into Router 2 WebUI;
  −
* Go to the '''Services → Mobile Utilities → SMS Utilities''' page and scroll down for '''Add new rule''';
  −
* Enter '''desired SMS text''' command ('''1''') and '''select action''' ('''2''');
  −
* '''Add''' new '''instance''' ('''3''');
     −
[[File:SMS utils add.png|border|center|class=tlt-border|1004x1004px]]
+
# '''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'''.
   −
After this you should redirected to configuration page for that rule:
+
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
−
[[File:SMS utils SMS config.png|border|center|class=tlt-border|1004x1004px]]
     −
# '''Open General''' tab;
+
'''Note''': ''Everything else can be left as default or changed according to your needs.''
−
# Check '''Enable''';
  −
# Action - '''Change I/O state''';
  −
# I/O - '''Output(4)''';
  −
# State - '''High'''
  −
# SMS text - Enter your desired '''SMS text''';
  −
# '''Save''' and '''apply''' '''changes''';
     −
'''Note:''' Fields that are not indicated can be left as default.
+
===Configuring Serial Gateway===
−
 
  −
===RUT 1===
  −
----
  −
This section contains RUT1 I/O Juggler configuration.
  −
====I/O Juggler configuration====
  −
----
  −
The [[RUT955_Input/Output#I.2FO_Juggler|I/O Juggler]] is a feature that provides the possibility to create automated rules that perform certain actions based on Input state changes and other conditions.
  −
=====Actions configuration=====
   
----
 
----
−
The [[RUT955_Input/Output#Actions|Actions section]] is used to manage and create new Actions that can be executed by the I/O Juggler Rules. To configure I/O Juggler Actions:
+
Under the MQTT Gateway configuration, create the Serial Gateway:
−
* Log into Router 1 WebUI and go to the '''Services → Input/Output → I/O Juggler → Actions (1)''' page;
+
# Enter the '''desired device ID''';
−
* '''Enter''' the desired action '''instance name (2)''' and select '''desired action type (3)''';
+
# Select the '''desired serial interface'''.
−
* Click '''add (4)''';
  −
[[File:IO juggler action sms.png|border|center|class=tlt-border|1004x1004px]]
  −
 
  −
This will open a new configuration page:
  −
[[File:IO_juggler_SMS_config_new.png|border|center|class=tlt-border|1004x1004px]]
     −
# Type - '''SMS''';
+
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
−
# Text message - '''RUT2 password''' and the '''SMS rule''' that have been created on RUT2;
  −
# Recipient's phone number - RUT2''' SIM cards number''';
  −
# '''Save''' and '''apply changes''';
     −
'''Note:''' Fields that are not indicated can be left as default.
+
===Configuring Flespi.io MQTT Broker===
−
 
  −
=====General configuration=====
   
----
 
----
−
The [[RUT955_Input/Output#General|General section]] is used to Input Trigger rules, which can perform a specified user-configured action when the Input state changes. Once I/O Juggler Action tab is configured open:
+
'''Log in''' or '''create an account''' on '''https://flespi.io''';
−
*'''General''' tab ('''1''') and '''enable''' it ('''2''');
  −
* Add '''new instance''' role ('''3''');
  −
* Click Add ('''4''');
     −
[[File:IO juggler general config.png|border|center|class=tlt-border|1004x1004px]]
+
#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'';
 +
#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'''.
   −
After that, you will be prompted to edit an instance:
+
Once done, save all the changes.
 +
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
   −
[[File:IO_Juggler_general_input_config.png|border|center|class=tlt-border|1004x1004px]]
+
===Message format for MQTT publisher===
−
# Check '''Enable''';
+
----
−
# Trigger - '''Raising''';
+
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
−
# Add actions - '''Action name''' that was created previously;
     −
'''Note:''' Fields that are not indicated can be left as default.
+
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
   −
==I/O control via Public IP==
+
The table below explains what each option means:
−
For this configuration you will need a Static or Dynamic Public IP address on RUT1. You can read up more on this in our article on [[Private_and_Public_IP_Addresses|Private and Public IP Addresses.]] Action will execute a script that contains a curl -X command which will change RUT2 Output state to a high via RUT2 Public IP.
     −
===RUT 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====
 
----
 
----
−
This section contain information on how to configure RUT2 device. A guide on how to [https://wiki.teltonika-networks.com/wikibase/index.php?title=Domnev&oldid=97979#SMS_Utilities_configuration configure SMS Utilities] can be found above.
+
{| class="wikitable"
−
====Remote access configuration====
+
|Setting relay (on) (Relay address is 202, which means 'Number of first register will be 203)
−
----
+
|'''1 1 1 1 1 6 203 1'''
−
The [[RUT955_Administration#Access_Control|Access Control]] page is used to manage remote and local access to device. Navigate to:
+
|-
 +
|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''']].
   −
* '''System → Administration → Access Control'''
+
==Testing MQTT Publisher and Subscriber on flespi.io==
−
* Open '''General''' tab ('''1''') and locate the '''WebUI section''';
+
====Adding Flespi Subscriber====
−
* '''Enable''' remote '''HTTP''' ('''2''') and '''HTTPS''' access ('''3''');
  −
* '''Save''' and '''apply''' '''changes''' ('''4''');
  −
 
  −
[[File:Access control rutos1.png|border|center|class=tlt-border|1004x1004px]]
  −
 
  −
====SMS Gateway (Post/Get) configuration====
   
----
 
----
−
[[RUT955_Mobile_Utilities#Post.2FGet|Post/Get]] allows you to perform action requests by writing them in the URL after your device’s IP address. Go to the:
+
To test the Modbus Serial Gateway functionality, '''log into''' your '''Flespi account''' → '''MQTT Board''' and '''add a Subscriber''':
−
* '''Services → Mobile Utilities → SMS Gateway page → Post/Get (1)''';
  −
* '''Enable''' Post/Get '''(2)''';
  −
* '''Set a username (3)''' and '''password (4)''';
  −
* '''Save''' and '''apply changes (5)''';
     −
[[File:SMS utils SMS config.png|border|center|class=tlt-border|1004x1004px]]
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
 +
#Select '''''<nowiki/>'Subscriber''''''
 +
# In the topic field enter '''''<nowiki/>'response''''''
 +
#Press '''''<nowiki/>'Subscribe'''''' button
   −
===RUT 1===
+
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]          [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
 +
====Adding Flespi Subscriber====
 
----
 
----
−
This section contain information on how to configure RUT1 device. A guide on how to [https://wiki.teltonika-networks.com/wikibase/index.php?title=Domnev&oldid=97979#I.2FO_Juggler_configuration configure I/O Juggler] can be found above.
  −
=====Actions configuration=====
  −
----
  −
Navigate to '''Services → Input/Output → I/O Juggler''' and create an Action instance.
     −
[[File:IO juggler script conf.png|border|center|class=tlt-border|1004x1004px]]
+
Also, you will need to '''add a Publisher''':
   −
# Type - '''Script''';
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
−
# Specify path - you can choose between '''specifying''' the '''script path''' or '''uploading''' a '''script file''' directly;
+
#Select '''''<nowiki/>'Publisher''''''
−
# Script file - depending on what you have chosen in the field above, you will be asked to enter a '''script directory''' or '''upload a script''' file;
+
#In the topic field enter '''''<nowiki/>'request''''''
−
# Save and apply changes
+
#In the message field enter message, for this example '''''<nowiki/>'Getting temperature'''''' is used
 +
#Press '''''<nowiki/>'Publish'''''' button
   −
'''Note:''' Fields that are not indicated can be left as default.
+
[[File:Flespi publisher.png|border|class=tlt-border|495x238px]]  [[File:Flespi publisher setup.png|border|class=tlt-border|494x239px]]
−
 
+
====Flespi Subscriber output====
−
Script example can be seen below:
  −
<pre>#!/bin/sh
  −
 
  −
curl -X GET "http://84.XXX.XXX.XXX/cgi-bin/sms_send?username=name&password=password&number=00370XXXXXXXX&text=admin01 outputon"
  −
 
  −
exit 0</pre>
  −
 
  −
More information about '''curl -X''' command syntax [[RUT955_Mobile_Utilities#Post.2FGet|here]].
  −
 
  −
==I/O control via RMS VPN==
  −
[https://teltonika-networks.com/lt/about-us/introducing-rms-vpn-service/ RMS VPN] is a service designed for remote efficient, low-cost management of large-scale networks. As opposed to point-to-point VPN service, RMS VPN allows creating encrypted VPN tunnels for secure access of multiple endpoints within a matter of seconds.
  −
===RMS VPN configuration===
   
----
 
----
−
A guide on how to set up a RMS VPN Hub can be found [https://youtu.be/dfAudZR2wPY here].
+
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
−
 
  −
[[File:RMS VPN IO config.png|border|center|class=tlt-border|704x704px]]
     −
Both RUT1 and RUT2 have to be added to RMS VPN Hub.
     −
====Script====
+
[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
−
----
  −
Adjust the script accordingly to the RMS VPN Hub assigned IP to RUT2. [https://wiki.teltonika-networks.com/wikibase/index.php?title=Domnev&oldid=98293#Actions_configuration_2| Script example] can be found above.
     −
==Results==
     −
If configured correctly you should be able to see that the RUT1 Input 1 state is being changed to high
+
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
   −
[[File:Input 1 to high.gif|border|center|class=tlt-border|804x804px]]
+
==See Also==
−
as well as RUT2 Output.
+
*[[RUT955 Monitoring via Modbus#Get Parameters]]
−
[[File:Output 4 to high.gif|border|center|class=tlt-border|804x804px]]
+
*[[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/100333...111434"