Template:Networking rutos manual data to server: Difference between revisions
No edit summary |
No edit summary |
||
| (22 intermediate revisions by 4 users not shown) | |||
| Line 17: | Line 17: | ||
| RUTX = | | RUTX = | ||
| RUTM = | | RUTM = | ||
| TCR1 = | | TCR1 = | ||
| TRB1 = | | TRB1 = | ||
| Line 29: | Line 28: | ||
| RUT9|RUT9M = | | RUT9|RUT9M = | ||
| RUT14X = | | RUT14X = | ||
| #default = | | #default = | ||
<u><b> | <u><b> | ||
| Line 54: | Line 52: | ||
<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]] | |||
====General==== | ====General==== | ||
| Line 73: | Line 68: | ||
<tr> | <tr> | ||
<td>Type</td> | <td>Type</td> | ||
<td><span>Base | <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> | ||
<td>Source of the data to be sent to server.</td> | <td>Source of the data to be sent to server.</td> | ||
| Line 107: | Line 102: | ||
<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> | ||
<tr> | <tr> | ||
<td><span style="color:grey">Data filtering</span></td> | <td><span style="color:grey">Data filtering</span></td> | ||
| Line 118: | Line 112: | ||
<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 144: | Line 137: | ||
<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>|}} | ||
<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 166: | Line 147: | ||
<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> | |||
<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 259: | Line 233: | ||
<tr> | <tr> | ||
<td><span style="color:orange">Require password</span></td> | <td><span style="color:orange">Require password</span></td> | ||
<td> | <td>checkbox; default: <b>empty</b></td> | ||
<td>Enables password for authentication.</td> | <td>Enables password for authentication.</td> | ||
</tr> | </tr> | ||
| Line 266: | Line 240: | ||
<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 settings==== | ====Collection general settings==== | ||
---- | ---- | ||
[[File:Networking rutos manual data to server collection configuration general | [[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 286: | Line 260: | ||
<td>off {{!}} on; default: <b>on</b></td> | <td>off {{!}} on; default: <b>on</b></td> | ||
<td>Enables data to server collection instance.</td> | <td>Enables data to server collection instance.</td> | ||
</tr> | |||
<tr> | |||
<td>Name</td> | |||
<td>string; default: <b></b></td> | |||
<td>Name of the data collection. Used for easier data collection management purposes only.</td> | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Format type</td> | <td>Format type</td> | ||
<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 301: | Line 280: | ||
<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 309: | Line 301: | ||
<tr> | <tr> | ||
<td>Retry</td> | <td>Retry</td> | ||
<td>off {{!}} <span style="color | <td>off {{!}} <span style="color red">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: | <td><span style="color:red">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: | <td><span style="color:red">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 337: | Line 329: | ||
<tr> | <tr> | ||
<td>Type</td> | <td>Type</td> | ||
<td>HTTP | <td>HTTP {{!}} <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 355: | Line 347: | ||
<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">Port</span></td> | <td><span style="color:red">Port</span></td> | ||
| Line 383: | Line 375: | ||
* 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> | ||
<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>Allow insecure connection</td> | <td>Certificate based: 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> | <td>Certificate based: Certificate files from device</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> | <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> | <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> | <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> | |||
<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 428: | Line 435: | ||
<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]] | ||
Revision as of 08:44, 10 April 2024
The information in this page is updated in accordance with firmware version .
Summary
The Data to Server feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers.
Note: On {{{name}}}, Data to Server is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.
If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.
Data Senders
A Data Sender is an instance that gathers and periodically sends collected data to a specified server. The Data Senders list is empty by default so, in order to begin configuration you must add a new data sender first. To add a new data sender, click the 'Add' button.
After this you should be redirected to the newly added data sender's configuration page.
Sender Settings
Refer to the table below for descriptions on data sender configuration fields.
Note: these tables have coloring schemes to indicate which fields can be seen with different configuration.
General
| Field | Value | Description |
|---|---|---|
| Name | string; default: none | Name of the data sender. Used for easier data senders management purposes only (optional). |
| Type | Base | MNF info | Modbus* | Modbus Alarms | DNP3* | MQTT; default: Base | Source of the data to be sent to server. |
| Format type | Json | Custom; default: Json | Arranges the format of the sent JSON segment. |
| Format string | string; default: none | Specifies custom format string. |
| Empty value | string; default: N/A | A string which will be placed if any value cannot be received. |
| Delimeter | string (Maximum length of value is 1 bytes); default: N/A | Specifies delimiters for multiple data segments. |
| Segment count | integer [1..64]; default: 1 | Max segment count in one JSON string sent to server. |
| Send as object | off | on; default: off | When turned on, sends JSON segment as object and not as an array element. |
| Data filtering | All | Server ID | Alarm ID | Register number; default: All | If Data type: Modbus alarms data. Choose which data this sender will send to server. |
| Data filtering | All | Server IP address | Server ID | Request name ; default: All | If Data type: Modbus data. Choose which data this sender will send to server. |
| Data filtering | All | Address | IP; default: All | If Data type: DNP3. Choose which data this sender will send to server. |
| Database | RAM | Flash; default: RAM | Database location |
| Server address | Default: empty | Hostname or ip address of the broker to connect to. |
| Port | integer [0..65535]; default: 1883 | Port number for connecting to MQTT. |
| Keepalive | integer [1..640]; default: 60 | MQTT Keepalive period in seconds. |
| Topic | string; default: none | MQTT topic to be used for publishing the data. |
| Client ID | string; default: none | Client ID to send with the data. If empty, a random client ID will be generated |
| QoS | integer [0..2]; default: 0 | MQTT Quality of Service. Allowed values:
|
| Enable secure connection | off | on; default: off | Enables the use of TLS certificates. |
| On: TLS type | Certificate based | Pre-shared key based; default: Certificate based | Select type of TLS. |
| Certificate based: Allow insecure connection | off | on; default: off | Allow not verifying server authentication. |
| Certificate based: Certificate files from device | off | on; default: off | Specify where the certificates will be used from. |
| Certificate based: CA File | .ca file; default: none | 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. |
| Certificate based: Client certificate | .crt file; default: none | 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. |
| Certificate based: CLient private Key | .key file; default: none | File containing private key for this client. This file needs to be not encrypted. |
| Pre-shared key based: Pre-Shared-Key | string; default: none | The pre-shared-key in hex format with no leading "0x". |
| Pre-shared key based: Identity | string; default: none | The identity of this client. May be used as the username depending on the server settings. |
| Username | string; default: none | Username used in authentication. |
| Require password | checkbox; default: empty | Enables password for authentication. |
| Password | string; default: none | Password used in authentication. |
* This is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.
Collection general settings
| Field | Value | Description |
|---|---|---|
| Enabled | off | on; default: on | Enables data to server collection instance. |
| Name | string; default: | Name of the data collection. Used for easier data collection management purposes only. |
| Format type | Json | custom; default: Json | Data collection objects formatting. |
| Format string | Default: Instance name | Specifies custom format string |
| Empty value | Default: N/A | A string which will be placed if any value cannot be received |
Collection advanced settings
| Field | Value | Description |
|---|---|---|
| Period | Default: 60 | Interval in seconds for collecting/sending data to destination. |
| Retry | off | on; default: off | In case of a failed attempt, retry to send the same data to destination later. |
| Retry count | Default: 10 | Retry to send the same data N times |
| Timeout | Default: 1 | Timeout in second between retry attempts |
Server configuration
| Field | Value | Description |
|---|---|---|
| Type | HTTP | MQTT; default: HTTP | Interval in seconds for collecting/sending data to destination. |
| Server address | Default: empty | Hostname or IP address of the broker to connect to. |
| HTTP headers | Default: empty | Allows to add custom headers to the HTTP requests. |
| Enable secure connection | on | off; default: off | Enables the use of TLS certificates. |
| Port | integer [0..65535]; default: 1883 | Port number for connecting to MQTT. |
| Keepalive | integer [1..640]; default: 60 | MQTT Keepalive period in seconds. |
| Topic | string; default: none | MQTT topic to be used for publishing the data. |
| Client ID | string; default: none | Client ID to send with the data. If empty, a random client ID will be generated |
| QoS | integer [0..2]; default: 0 | MQTT Quality of Service. Allowed values:
|
| Enable secure connection | off | on; default: off | Enables the use of TLS certificates. |
| On: TLS type | Certificate based | Pre-shared key based; default: Certificate based | Select type of TLS. |
| Certificate based: Allow insecure connection | off | on; default: off | Allow not verifying server authentication. |
| Certificate based: Certificate files from device | off | on; default: off | Specify where the certificates will be used from. |
| Certificate based: CA File | .ca file; default: none | 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. |
| Certificate based: Client Certificate | .crt file; default: none | 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. |
| Certificate based: Client Private Key | .key file; default: none | File containing private key for this client. This file needs to be not encrypted. |
| Pre-shared key based: Pre-Shared-Key | string; default: none | The pre-shared-key in hex format with no leading "0x". |
| Pre-shared key based: Identity | string; default: none | The identity of this client. May be used as the username depending on the server settings. |
| Use credentials | off | on; default: off | Enables use of username and password for authentication. |
| On: Username | string; default: none | Username used in authentication. |
| On: Password | string; default: none | Password used in authentication. |
[[Category:{{{name}}} Services section]]