9,063
edits
Changes
Template:Networking rutos manual data to server v2 rut2 rut9 (view source)
Revision as of 10:37, 9 April 2024
, 9 AprilCreated page with "<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}, {{{mobile}}}--> {{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name =..."
<!-- Template uses {{{name}}}, {{{series}}}, {{{bluetooth}}}, {{{wifi}}}, {{{mobile}}}-->
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
==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 =
| TCR1 =
| TRB1 =
| TRB2 =
| TRB2M =
| TRB5 =
| RUT2M =
| RUT2 =
| RUT30X =
| RUT36X =
| RUT9|RUT9M =
| RUT14X =
| #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>}}
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 which is located at the top of the WebUI.
==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, insert collection name and click the 'Add' button.
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button_v2.png|border|class=tlt-border]]
After this you should be redirected to the newly added data sender's configuration page.
===Advanced 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_advanced_sender_settings_v4.png|border|class=tlt-border]]
====General====
----
<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>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>
</tr>
<tr>
<td>JSON format</td>
<td>Json | Custom; default: <b>Json</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: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>
<td><span style="color:red">Data filtering</span></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 type: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
</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>
<td><span style="color:blue">Data period</span></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>
</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>
<td><span style="color:orange">Keepalive</span></td>
<td>integer [1..640]; default: <b>60</b></td>
<td>MQTT Keepalive period in seconds.</td>
</tr>
<tr>
<td><span style="color:orange">Topic</span></td>
<td>string; default: <b>none</b></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>
<td><span>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>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>Require password</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>
<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 configuration====
----
[[File:Networking rutos manual data to server collection configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enabled</td>
<td>off | on; default: <b>on</b></td>
<td>Enables data to server collection instance.</td>
</tr>
<tr>
<td>Format type</td>
<td>Json | <span style="color:red">custom</span>; default: <b>Json</b></td>
<td>Data collection objects formatting.</td>
</tr>
<tr>
<td><span style="color:red">Format string</span></td>
<td>Default: <b>Instance name</b></td>
<td>Specifies custom format string</td>
</tr>
<tr>
<td><span style="color:red">Empty value </span></td>
<td>Default: <b>N/A</b></td>
<td>A string which will be placed if any value cannot be received</td>
</tr>
</table>
[[File:Networking rutos manual data to server collection configuration advanced.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>Default: <b>60</b></td>
<td>Interval in seconds for collecting/sending data to destination.</td>
</tr>
<tr>
<td>Retry</td>
<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>
</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>
<td><span style="color:red">Timeout</span></td>
<td>Default: <b>1</b></td>
<td>Timeout in second between retry attempts</td>
</tr>
</table>
====Server configuration====
----
[[File:Networking rutos manual data to server configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</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>
<td><span style="color:red">Topic</span></td>
<td>string; default: <b>none</b></td>
<td>MQTT topic to be used for publishing the data.</td>
</tr>
<tr>
<td><span style="color:red">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:red">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:blue">on</span>; default: '''off'''</td>
<td>Enables the use of TLS certificates.</td>
</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>
<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>
<td><span>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>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>
[[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}}}
}}
}}
==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 =
| TCR1 =
| TRB1 =
| TRB2 =
| TRB2M =
| TRB5 =
| RUT2M =
| RUT2 =
| RUT30X =
| RUT36X =
| RUT9|RUT9M =
| RUT14X =
| #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>}}
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 which is located at the top of the WebUI.
==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, insert collection name and click the 'Add' button.
[[File:Networking_rutos_manual_data_to_server_data_senders_add_button_v2.png|border|class=tlt-border]]
After this you should be redirected to the newly added data sender's configuration page.
===Advanced 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_advanced_sender_settings_v4.png|border|class=tlt-border]]
====General====
----
<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>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>
</tr>
<tr>
<td>JSON format</td>
<td>Json | Custom; default: <b>Json</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: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>
<td><span style="color:red">Data filtering</span></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 type: <span style="color:red">Modbus data</span>. Choose which data this sender will send to server.</td>
</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>
<td><span style="color:blue">Data period</span></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>
</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>
<td><span style="color:orange">Keepalive</span></td>
<td>integer [1..640]; default: <b>60</b></td>
<td>MQTT Keepalive period in seconds.</td>
</tr>
<tr>
<td><span style="color:orange">Topic</span></td>
<td>string; default: <b>none</b></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>
<td><span>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>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>Require password</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>
<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 configuration====
----
[[File:Networking rutos manual data to server collection configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enabled</td>
<td>off | on; default: <b>on</b></td>
<td>Enables data to server collection instance.</td>
</tr>
<tr>
<td>Format type</td>
<td>Json | <span style="color:red">custom</span>; default: <b>Json</b></td>
<td>Data collection objects formatting.</td>
</tr>
<tr>
<td><span style="color:red">Format string</span></td>
<td>Default: <b>Instance name</b></td>
<td>Specifies custom format string</td>
</tr>
<tr>
<td><span style="color:red">Empty value </span></td>
<td>Default: <b>N/A</b></td>
<td>A string which will be placed if any value cannot be received</td>
</tr>
</table>
[[File:Networking rutos manual data to server collection configuration advanced.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>Default: <b>60</b></td>
<td>Interval in seconds for collecting/sending data to destination.</td>
</tr>
<tr>
<td>Retry</td>
<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>
</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>
<td><span style="color:red">Timeout</span></td>
<td>Default: <b>1</b></td>
<td>Timeout in second between retry attempts</td>
</tr>
</table>
====Server configuration====
----
[[File:Networking rutos manual data to server configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</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>
<td><span style="color:red">Topic</span></td>
<td>string; default: <b>none</b></td>
<td>MQTT topic to be used for publishing the data.</td>
</tr>
<tr>
<td><span style="color:red">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:red">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:blue">on</span>; default: '''off'''</td>
<td>Enables the use of TLS certificates.</td>
</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>
<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>
<td><span>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>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>
[[Category:{{{name}}} Services section]]
