Changes

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

Revision as of 12:41, 18 December 2023

4,074 bytes removed ,  12:41, 18 December 2023
no edit summary
Line 38: Line 38:  
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 44: 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_v2.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 53: 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 65: Line 60:  
     </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:{{{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 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{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | 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 88: Line 83:  
       <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>URL/Host/Connection string</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>
 
     <tr>
 
     <tr>
Line 152: Line 137:  
<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====
−
====Protocol HTTP(S)====
+
----
 +
 
 +
[[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 162: 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 TLS 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> CA 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>
 
     <tr>
 
     <tr>
−
    <td><span style="color:red">On:</span> Client Certificate</td>
+
      <td><span style="color:blue">custom</span></td>
−
        <td>.crt file; default: <b>none</b></td>
+
      <td>string; default: <b>empty</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>Type of data formatting.</td>  
−
     </tr>
+
     </tr>   <tr>
−
    <tr>
+
      <td><span style="color:blue">Empty value</span></td>
−
    <td><span style="color:red">On:</span> Private Key</td>
+
      <td>string; default: <b>N/A</b></td>
−
        <td>.key file; default: <b>none</b></td>
+
         <td>A string which will be placed if any value cannot be received.</td>  
−
         <td>File containing private key for this client. This file needs to be not encrypted.</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 202: 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>
  −
        <td>Topic</td>
  −
        <td>string; default: <b>none</b></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>
  −
        <td>QoS</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>
 
     <tr>
 
     <tr>
−
       <td>Use TLS</td>
+
       <td><span style="color:darkgreen">Retry count</span></td>
−
      <td>off | <span style="color:red">on</span>; default: '''off'''</td>
+
      <td>integer [1..10]; default: <b>10</b></td>
−
       <td>Enables the use of TLS certificates.</td>
+
       <td>Retry to send the same data N times.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td><span style="color:red">On:</span> TLS type</td>
+
       <td><span style="color:darkgreen">Timeout</span></td>
−
      <td><span style="color:chocolate">Certificate based</span> {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
+
       <td>integer [1..60]; default: <b>1</b></td>
−
      <td>Select type of TLS.</td>
+
       <td>Timeout in second between retry attempts.</td>
−
    </tr>
  −
    <tr>
  −
      <td><span style="color:chocolate">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 style="color:chocolate">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>
  −
    <td><span style="color:chocolate">Certificate based:</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>
  −
      <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>
−
</br>
+
 
−
====Protocol Kinesis====
+
====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 289: Line 218:  
       <th>Description</th>
 
       <th>Description</th>
 
     </tr>
 
     </tr>
−
    <tr>
+
        <tr>
−
       <td>Stream name</td>
+
       <td>Protocol</td>
−
       <td>string; default: <b>none</b></td>
+
       <td>HTTP(S) | MQTT{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | Kinesis; default: <b>HTTP(S)</b></td>
−
       <td>The name of the stream for which to start encrypting records.</td>
+
       <td>Protocol used for sending the data to server.</td>
 
     </tr>
 
     </tr>
−
    <tr>
+
        <tr>
−
       <td>Partition key</td>
+
       <td>Server address</td>
 
       <td>string; default: <b>none</b></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>
+
       <td>URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.</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>
 
     <tr>
 
     <tr>
−
       <td>Region</td>
+
       <td>HTTP Header</td>
 
       <td>string; default: <b>none</b></td>
 
       <td>string; default: <b>none</b></td>
−
       <td>Region code of the Kinesis server.</td>
+
       <td>Allows to add custom headers to the HTTP requests.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
    <td>Domain</td>
+
      <td>Enable secure connection</td>
−
        <td>domain; default: <b>none</b></td>
+
      <td><span style="color:chocolate">on</span>, off; default: <b>off</b></td>
−
        <td>Domain of the Kinesis server. E.g. 'amazonaws.com'</td>
+
      <td>Enables use of TLS certificates</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
    <td>Access key</td>
+
      <td>Certificate files from device</td>
−
        <td>string; default: <b>none</b></td>
+
      <td>on, off; default: <b>off</b></td>
−
        <td>Access key ID is a part of Access keys used for authentication.</td>
+
      <td>Choose this option if you want to select certificate files from device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
    <td>Secret key</td>
+
       <td><span style="color:chocolate">Certificate based:</span> CA File</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>.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:red">On:</span> Client Certificate</td>
+
     <td><span style="color:chocolate">Certificate based:</span> 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:red">On:</span> Private Key</td>
+
     <td><span style="color:chocolate">Certificate based:</span> 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>
 
</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]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/117137"

Navigation menu