Jump to content

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

no edit summary
No edit summary
No edit summary
 
(20 intermediate revisions by 4 users not shown)
Line 17: Line 17:
| RUTX =
| RUTX =
| RUTM =
| RUTM =
| RUTC =
| TCR1 =
| TCR1 =
| TRB1 =
| TRB1 =
Line 28: Line 29:
| RUT9|RUT9M =
| RUT9|RUT9M =
| RUT14X =
| RUT14X =
| TAP100 | TAP200 =
| #default =  
| #default =  
<u><b>
<u><b>
Line 52: Line 54:
<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 data configuration.png|border|class=tlt-border]]
{{#switch: {{{series}}}
| TAP100 | TAP200 =  [[File:Networking rutos manual data to server data configuration_tap.png|border|class=tlt-border]]
| #default = [[File:Networking rutos manual data to server data configuration.png|border|class=tlt-border]]
}}


====General====
====General====
Line 68: Line 73:
     <tr>
     <tr>
       <td>Type</td>
       <td>Type</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> {{#ifeq:{{{dlms}}}|1|{{!}} <span style="color:hotpink">DLMS</span>|}}; default: <b>Base</b></span>     
       <td><span>Base {{!}} {{#ifeq:{{{bluetooth}}}|1|<span style="color:green">Bluetooth</span> {{!}} |}}{{#ifeq:{{{mobile}}}|1| GSM {{!}} |}} Lua script {{!}} {{#ifeq:{{{mobile_usage}}}|1|<span style="color:blue">Mobile usage</span>{{!}} |}}{{#ifeq:{{{MNF}}}|1|MNF info{{!}} |}}{{#ifeq:{{{Modbus}}}|1| <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> {{!}} |}}{{#ifeq:{{{DNP3}}}|1|<span style="color:brown">DNP3</span><span class="asterisk">*</span> {{!}} |}}{{#ifeq:{{{MQTT}}}|1|<span style="color:orange">MQTT</span> {{!}} |}}  {{#ifeq:{{{OPC}}}|1|<span style="color:lightblue">OPC UA</span> {{!}} |}}{{#ifeq:{{{DLMS}}}|1|<span style="color:hotpink">DLMS</span><span class="asterisk">*</span>|}}; default: <b>Base</b></span>     
         </td>
         </td>
       <td>Source of the data to be sent to server.</td>
       <td>Source of the data to be sent to server.</td>
Line 102: Line 107:
       <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>
    {{#ifeq:{{{Modbus}}}|1|
     <tr>
     <tr>
       <td><span style="color:grey">Data filtering</span></td>
       <td><span style="color:grey">Data filtering</span></td>
Line 112: Line 118:
       <td>If Data type: <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>
     </tr>
    |}}
     {{#ifeq:{{{bluetooth}}}|1|
     {{#ifeq:{{{bluetooth}}}|1|
     <tr>
     <tr>
Line 137: Line 144:
       <td>If Data type: <span style="color:blue">Mobile usage</span>.</td>
       <td>If Data type: <span style="color:blue">Mobile usage</span>.</td>
     </tr>|}}
     </tr>|}}
   
     {{#ifeq: {{{DLMS}}}|1|
     {{#ifeq:{{{dlms}}}|1|
     <tr>
     <tr>
       <td><span style="color:hotpink">Data filtering</span></td>
       <td><span style="color:hotpink">Data filtering</span></td>
Line 146: Line 152:
     <tr>
     <tr>
       <td><span style="color:hotpink">Invert file</span></td>
       <td><span style="color:hotpink">Invert file</span></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td><span style="color:hotpink">off</span> {{!}} <span style="color:hotpink">on</span>; default: <b>off</b></td>
       <td>If Data type: <span style="color:hotpink">DLMS</span>. Inverts filter condition.</td>
       <td>If Data type: <span style="color:hotpink">DLMS</span>. Inverts filter condition.</td>
     </tr>|}}
     </tr>
      
    |}}
     {{#ifeq: {{{DNP3}}}|1|
     <tr>
     <tr>
       <td><span style="color:brown">Data filtering</span></td>
       <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>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>  
         <td>If Data type: <span style="color:brown">DNP3</span>. Choose which data this sender will send to server.</td>  
     </tr>
     </tr>
Line 159: Line 166:
       <td>RAM {{!}} Flash; default: <b>RAM</b></td>
       <td>RAM {{!}} Flash; default: <b>RAM</b></td>
         <td>Database location</td>  
         <td>Database location</td>  
     </tr>  
     </tr>|}}
     <tr>
     {{#ifeq:{{{OPC}}}|1|
    <tr>
      <td><span style="color:lightblue">Data filtering</span></td>
      <td>All {{!}} <span style="color:lightblue"> Name </span>; default: <b>All</b></td>
        <td>If Data type: <span style="color:lightblue">OPC UA</span>. Choose which data this sender will send to server.</td>
    </tr>
    |}}
    {{#ifeq:{{{MQTT}}}|1|<tr>
         <td><span style="color:orange">Server address</span></td>
         <td><span style="color:orange">Server address</span></td>
         <td>Default: <b>empty</b></td>
         <td>Default: <b>empty</b></td>
Line 245: Line 259:
     <tr>
     <tr>
       <td><span style="color:orange">Require password</span></td>
       <td><span style="color:orange">Require password</span></td>
       <td>checkbox; default: <b>empty</b></td>
       <td>on {{!}} off; default: <b>off</b></td>
       <td>Enables password for authentication.</td>
       <td>Enables password for authentication.</td>
     </tr>
     </tr>
Line 252: Line 266:
       <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>
     </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.
<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 settings====
----
----


[[File:Networking rutos manual data to server collection configuration general settings.png|border|class=tlt-border]]
[[File:Networking rutos manual data to server collection configuration general settings_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 275: Line 289:
     <tr>
     <tr>
       <td>Format type</td>
       <td>Format type</td>
       <td>Json {{!}} <span style="color:red">custom</span>; default: <b>Json</b></td>
       <td>JSON {{!}} <span style="color:red">custom</span>; default: <b>JSON</b></td>
       <td>Data collection objects formatting.</td>
       <td>Data collection objects formatting.</td>
     </tr>
     </tr>
Line 287: Line 301:
       <td>Default: <b>N/A</b></td>
       <td>Default: <b>N/A</b></td>
       <td>A string which will be placed if any value cannot be received</td>
       <td>A string which will be placed if any value cannot be received</td>
     </tr>
     </tr>  
</table>
 
====Collection advanced settings====
----
 
[[File:Networking rutos manual data to server collection configuration advanced settings.png|border|class=tlt-border]]
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr> 
     <tr>
     <tr>
       <td>Period</td>
       <td>Period</td>
Line 308: Line 309:
     <tr>
     <tr>
       <td>Retry</td>
       <td>Retry</td>
       <td>off {{!}} <span style="color red">on</span>; default: <b>off</b></td>
       <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
       <td>In case of a failed attempt, retry to send the same data to destination later.</td>
       <td>In case of a failed attempt, retry to send the same data to destination later.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color:red">Retry count</span></td>
       <td><span style="color:blue">Retry count</span></td>
       <td>Default: <b>10</b></td>
       <td>Default: <b>10</b></td>
       <td>Retry to send the same data N times </td>
       <td>Retry to send the same data N times </td>
     </tr>  
     </tr>  
     <tr>
     <tr>
       <td><span style="color:red">Timeout</span></td>
       <td><span style="color:blue">Timeout</span></td>
       <td>Default: <b>1</b></td>
       <td>Default: <b>1</b></td>
       <td>Timeout in second between retry attempts</td>
       <td>Timeout in second between retry attempts</td>
Line 336: Line 337:
     <tr>
     <tr>
       <td>Type</td>
       <td>Type</td>
       <td>HTTP {{!}} <span style="color:red">MQTT</span>; default: <b>HTTP</b></td>
       <td>HTTP {{#ifeq:{{{MQTT}}}|1|{{!}} <span style="color:red">MQTT</span>}}; default: <b>HTTP</b></td>
       <td>Interval in seconds for collecting/sending data to destination.</td>
       <td>Interval in seconds for collecting/sending data to destination.</td>
     </tr>
     </tr>
Line 354: Line 355:
       <td>Enables the use of TLS certificates.</td>
       <td>Enables the use of TLS certificates.</td>
     </tr>  
     </tr>  
      
     {{#ifeq:{{{MQTT}}}|1|
     <tr>
     <tr>
         <td><span style="color:red">Port</span></td>
         <td><span style="color:red">Port</span></td>
Line 382: Line 383:
* 1 - when we want the message to arrive at least once but don't care if it arrives twice (or more),
* 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>
* 2 - when we want the message to arrive exactly once. A higher QoS value means a slower transfer.</td>
     </tr>
     </tr>}}
     <tr>
     <tr>
       <td>Enable secure connection</td>
       <td>Enable secure connection</td>
       <td>off {{!}} <span style="color:blue">on</span>; default: '''off'''</td>
       <td>off {{!}} <span style="color:blue">on</span>; default: '''off'''</td>
       <td>Enables the use of TLS certificates.</td>
       <td>Enables the use of TLS certificates.</td>
     </tr>
     </tr>{{#ifeq:{{{MQTT}}}|1|
    <tr>
      <td><span style="color:blue">On:</span> TLS type</td>
      <td>Certificate based {{!}} Pre-shared key based; default: '''Certificate based'''</td>
      <td>Select type of TLS.</td>
    </tr>
     <tr>
     <tr>
       <td>Certificate based: Allow insecure connection</td>
       <td>Allow insecure connection</td>
       <td>off {{!}} on; default: '''off'''</td>
       <td>off {{!}} on; default: '''off'''</td>
       <td>Allow not verifying server authentication.</td>
       <td>Allow not verifying server authentication.</td>
     </tr>
     </tr>}}
     <tr>
     <tr>
       <td>Certificate based: Certificate files from device</td>
       <td><span style="color:blue">Certificate files from device</span></td>
       <td>off {{!}} on; default: '''off'''</td>
       <td>off {{!}} on; default: '''off'''</td>
       <td>Specify where the certificates will be used from.</td>
       <td>Specify where the certificates will be used from.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Certificate based: CA File</td>
       <td><span style="color:blue">Certificate authority file</span></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>Certificate based: Client Certificate</td>
     <td><span style="color:blue">Client Certificate</span></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>Certificate based: Client Private Key</td>
     <td><span style="color:blue">Client Private Keyfile</span></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>{{#ifeq:{{{MQTT}}}|1|
    <tr>
      <td>Pre-shared key based: 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>Pre-shared key based: 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>
     <tr>
       <td>Use credentials</td>
       <td>Use credentials</td>
Line 442: Line 428:
       <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>
     </tr>}}
      
      
</table>
</table>


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