Domnev: Difference between revisions

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


==Introduction==
==Configuration overview & prerequisites==
This article contains instructions on how to configure SMS and Script alerts using I/O Juggler and SMS Utilities between two RUT955 routers.
Before we begin, let's take a look at the configuration that we are attempting to achieve and the prerequisites that make it possible.


==Configuration overview and prerequisites==
'''Prerequisites''':
* TRB143;
* M-Bus device;
* Server;
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;


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" to change the output state to "high" on a RUT2.
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = RUTX
}}


'''TOPOLOGY'''
==Adding M-Bus devices==
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.


'''Prerequisites''':
[[File:Mbus adding new device.png||border|class=tlt-border]]
* Two RUT955 routers (one of them with SIM card inserted);
 
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;
===Device configuration===
----
You will be granted to a new window. Configure your M-Bus device accordingly:
 
# '''Name''': Enter the desired name of the M-Bus device
# '''Address type''': select which M-Bus address will be used
# '''Primary/Secondary address''': specify M-Bus address
 
[[File:Mbus adding new device configuration v3.png|border|class=tlt-border]]
 
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:
 
* If you have specified correct primary/secondary address, you will receive:
[[File:Mbus device pingable v2.png|border|class=tlt-border|300px]]
 
* 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:
[[File:Mbus device not pingable v2.png|border|class=tlt-border|300px]]
 
Once finished, save the configuration by clicking [[File:Savenapply button.png|Savenapply button.png]].
 
===Scanning for available M-Bus devices===
----


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


==I/O control via SMS==
====Scan settings====
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 scan settings accordingly:
====SMS Utilities 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_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:
Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:
* Log into Router 2 WebUI;
 
* Go to the '''Services → Mobile Utilities → SMS Utilities''' page and scroll down for '''Add new rule''';
[[File:Mbus scanned devices add.png|border|class=tlt-border]]
* 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]]
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.


After this you should redirected to configuration page for that rule:
==Gathering M-Bus data==
[[File:SMS utils SMS config.png|border|center|class=tlt-border|1004x1004px]]


# '''Open General''' tab;
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>.
# 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.
[[File:Mbus status active v2.png|border|class=tlt-border]]


===RUT 1===
===Data collecting groups===
----
----
This section contains RUT1 I/O Juggler configuration.
To reach data collecting groups configuration press [[File:Pencil2.png]] button. [[File:Add Button.png|60x90px]] button lets you to create a new instance.
====I/O Juggler configuration====
 
[[File:Mbus data collect overview.png|border|class=tlt-border]]
 
====Data collecting group instance====
----
----
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:
* 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)''';
* Click '''add (4)''';
[[File:IO juggler action sms.png|border|center|class=tlt-border|1004x1004px]]


This will open a new configuration page:
Each data collection group contains the following information. Configure device accordingly:
[[File:IO_juggler_SMS_config_new.png|border|center|class=tlt-border|1004x1004px]]
 
# '''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:Mbus data collect group v2.png|border|class=tlt-border]]


# Type - '''SMS''';
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:
# 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.
[[File:Mbus TEST output.png|border|class=tlt-border]]


=====General configuration=====
====Group values====
----
----
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:
To reach group values configuration press [[File:Pencil2.png]] button:
*'''General''' tab ('''1''') and '''enable''' it ('''2''');
 
* Add '''new instance''' role ('''3''');
[[File:Mbus edit group values.png|border|class=tlt-border]]
* Click Add ('''4''');


[[File:IO juggler general config.png|border|center|class=tlt-border|1004x1004px]]
There you can adjust additional settings:


After that, you will be prompted to edit an instance:
# '''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:IO_Juggler_general_input_config.png|border|center|class=tlt-border|1004x1004px]]
[[File:Mbus device groupsa.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.


==I/O control via Public IP==
==Sending data to the server==
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.  
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.


===RUT 2===
===Data to Server configuration===
----
----
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 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.
====Remote access configuration====
 
[[File:Mbus data to server create.png|border|class=tlt-border]]
 
===Data configuration===
----
----
The [[RUT955_Administration#Access_Control|Access Control]] page is used to manage remote and local access to device. Navigate to:


* '''System → Administration → Access Control'''
Each data collection group contains the following information. Configure device accordingly:
* 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]]
# '''Name''': desired name of the instance
# '''Type''': M-Bus data
# '''Format''': custom or JSON depending on a need.
 
[[File:Mbus data to server configuration.png|border|class=tlt-border]]


====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:
* '''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]]
Once finished configuring Data configuration tab click on [[File:Mbus data to server collection edit.png|160x160px]] button.


===RUT 1===
===Collection 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 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]]
[[File:Mbus data to server collection configuration.png|border|class=tlt-border]]


# Type - '''Script''';
Once finished configuring Collection configuration tab click on [[File:Mbus data to server server button.png|160x160px]] button.
# Specify path - you can choose between '''specifying''' the '''script path''' or '''uploading''' a '''script file''' directly;
# 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;
# Save and apply changes


'''Note:''' Fields that are not indicated can be left as default.
===Server configuration===
----
This section contains information on how to configure MQTT and HTTP servers information.


Script example can be seen below:
====HTTP configuration====
<pre>#!/bin/sh
----


curl -X GET "http://84.25.189.15/cgi-bin/sms_send?username=name&password=password&number=0037066081843&text=admin01 outputon"
# '''Type''': HTTP
# '''Server address''': desired server address


exit 0</pre>
'''Note''': not specified fields are optional.


More information about '''curl -X''' command syntax [[RUT955_Mobile_Utilities#Post.2FGet|here]].
[[File:Mbus data to server HTTP configuration.png|border|class=tlt-border]]


==I/O control via RMS VPN==
====MQTT configuration====
[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].


[[File:RMS VPN IO config.png|border|center|class=tlt-border|704x704px]]
# '''Type''': MQTT
# '''Server address''': desired server address
# '''Topic''': MQTT topic to be used for publishing the data.
 
'''Note''': not specified fields are optional.
 
[[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"