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

From Teltonika Networks Wiki
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}-->
+
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}-->
−
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
−
| fw_version = {{{series}}}_R_00.02.03.1
+
| fw_version = {{{series}}}_R_00.02.06.1
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 7: Line 7:
 
==Summary==
 
==Summary==
  
−
Data to Server function provides you with the possibility to set up senders that transfer data collected from Modbus slaves {{#ifeq:{{{bluetooth}}}|1|or Bluetooth devices|}} 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.
  
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
Line 13: Line 13:
 
}}
 
}}
  
−
==Data senders==
+
==Data Senders==
  
−
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_rutx_manual_data_to_server_data_senders_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button.png|border|class=tlt-border]]
  
−
===Configure data sender===
+
After this you should be redirected to the newly added data sender's configuration page.
 +
 
 +
===Advanced Sender Settings===
 
----
 
----
 +
Refer to the table below for descriptions on data sender configuration fields.
  
−
When you add a new data sender, you will be redirected to its configuration window. The figure below is an example of that window and the table below provides information on the fields that it contains:
+
<b>Note</b>: these tables have coloring schemes to indicate which fields can be seen with different configuration.
  
−
[[File:Networking_rutx_manual_data_to_server_advanced_sender_settings_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_data_to_server_advanced_sender_settings.png|border|class=tlt-border]]
  
 
====General====
 
====General====
 +
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 35: Line 39:
 
     <tr>
 
     <tr>
 
       <td>Enabled</td>
 
       <td>Enabled</td>
−
       <td>off {{!}} on; default: '''off'''</td>
+
       <td>off | on; default: <b>off</b></td>
−
       <td>Enables or disables data sender.</td>
+
       <td>Turns the data sender on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 42: Line 46:
 
       <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>
+
     </tr>{{#ifeq: {{{wifi}}} | 1 |  
−
    {{#ifeq:{{{bluetooth}}}|1|
 
 
     <tr>
 
     <tr>
 
       <td>Data source</td>
 
       <td>Data source</td>
−
       <td>Modbus data {{!}} Bluetooth data; default: '''Bluetooth data'''</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>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>Protocol</td>
−
       <td>HTTP(S) {{!}} MQTT; default: '''HTTP(S)'''</td>
+
       <td>HTTP(S) | MQTT | Kinesis; default: <b>HTTP(S)</b></td>
 
       <td>Protocol used for sending the data to server.</td>
 
       <td>Protocol used for sending the data to server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>JSON format</td>
 
       <td>JSON format</td>
−
       <td>string; default: '''{"TS": "%t", "D": "%d", "data": %a}'''</td>
+
       <td>string; default: </b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
−
{{#ifeq:{{{bluetooth}}}|1|
+
         <td>Arranges the format of the sent JSON segment.</td>  
−
        <td>You can fully customize JSON segment.<br>Possible Modbus values:
 
−
* Date (Linux timestamp) - %t
 
−
* Date (Day/Month/Year Hour:Minute:Second) - %d
 
−
* Modbus slave ID - %i
 
−
* Modbus slave IP - %p
 
−
* Start register - %s
 
−
* Register data (JSON object) - %a
 
−
Possible Bluetooth values:
 
−
* Date (Linux timestamp) - %t
 
−
* Date (Day/Month/Year Hour:Minute:Second) - %d
 
−
* MAC address - %m
 
−
* Device name - %n
 
−
* RSSI - %r
 
−
* Device data (JSON object) - %b
 
−
        </td>
 
−
| <!-- not bluetooth -->
 
−
         <td>You can fully customize JSON segment, possible values:
 
−
* Date (Linux timestamp) - %t
 
−
* Date (Day/Month/Year Hour:Minute:Second) - %d
 
−
* Modbus slave ID - %i
 
−
* Modbus slave IP - %p
 
−
* Start register - %s
 
−
* Register data (JSON object) - %a
 
−
        </td>  
 
−
}}
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Segment count</td>
 
       <td>Segment count</td>
−
       <td>integer [1..10]; default: '''1'''</td>
+
       <td>integer [1..10]; default: <b>1</b></td>
 
       <td>Max segment count in one JSON string sent to server.</td>
 
       <td>Max segment count in one JSON string sent to server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Send as object</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>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 97: Line 79:
 
     <tr>
 
     <tr>
 
       <td>Period</td>
 
       <td>Period</td>
−
       <td>integer [1..86400]; default: '''60'''</td>
+
       <td>integer [1..86400]; default: <b>60</b></td>
−
       <td>Interval for sending the collected data to server (in seconds, 1-86400)</td>
+
       <td>Data sending frequency (in seconds).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Data filtering</td>
 
       <td>Data filtering</td>
−
       <td>All data {{!}} <span style="color:darkred">By slave ID</span> {{!}} <span style="color:blue">By slave IP</span>; default: '''All data'''</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>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:darkred">By slave ID:</span> Slave ID</td>
−
       <td>integer [1..255]; default: '''none'''</td>
+
       <td>integer [1..255]; default: <b>none</b></td>
−
       <td>Data will be sent to server only from slave device with this modbus ID (1-255).</td>
+
       <td>ID of the Modbus slave whose collected data will be sent to server.</td>
 
     </tr>
 
     </tr>
 
     <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: '''none'''</td>
+
       <td>ip; default: </b>none</b></td>
−
       <td>Data will be sent to server from slave device with this IP address only (Modbus TCP slaves only).</td>
+
       <td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Retry on fail</td>
 
       <td>Retry on fail</td>
−
       <td>off {{!}} on; default: '''off'''</td>
+
       <td>off | on; default: <b>off</b></td>
−
       <td>In case of a failed attempt, retry to send the same data to server later (Retry until successful).</td>
+
       <td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
<br>
 +
====Protocol HTTP(S)====
  
−
 
−
====Protocol HTTP(S)====
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 161: Line 143:
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
<br>
 +
====Protocol MQTT====
  
−
 
−
====Protocol MQTT====
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 244: Line 226:
 
     </tr>
 
     </tr>
 
</table>
 
</table>
−
 
−
<b>Note</b>: these tables have coloring schemes to indicate which fields can be seen with different configuration.
 
  
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Revision as of 14:22, 15 February 2021

Template:Networking rutos manual fw disclosure

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.

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

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

Advanced 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 advanced sender settings.png

General

Field Value Description
Enabled off | on; default: off Turns the data sender on or off.
Name string; default: none Name of the data sender. Used for easier data senders management purposes only (optional).
Protocol HTTP(S) | MQTT | Kinesis; default: HTTP(S) Protocol used for sending the data to server.
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.
URL/Host/Connection string string; default: none URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.
Period integer [1..86400]; default: 60 Data sending frequency (in seconds).
Data filtering All data | By slave ID | By slave IP; default: All 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).
Retry on fail off | on; default: off When turned on, the data sender retries failed sending attempts until the are successfully delivered.


Protocol HTTP(S)

Field Value Description
Custom Header string; default: none Allows to add custom headers to the HTTP requests.
Use TLS off | on; default: off Enables the use of TSL certificates.
On: TLS type Certificate based; default: Certificate based Select type of TLS.
On: A 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.
On: 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.
On: Private Key .key file; default: none File containing private key for this client. This file needs to be not encrypted.


Protocol MQTT

Field Value Description
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.
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.
Use TLS off | on; default: off Enables the use of TSL 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.
Use Credentials 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.

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

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