Domnev: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
 
(173 intermediate revisions by the same user not shown)
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.08'''] 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==
This article contains instructions on how to send M-Bus data to the server using various protocols.


==Configuration overview and prerequisites==
==Configuration overview & 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.


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 second sensor.
'''Prerequisites''':
* TRB143;
* M-Bus device;
* Server;
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;


[[File:IO topology new.jpg|border|center|class=tlt-border|954x954px]]
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = RUTX
}}


'''Prerequisites''':
==Adding M-Bus devices==
* Two RUT955 routers;
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 → Client'''. Add a new device to the configuration press [[File:Add Button.png|60x90px]] button which is shown below.
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;
* Device to trigger input;


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:Mbus adding new device.png||border|class=tlt-border]]
[[File:Basic WebUI Advanced.gif|border|center|class=tlt-border|1004x1004px]]


==I/O control via SMS==
===Device 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.
===RUT 2===
----
----
This section contains information on how to configure the RUT2 device.
You will be granted to a new window. Configure your M-Bus device accordingly:
====SMS Utilities configuration====
 
----
# '''Name''': Enter the desired name of the M-Bus device
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:
# '''Address type''': select which M-Bus address will be used
* Log into RUT2 WebUI;
# '''Primary/Secondary address''': specify M-Bus address
* 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''');
[[File:Mbus adding new device configuration v3.png|border|class=tlt-border]]
* '''Add''' new '''instance''' ('''3''');


[[File:SMS utils add.png|border|center|class=tlt-border|1004x1004px]]
Test if the M-Bus device is reachable by a specified primary/secondary address. To do so click on [[File:Ping_device_option_mbus.png|110x110px]]. You might get on of two outputs:


After this you should redirected to configuration page for that rule:
* If you have specified correct primary/secondary address, you will receive:
[[File:SMS utils SMS config.png|border|center|class=tlt-border|1004x1004px]]
[[File:Mbus device pingable v2.png|border|class=tlt-border|300px]]


# '''Open General''' tab;
* If you have specified incorrect primary/secondary address, you will receive (if you do not know what address should be used, refer to the Scanning for available M-Bus devices (PRIDET URL) secion:
# Check '''Enable''';
[[File:Mbus device not pingable v2.png|border|class=tlt-border|300px]]
# 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.
Once finished, save the configuration by clicking [[File:Savenapply button.png|Savenapply button.png]].


===RUT 1===
===Scanning for available M-Bus devices===
----
----
This section contains RUT1 I/O Juggler configuration.
 
====I/O Juggler configuration====
If you are not sure what address your M-Bus devices have, you can try scanning for the available M-Bus devices. To do so click on [[File:Scan button.png]] button.
 
====Scan settings====
----
----
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.
You will be granted to a new window. Configure scan settings accordingly:
=====Actions configuration=====
 
# '''Scan type''': select which M-Bus address will be scanned
# '''Scan range''': From what M-Bus address scanning will start and M-Bus address until scanning will be performed.
[[File:Mbus scan.png|border|class=tlt-border]]
 
To start the scan click on [[File:Start scan button.png]] button.
 
====Found devices====
----
----
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:
Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:
* Log into Router 1 WebUI and go to the '''Services → Input/Output → I/O Juggler → Actions (1)''' page;
 
* '''Enter''' the desired action '''instance name (2)''' and select '''desired action type (3)''';
[[File:Mbus scanned devices add.png|border|class=tlt-border]]
* Click '''add (4)''';
 
[[File:IO juggler action sms.png|border|center|class=tlt-border|1004x1004px]]
You can either [[File:Pencil2.png]] '''(1)''' M-Bus devices primary address or [[File:Add Button.png|60x90px]] '''(2)''' to the M-Bus devices list.
 
==Gathering M-Bus data==
 
If the device successfully added to the list, under the General settings you should see that the Status changes to <span style="color:green">Active</span>.


This will open a new configuration page:
[[File:Mbus status active v2.png|border|class=tlt-border]]
[[File:IO_juggler_SMS_config_new.png|border|center|class=tlt-border|1004x1004px]]


# Type - '''SMS''';
===Data collecting groups===
# Text message - '''RUT2 password''' and the '''SMS rule''' that have been created on RUT2;
----
# Recipient's phone number - RUT2''' SIM cards number''';
To reach data collecting groups configuration press [[File:Pencil2.png]] button. [[File:Add Button.png|60x90px]] button lets you to create a new instance.
# '''Save''' and '''apply changes''';


'''Note:''' Fields that are not indicated can be left as default.
[[File:Mbus data collect overview.png|border|class=tlt-border]]


=====General configuration=====
====Data collecting group instance====
----
----
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:
*'''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]]
Each data collection group contains the following information. Configure device accordingly:


After that, you will be prompted to edit an instance:
# '''Enabled''': on
# '''Name''': desired name of the instance
# '''Period''': desired time duration between data retrievals
# '''Data type''': desired data type to process the received data. Depending on your needs you can select between 5 different data types: '''JSON, XML, ASCII, Hexadecimal''' and '''Binary'''.


