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

From Teltonika Networks Wiki
 
(35 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.
−
{{#ifeq: {{{series}}} | RUT36X |<u><b>
+
{{#switch: {{{series}}}
−
 
+
| RUTX =
−
Note:</b>On {{{name}}}, Data to Server is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>|}}
+
| RUTM =
−
{{#ifeq: {{{series}}} | RUT30X |<u><b>
+
| TCR1 =
 +
| TRB1 =
 +
| TRB2 =
 +
| TRB2M =
 +
| TRB5 =
 +
| RUT2M =
 +
| RUT2 =
 +
| RUT30X =
 +
| RUT36X =
 +
| RUT9|RUT9M =
 +
| RUT14X =
 +
| #default =
 +
<u><b>
  
−
Note:</b> On {{{name}}}, Data to Server is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>|}}
+
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 23: Line 42:
 
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 33: Line 52:
 
<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====
 
====General====
−
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 42: Line 60:
 
       <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 54: Line 67:
 
     </tr>  
 
     </tr>  
 
     <tr>
 
     <tr>
−
       <td>Data source</td>
+
       <td>Type</td>
−
       <td><span style="color:red">Modbus data</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:{{{wiki}}}|1|<nowiki>|</nowiki> WiFi scanner data{{#ifeq: {{{series}}} | RUTX | | <span class="asterisk">*</span>}}|}} | <span style="color:magenta">DNP3</span><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> {{!}} <span style="color:hotpink">DLMS</span><span class="asterisk">*</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>
 
     <tr>
 
     <tr>
−
       <td>Protocol</td>
+
       <td>Format type</td>
−
       <td>HTTP(S) | MQTT{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | Kinesis; default: <b>HTTP(S)</b></td>
+
       <td>Json {{!}} <span style="color:limegreen">Custom</span>; default: <b>Json</b></td>
−
       <td>Protocol used for sending the data to server.</td>
+
        <td>Arranges the format of the sent JSON segment.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:limegreen">Format string</span></td>
 +
      <td>string; default: <b>none</b></td>
 +
        <td>Specifies custom format string.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:limegreen">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>
 
     <tr>
 
     <tr>
−
       <td>JSON format</td>
+
       <td><span style="color:limegreen">Delimeter</span></td>
−
       <td>string; default: </b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
+
       <td>string (Maximum length of value is 1 bytes); default: <b>N/A</b></td>
−
         <td>Arranges the format of the sent JSON segment.</td>  
+
         <td>Specifies delimiters for multiple data segments.</td>  
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Segment count</td>
 
       <td>Segment count</td>
−
       <td>integer [1..10]; default: <b>1</b></td>
+
       <td>integer [1..64]; 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>
 
     <tr>
 
     <tr>
 
       <td>Send as object</td>
 
       <td>Send as object</td>
−
       <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>
 
     <tr>
 
     <tr>
−
       <td>URL/Host/Connection string</td>
+
       <td><span style="color:grey">Data filtering</span></td>
−
       <td>string; default: <b>none</b></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>URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.</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>Period</td>
+
       <td><span style="color:red">Data filtering</span></td>
−
       <td>integer [1..86400]; default: <b>60</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>Data sending frequency (in seconds).</td>
+
       <td>If Data type: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
 
     </tr>
 
     </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>
 
     <tr>
−
       <td><span style="color:red">Data filtering</span></td>
+
       <td><span style="color:purple">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: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 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:purple">Wifi scanner</span>. Choose which data this sender will send to server.</td>
−
     </tr>
+
     </tr>|}}
 +
   
 +
    {{#ifeq:{{{mobile}}}|1|
 
     <tr>
 
     <tr>
−
       <td><span style="color:darkred">By slave ID:</span> Slave ID</td>
+
       <td><span style="color:blue">Data period</span></td>
−
       <td>integer [1..255]; default: <b>none</b></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>ID of the Modbus slave whose collected data will be sent to server.</td>
+
       <td>If Data type: <span style="color:blue">Mobile usage</span>. Choose for which time period to send info from.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:blue">By slave IP:</span> Slave IP</td>
+
       <td><span style="color:blue">Current</span></td>
−
       <td>ip; default: <b>none</b></td>
+
       <td><span style="color:blue>off</span> {{!}} <span style="color:blue>on</span>; default: <b>off</b></td>
−
       <td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
+
       <td>If Data type: <span style="color:blue">Mobile usage</span>.</td>
−
     </tr>{{#ifeq:{{{bluetooth}}}|1|
+
     </tr>|}}
 
     <tr>
 
     <tr>
−
       <td><span style="color:green">Data filtering</span></td>
+
       <td><span style="color:hotpink">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>All {{!}} <span style="color:hotpink">Name</span>; default: <b>All</b></td>
−
       <td>If Data source: <span style="color:red">Bluetooth data</span>. Choose which data this sender will send to server.</td>
+
       <td>If Data type: <span style="color:hotpink">DLMS</span>. Choose which data this sender will send to server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:darkred">By MAC address:</span> MAC address</td>
+
       <td><span style="color:hotpink">Invert file</span></td>
−
       <td>mac; default: <b>none</b></td>
+
      <td><span style="color:hotpink">off</span> {{!}} <span style="color:hotpink">on</span>; default: <b>off</b></td>
−
      <td>MAC address of bluetooth device whose collected data will be sent to server.</td>
+
       <td>If Data type: <span style="color:hotpink">DLMS</span>. Inverts filter condition.</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:blue">By device name:</span> Device name</td>
+
       <td><span style="color:brown">Database</span></td>
−
       <td>string; default: <b>none</b></td>
+
       <td>RAM {{!}} Flash; default: <b>RAM</b></td>
−
      <td>Device name of bluetooth device whose collected data will be sent to server.</td>
+
        <td>Database location</td>  
−
     </tr>|}}
+
     </tr>  
 
     <tr>
 
     <tr>
−
      <td><span style="color:magenta">Data filtering</span></td>
+
        <td><span style="color:orange">Server address</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>Default: <b>empty</b></td>
−
      <td>If Data source: <span style="color:magenta">DNP3</span>. Choose which data this sender will send to server.</td>
+
        <td>Hostname or ip address of the broker to connect to.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
      <td><span style="color:darkred">DNP3 Address:</span> DNP3 Address</td>
+
        <td><span style="color:orange">Port</span></td>
−
      <td>integer [0..65519]; default: <b>none</b></td>
+
        <td>integer [0..65535]; default: <b>1883</b></td>
−
      <td>DNP3 address of device whose collected data will be sent to server.</td>
+
        <td>Port number for connecting to MQTT.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
      <td><span style="color:blue">DNP3 IP:</span> DNP3 IP</td>
+
        <td><span style="color:orange">Keepalive</span></td>
−
      <td>ip | domain; default: <b>none</b></td>
+
        <td>integer [1..640]; default: <b>60</b></td>
−
      <td>IP address of DNP3 device whose collected data will be sent to server.</td>
+
        <td>MQTT Keepalive period in seconds.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
      <td>Retry on fail</td>
+
        <td><span style="color:orange">Topic</span></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>MQTT topic to be used for publishing the data.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
      <td>Custom Header</td>
+
        <td><span style="color:orange">Client ID</span></td>
−
      <td>string; default: <b>none</b></td>
+
        <td>string; default: <b>none</b></td>
−
      <td>Allows to add custom headers to the HTTP requests.</td>
+
        <td>Client ID to send with the data. If empty, a random client ID will be generated</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
    <td>Use TLS</td>
+
        <td><span style="color:orange">QoS</span></td>
−
      <td>off | <span style="color:blue"><b>on</b></span>; default: <b>off</b></td>
+
        <td>integer [0..2]; default: <b>0</b></td>
−
       <td>Use TLS to encrypt the data sent.</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><span style="color:orange">Enable secure connection</span></td>
 +
      <td>off {{!}} <span style="color:blue">on</span>; default: '''off'''</td>
 +
       <td>Enables the use of TLS certificates.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>TLS type</td>
+
      <td><span style="color:blue">On:</span> <span style="color:orange">TLS type</span></td>
−
       <td>Certificate based; default: '''Certificate based'''</td>
+
       <td>Certificate based {{!}} Pre-shared key based; default: '''Certificate based'''</td>
 
       <td>Select type of TLS.</td>
 
       <td>Select type of TLS.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:blue">On:</span> Certificate files from device</td>
+
       <td><span style="color:orange">Certificate based: Allow insecure connection</span></td>
−
       <td>off | on; default: <b>off</b></td>
+
       <td>off {{!}} on; default: '''off'''</td>
−
       <td>When turned on, provides the possibility to use certificate files generated on this device instead of uploading certificate files. You can generate TLS certificates on your device in the System → Administration → [[{{{name}}} Administration#Certificates|Certificates]] page.</td>
+
       <td>Allow not verifying server authentication.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
    <td><span style="color:blue">On:</span> CA file</td>
+
      <td><span style="color:orange">Certificate based: Certificate files from device</span></td>
−
        <td>.ca file; default: <b>none</b></td>
+
      <td>off {{!}} on; default: '''off'''</td>
−
        <td>Certificate authority file used in Transport Layer Security.</td>
+
      <td>Specify where the certificates will be used from.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
    <td><span style="color:blue">On:</span> Client certificate</td>
+
      <td><span style="color:orange">Certificate based: CA File</span></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 style="color:orange">Certificate based: Client certificate</span></td>
 
         <td>.crt file; default: <b>none</b></td>
 
         <td>.crt file; default: <b>none</b></td>
−
         <td>Certificate file used in Transport Layer Security.</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:blue">On:</span> Private key</td>
+
     <td><span style="color:orange">Certificate based: CLient private Key</span></td>
 
         <td>.key file; default: <b>none</b></td>
 
         <td>.key file; default: <b>none</b></td>
−
         <td>Key file used in Transport Layer Security.</td>
+
         <td>File containing private key for this client. This file needs to be not encrypted.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:orange">Pre-shared key based: Pre-Shared-Key</span></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:orange">Pre-shared key based: Identity</span></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><span style="color:orange">Username</span></td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Username used in authentication.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:orange">Require password</span></td>
 +
      <td>on | off; default: <b>off</b></td>
 +
      <td>Enables password for authentication.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:orange">Password</span></td>
 +
      <td>string; default: <b>none</b></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 settings====
 +
----
  
−
<span class="asterisk">*</span> This is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.
+
[[File:Networking rutos manual data to server collection configuration general settings_v1.png|border|class=tlt-border]]
−
====Protocol HTTP(S)====
 
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 186: Line 266:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Custom Header</td>
+
       <td>Enabled</td>
−
       <td>string; default: <b>none</b></td>
+
       <td>off {{!}} on; default: <b>on</b></td>
−
       <td>Allows to add custom headers to the HTTP requests.</td>
+
       <td>Enables data to server collection instance.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Use TLS</td>
+
       <td>Format type</td>
−
       <td>off | <span style="color:red">on</span>; default: '''off'''</td>
+
       <td>Json {{!}} <span style="color:red">custom</span>; default: <b>Json</b></td>
−
       <td>Enables the use of TSL certificates.</td>
+
       <td>Data collection objects formatting.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:red">On:</span> TLS type</td>
+
       <td><span style="color:red">Format string</span></td>
−
       <td>Certificate based; default: '''Certificate based'''</td>
+
       <td>Default: <b>Instance name</b></td>
−
       <td>Select type of TLS.</td>
+
       <td>Specifies custom format string</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:red">On:</span> A File</td>
+
       <td><span style="color:red">Empty value </span></td>
−
       <td>.ca file; default: <b>none</b></td>
+
      <td>Default: <b>N/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>A string which will be placed if any value cannot be received</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Period</td>
 +
       <td>Default: <b>60</b></td>
 +
       <td>Interval in seconds for collecting/sending data to destination.</td>
 
     </tr>
 
     </tr>
−
    <tr>
+
    <tr>
−
    <td><span style="color:red">On:</span> Client Certificate</td>
+
      <td>Retry</td>
−
        <td>.crt file; default: <b>none</b></td>
+
      <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</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>
+
      <td>In case of a failed attempt, retry to send the same data to destination later.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
      <td><span style="color:blue">Retry count</span></td>
 +
      <td>Default: <b>10</b></td>
 +
      <td>Retry to send the same data N times </td>
 +
    </tr>
 
     <tr>
 
     <tr>
−
    <td><span style="color:red">On:</span> Private Key</td>
+
      <td><span style="color:blue">Timeout</span></td>
−
        <td>.key file; default: <b>none</b></td>
+
      <td>Default: <b>1</b></td>
−
        <td>File containing private key for this client. This file needs to be not encrypted.</td>
+
      <td>Timeout in second between retry attempts</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
−
<br>
+
 
−
====Protocol MQTT====
+
====Server configuration====
 +
----
 +
 
 +
[[File:Networking rutos manual data to server server configuration.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 224: Line 317:
 
       <th>Value</th>
 
       <th>Value</th>
 
       <th>Description</th>
 
       <th>Description</th>
 +
    </tr> 
 +
    <tr>
 +
      <td>Type</td>
 +
      <td>HTTP {{!}} <span style="color:red">MQTT</span>; default: <b>HTTP</b></td>
 +
      <td>Interval in seconds for collecting/sending data to destination.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Server address</td>
 +
      <td>Default: <b>empty</b></td>
 +
      <td>Hostname or IP address of the broker to connect to.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
      <td>HTTP headers</td>
 +
      <td>Default: <b>empty</b></td>
 +
      <td>Allows to add custom headers to the HTTP requests.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Enable secure connection</td>
 +
      <td>on {{!}} off; default: <b>off</b></td>
 +
      <td>Enables the use of TLS certificates.</td>
 +
    </tr>
 +
   
 
     <tr>
 
     <tr>
−
         <td>Port</td>
+
         <td><span style="color:red">Port</span></td>
 
         <td>integer [0..65535]; default: <b>1883</b></td>
 
         <td>integer [0..65535]; default: <b>1883</b></td>
 
         <td>Port number for connecting to MQTT.</td>
 
         <td>Port number for connecting to MQTT.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Keepalive</td>
+
         <td><span style="color:red">Keepalive</span></td>
 
         <td>integer [1..640]; default: <b>60</b></td>
 
         <td>integer [1..640]; default: <b>60</b></td>
 
         <td>MQTT Keepalive period in seconds.</td>
 
         <td>MQTT Keepalive period in seconds.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Topic</td>
+
         <td><span style="color:red">Topic</span></td>
 
         <td>string; default: <b>none</b></td>
 
         <td>string; default: <b>none</b></td>
 
         <td>MQTT topic to be used for publishing the data.</td>
 
         <td>MQTT topic to be used for publishing the data.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Client ID</td>
+
         <td><span style="color:red">Client ID</span></td>
 
         <td>string; default: <b>none</b></td>
 
         <td>string; default: <b>none</b></td>
 
         <td>Client ID to send with the data. If empty, a random client ID will be generated</td>
 
         <td>Client ID to send with the data. If empty, a random client ID will be generated</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>QoS</td>
+
         <td><span style="color:red">QoS</span></td>
 
         <td>integer [0..2]; default: <b>0</b></td>
 
         <td>integer [0..2]; default: <b>0</b></td>
 
         <td>MQTT Quality of Service. Allowed values:
 
         <td>MQTT Quality of Service. Allowed values:
Line 254: Line 368:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Use TLS</td>
+
       <td>Enable secure connection</td>
−
       <td>off | <span style="color:red">on</span>; default: '''off'''</td>
+
       <td>off {{!}} <span style="color:blue">on</span>; default: '''off'''</td>
−
       <td>Enables the use of TSL certificates.</td>
+
       <td>Enables the use of TLS certificates.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:red">On:</span> TLS type</td>
+
       <td><span style="color:blue">On:</span> TLS type</td>
−
       <td><span style="color:chocolate">Certificate based</span> {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
+
       <td>Certificate based {{!}} Pre-shared key based; default: '''Certificate based'''</td>
 
       <td>Select type of TLS.</td>
 
       <td>Select type of TLS.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:chocolate">Certificate based:</span> CA File</td>
+
       <td>Certificate based: Allow insecure connection</td>
 +
      <td>off {{!}} on; default: '''off'''</td>
 +
      <td>Allow not verifying server authentication.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Certificate based: Certificate files from device</td>
 +
      <td>off {{!}} on; default: '''off'''</td>
 +
      <td>Specify where the certificates will be used from.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Certificate based: CA File</td>
 
       <td>.ca file; default: <b>none</b></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>
 
       <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>
 
     <tr>
 
     <tr>
−
     <td><span style="color:chocolate">Certificate based:</span> Client Certificate</td>
+
     <td>Certificate based: Client Certificate</td>
 
         <td>.crt file; default: <b>none</b></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>
 
         <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:chocolate">Certificate based:</span> Private Key</td>
+
     <td>Certificate based: Client Private Key</td>
 
         <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>
 
     <tr>
 
     <tr>
−
       <td><span style="color:darkred">Pre-shared key based:</span> Pre-Shared-Key</td>
+
       <td>Pre-shared key based: Pre-Shared-Key</td>
 
       <td>string; default: <b>none</b></td>
 
       <td>string; default: <b>none</b></td>
 
       <td>The pre-shared-key in hex format with no leading "0x".</td>
 
       <td>The pre-shared-key in hex format with no leading "0x".</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:darkred">Pre-shared key based:</span> Identity</td>
+
       <td>Pre-shared key based: Identity</td>
 
       <td>string; default: <b>none</b></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>
 
       <td>The identity of this client. May be used as the username depending on the server settings.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Use Credentials</td>
+
       <td>Use credentials</td>
−
       <td>off | <span style="color:darkgreen">on</span>; default: '''off'''</td>
+
       <td>off {{!}} <span style="color:darkgreen">on</span>; default: '''off'''</td>
 
       <td>Enables use of username and password for authentication.</td>
 
       <td>Enables use of username and password for authentication.</td>
 
     </tr>
 
     </tr>
Line 303: Line 427:
 
       <td>Password used in authentication.</td>
 
       <td>Password used in authentication.</td>
 
     </tr>
 
     </tr>
−
</table>
+
      
−
</br>
 
−
====Protocol Kinesis====
 
−
 
 
−
<table class="nd-mantable">
 
−
     <tr>
 
−
        <th>Field</th>
 
−
      <th>Value</th>
 
−
      <th>Description</th>
 
−
    </tr>
 
−
    <tr>
 
−
      <td>Stream name</td>
 
−
      <td>string; default: <b>none</b></td>
 
−
      <td>The name of the stream for which to start encrypting records.</td>
 
−
    </tr>
 
−
    <tr>
 
−
      <td>Partition key</td>
 
−
      <td>string; default: <b>none</b></td>
 
−
      <td>The partition key is used by Kinesis Data Streams as input to a hash function that maps the partitionkey and associated data to a specific shard.</td>
 
−
    </tr>
 
−
    <tr>
 
−
      <td>API version</td>
 
−
      <td>positive integer; default: <b>none</b></td>
 
−
      <td>Optional. Used version of the Kinesis API.</td>
 
−
    </tr>
 
−
    <tr>
 
−
      <td>Region</td>
 
−
      <td>string; default: <b>none</b></td>
 
−
      <td>Region code of the Kinesis server.</td>
 
−
    </tr>
 
−
    <tr>
 
−
    <td>Domain</td>
 
−
        <td>domain; default: <b>none</b></td>
 
−
        <td>Domain of the Kinesis server. E.g. 'amazonaws.com'</td>
 
−
    </tr>
 
−
    <tr>
 
−
    <td>Access key</td>
 
−
        <td>string; default: <b>none</b></td>
 
−
        <td>Access key ID is a part of Access keys used for authentication.</td>
 
−
    </tr>
 
−
    <tr>
 
−
    <td>Secret key</td>
 
−
        <td>string; default: <b>none</b></td>
 
−
        <td>Secret access key is a part of Access keys used for authentication.</td>
 
−
    </tr>
 
 
</table>
 
</table>
  
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Latest revision as of 15:13, 12 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 | DLMS*; default: Base Source of the data to be sent to server.
Format type Json | Custom; default: Json Arranges the format of the sent JSON segment.
Format string string; default: none Specifies custom format string.
Empty value string; default: N/A A string which will be placed if any value cannot be received.
Delimeter string (Maximum length of value is 1 bytes); default: N/A Specifies delimiters for multiple data segments.
Segment count integer [1..64]; 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 | Name; default: All If Data type: DLMS. Choose which data this sender will send to server.
Invert file off | on; default: off If Data type: DLMS. Inverts filter condition.
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
Server address Default: empty Hostname or ip address of the broker to connect to.
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: Allow insecure connection off | on; default: off Allow not verifying server authentication.
Certificate based: Certificate files from device off | on; default: off Specify where the certificates will be used from.
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: CLient 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.
Username string; default: none Username used in authentication.
Require password on | off; default: off Enables password for authentication.
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 settings

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

Field Value Description
Enabled off | on; default: on Enables data to server collection instance.
Format type Json | custom; default: Json Data collection objects formatting.
Format string Default: Instance name Specifies custom format string
Empty value Default: N/A A string which will be placed if any value cannot be received
Period Default: 60 Interval in seconds for collecting/sending data to destination.
Retry off | on; default: off In case of a failed attempt, retry to send the same data to destination later.
Retry count Default: 10 Retry to send the same data N times
Timeout Default: 1 Timeout in second between retry attempts

Server configuration

Networking rutos manual data to server server configuration.png

Field Value Description
Type HTTP | MQTT; default: HTTP Interval in seconds for collecting/sending data to destination.
Server address Default: empty Hostname or IP address of the broker to connect to.
HTTP headers Default: empty Allows to add custom headers to the HTTP requests.
Enable secure connection on | off; default: off Enables the use of TLS certificates.
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: Allow insecure connection off | on; default: off Allow not verifying server authentication.
Certificate based: Certificate files from device off | on; default: off Specify where the certificates will be used from.
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: Client 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=123580"