Difference between revisions of "Domnev"

From Teltonika Networks Wiki
 
(233 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 I/O Juggler 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 overview 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 SMS and Script when Input 1 is being triggered to a state high to change Output state to high on a RUT2.
 
  
# RUT1 Input 1 state changes to a High;
+
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
# RUT1 executes action and send command to RUT2;
+
| series = RUTX
# RUT2 Output(4) state changes to High;
+
}}
  
'''Prerequisites''':
 
* Two RUT955 routers (one of them with SIM card inserted);
 
* An end device (PC, Laptop, Tablet, Smartphone) 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</b>. . You can do that by clicking the "Basic" button under "Mode", which is located at the top-right corner of the WebUI.
+
==Adding M-Bus devices==
[[File:Basic WebUI Advanced.gif|border|center|class=tlt-border|1004x1004px]]
+
To add a new device to the configuration press [[File:Add Button.png|60x90px]] button which is shown below.
 +
 
 +
[[File:Mbus adding new device.png||border|class=tlt-border]]
  
==Via SMS==
+
===Device configuration===
This section contains a detailed guide on how to execute an action from RUT1 when Input 1 is being trigger. Action will send an SMS message to a RUT2 and change the device Output state to a high.
 
===RUT 2===
 
This section contain information on how to configure RUT2 device.
 
 
----
 
----
====SMS Utilities configuration====
+
You will be granted to a new window. Configure your M-Bus device accordingly:
The SMS Utilities section contains a list of rules that perform certain actions when they are activated by SMS messages.
+
 
----
+
# '''Name''': Enter the desired name of the M-Bus device
* Log into Router 2 WebUI;
+
# '''Address type''': select which M-Bus address will be used
* Go to the '''Services → Mobile Utilities → SMS Utilities''' page and scroll down for '''Add new rule''';
+
# '''Primary/Secondary address''': specify M-Bus address
* Enter '''desired SMS text''' command ('''1''') and '''select action''' ('''2''');
+
 
* '''Add''' new '''instance''' ('''3''');
+
[[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:
  
[[File:SMS utils add.png|border|center|class=tlt-border|1004x1004px]]
+
* If you have specified correct primary/secondary address, you will receive:
 +
[[File:Mbus device pingable v2.png|border|class=tlt-border|300px]]
  
After this you should redirected to configuration page for that rule:
+
* 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:SMS utils SMS config.png|border|center|class=tlt-border|1004x1004px]]
+
[[File:Mbus device not pingable v2.png|border|class=tlt-border|300px]]
  
# '''Open General''' tab;
+
Once finished, save the configuration by clicking [[File:Savenapply button.png|Savenapply button.png]].
# 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:''' Not marked fields can be left as default.
+
===Scanning for available M-Bus devices===
 
----
 
----
===RUT 1===
+
 
This section contains RUT1 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====
 
----
 
----
====I/O Juggler configuration====
+
You will be granted to a new window. Configure scan settings accordingly:
The 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 can learn more about it [[RUT955_Input/Output#I.2FO_Juggler|here]].
+
 
 +
# '''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====
 
----
 
----
=====Actions configuration=====
+
Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:
The Actions section is used to manage and create new Actions that can be executed by the I/O Juggler Rules. The figure below is an example of the Actions section, which is empty by default. You can learn more about it [[RUT955_Input/Output#Actions|here]].
+
 
----
+
[[File:Mbus scanned devices add.png|border|class=tlt-border]]
* 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)''';
+
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.
* Click '''add (4)''';
+
 
[[File:IO juggler action sms.png|border|center|class=tlt-border|1004x1004px]]
+
==Gathering M-Bus data==
  
This will open a new configuration page:
+
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>.
[[File:IO_juggler_SMS_config_new.png|border|center|class=tlt-border|1004x1004px]]
 
  
# Type - '''SMS''';
+
[[File:Mbus status active v2.png|border|class=tlt-border]]
# 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:''' Not marked fields can be left as default.
+
===Data collecting groups===
 
----
 
----
=====General 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.
The General section is used to Input Trigger rules, which can perform a specified user-configured action when the Input state changes
+
 
 +
[[File:Mbus data collect overview.png|border|class=tlt-border]]
 +
 
 +
====Data collecting group instance====
 
----
 
----
* 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:
 +
 
 +
# '''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]]
  
After that, you will be prompted to edit an instance:
+
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:
  
[[File:IO_Juggler_general_input_config.png|border|center|class=tlt-border|1004x1004px]]
+
[[File:Mbus TEST output.png|border|class=tlt-border]]
# Check '''Enable''';
 
# Trigger - '''Raising''';
 
# Add actions - '''Action name''' that was created previously;
 
  
'''Note:''' Not marked fields can be left as default.
+
====Group values====
 
----
 
----
 +
To reach group values configuration press [[File:Pencil2.png]] button:
 +
 +
[[File:Mbus edit group values.png|border|class=tlt-border]]
 +
 +
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'''
  
==Via Public IP using curl -X==
+
[[File:Mbus device groupsa.png|border|class=tlt-border]]
For this configuration you will need a Static or Dynamic Public IP address. 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===
 
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.
 
----
 
====Remote access configuration====
 
The Access Control page is used to manage remote and local access to device.
 
----
 
* Navigate to '''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 rutos.png|border|center|class=tlt-border|1004x1004px]]
+
==Sending data to the server==
 +
This section contains information on how to send M-Bus data to the server using MQTT and HTTP protocols.
  
====Post/Get configuration====
+
===Data to Server configuration===
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)''';
+
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.
* '''Enable''' Post/Get '''(2)''';
 
* '''Set a username (3)''' and '''password (4)''';
 
* '''Save''' and '''apply changes (5)''';
 
  
[[File:SMS 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 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 configuration.png|border|class=tlt-border]]
  
# Type - '''Script''';
 
# 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:''' Not marked fields can be left as default.
+
Once finished configuring Data configuration tab click on [[File:Mbus data to server collection edit.png|160x160px]] button.
  
