Difference between revisions of "Template:Networking rutos manual data to server"

From Teltonika Networks Wiki
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}-->
 
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}-->
{{Template: Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_device_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.06.1
+
| series = {{{series}}}
| series     = {{{series}}}
+
| name  = {{{name}}}
 +
| fw_version ={{Template: Networking_device_manual_latest_fw
 +
| series = {{{series}}}
 +
| name  = {{{name}}}
 +
}}
 
}}
 
}}
 
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)#Modbus_Data_to_Server|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
 +
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)#Modbus_Data_to_Server|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
 +
__TOC__
 
==Summary==
 
==Summary==
  
 
The <b>Data to Server</b> feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers.
 
The <b>Data to Server</b> feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers.
 +
{{#switch: {{{series}}}
 +
| RUTX =
 +
| RUTM =
 +
| TRB1 =
 +
| TRB2 =
 +
| RUT9|RUT9M =
 +
| #default =
 +
<u><b>
 +
 +
Note:</b> On {{{name}}}, Data to Server is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
  
 +
</u>}}
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
| series = {{{series}}}
 
| series = {{{series}}}
Line 17: Line 34:
 
A <b>Data Sender</b> is an instance that gathers and periodically sends collected data to a specified server. The Data Senders list is empty by default so, in order to begin configuration you must add a new data sender first. To add a new data sender, click the 'Add' button.
 
A <b>Data Sender</b> is an instance that gathers and periodically sends collected data to a specified server. The Data Senders list is empty by default so, in order to begin configuration you must add a new data sender first. To add a new data sender, click the 'Add' button.
  
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button_v3.png|border|class=tlt-border]]
  
 
After this you should be redirected to the newly added data sender's configuration page.
 
After this you should be redirected to the newly added data sender's configuration page.
  
===Advanced Sender Settings===
+
===Sender Settings===
 
----
 
----
 
Refer to the table below for descriptions on data sender configuration fields.
 
Refer to the table below for descriptions on data sender configuration fields.
Line 27: Line 44:
 
<b>Note</b>: these tables have coloring schemes to indicate which fields can be seen with different configuration.
 
<b>Note</b>: these tables have coloring schemes to indicate which fields can be seen with different configuration.
  
[[File:Networking_rutos_manual_data_to_server_advanced_sender_settings.png|border|class=tlt-border]]
+
[[File:Networking rutos manual data to server data configuration.png|border|class=tlt-border]]
  
