Jump to content
  • EN

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

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

Revision as of 15:08, 9 April 2024

5,240 bytes added ,  9 April
no edit summary
VisualWikitext
(Created page with "<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}--> {{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} |...")
 
No edit summary
 
Line 17: Line 17:
| RUTX =
| RUTX =
| RUTM =
| RUTM =
| TCR1 =
| TRB1 =
| TRB1 =
| TRB2 =
| TRB2 =
| TRB2M =
| TRB5 =
| RUT2M =
| RUT2 =
| RUT30X =
| RUT36X =
| RUT9|RUT9M =
| RUT9|RUT9M =
| RUT14X =
| #default =  
| #default =  
<u><b>
<u><b>
Line 46: Line 54:
[[File:Networking rutos manual data to server data configuration.png|border|class=tlt-border]]
[[File:Networking rutos manual data to server data configuration.png|border|class=tlt-border]]


====Data configuration====
====General====
 
<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
Line 61: Line 68:
     <tr>
     <tr>
       <td>Type</td>
       <td>Type</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><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>; 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>
      <td>Format type</td>
      <td>Json, custom; default: <b>Json</b></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>Json | Custom; default: <b>Json</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 83: Line 86:
       <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><span style="color:grey">Data filtering</span></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>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><span style="color:red">Data filtering</span></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 | <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>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: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>
      <td><span style="color:purple">Data filtering</span></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 type: <span style="color:purple">Wifi scanner</span>. Choose which data this sender will send to server.</td>
    </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>
      <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>
      <td><span style="color:brown">Database</span></td>
       <td>RAM | Flash; default: <b>RAM</b></td>
        <td>Database location</td>
    </tr> 
   
   
    <tr>
        <td><span style="color:orange">Port</span></td>
        <td>integer [0..65535]; default: <b>1883</b></td>
        <td>Port number for connecting to MQTT.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color:blue">By slave IP:</span> Slave IP</td>
        <td><span style="color:orange">Keepalive</span></td>
      <td>ip; default: <b>none</b></td>
        <td>integer [1..640]; default: <b>60</b></td>
      <td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
        <td>MQTT Keepalive period in seconds.</td>
     </tr>{{#ifeq:{{{bluetooth}}}|1|
     </tr>
     <tr>
     <tr>
      <td><span style="color:green">Data filtering</span></td>
        <td><span style="color:orange">Topic</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>string; default: <b>none</b></td>
       <td>If Data source: <span style="color:green">Bluetooth data</span>. Choose which data this sender will send to server.</td>
        <td>MQTT topic to be used for publishing the data.</td>
    </tr>
    <tr>
        <td><span style="color:orange">Client ID</span></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><span style="color:orange">QoS</span></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>
      <td>Enable secure connection</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 {{!}} Pre-shared key based; default: '''Certificate based'''</td>
      <td>Select type of TLS.</td>
    </tr>
    <tr>
      <td><span>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>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>
     <tr>
     <tr>
      <td><span style="color:darkred">By MAC address:</span> MAC address</td>
    <td><span>Certificate based:</span> Private Key</td>
      <td>mac; default: <b>none</b></td>
        <td>.key file; default: <b>none</b></td>
      <td>MAC address of bluetooth device whose collected data will be sent to server.</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:blue">By device name:</span> Device name</td>
       <td><span>Pre-shared key based:</span> Pre-Shared-Key</td>
       <td>string; default: <b>none</b></td>
       <td>string; default: <b>none</b></td>
       <td>Device name of bluetooth device whose collected data will be sent to server.</td>
       <td>The pre-shared-key in hex format with no leading "0x".</td>
     </tr>|}}
     </tr>
     <tr>
     <tr>
       <td><span style="color:magenta">Data filtering</span></td>
       <td><span>Pre-shared key based:</span> Identity</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>string; default: <b>none</b></td>
       <td>If Data source: <span style="color:magenta">DNP3</span>. Choose which data this sender will send to server.</td>
       <td>The identity of this client. May be used as the username depending on the server settings.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color:darkred">DNP3 Address:</span> DNP3 Address</td>
       <td>Require password</td>
      <td>integer [0..65519]; default: <b>none</b></td>
      <td>off | <span style="color:darkgreen">on</span>; default: '''off'''</td>
       <td>DNP3 address of device whose collected data will be sent to server.</td>
       <td>Enables use of username and password for authentication.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color:blue">DNP3 IP:</span> DNP3 IP</td>
       <td><span style="color:darkgreen">On:</span> Username</td>
       <td>ip | domain; default: <b>none</b></td>
       <td>string; default: <b>none</b></td>
       <td>IP address of DNP3 device whose collected data will be sent to server.</td>
       <td>Username used in authentication.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Retry on fail</td>
       <td><span style="color:darkgreen">On:</span> Password</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>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 general settings====
