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

From Teltonika Networks Wiki
Line 17: Line 17:
 
| RUTX =
 
| RUTX =
 
| RUTM =
 
| RUTM =
 +
| TCR1 =
 
| TRB1 =
 
| TRB1 =
 
| TRB2 =
 
| TRB2 =
 +
| TRB2M =
 +
| TRB5 =
 +
| RUT2M =
 +
| RUT2 =
 +
| RUT30X =
 +
| RUT36X =
 
| RUT9|RUT9M =
 
| RUT9|RUT9M =
 +
| RUT14X =
 
| #default =  
 
| #default =  
 
<u><b>
 
<u><b>
Line 46: Line 54:
 
[[File:Networking rutos manual data to server data configuration.png|border|class=tlt-border]]
 
[[File:Networking rutos manual data to server data configuration.png|border|class=tlt-border]]
  
−
====Data configuration====
+
====General====
−
 
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 61: Line 68:
 
     <tr>
 
     <tr>
 
       <td>Type</td>
 
       <td>Type</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><span>Base | {{#ifeq:{{{bluetooth}}}|1|<span style="color:green">Bluetooth</span> {{!}} |}}{{#ifeq:{{{mobile}}}|1| GSM {{!}} <span style="color:blue">Mobile usage</span> {{!}} |}} MNF info | <span style="color:red">Modbus</span><span class="asterisk">*</span> | <span style="color:grey">Modbus Alarms</span> | {{#ifeq:{{{wifi}}}|1|<span style="color:purple">Wifi scanner</span><span class="asterisk">*</span> {{!}} |}}<span style="color:brown">DNP3</span><span class="asterisk">*</span> | <span style="color:orange">MQTT</span>; default: <b>Base</b></span>     
 +
        </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>
 
−
      <td>Format type</td>
 
−
      <td>Json, custom; default: <b>Json</b></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>Json | Custom; default: <b>Json</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 83: Line 86:
 
       <td>off | on; default: <b>off</b></td>
 
       <td>off | on; default: <b>off</b></td>
 
       <td>When turned on, sends JSON segment as object and not as an array element.</td>
 
       <td>When turned on, sends JSON segment as object and not as an array element.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:grey">Data filtering</span></td>
 +
      <td>All | <span style="color:grey">Server ID</span> | <span style="color:grey>Alarm ID</span> | <span style="color:grey">Register number</span>; default: <b>All</b></td>
 +
      <td>If Data type: <span style="color:grey">Modbus alarms data</span>. Choose which data this sender will send to server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td><span style="color:red">Data filtering</span></td>
 
       <td><span style="color:red">Data filtering</span></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 | <span style="color:red">Server IP address</span> | <span style="color:red">Server ID</span> | <span style="color:red">Request name</span> ; default: <b>All</b></td>
−
       <td>If Data source: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
+
       <td>If Data type: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
 +
    </tr>
 +
    {{#ifeq:{{{bluetooth}}}|1|
 +
    <tr>
 +
      <td><span style="color:green">Data filtering</span></td>
 +
      <td>All {{!}} <span style="color:green">Device MAC address</span> {{!}} <span style="color:green">Device name</span>; default: <b>All</b></td>
 +
      <td>If Data type: <span style="color:green">Bluetooth</span>. Choose which data this sender will send to server.</td>
 +
    </tr>|}}
 +
   
 +
    {{#ifeq:{{{wifi}}}|1|
 +
    <tr>
 +
      <td><span style="color:purple">Data filtering</span></td>
 +
      <td>All {{!}} <span style="color:purple">Name</span> {{!}} <span style="color:purple">MAC address</span> {{!}} <span style="color:purple">Signal strength</span>; default: <b>All</b></td>
 +
      <td>If Data type: <span style="color:purple">Wifi scanner</span>. Choose which data this sender will send to server.</td>
 +
    </tr>|}}
 +
   
 +
    {{#ifeq:{{{mobile}}}|1|
 +
    <tr>
 +
      <td><span style="color:blue">Data period</span></td>
 +
      <td><span style="color:blue>Day</span> {{!}} <span style="color:blue>Week</span> {{!}} <span style="color:blue>Month</span>; default: <b>Day</b></td>
 +
      <td>If Data type: <span style="color:blue">Mobile usage</span>. Choose for which time period to send info from.</td>
 +
    </tr>|}}
 +
   
 +
    <tr>
 +
      <td><span style="color:brown">Data filtering</span></td>
 +
      <td>All | <span style="color:brown"> Address</span> | <span style="color:brown">IP</span>; default: <b>All</b></td>
 +
        <td>If Data type: <span style="color:brown">DNP3</span>. Choose which data this sender will send to server.</td>  
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:darkred">By slave ID:</span> Slave ID</td>
+
       <td><span style="color:brown">Database</span></td>
−
      <td>integer [1..255]; default: <b>none</b></td>
+
      <td>RAM | Flash; default: <b>RAM</b></td>
−
      <td>ID of the Modbus slave whose collected data will be sent to server.</td>
+
        <td>Database location</td>
 +
    </tr> 
 +
   
 +
   
 +
    <tr>
 +
        <td><span style="color:orange">Port</span></td>
 +
        <td>integer [0..65535]; default: <b>1883</b></td>
 +
        <td>Port number for connecting to MQTT.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:orange">Keepalive</span></td>
 +
        <td>integer [1..640]; default: <b>60</b></td>
 +
        <td>MQTT Keepalive period in seconds.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
      <td><span style="color:blue">By slave IP:</span> Slave IP</td>
+
        <td><span style="color:orange">Topic</span></td>
−
      <td>ip; default: <b>none</b></td>
+
        <td>string; 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>MQTT topic to be used for publishing the data.</td>
−
     </tr>{{#ifeq:{{{bluetooth}}}|1|
+
     </tr>
 
     <tr>
 
     <tr>
−
      <td><span style="color:green">Data filtering</span></td>
+
        <td><span style="color:orange">Client ID</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>string; default: <b>none</b></td>
−
      <td>If Data source: <span style="color:green">Bluetooth data</span>. Choose which data this sender will send to server.</td>
+
        <td>Client ID to send with the data. If empty, a random client ID will be generated</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:orange">QoS</span></td>
 +
        <td>integer [0..2]; default: <b>0</b></td>
 +
        <td>MQTT Quality of Service. Allowed values:
 +
* 0 - when we prefer that the message will not arrive at all rather than arrive twice,
 +
* 1 - when we want the message to arrive at least once but don't care if it arrives twice (or more),
 +
* 2 - when we want the message to arrive exactly once. A higher QoS value means a slower transfer.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Enable secure connection</td>
 +
      <td>off | <span style="color:red">on</span>; default: '''off'''</td>
 +
      <td>Enables the use of TLS certificates.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:red">On:</span> TLS type</td>
 +
      <td>Certificate based {{!}} Pre-shared key based; default: '''Certificate based'''</td>
 +
      <td>Select type of TLS.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span>Certificate based:</span> CA File</td>
 +
      <td>.ca file; default: <b>none</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>
 +
    </tr>
 +
    <tr>
 +
    <td><span>Certificate based:</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:darkred">By MAC address:</span> MAC address</td>
+
    <td><span>Certificate based:</span> Private Key</td>
−
      <td>mac; default: <b>none</b></td>
+
        <td>.key file; default: <b>none</b></td>
−
      <td>MAC address of bluetooth device whose collected data will be sent to server.</td>
+
        <td>File containing private key for this client. This file needs to be not encrypted.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:blue">By device name:</span> Device name</td>
+
       <td><span>Pre-shared key based:</span> Pre-Shared-Key</td>
 
       <td>string; default: <b>none</b></td>
 
       <td>string; default: <b>none</b></td>
−
       <td>Device name of bluetooth device whose collected data will be sent to server.</td>
+
       <td>The pre-shared-key in hex format with no leading "0x".</td>
−
     </tr>|}}
+
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:magenta">Data filtering</span></td>
+
       <td><span>Pre-shared key based:</span> Identity</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>string; default: <b>none</b></td>
−
       <td>If Data source: <span style="color:magenta">DNP3</span>. Choose which data this sender will send to server.</td>
+
       <td>The identity of this client. May be used as the username depending on the server settings.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:darkred">DNP3 Address:</span> DNP3 Address</td>
+
       <td>Require password</td>
−
      <td>integer [0..65519]; default: <b>none</b></td>
+
      <td>off | <span style="color:darkgreen">on</span>; default: '''off'''</td>
−
       <td>DNP3 address of device whose collected data will be sent to server.</td>
+
       <td>Enables use of username and password for authentication.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:blue">DNP3 IP:</span> DNP3 IP</td>
+
       <td><span style="color:darkgreen">On:</span> Username</td>
−
       <td>ip | domain; default: <b>none</b></td>
+
       <td>string; default: <b>none</b></td>
−
       <td>IP address of DNP3 device whose collected data will be sent to server.</td>
+
       <td>Username used in authentication.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Retry on fail</td>
+
       <td><span style="color:darkgreen">On:</span> Password</td>
−
       <td>off | on; default: <b>off</b></td>
+
       <td>string; default: <b>none</b></td>
−
       <td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
+
       <td>Password used in authentication.</td>
 
     </tr>
 
     </tr>
 +
   
 
</table>
 
</table>
 
<br>
 
<br>
 +
<span class="asterisk">*</span> This is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
  
 
====Collection general settings====
 
====Collection general settings====

Revision as of 15:58, 9 April 2024

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

General

Field Value Description
Name string; default: none Name of the data sender. Used for easier data senders management purposes only (optional).
Type Base | MNF info | Modbus* | Modbus Alarms | DNP3* | MQTT; default: Base Source of the data to be sent to server.
JSON format Json | Custom; default: Json 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 | Server ID | Alarm ID | Register number; default: All If Data type: Modbus alarms data. Choose which data this sender will send to server.
Data filtering All | Server IP address | Server ID | Request name ; default: All If Data type: Modbus data. Choose which data this sender will send to server.
Data filtering All | Address | IP; default: All If Data type: DNP3. Choose which data this sender will send to server.
Database RAM | Flash; default: RAM Database location
Port integer [0..65535]; default: 1883 Port number for connecting to MQTT.
Keepalive integer [1..640]; default: 60 MQTT Keepalive period in seconds.
Topic string; default: none MQTT topic to be used for publishing the data.
Client ID string; default: none Client ID to send with the data. If empty, a random client ID will be generated
QoS integer [0..2]; default: 0 MQTT Quality of Service. Allowed values:
  • 0 - when we prefer that the message will not arrive at all rather than arrive twice,
  • 1 - when we want the message to arrive at least once but don't care if it arrives twice (or more),
  • 2 - when we want the message to arrive exactly once. A higher QoS value means a slower transfer.
Enable secure connection off | on; default: off Enables the use of TLS certificates.
On: TLS type Certificate based | Pre-shared key based; default: Certificate based Select type of TLS.
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.
Pre-shared key based: Pre-Shared-Key string; default: none The pre-shared-key in hex format with no leading "0x".
Pre-shared key based: Identity string; default: none The identity of this client. May be used as the username depending on the server settings.
Require password off | on; default: off Enables use of username and password for authentication.
On: Username string; default: none Username used in authentication.
On: Password string; default: none Password used in authentication.


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

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]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_data_to_server&oldid=123352"