====General====
+
====Data configuration====
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 36: Line 53:
 
       <th>Value</th>
 
       <th>Value</th>
 
       <th>Description</th>
 
       <th>Description</th>
    </tr>
 
    <tr>
 
      <td>Enabled</td>
 
      <td>off | on; default: <b>off</b></td>
 
      <td>Turns the data sender on or off.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 46: Line 58:
 
       <td>string; default: <b>none</b></td>
 
       <td>string; default: <b>none</b></td>
 
       <td>Name of the data sender. Used for easier data senders management purposes only (optional).</td>
 
       <td>Name of the data sender. Used for easier data senders management purposes only (optional).</td>
     </tr>{{#ifeq: {{{wifi}}} | 1 |
+
     </tr>  
 
     <tr>
 
     <tr>
       <td>Data source</td>
+
       <td>Type</td>
       <td>Modbus data {{#ifeq:{{{bluetooth}}}|1|<nowiki>|</nowiki> Bluetooth data |}} {{#ifeq:{{{wifi}}}|1|<nowiki>|</nowiki> WiFi scanner data|}}; default: <b>Modbus data</b></td>
+
       <td><span style="color:red">Modbus</span><span style="color:blue">Modbus alarms</span>{{#ifeq:{{{series}}}|RUT36X|<span class="asterisk">*</span>|}}{{#ifeq:{{{series}}}|RUT30X|<span class="asterisk">*</span>|}} {{#ifeq:{{{bluetooth}}}|1|<nowiki>|</nowiki> <span style="color:green">Bluetooth data</span> |}} {{#ifeq:{{{wifi}}}|1|<nowiki>|</nowiki> WiFi scanner data{{#ifeq: {{{series}}} | RUTX | | <span class="asterisk">*</span>}}|}} | <span style="color:magenta">DNP3</span><span class="asterisk">*</span> {{!}} DNP3 data flash<span class="asterisk">*</span>; default: <b>Modbus data</b></td>
 
       <td>Source of the data to be sent to server.</td>
 
       <td>Source of the data to be sent to server.</td>
     </tr>|}}
+
     </tr>
 
     <tr>
 
     <tr>
       <td>Protocol</td>
+
       <td>Format type</td>
       <td>HTTP(S) | MQTT | Kinesis; default: <b>HTTP(S)</b></td>
+
       <td>Json, custom; default: <b>Json</b></td>
      <td>Protocol used for sending the data to server.</td>
+
        <td>Arranges the format of the sent segment.</td>  
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>JSON format</td>
 
       <td>JSON format</td>
       <td>string; default: </b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
+
       <td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
 
         <td>Arranges the format of the sent JSON segment.</td>  
 
         <td>Arranges the format of the sent JSON segment.</td>  
 
     </tr>
 
     </tr>
Line 73: Line 85:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>URL/Host/Connection string</td>
+
       <td><span style="color:red">Data filtering</span></td>
      <td>string; default: <b>none</b></td>
 
      <td>URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.</td>
 
    </tr>
 
    <tr>
 
      <td>Period</td>
 
      <td>integer [1..86400]; default: <b>60</b></td>
 
      <td>Data sending frequency (in seconds).</td>
 
    </tr>
 
    <tr>
 
      <td>Data filtering</td>
 
 
       <td>All data | <span style="color:darkred">By slave ID</span> | <span style="color:blue">By slave IP</span>; default: <b>All data</b></td>
 
       <td>All data | <span style="color:darkred">By slave ID</span> | <span style="color:blue">By slave IP</span>; default: <b>All data</b></td>
       <td>Choose which data this sender will send to server.</td>
+
       <td>If Data source: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 94: Line 96:
 
     <tr>
 
     <tr>
 
       <td><span style="color:blue">By slave IP:</span> Slave IP</td>
 
       <td><span style="color:blue">By slave IP:</span> Slave IP</td>
       <td>ip; default: </b>none</b></td>
+
       <td>ip; default: <b>none</b></td>
 
       <td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
 
       <td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
 +
    </tr>{{#ifeq:{{{bluetooth}}}|1|
 +
    <tr>
 +
      <td><span style="color:green">Data filtering</span></td>
 +
      <td>All data <nowiki>|</nowiki> <span style="color:darkred">By MAC address</span> <nowiki>|</nowiki> <span style="color:blue">By device name</span>; default: <b>All data</b></td>
 +
      <td>If Data source: <span style="color:green">Bluetooth data</span>. Choose which data this sender will send to server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:darkred">By MAC address:</span> MAC address</td>
 +
      <td>mac; default: <b>none</b></td>
 +
      <td>MAC address of bluetooth device whose collected data will be sent to server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:blue">By device name:</span> Device name</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Device name of bluetooth device whose collected data will be sent to server.</td>
 +
    </tr>|}}
 +
    <tr>
 +
      <td><span style="color:magenta">Data filtering</span></td>
 +
      <td>All data <nowiki>|</nowiki> <span style="color:darkred">DNP3 Address</span> <nowiki>|</nowiki> <span style="color:blue">DNP3 IP</span>; default: <b>All data</b></td>
 +
      <td>If Data source: <span style="color:magenta">DNP3</span>. Choose which data this sender will send to server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:darkred">DNP3 Address:</span> DNP3 Address</td>
 +
      <td>integer [0..65519]; default: <b>none</b></td>
 +
      <td>DNP3 address of device whose collected data will be sent to server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:blue">DNP3 IP:</span> DNP3 IP</td>
 +
      <td>ip | domain; default: <b>none</b></td>
 +
      <td>IP address of DNP3 device whose collected data will be sent to server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 104: Line 136:
 
</table>
 
</table>
 
<br>
 
<br>
====Protocol HTTP(S)====
+
 
 +
====Collection general settings====
 +
----
 +
 
 +
[[File:Networking rutos manual data to server collection configuration general settings.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 113: Line 149:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Custom Header</td>
+
       <td>Enable</td>
       <td>string; default: <b>none</b></td>
+
       <td>on, off; default: <b>on</b></td>
      <td>Allows to add custom headers to the HTTP requests.</td>
+
       <td>Enables instance.</td>
    </tr>
 
    <tr>
 
      <td>Use TLS</td>
 
      <td>off | <span style="color:red">on</span>; default: '''off'''</td>
 
       <td>Enables the use of TSL certificates.</td>
 
 
     </tr>
 
     </tr>
    <tr>
+
        <tr>
       <td><span style="color:red">On:</span> TLS type</td>
+
       <td>Type</td>
      <td>Certificate based; default: '''Certificate based'''</td>
+
      <td><span style="color:red">Json</span>, <span style="color:blue">custom</span>; default: <b>Json</b></td>
      <td>Select type of TLS.</td>
+
        <td>Data input type.</td>  
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td><span style="color:red">On:</span> A File</td>
+
       <td><span style="color:red">Json</span></td>
       <td>.ca file; default: <b>none</b></td>
+
       <td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
      <td>'''Certificate authority''' is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate.</td>
+
         <td>Arranges the format of the sent JSON segment.</td>  
    </tr>
 
    <tr>
 
    <td><span style="color:red">On:</span> Client Certificate</td>
 
        <td>.crt file; default: <b>none</b></td>
 
         <td>Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. If client certificate is not needed, leave both client certificate and client key fields empty.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
    <td><span style="color:red">On:</span> Private Key</td>
+
      <td><span style="color:blue">custom</span></td>
         <td>.key file; default: <b>none</b></td>
+
      <td>string; default: <b>empty</b></td>
         <td>File containing private key for this client. This file needs to be not encrypted.</td>
+
         <td>Type of data formatting.</td>
 +
    </tr>    <tr>
 +
      <td><span style="color:blue">Empty value</span></td>
 +
      <td>string; default: <b>N/A</b></td>
 +
         <td>A string which will be placed if any value cannot be received.</td>  
 
     </tr>
 
     </tr>
 
</table>
 
</table>
<br>
+
 
====Protocol MQTT====
+
====Collection advanced settings====
 +
----
 +
 
 +
[[File:Networking rutos manual data to server collection configuration advanced settings.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 153: Line 186:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Port</td>
+
      <td>Period</td>
        <td>integer [0..65535]; default: <b>1883</b></td>
+
      <td>integer [1..86400]; default: <b>60</b></td>
        <td>Port number for connecting to MQTT.</td>
+
      <td>Data sending frequency (in seconds).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Keepalive</td>
+
      <td>Retry</td>
        <td>integer [1..640]; default: <b>60</b></td>
+
      <td>off | <span style="color:darkgreen">on</span>; default: <b>off</b></td>
        <td>MQTT Keepalive period in seconds.</td>
+
      <td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Topic</td>
+
      <td><span style="color:darkgreen">Retry count</span></td>
        <td>string; default: <b>none</b></td>
+
      <td>integer [1..10]; default: <b>10</b></td>
        <td>MQTT topic to be used for publishing the data.</td>
+
      <td>Retry to send the same data N times.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Client ID</td>
+
      <td><span style="color:darkgreen">Timeout</span></td>
        <td>string; default: <b>none</b></td>
+
      <td>integer [1..60]; default: <b>1</b></td>
        <td>Client ID to send with the data. If empty, a random client ID will be generated</td>
+
      <td>Timeout in second between retry attempts.</td>
 
     </tr>
 
     </tr>
 +
</table>
 +
 +
====Server configuration====
 +
----
 +
 +
[[File:Networking rutos manual data to server server configuration.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <td>QoS</td>
+
         <th>Field</th>
        <td>integer [0..2]; default: <b>0</b></td>
+
      <th>Value</th>
         <td>MQTT Quality of Service. Allowed values:
+
      <th>Description</th>
* 0 - when we prefer that the message will not arrive at all rather than arrive twice,
+
    </tr>
* 1 - when we want the message to arrive at least once but don't care if it arrives twice (or more),
+
        <tr>
* 2 - when we want the message to arrive exactly once. A higher QoS value means a slower transfer.</td>
+
      <td>Protocol</td>
 +
      <td>HTTP(S) | MQTT{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | Kinesis; default: <b>HTTP(S)</b></td>
 +
      <td>Protocol used for sending the data to server.</td>
 +
    </tr>
 +
         <tr>
 +
      <td>Server address</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Use TLS</td>
+
       <td>HTTP Header</td>
       <td>off | <span style="color:red">on</span>; default: '''off'''</td>
+
       <td>string; default: <b>none</b></td>
       <td>Enables the use of TSL certificates.</td>
+
       <td>Allows to add custom headers to the HTTP requests.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td><span style="color:red">On:</span> TLS type</td>
+
       <td>Enable secure connection</td>
       <td><span style="color:chocolate">Certificate based</span> {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
+
      <td><span style="color:chocolate">on</span>, off; default: <b>off</b></td>
       <td>Select type of TLS.</td>
+
       <td>Enables use of TLS certificates</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Certificate files from device</td>
 +
      <td>on, off; default: <b>off</b></td>
 +
       <td>Choose this option if you want to select certificate files from device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 204: Line 257:
 
         <td>.key file; default: <b>none</b></td>
 
         <td>.key file; default: <b>none</b></td>
 
         <td>File containing private key for this client. This file needs to be not encrypted.</td>
 
         <td>File containing private key for this client. This file needs to be not encrypted.</td>
    </tr>
 
    <tr>
 
      <td><span style="color:darkred">Pre-shared key based:</span> Pre-Shared-Key</td>
 
      <td>string; default: <b>none</b></td>
 
      <td>The pre-shared-key in hex format with no leading "0x".</td>
 
    </tr>
 
    <tr>
 
      <td><span style="color:darkred">Pre-shared key based:</span> Identity</td>
 
      <td>string; default: <b>none</b></td>
 
      <td>The identity of this client. May be used as the username depending on the server settings.</td>
 
    </tr>
 
    <tr>
 
      <td>Use Credentials</td>
 
      <td>off | <span style="color:darkgreen">on</span>; default: '''off'''</td>
 
      <td>Enables use of username and password for authentication.</td>
 
    </tr>
 
    <tr>
 
      <td><span style="color:darkgreen">On:</span> Username</td>
 
      <td>string; default: <b>none</b></td>
 
      <td>Username used in authentication.</td>
 
    </tr>
 
    <tr>
 
      <td><span style="color:darkgreen">On:</span> Password</td>
 
      <td>string; default: <b>none</b></td>
 
      <td>Password used in authentication.</td>
 
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 +
<span class="asterisk">*</span> This is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
  
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Revision as of 12:41, 18 December 2023

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


Summary

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.

Note: On {{{name}}}, Data to Server is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

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

Data Senders

A Data Sender is an instance that gathers and periodically sends collected data to a specified server. The Data Senders list is empty by default so, in order to begin configuration you must add a new data sender first. To add a new data sender, click the 'Add' button.

Networking rutos manual data to server data senders add button v3.png

After this you should be redirected to the newly added data sender's configuration page.

Sender Settings


Refer to the table below for descriptions on data sender configuration fields.

Note: these tables have coloring schemes to indicate which fields can be seen with different configuration.

Networking rutos manual data to server data configuration.png

Data configuration

Field Value Description
Name string; default: none Name of the data sender. Used for easier data senders management purposes only (optional).
Type ModbusModbus alarms | DNP3* | DNP3 data flash*; default: Modbus data Source of the data to be sent to server.
Format type Json, custom; default: Json Arranges the format of the sent segment.
JSON format string; default: {"TS": "%t", "D": "%d", "data": %a} Arranges the format of the sent JSON segment.
Segment count integer [1..10]; default: 1 Max segment count in one JSON string sent to server.
Send as object off | on; default: off When turned on, sends JSON segment as object and not as an array element.
Data filtering All data | By slave ID | By slave IP; default: All data If Data source: Modbus data. Choose which data this sender will send to server.
By slave ID: Slave ID integer [1..255]; default: none ID of the Modbus slave whose collected data will be sent to server.
By slave IP: Slave IP ip; default: none IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).
Data filtering All data | DNP3 Address | DNP3 IP; default: All data If Data source: DNP3. Choose which data this sender will send to server.
DNP3 Address: DNP3 Address integer [0..65519]; default: none DNP3 address of device whose collected data will be sent to server.
DNP3 IP: DNP3 IP ip | domain; default: none IP address of DNP3 device whose collected data will be sent to server.
Retry on fail off | on; default: off When turned on, the data sender retries failed sending attempts until the are successfully delivered.


Collection general settings


Networking rutos manual data to server collection configuration general settings.png

Field Value Description
Enable on, off; default: on Enables instance.
Type Json, custom; default: Json Data input type.
Json string; default: {"TS": "%t", "D": "%d", "data": %a} Arranges the format of the sent JSON segment.
custom string; default: empty Type of data formatting.
Empty value string; default: N/A A string which will be placed if any value cannot be received.

Collection advanced settings


Networking rutos manual data to server collection configuration advanced settings.png

Field Value Description
Period integer [1..86400]; default: 60 Data sending frequency (in seconds).
Retry off | on; default: off When turned on, the data sender retries failed sending attempts until the are successfully delivered.
Retry count integer [1..10]; default: 10 Retry to send the same data N times.
Timeout integer [1..60]; default: 1 Timeout in second between retry attempts.

Server configuration


Networking rutos manual data to server server configuration.png

Field Value Description
Protocol HTTP(S) | MQTT* | Kinesis; default: HTTP(S) Protocol used for sending the data to server.
Server address string; default: none URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.
HTTP Header string; default: none Allows to add custom headers to the HTTP requests.
Enable secure connection on, off; default: off Enables use of TLS certificates
Certificate files from device on, off; default: off Choose this option if you want to select certificate files from device.
Certificate based: CA File .ca file; default: none Certificate authority is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate.
Certificate based: Client Certificate .crt file; default: none Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. If client certificate is not needed, leave both client certificate and client key fields empty.
Certificate based: Private Key .key file; default: none File containing private key for this client. This file needs to be not encrypted.

* This is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

[[Category:{{{name}}} Services section]]