[[File:IO_Juggler_general_input_config.png|border|center|class=tlt-border|1004x1004px]]
[[File:Mbus data collect group v2.png|border|class=tlt-border]]
# Check '''Enable''';
# Trigger - '''Raising''';
# Add actions - '''Action name''' that was created previously;


'''Note:''' Fields that are not indicated can be left as default.
You can check if your configuration works accordingly by pressing the [[File:Mbus test button.png]] button. You should see the data in a pop-up field:


==I/O control via Public IP and HTTP==
[[File:Mbus TEST output.png|border|class=tlt-border]]
For this configuration you will need a Static or Dynamic Public IP address on RUT2. 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===
====Group values====
----
----
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.
To reach group values configuration press [[File:Pencil2.png]] button:
====Remote access configuration====
 
----
[[File:Mbus edit group values.png|border|class=tlt-border]]
The [[RUT955_Administration#Access_Control|Access Control]] page is used to manage remote and local access to device. Navigate to:
 
There you can adjust additional settings:
 
# '''Enable''': Enable/disable data group value.
# '''FCB toggle''': FCB (Frame Count-Bit), one-bit counter for reliable server-client communication.
# '''Manufacturer information''': Select to include manufacturer information in the payload.
# '''Selected parameters''': Select to include the all parameters saved from device, or a custom subset of them. If the custom is selected you can specify '''frame''', '''record''' numbers and also a '''paramater'''
 
[[File:Mbus device groupsa.png|border|class=tlt-border]]


* '''System → Administration → Access Control'''
* Open '''General''' tab ('''1''') and locate the '''WebUI section''';
* '''Enable''' remote '''HTTP''' ('''2''') and '''HTTPS''' access ('''3''');
* '''Save''' and '''apply''' '''changes''' ('''4''');


[[File:Access control rutos1.png|border|center|class=tlt-border|1004x1004px]]
==Sending data to the server==
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 desired HTTP or MQTT server.


====I/O Post/Get configuration====
===Data to Server 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 set up Data to Server, navigate to Services → Data to Server. Enter desired name of the instnace and hit [[File:Add Button.png|60x90px]] button which is shown below.
* '''Services → Input/Output → Post/Get''';
* '''Enable''' Post/Get '''(1)''';
* '''Set a username (2)''' and '''password (3)''';
* '''Save''' and '''apply changes (4)''';


[[File:IO_post_get.png|border|center|class=tlt-border|1004x1004px]]
[[File:Mbus data to server create.png|border|class=tlt-border]]


===RUT 1===
===Data configuration===
----
----
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 (Public IP) configuration=====
----
Navigate to '''Services → Input/Output → I/O Juggler''' and create an Action instance.


# Type ('''1''') - '''Script''';
Each data collection group contains the following information. Configure device accordingly:
# Specify path ('''2''') - you can choose between '''specifying''' the '''script path''' or '''uploading''' a '''script file''' directly;
 
# Script file ('''3''') - depending on what you have chosen in the field above, you will be asked to enter a '''script directory''' or '''upload a script''' file;
# '''Name''': desired name of the instance
# Save and apply changes ('''4''')
# '''Type''': M-Bus data
# '''Format''': custom or JSON depending on a need.


'''Note:''' Fields that are not indicated can be left as default.
[[File:Mbus data to server configuration.png|border|class=tlt-border]]


[[File:IO juggler script conf.png|border|center|class=tlt-border|1004x1004px]]


Script example can be seen below:
Once finished configuring Data configuration tab click on [[File:Mbus data to server collection edit.png|160x160px]] button.
<pre>#!/bin/sh


curl -X GET "http:///84.XX.XXX.XX/cgi-bin/io_state?username=YOUR_USERNAME&password=YOUR_PASSWORD&pin=dout1&state=on"
===Collection configuration===
----


exit 0</pre>
[[File:Mbus data to server collection configuration.png|border|class=tlt-border]]


'''Note''': replace YOUR_USERNAME and YOUR_PASSWORD with your Post/Get created username and password.
Once finished configuring Collection configuration tab click on [[File:Mbus data to server server button.png|160x160px]] button.


=====Actions (HTTP) configuration=====
===Server configuration===
----
----
Navigate to '''Services → Input/Output → I/O Juggler''' and create an Action instance.
This section contains information on how to configure MQTT and HTTP servers information.


# Type ('''1''') - '''HTTP''';
====HTTP configuration====
# Method ('''2''') - '''GET''';
----
# URL ('''3''') - Enter your '''POST/GET URL''';
# Save and apply changes ('''4''')


Note: Fields that are not indicated can be left as default.
# '''Type''': HTTP
# '''Server address''': desired server address


[[File:HTTP IO.png|border|center|class=tlt-border|1004x1004px]]
'''Note''': not specified fields are optional.


'''Note''': replace YOUR_USERNAME and YOUR_PASSWORD with your Post/Get created username and password.
[[File:Mbus data to server HTTP configuration.png|border|class=tlt-border]]


More information about '''POST/GET''' command syntax [[RUT955_Mobile_Utilities#Post.2FGet|here]].
====MQTT configuration====
----


==I/O control via RMS VPN==
# '''Type''': MQTT
If having Public IP is not an option, RMS VPN could be used as an alternative to access your device over the internet. [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 the creation of encrypted VPN tunnels for secure access to multiple endpoints within a matter of seconds.
# '''Server address''': desired server address
===RMS VPN configuration===
# '''Topic''': MQTT topic to be used for publishing the data.
----
 
A guide on how to set up an RMS VPN Hub can be found [https://youtu.be/dfAudZR2wPY here].
'''Note''': not specified fields are optional.


[[File:RMS VPN IO config.png|border|center|class=tlt-border|704x704px]]
[[File:Mbus data to server MQTT configuration.png|border|class=tlt-border]]


Both RUT1 and RUT2 have to be added to RMS VPN Hub.
Once finished configuring Server configuration tab click on [[File:Savenapply button.png|Savenapply button.png]] button.


====Script====
===Results===
----
----
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
[[File:Mbus data received v2.png|border|class=tlt-border]]


[[File:Input 1 to high.gif|border|center|class=tlt-border|804x804px]]
'''Note''': received data formating depends on the settings you apply under Data to Server and M-Bus configurations.
as well as RUT2 Output.
[[File:Output 4 to high.gif|border|center|class=tlt-border|804x804px]]

Latest revision as of 07:20, 25 October 2024

The information on this page is updated in accordance with the 00.07.08 firmware version .

Summary

This article contains instructions on how to send M-Bus data to the server using various protocols.

Configuration overview & 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 this 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 "Advanced" button, located at the top of the WebUI.

Adding M-Bus devices

The 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 → Client. Add a new device to the configuration press button which is shown below.

Device configuration

You will be granted to a new window. Configure your M-Bus device accordingly:

  1. Name: Enter the desired name of the M-Bus device
  2. Address type: select which M-Bus address will be used
  3. Primary/Secondary address: specify M-Bus address

Test if the M-Bus device is reachable by a specified primary/secondary address. To do so click on . You might get on of two outputs:

  • If you have specified correct primary/secondary address, you will receive:

  • If you have specified incorrect primary/secondary address, you will receive (if you do not know what address should be used, refer to the Scanning for available M-Bus devices (PRIDET URL) secion:

Once finished, save the configuration by clicking Savenapply button.png.

Scanning for available M-Bus devices

If you are not sure what address your M-Bus devices have, you can try scanning for the available M-Bus devices. To do so click on button.

Scan settings

You will be granted to a new window. Configure scan settings accordingly:

  1. Scan type: select which M-Bus address will be scanned
  2. Scan range: From what M-Bus address scanning will start and M-Bus address until scanning will be performed.

To start the scan click on button.

Found devices

Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:

You can either (1) M-Bus devices primary address or (2) to the M-Bus devices list.

Gathering M-Bus data

If the device successfully added to the list, under the General settings you should see that the Status changes to Active.

Data collecting groups

To reach data collecting groups configuration press button. button lets you to create a new instance.

Data collecting group instance

Each data collection group contains the following information. Configure device accordingly:

  1. Enabled: on
  2. Name: desired name of the instance
  3. Period: desired time duration between data retrievals
  4. Data type: desired data type to process the received data. Depending on your needs you can select between 5 different data types: JSON, XML, ASCII, Hexadecimal and Binary.

You can check if your configuration works accordingly by pressing the button. You should see the data in a pop-up field:

Group values

To reach group values configuration press button:

There you can adjust additional settings:

  1. Enable: Enable/disable data group value.
  2. FCB toggle: FCB (Frame Count-Bit), one-bit counter for reliable server-client communication.
  3. Manufacturer information: Select to include manufacturer information in the payload.
  4. Selected parameters: Select to include the all parameters saved from device, or a custom subset of them. If the custom is selected you can specify frame, record numbers and also a paramater


Sending data to the server

The 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 desired HTTP or MQTT server.

Data to Server configuration

To set up Data to Server, navigate to Services → Data to Server. Enter desired name of the instnace and hit button which is shown below.

Data configuration

Each data collection group contains the following information. Configure device accordingly:

  1. Name: desired name of the instance
  2. Type: M-Bus data
  3. Format: custom or JSON depending on a need.


Once finished configuring Data configuration tab click on button.

Collection configuration

Once finished configuring Collection configuration tab click on button.

Server configuration

This section contains information on how to configure MQTT and HTTP servers information.

HTTP configuration

  1. Type: HTTP
  2. Server address: desired server address

Note: not specified fields are optional.

MQTT configuration

  1. Type: MQTT
  2. Server address: desired server address
  3. Topic: MQTT topic to be used for publishing the data.

Note: not specified fields are optional.

Once finished configuring Server configuration tab click on Savenapply button.png button.

Results

Note: received data formating depends on the settings you apply under Data to Server and M-Bus configurations.

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Domnev&oldid=134858"