7,494
edits
Changes
Template:Networking rutos manual data to server (view source)
Revision as of 16:02, 9 April 2024
, 9 Aprilno edit summary
</tr>
</tr>
<tr>
<tr>
<td>Enable</td>
<td>Enabled</td>
<td>on, off; default: <b>on</b></td>
<td>off | on; default: <b>on</b></td>
<td>Enables instance.</td>
<td>Enables data to server collection instance.</td>
</tr>
</tr>
<td>Type</td>
<tr>
<td><span style="color:red">Json</span>, <span style="color:blue">custom</span>; default: <b>Json</b></td>
<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>
<tr>
<td><span style="color:red">Json</span></td>
<tr>
<td>string; default: <b>{"TS": "%t", "D": "%d", "data": %a}</b></td>
<td><span style="color:red">Format string</span></td>
<td>Default: <b>Instance name</b></td>
<td>Specifies custom format string</td>
</tr>
</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>
<td><span style="color:blue">Empty value</span></td>
<td>string; default: <b>N/A</b></td>
</tr>
</tr>
</table>
</table>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<td>Period</td>
<td>Period</td>
<td>integer [1..86400]; default: <b>60</b></td>
<td>Default: <b>60</b></td>
<td>Data sending frequency (in seconds).</td>
<td>Interval in seconds for collecting/sending data to destination.</td>
</tr>
</tr>
<tr>
<td>Retry</td>
<td>Retry</td>
<td>off | <span style="color:darkgreen">on</span>; default: <b>off</b></td>
<td>off | <span style="color red">on</span>; default: <b>off</b></td>
<td>When turned on, the data sender retries failed sending attempts until the are successfully delivered.</td>
<td>In case of a failed attempt, retry to send the same data to destination later.</td>
</tr>
</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>
<tr>
<td><span style="color:darkgreen">Retry count</span></td>
<td><span style="color:red">Timeout</span></td>
<td>Default: <b>1</b></td>
<td>Timeout in second between retry attempts</td>
<td>integer [1..60]; default: <b>1</b></td>
<td>Timeout in second between retry attempts.</td>
</tr>
</tr>
</table>
</table>
<th>Value</th>
<th>Value</th>
<th>Description</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>
<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>
<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>
<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>
<tr>
<tr>
<td>Enable secure connection</td>
<td>Enable secure connection</td>
<td><span style="color:chocolate">on</span>, off; default: <b>off</b></td>
<td>off | <span style="color:blue">on</span>; default: '''off'''</td>
<td>Enables use of TLS certificates</td>
<td>Enables the use of TLS certificates.</td>
</tr>
</tr>
<tr>
<tr>
<td>Certificate files from device</td>
<td><span style="color:blue">On:</span> TLS type</td>
<td>on, off; default: <b>off</b></td>
<td>Certificate based {{!}} Pre-shared key based; default: '''Certificate based'''</td>
<td>Choose this option if you want to select certificate files from device.</td>
<td>Select type of TLS.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:chocolate">Certificate based:</span> CA File</td>
<td><span>Certificate based:</span> 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 style="color:chocolate">Certificate based:</span> Client Certificate</td>
<td><span>Certificate based:</span> 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 style="color:chocolate">Certificate based:</span> Private Key</td>
<td><span>Certificate based:</span> 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><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>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