Script example can be seen below:
+
===Collection 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"
+
[[File:Mbus data to server collection configuration.png|border|class=tlt-border]]
  
exit 0</pre></li>
+
Once finished configuring Collection configuration tab click on [[File:Mbus data to server server button.png|160x160px]] button.
  
More information about '''curl -X''' command syntax [[RUT955_Mobile_Utilities#Post.2FGet|here]].
+
===Server configuration===
 +
----
  
==Via RMS VPN using curl -X==
+
====HTTP configuration====
For a more secure alternative, RMS VPN could be used to execute a curl -X script.
+
----
===RMS VPN configuration===
 
  
Go to [http://rms.teltonika-networks.com rms.teltonika-networks.com], log into your RMS account and create a RMS VPN Hub. A guide on how to set up a RMS VPN Hub can be found [https://youtu.be/dfAudZR2wPY here].
+
[[File:Mbus data to server HTTP configuration.png|border|class=tlt-border]]
  
[[File:RMS VPN config IO.png|border|center|class=tlt-border|604x604px]]
+
====MQTT configuration====
 
+
----
Please make sure that both RUT1 and RUT2 have been added to RMS VPN Hub.
 
  
====Script====
+
[[File:Mbus data to server MQTT configuration.png|border|class=tlt-border]]
Adjust the script accordingly to the RMS VPN Hub assigned IP to RUT2. The script that been used in this example can be found [https://wiki.teltonika-networks.com/wikibase/index.php?title=Domnev&oldid=97995#Actions_configuration_2 here].
 
  
==Results==
+
Once finished configuring Server configuration tab click on [[File:Savenapply button.png|Savenapply button.png]] button.
  
If configured correctly you should be able to see that the RUT1 Input 1 state is being changed to high as well as RUT2 Output.
 
  
[[File:IO state.gif|border|center|class=tlt-border|1004x1004px]]
+
==See Also==
  
[[File:Output state.gif|border|center|class=tlt-border|1004x1004px]]
+
==External links==
 +
[https://flespi.io/#/ Flespi.io]

Latest revision as of 09:32, 22 August 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.

Networking rutos manual webui basic advanced mode 75.gif


Adding M-Bus devices

To add a new device to the configuration press Add Button.png button which is shown below.

Mbus adding new device.png

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

Mbus adding new device configuration v3.png

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

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

Mbus device pingable v2.png

  • 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:

Mbus device not pingable v2.png

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 Scan button.png 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.

Mbus scan.png

To start the scan click on Start scan button.png button.

Found devices


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

Mbus scanned devices add.png

You can either Pencil2.png (1) M-Bus devices primary address or Add Button.png (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.

Mbus status active v2.png

Data collecting groups


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

Mbus data collect overview.png

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.

Mbus data collect group v2.png

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

Mbus TEST output.png

Group values


To reach group values configuration press Pencil2.png button:

Mbus edit group values.png

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

Mbus device groupsa.png


Sending data to the server

This section contains information on how to send M-Bus data to the server using MQTT and HTTP protocols.

Data to Server configuration


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

Mbus data to server create.png

Data configuration


Mbus data to server configuration.png


Once finished configuring Data configuration tab click on Mbus data to server collection edit.png button.

Collection configuration


Mbus data to server collection configuration.png

Once finished configuring Collection configuration tab click on Mbus data to server server button.png button.

Server configuration


HTTP configuration


Mbus data to server HTTP configuration.png

MQTT configuration


Mbus data to server MQTT configuration.png

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


See Also

External links

Flespi.io