8,907
edits
Changes
Template:Networking rutos manual data to server rut2 rut9 (view source)
Revision as of 16:20, 8 April 2024
, 8 AprilCreated page with "<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}--> {{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} |..."
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}-->
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)#Modbus_Data_to_Server|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)#Modbus_Data_to_Server|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
__TOC__
==Summary==
The <b>Data to Server</b> feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers.
{{#switch: {{{series}}}
| RUTX =
| RUTM =
| TRB1 =
| TRB2 =
| RUT9|RUT9M =
| #default =
<u><b>
Note:</b> On {{{name}}}, Data to Server is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
</u>}}
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = {{{series}}}
}}
==Data Senders==
A <b>Data Sender</b> 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.
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button_v3.png|border|class=tlt-border]]
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.
<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]]
====Data configuration====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>string; default: <b>none</b></td>
<td>Name of the data sender. Used for easier data senders management purposes only (optional).</td>
</tr>
<tr>
<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>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>
<td>JSON format</td>
<td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
<td>Arranges the format of the sent JSON segment.</td>
</tr>
<tr>
<td>Segment count</td>
<td>integer [1..10]; default: <b>1</b></td>
<td>Max segment count in one JSON string sent to server.</td>
</tr>
<tr>
<td>Send as object</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>
</tr>
<tr>
<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>If Data source: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:darkred">By slave ID:</span> Slave ID</td>
<td>integer [1..255]; default: <b>none</b></td>
<td>ID of the Modbus slave whose collected data will be sent to server.</td>
</tr>
<tr>
<td><span style="color:blue">By slave IP:</span> Slave IP</td>
<td>ip; default: <b>none</b></td>
<td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
</tr>{{#ifeq:{{{bluetooth}}}|1|
<tr>
<td><span style="color:green">Data filtering</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>If Data source: <span style="color:green">Bluetooth data</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:darkred">By MAC address:</span> MAC address</td>
<td>mac; default: <b>none</b></td>
<td>MAC address of bluetooth device whose collected data will be sent to server.</td>
</tr>
<tr>
<td><span style="color:blue">By device name:</span> Device name</td>
<td>string; default: <b>none</b></td>
<td>Device name of bluetooth device whose collected data will be sent to server.</td>
</tr>|}}
<tr>
<td><span style="color:magenta">Data filtering</span></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>If Data source: <span style="color:magenta">DNP3</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:darkred">DNP3 Address:</span> DNP3 Address</td>
<td>integer [0..65519]; default: <b>none</b></td>
<td>DNP3 address of device whose collected data will be sent to server.</td>
</tr>
<tr>
<td><span style="color:blue">DNP3 IP:</span> DNP3 IP</td>
<td>ip | domain; default: <b>none</b></td>
<td>IP address of DNP3 device whose collected data will be sent to server.</td>
</tr>
<tr>
<td>Retry on fail</td>
<td>off | on; default: <b>off</b></td>
<td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
</tr>
</table>
<br>
====Collection general settings====
----
[[File:Networking rutos manual data to server collection configuration general settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>on, off; default: <b>on</b></td>
<td>Enables instance.</td>
</tr>
<tr>
<td>Type</td>
<td><span style="color:red">Json</span>, <span style="color:blue">custom</span>; default: <b>Json</b></td>
<td>Data input type.</td>
</tr>
<tr>
<td><span style="color:red">Json</span></td>
<td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
<td>Arranges the format of the sent JSON segment.</td>
</tr>
<tr>
<td><span style="color:blue">custom</span></td>
<td>string; default: <b>empty</b></td>
<td>Type of data formatting.</td>
</tr> <tr>
<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>
</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>
<td>Period</td>
<td>integer [1..86400]; default: <b>60</b></td>
<td>Data sending frequency (in seconds).</td>
</tr>
<tr>
<td>Retry</td>
<td>off | <span style="color:darkgreen">on</span>; default: <b>off</b></td>
<td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
</tr>
<tr>
<td><span style="color:darkgreen">Retry count</span></td>
<td>integer [1..10]; default: <b>10</b></td>
<td>Retry to send the same data N times.</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>
</table>
====Server configuration====
----
[[File:Networking rutos manual data to server server configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Protocol</td>
<td>HTTP(S) | MQTT{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | Kinesis; default: <b>HTTP(S)</b></td>
<td>Protocol used for sending the data to server.</td>
</tr>
<tr>
<td>Server address</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>HTTP Header</td>
<td>string; default: <b>none</b></td>
<td>Allows to add custom headers to the HTTP requests.</td>
</tr>
<tr>
<td>Enable secure connection</td>
<td><span style="color:chocolate">on</span>, off; default: <b>off</b></td>
<td>Enables use of TLS certificates</td>
</tr>
<tr>
<td>Certificate files from device</td>
<td>on, off; default: <b>off</b></td>
<td>Choose this option if you want to select certificate files from device.</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>
</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]]
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)#Modbus_Data_to_Server|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)#Modbus_Data_to_Server|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
__TOC__
==Summary==
The <b>Data to Server</b> feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers.
{{#switch: {{{series}}}
| RUTX =
| RUTM =
| TRB1 =
| TRB2 =
| RUT9|RUT9M =
| #default =
<u><b>
Note:</b> On {{{name}}}, Data to Server is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
</u>}}
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = {{{series}}}
}}
==Data Senders==
A <b>Data Sender</b> 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.
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button_v3.png|border|class=tlt-border]]
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.
<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]]
====Data configuration====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>string; default: <b>none</b></td>
<td>Name of the data sender. Used for easier data senders management purposes only (optional).</td>
</tr>
<tr>
<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>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>
<td>JSON format</td>
<td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
<td>Arranges the format of the sent JSON segment.</td>
</tr>
<tr>
<td>Segment count</td>
<td>integer [1..10]; default: <b>1</b></td>
<td>Max segment count in one JSON string sent to server.</td>
</tr>
<tr>
<td>Send as object</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>
</tr>
<tr>
<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>If Data source: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:darkred">By slave ID:</span> Slave ID</td>
<td>integer [1..255]; default: <b>none</b></td>
<td>ID of the Modbus slave whose collected data will be sent to server.</td>
</tr>
<tr>
<td><span style="color:blue">By slave IP:</span> Slave IP</td>
<td>ip; default: <b>none</b></td>
<td>IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).</td>
</tr>{{#ifeq:{{{bluetooth}}}|1|
<tr>
<td><span style="color:green">Data filtering</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>If Data source: <span style="color:green">Bluetooth data</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:darkred">By MAC address:</span> MAC address</td>
<td>mac; default: <b>none</b></td>
<td>MAC address of bluetooth device whose collected data will be sent to server.</td>
</tr>
<tr>
<td><span style="color:blue">By device name:</span> Device name</td>
<td>string; default: <b>none</b></td>
<td>Device name of bluetooth device whose collected data will be sent to server.</td>
</tr>|}}
<tr>
<td><span style="color:magenta">Data filtering</span></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>If Data source: <span style="color:magenta">DNP3</span>. Choose which data this sender will send to server.</td>
</tr>
<tr>
<td><span style="color:darkred">DNP3 Address:</span> DNP3 Address</td>
<td>integer [0..65519]; default: <b>none</b></td>
<td>DNP3 address of device whose collected data will be sent to server.</td>
</tr>
<tr>
<td><span style="color:blue">DNP3 IP:</span> DNP3 IP</td>
<td>ip | domain; default: <b>none</b></td>
<td>IP address of DNP3 device whose collected data will be sent to server.</td>
</tr>
<tr>
<td>Retry on fail</td>
<td>off | on; default: <b>off</b></td>
<td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
</tr>
</table>
<br>
====Collection general settings====
----
[[File:Networking rutos manual data to server collection configuration general settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>on, off; default: <b>on</b></td>
<td>Enables instance.</td>
</tr>
<tr>
<td>Type</td>
<td><span style="color:red">Json</span>, <span style="color:blue">custom</span>; default: <b>Json</b></td>
<td>Data input type.</td>
</tr>
<tr>
<td><span style="color:red">Json</span></td>
<td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
<td>Arranges the format of the sent JSON segment.</td>
</tr>
<tr>
<td><span style="color:blue">custom</span></td>
<td>string; default: <b>empty</b></td>
<td>Type of data formatting.</td>
</tr> <tr>
<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>
</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>
<td>Period</td>
<td>integer [1..86400]; default: <b>60</b></td>
<td>Data sending frequency (in seconds).</td>
</tr>
<tr>
<td>Retry</td>
<td>off | <span style="color:darkgreen">on</span>; default: <b>off</b></td>
<td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
</tr>
<tr>
<td><span style="color:darkgreen">Retry count</span></td>
<td>integer [1..10]; default: <b>10</b></td>
<td>Retry to send the same data N times.</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>
</table>
====Server configuration====
----
[[File:Networking rutos manual data to server server configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Protocol</td>
<td>HTTP(S) | MQTT{{#ifeq: {{{series}}} | RUTX || <span class="asterisk">*</span>}} | Kinesis; default: <b>HTTP(S)</b></td>
<td>Protocol used for sending the data to server.</td>
</tr>
<tr>
<td>Server address</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>HTTP Header</td>
<td>string; default: <b>none</b></td>
<td>Allows to add custom headers to the HTTP requests.</td>
</tr>
<tr>
<td>Enable secure connection</td>
<td><span style="color:chocolate">on</span>, off; default: <b>off</b></td>
<td>Enables use of TLS certificates</td>
</tr>
<tr>
<td>Certificate files from device</td>
<td>on, off; default: <b>off</b></td>
<td>Choose this option if you want to select certificate files from device.</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>
</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]]
