7,851
edits
Changes
Template:Networking rutos manual data to server (view source)
Revision as of 14:04, 10 April 2024
, 10 Aprilno edit summary
<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>; default: <b>Base</b></span>
<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>
<td>Source of the data to be sent to server.</td>
<td>Source of the data to be sent to server.</td>
<td>Json {{!}} <span style="color:limegreen">Custom</span>; default: <b>Json</b></td>
<td>Json {{!}} <span style="color:limegreen">Custom</span>; 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>
<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>
<td><span style="color:limegreen">Delimeter</span></td>
<td>string (Maximum length of value is 1 bytes); default: <b>N/A</b></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>
<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><span style="color:blue>Day</span> {{!}} <span style="color:blue>Week</span> {{!}} <span style="color:blue>Month</span>; default: <b>Day</b></td>
<td>If Data type: <span style="color:blue">Mobile usage</span>. Choose for which time period to send info from.</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:blue">Current</span></td>
<td><span style="color:blue>off</span> {{!}} <span style="color:blue>on</span>; default: <b>off</b></td>
<td>If Data type: <span style="color:blue">Mobile usage</span>.</td>
</tr>|}}
</tr>|}}
<tr>
<td><span style="color:hotpink">Data filtering</span></td>
<td>All {{!}} <span style="color:hotpink">Name</span>; default: <b>All</b></td>
<td>If Data type: <span style="color:hotpink">DLMS</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:hotpink">Invert file</span></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>
</tr>
<tr>
<tr>
<td><span style="color:brown">Data filtering</span></td>
<td><span style="color:brown">Data filtering</span></td>
<td>Database location</td>
<td>Database location</td>
</tr>
</tr>
<tr>
<td><span style="color:orange">Server address</span></td>
<td>Default: <b>empty</b></td>
<td>Hostname or ip address of the broker to connect to.</td>
</tr>
<tr>
<tr>
<td><span style="color:orange">Port</span></td>
<td><span style="color:orange">Port</span></td>
* 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>
<td>Enable secure connection</td>
<td><span style="color:orange">Enable secure connection</span></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 TLS 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> <span style="color:orange">TLS type</span></td>
<td>Certificate based {{!}} Pre-shared key 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>Certificate based:</span> CA File</td>
<td><span style="color:orange">Certificate based: Allow insecure connection</span></td>
<td>off {{!}} on; default: '''off'''</td>
<td>Allow not verifying server authentication.</td>
</tr>
<tr>
<td><span style="color:orange">Certificate based: Certificate files from device</span></td>
<td>off {{!}} on; default: '''off'''</td>
<td>Specify where the certificates will be used from.</td>
</tr>
<tr>
<td><span style="color:orange">Certificate based: CA 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><span>Certificate based:</span> Client Certificate</td>
<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 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>Certificate based:</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>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>Pre-shared key based:</span> Pre-Shared-Key</td>
<td><span style="color:orange">Pre-shared key based: Pre-Shared-Key</span></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>Pre-shared key based:</span> Identity</td>
<td><span style="color:orange">Pre-shared key based: Identity</span></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>Require password</td>
<td><span style="color:orange">Username</span></td>
<td>string; default: <b>none</b></td>
<td>Enables use of username and password for authentication.</td>
<td>Username used in authentication.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkgreen">On:</span> Username</td>
<td><span style="color:orange">Require password</span></td>
<td>string; default: <b>none</b></td>
<td>checkbox; default: <b>empty</b></td>
<td>Username used in authentication.</td>
<td>Enables password for authentication.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkgreen">On:</span> Password</td>
<td><span style="color:orange">Password</span></td>
<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">
<td>Enables data to server collection instance.</td>
<td>Enables data to server collection instance.</td>
</tr>
</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>
<tr>
<td><span style="color:red">Format string</span></td>
<td><span style="color:red">Format string</span></td>
<td>Default: <b>Instance name</b></td>
<td>Default: <b>Instance name</b></td>
<td>Specifies custom format string</td>
<td>Specifies custom format string</td>
</tr>
</tr>
<tr>
<td><span style="color:red">Empty value </span></td>
<td><span style="color:red">Empty value </span></td>
<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>
<tr>
<tr>
<td>Period</td>
<td>Period</td>
<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>
</tr>
</tr>
<tr>
<tr>
<td><span>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>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>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>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>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>