Changes

Template:Networking rutos manual data to server (view source)

Revision as of 10:18, 24 May 2022

6,152 bytes added ,  10:18, 24 May 2022
no edit summary
Line 1: Line 1:  
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}-->
 
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}-->
−
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
−
| fw_version = {{{series}}}_R_00.02.06
+
| fw_version ={{Template: Networking_rutos_manual_latest_fw
−
| series    = {{{series}}}
+
| 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_rutos_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_rutos_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 =
 +
| TRB1 =
 +
| TRB2 =
 +
| RUT9|RUT9M =
 +
| #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>}}
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
| series = {{{series}}}
 
| series = {{{series}}}
Line 27: Line 41:  
<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_advanced_sender_settings_v2.png|border|class=tlt-border]]
    
====General====
 
====General====
Line 46: Line 60:  
       <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>Data source</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 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:{{{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>Protocol</td>
−
       <td>HTTP(S) | MQTT | Kinesis; default: <b>HTTP(S)</b></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>
 
       <td>Protocol used for sending the data to server.</td>
 
     </tr>
 
     </tr>
Line 83: Line 97:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Data filtering</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 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 108:  
     <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 148:  
</table>
 
</table>
 
<br>
 
<br>
 +
 +
<span class="asterisk">*</span> This is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.
 
====Protocol HTTP(S)====
 
====Protocol HTTP(S)====
   Line 120: Line 166:  
       <td>Use TLS</td>
 
       <td>Use TLS</td>
 
       <td>off | <span style="color:red">on</span>; default: '''off'''</td>
 
       <td>off | <span style="color:red">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>
Line 128: Line 174:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:red">On:</span> A File</td>
+
       <td><span style="color:red">On:</span> 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>
Line 166: Line 212:  
         <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>
 +
        <td>Client ID</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>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 178: Line 229:  
       <td>Use TLS</td>
 
       <td>Use TLS</td>
 
       <td>off | <span style="color:red">on</span>; default: '''off'''</td>
 
       <td>off | <span style="color:red">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>
Line 224: Line 275:  
       <td>string; default: <b>none</b></td>
 
       <td>string; default: <b>none</b></td>
 
       <td>Password used in authentication.</td>
 
       <td>Password used in authentication.</td>
 +
    </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>
 +
    <tr>
 +
      <td>Use TLS</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; default: '''Certificate based'''</td>
 +
      <td>Select type of TLS.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:red">On:</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 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>
 +
    <td><span style="color:red">On:</span> Private Key</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>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
    
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/76029...91834"

Navigation menu