0
edits
Changes
Template:Networking rutos manual data to server (view source)
Revision as of 10:56, 13 May 2020
, 10:56, 13 May 2020prepare for release
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}-->
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03
| series = {{{series}}}
}}
__TOC__
==Summary==
Data to Server function provides you with the possibility to set up senders that transfer data collected from Modbus slaves {{#ifeq:{{{bluetooth}}}|1|or Bluetooth devices|}} to remote servers.
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer}}
==Data senders==
To add a new data sender, click the '''Add''' button:
[[File:Networking_rutx_manual_data_to_server_data_senders_v1.png|border|class=tlt-border]]
===Configure data sender===
----
When you add a new data sender, you will be redirected to its configuration window. The figure below is an example of that window and the table below provides information on the fields that it contains:
[[File:Networking_rutx_manual_data_to_server_advanced_sender_settings_v1.png|border|class=tlt-border]]
====General====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enabled</td>
<td>off {{!}} on; default: '''off'''</td>
<td>Enables or disables data sender.</td>
</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>
{{#ifeq:{{{bluetooth}}}|1|
<tr>
<td>Data source</td>
<td>Modbus data {{!}} Bluetooth data; default: '''Bluetooth data'''</td>
<td>Source of the data to be sent to server.</td>
</tr>
|}}
<tr>
<td>Protocol</td>
<td>HTTP(S) {{!}} MQTT; default: '''HTTP(S)'''</td>
<td>Protocol used for sending the data to server.</td>
</tr>
<tr>
<td>JSON format</td>
<td>string; default: '''{"TS": "%t", "D": "%d", "data": %a}'''</td>
{{#ifeq:{{{bluetooth}}}|1|
<td>You can fully customize JSON segment.<br>Possible Modbus values:
* Date (Linux timestamp) - %t
* Date (Day/Month/Year Hour:Minute:Second) - %d
* Modbus slave ID - %i
* Modbus slave IP - %p
* Start register - %s
* Register data (JSON object) - %a
Possible Bluetooth values:
* Date (Linux timestamp) - %t
* Date (Day/Month/Year Hour:Minute:Second) - %d
* Modbus slave ID - %i
* Modbus slave IP - %p
* Start register - %s
* Register data (JSON object) - %a
</td>
| <!-- not bluetooth -->
<td>You can fully customize JSON segment, possible values:
* Date (Linux timestamp) - %t
* Date (Day/Month/Year Hour:Minute:Second) - %d
* Modbus slave ID - %i
* Modbus slave IP - %p
* Start register - %s
* Register data (JSON object) - %a
</td>
}}
</tr>
<tr>
<td>Segment count</td>
<td>integer [1..10]; default: '''1'''</td>
<td>Max segment count in one JSON string sent to server.</td>
</tr>
<tr>
<td>URL/Host/Connection string</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>Period</td>
<td>integer [1..86400]; default: '''60'''</td>
<td>Interval for sending the collected data to server (in seconds, 1-86400)</td>
</tr>
<tr>
<td>Data filtering</td>
<td>All data {{!}} <span style="color:darkred">By slave ID</span> {{!}} <span style="color:blue">By slave IP</span>; default: '''All data'''</td>
<td>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: '''none'''</td>
<td>Data will be sent to server only from slave device with this modbus ID (1-255).</td>
</tr>
<tr>
<td><span style="color:blue">By slave IP:</span> Slave IP</td>
<td>ip; default: '''none'''</td>
<td>Data will be sent to server from slave device with this IP address only (Modbus TCP slaves only).</td>
</tr>
<tr>
<td>Retry on fail</td>
<td>off {{!}} on; default: '''off'''</td>
<td>In case of a failed attempt, retry to send the same data to server later (Retry until successful).</td>
</tr>
</table>
====Protocol HTTP(S)====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Custom Header</td>
<td>string; default: <b>none</b></td>
<td>Allows to add custom headers to the HTTP requests.</td>
</tr>
<tr>
<td>Use TLS</td>
<td>off | <span style="color:red">on</span>; default: '''off'''</td>
<td>Enables the use of TSL certificates.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> TLS type</td>
<td>Certificate based; default: '''Certificate based'''</td>
<td>Select type of TLS.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> A 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:red">On:</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:red">On:</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>
====Protocol MQTT====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>1883</b></td>
<td>Port number for connecting to MQTT.</td>
</tr>
<tr>
<td>Keepalive</td>
<td>integer [1..640]; default: <b>60</b></td>
<td>MQTT Keepalive period in seconds.</td>
</tr>
<tr>
<td>Topic</td>
<td>string; default: <b>none</b></td>
<td>MQTT topic to be used for publishing the data.</td>
</tr>
<tr>
<td>QoS</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>Use TLS</td>
<td>off | <span style="color:red">on</span>; default: '''off'''</td>
<td>Enables the use of TSL certificates.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> TLS type</td>
<td><span style="color:chocolate">Certificate based</span> {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<td>Select type of TLS.</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>
<tr>
<td><span style="color:darkred">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 style="color:darkred">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>
<b>Note</b>: these tables have coloring schemes to indicate which fields can be seen with different configuration.
[[Category:{{{name}}} Services section]]
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03
| series = {{{series}}}
}}
__TOC__
==Summary==
Data to Server function provides you with the possibility to set up senders that transfer data collected from Modbus slaves {{#ifeq:{{{bluetooth}}}|1|or Bluetooth devices|}} to remote servers.
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer}}
==Data senders==
To add a new data sender, click the '''Add''' button:
[[File:Networking_rutx_manual_data_to_server_data_senders_v1.png|border|class=tlt-border]]
===Configure data sender===
----
When you add a new data sender, you will be redirected to its configuration window. The figure below is an example of that window and the table below provides information on the fields that it contains:
[[File:Networking_rutx_manual_data_to_server_advanced_sender_settings_v1.png|border|class=tlt-border]]
====General====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enabled</td>
<td>off {{!}} on; default: '''off'''</td>
<td>Enables or disables data sender.</td>
</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>
{{#ifeq:{{{bluetooth}}}|1|
<tr>
<td>Data source</td>
<td>Modbus data {{!}} Bluetooth data; default: '''Bluetooth data'''</td>
<td>Source of the data to be sent to server.</td>
</tr>
|}}
<tr>
<td>Protocol</td>
<td>HTTP(S) {{!}} MQTT; default: '''HTTP(S)'''</td>
<td>Protocol used for sending the data to server.</td>
</tr>
<tr>
<td>JSON format</td>
<td>string; default: '''{"TS": "%t", "D": "%d", "data": %a}'''</td>
{{#ifeq:{{{bluetooth}}}|1|
<td>You can fully customize JSON segment.<br>Possible Modbus values:
* Date (Linux timestamp) - %t
* Date (Day/Month/Year Hour:Minute:Second) - %d
* Modbus slave ID - %i
* Modbus slave IP - %p
* Start register - %s
* Register data (JSON object) - %a
Possible Bluetooth values:
* Date (Linux timestamp) - %t
* Date (Day/Month/Year Hour:Minute:Second) - %d
* Modbus slave ID - %i
* Modbus slave IP - %p
* Start register - %s
* Register data (JSON object) - %a
</td>
| <!-- not bluetooth -->
<td>You can fully customize JSON segment, possible values:
* Date (Linux timestamp) - %t
* Date (Day/Month/Year Hour:Minute:Second) - %d
* Modbus slave ID - %i
* Modbus slave IP - %p
* Start register - %s
* Register data (JSON object) - %a
</td>
}}
</tr>
<tr>
<td>Segment count</td>
<td>integer [1..10]; default: '''1'''</td>
<td>Max segment count in one JSON string sent to server.</td>
</tr>
<tr>
<td>URL/Host/Connection string</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>Period</td>
<td>integer [1..86400]; default: '''60'''</td>
<td>Interval for sending the collected data to server (in seconds, 1-86400)</td>
</tr>
<tr>
<td>Data filtering</td>
<td>All data {{!}} <span style="color:darkred">By slave ID</span> {{!}} <span style="color:blue">By slave IP</span>; default: '''All data'''</td>
<td>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: '''none'''</td>
<td>Data will be sent to server only from slave device with this modbus ID (1-255).</td>
</tr>
<tr>
<td><span style="color:blue">By slave IP:</span> Slave IP</td>
<td>ip; default: '''none'''</td>
<td>Data will be sent to server from slave device with this IP address only (Modbus TCP slaves only).</td>
</tr>
<tr>
<td>Retry on fail</td>
<td>off {{!}} on; default: '''off'''</td>
<td>In case of a failed attempt, retry to send the same data to server later (Retry until successful).</td>
</tr>
</table>
====Protocol HTTP(S)====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Custom Header</td>
<td>string; default: <b>none</b></td>
<td>Allows to add custom headers to the HTTP requests.</td>
</tr>
<tr>
<td>Use TLS</td>
<td>off | <span style="color:red">on</span>; default: '''off'''</td>
<td>Enables the use of TSL certificates.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> TLS type</td>
<td>Certificate based; default: '''Certificate based'''</td>
<td>Select type of TLS.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> A 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:red">On:</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:red">On:</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>
====Protocol MQTT====
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>1883</b></td>
<td>Port number for connecting to MQTT.</td>
</tr>
<tr>
<td>Keepalive</td>
<td>integer [1..640]; default: <b>60</b></td>
<td>MQTT Keepalive period in seconds.</td>
</tr>
<tr>
<td>Topic</td>
<td>string; default: <b>none</b></td>
<td>MQTT topic to be used for publishing the data.</td>
</tr>
<tr>
<td>QoS</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>Use TLS</td>
<td>off | <span style="color:red">on</span>; default: '''off'''</td>
<td>Enables the use of TSL certificates.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> TLS type</td>
<td><span style="color:chocolate">Certificate based</span> {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<td>Select type of TLS.</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>
<tr>
<td><span style="color:darkred">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 style="color:darkred">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>
<b>Note</b>: these tables have coloring schemes to indicate which fields can be seen with different configuration.
[[Category:{{{name}}} Services section]]