====Collection general settings====
Line 149: Line 225:
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enabled</td>
       <td>on, off; default: <b>on</b></td>
       <td>off | on; default: <b>on</b></td>
       <td>Enables instance.</td>
       <td>Enables data to server collection instance.</td>
     </tr>
     </tr>
        <tr>
   
       <td>Type</td>
    <tr>
       <td><span style="color:red">Json</span>, <span style="color:blue">custom</span>; default: <b>Json</b></td>
       <td>Format type</td>
        <td>Data input type.</td>  
       <td>Json | <span style="color:red">custom</span>; default: <b>Json</b></td>
      <td>Data collection objects formatting.</td>
     </tr>
     </tr>
     <tr>
      
       <td><span style="color:red">Json</span></td>
    <tr>
       <td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
       <td><span style="color:red">Format string</span></td>
        <td>Arranges the format of the sent JSON segment.</td>  
       <td>Default: <b>Instance name</b></td>
      <td>Specifies custom format string</td>
     </tr>
     </tr>
     <tr>
      
      <td><span style="color:blue">custom</span></td>
        <tr>
      <td>string; default: <b>empty</b></td>
       <td><span style="color:red">Empty value </span></td>
        <td>Type of data formatting.</td>
       <td>Default: <b>N/A</b></td>
    </tr>    <tr>
      <td>A string which will be placed if any value cannot be received</td>
       <td><span style="color:blue">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>
</table>
</table>
Line 184: Line 259:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
     </tr>
     </tr>  
    <tr>
    <tr>
       <td>Period</td>
       <td>Period</td>
       <td>integer [1..86400]; default: <b>60</b></td>
       <td>Default: <b>60</b></td>
       <td>Data sending frequency (in seconds).</td>
       <td>Interval in seconds for collecting/sending data to destination.</td>
     </tr>
     </tr>
    <tr>
    <tr>
       <td>Retry</td>
       <td>Retry</td>
       <td>off | <span style="color:darkgreen">on</span>; default: <b>off</b></td>
       <td>off | <span style="color red">on</span>; default: <b>off</b></td>
       <td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</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:red">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:darkgreen">Retry count</span></td>
       <td><span style="color:red">Timeout</span></td>
      <td>integer [1..10]; default: <b>10</b></td>
       <td>Default: <b>1</b></td>
      <td>Retry to send the same data N times.</td>
       <td>Timeout in second between retry attempts</td>
    </tr>
    <tr>
      <td><span style="color:darkgreen">Timeout</span></td>
       <td>integer [1..60]; default: <b>1</b></td>
       <td>Timeout in second between retry attempts.</td>
     </tr>
     </tr>
</table>
</table>
Line 217: Line 292:
       <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>
      <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>
        <td><span style="color:red">Port</span></td>
        <td>integer [0..65535]; default: <b>1883</b></td>
        <td>Port number for connecting to MQTT.</td>
    </tr>
    <tr>
        <td><span style="color:red">Keepalive</span></td>
        <td>integer [1..640]; default: <b>60</b></td>
        <td>MQTT Keepalive period in seconds.</td>
     </tr>
     </tr>
        <tr>
    <tr>
      <td>Protocol</td>
        <td><span style="color:red">Topic</span></td>
      <td>HTTP(S) | MQTT{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | Kinesis; default: <b>HTTP(S)</b></td>
        <td>string; default: <b>none</b></td>
      <td>Protocol used for sending the data to server.</td>
        <td>MQTT topic to be used for publishing the data.</td>
     </tr>
     </tr>
        <tr>
    <tr>
      <td>Server address</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>URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.</td>
        <td>Client ID to send with the data. If empty, a random client ID will be generated</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>HTTP Header</td>
        <td><span style="color:red">QoS</span></td>
      <td>string; default: <b>none</b></td>
        <td>integer [0..2]; default: <b>0</b></td>
      <td>Allows to add custom headers to the HTTP requests.</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>Enable secure connection</td>
       <td>Enable secure connection</td>
       <td><span style="color:chocolate">on</span>, off; default: <b>off</b></td>
       <td>off | <span style="color:blue">on</span>; default: '''off'''</td>
       <td>Enables use of TLS certificates</td>
       <td>Enables the use of TLS certificates.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Certificate files from device</td>
       <td><span style="color:blue">On:</span> TLS type</td>
       <td>on, off; default: <b>off</b></td>
       <td>Certificate based {{!}} Pre-shared key based; default: '''Certificate based'''</td>
       <td>Choose this option if you want to select certificate files from device.</td>
       <td>Select type of TLS.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td><span style="color:chocolate">Certificate based:</span> CA File</td>
       <td><span>Certificate based:</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:chocolate">Certificate based:</span> Client Certificate</td>
     <td><span>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:chocolate">Certificate based:</span> Private Key</td>
     <td><span>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>
    <tr>
      <td><span>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>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>
   
</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/123357"