Template:Networking rutos manual data to server: Difference between revisions
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 36: | Line 36: | ||
[[File:Networking rutos manual data to server data configuration_v1.png|border|class=tlt-border]] | [[File:Networking rutos manual data to server data configuration_v1.png|border|class=tlt-border]] | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
<tr> | <tr> | ||
| Line 50: | Line 49: | ||
<tr> | <tr> | ||
<td>Type</td> | <td>Type</td> | ||
<td><span>Base {{!}} {{#ifeq:{{{bluetooth}}}|1|<span style="color:green">Bluetooth</span> {{!}}|}} {{#ifeq:{{{mobile}}}|1| GSM {{!}}|}} {{#ifeq:{{{impulse_counter}}}|1|<span style="color:coral">Impulse counter</span> {{!}}|}} <span style="color:olive">Lua script</span> {{!}} {{#ifeq:{{{mobile_usage}}}|1|<span style="color:blue">Mobile usage</span>{{!}}|}} {{#ifeq:{{{MNF}}}|1| MNF info {{!}}|}} {{#ifeq:{{{Modbus}}}|1|<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> {{!}}|}} {{#ifeq:{{{DNP3}}}|1|<span style="color:brown">DNP3</span><span class="asterisk">*</span> {{!}}|}} {{#ifeq:{{{MQTT}}}|1|<span style="color:orange">MQTT</span> {{!}}|}} {{#ifeq:{{{OPC}}}|1|<span style="color:lightblue">OPC UA</span> {{!}}|}} {{#ifeq:{{{DLMS}}}|1|<span style="color:hotpink">DLMS</span><span class="asterisk">*</span>|}}; default: <b>Base</b></span></td> | <td><span>Base {{!}} {{#ifeq:{{{bluetooth}}}|1|<span style="color:green">Bluetooth</span> {{!}}|}} {{#ifeq:{{{mobile}}}|1| GSM {{!}}|}} {{#ifeq:{{{impulse_counter}}}|1|<span style="color:coral">Impulse counter</span> {{!}}|}} <span style="color:olive">Lua script</span> {{!}} {{#ifeq:{{{m-bus}}}|1|<span style="color:midnightblue ">M-Bus</span>{{!}}|}} {{#ifeq:{{{mobile_usage}}}|1|<span style="color:blue">Mobile usage</span>{{!}}|}} {{#ifeq:{{{MNF}}}|1| MNF info {{!}}|}} {{#ifeq:{{{Modbus}}}|1|<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> {{!}}|}} {{#ifeq:{{{DNP3}}}|1|<span style="color:brown">DNP3</span><span class="asterisk">*</span> {{!}}|}} {{#ifeq:{{{MQTT}}}|1|<span style="color:orange">MQTT</span> {{!}}|}} {{#ifeq:{{{OPC}}}|1|<span style="color:lightblue">OPC UA</span><span class="asterisk">*</span> {{!}}|}} {{#ifeq:{{{DLMS}}}|1|<span style="color:hotpink">DLMS</span><span class="asterisk">*</span>|}}; default: <b>Base</b></span></td> | ||
<td>Data input type.</td> | <td>Data input type.</td> | ||
</tr> | </tr> | ||
| Line 96: | Line 95: | ||
<td>Send as object</td> | <td>Send as object</td> | ||
<td>off {{!}} on; default: <b>off</b></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> | <td>When turned on, sends JSON segment as object and not as an array element. | ||
<ul> | |||
<li><b>Object syntax</b> --> {input1:{}...}</li> | |||
<li><b>JSON Array of Objects syntax</b> --> {input1:<b>[</b>{},{}...<b>]</b>}</li> | |||
</ul> | |||
</td> | |||
</tr> | </tr> | ||
{{#ifeq:{{{Modbus}}}|1| | {{#ifeq:{{{Modbus}}}|1| | ||
<tr> | <tr> | ||
<td><span style="color:grey">Data filtering</span></td> | <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>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> | <td>If Data type: <span style="color:grey">Modbus alarms data</span>. Choose which data this sender will send to server.</td> | ||
</tr> | </tr> | ||
| Line 109: | Line 113: | ||
<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:{{{m-bus}}}|1| | |||
<tr> | |||
<td><span style="color:midnightblue">Data filtering</span></td> | |||
<td>All {{!}} Name; default: <b>All</b></td> | |||
<td>If Data type: <span style="color:midnightblue">M-Bus</span>. Choose which data this sender will send to server.</td> | |||
</tr> | |||
|}} | |||
<tr> | <tr> | ||
<td><span style="color:olive">Lua data example script</span></td> | <td><span style="color:olive">Lua data example script</span></td> | ||
| Line 151: | Line 162: | ||
<tr> | <tr> | ||
<td><span style="color:blue">Data period</span></td> | <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><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> | <td>If Data type: <span style="color:blue">Mobile usage</span>. Choose for which time period to send info from.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color:blue">Current</span></td> | <td><span style="color:blue">Current</span></td> | ||
<td><span style="color:blue>off</span> {{!}} <span style="color:blue>on</span>; default: <b>off</b></td> | <td><span style="color:blue">off</span> {{!}} <span style="color:blue">on</span>; default: <b>off</b></td> | ||
<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>|}} | ||
| Line 284: | Line 295: | ||
<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 configuration=== | |||
---- | ---- | ||
[[File:Networking rutos manual data to server collection configuration general | [[File:Networking rutos manual data to server collection configuration general settings_v2.png|border|class=tlt-border]] | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 299: | Line 310: | ||
<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>Timer</td> | |||
<td><span style="color:blue">Period</span> {{!}} <span style="color:orange">Scheduler</span> {{!}} None; default: <b>Period</b></td> | |||
<td>Strategy for collecting/sending data to destination.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:blue">Period</span></td> | |||
<td>integer; default: <b>60</b></td>> | |||
<td>Interval in seconds for collecting/sending data to destination.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:orange">Day time</span></td> | |||
<td>string; default: <b>none</b></td>> | |||
<td>Day time when action should be executed. Use '*' to indicate every hour or minute, (e.g., 12:15, *:15, 12:*, or *:*).</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:orange">Interval type</span></td> | |||
<td>Weekdays {{!}} Month days; default: <b>Weekdays</b></td>> | |||
<td>Allows selecting between week and month days for instance intervals.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:orange">Weekdays</span></td> | |||
<td>list; default: <b>Every day is selected</b></td>> | |||
<td>Weekdays, when data should be sent/collected. If nothing is selected, every day of the week will be included.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:orange">Month day</span></td> | |||
<td>list; default: <b>Every day is selected</b></td>> | |||
<td>Month days, when data should be sent/collected. If nothing is selected, every day of the month will be included.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:orange">Month day: Force last day</span></td> | |||
<td>off {{!}} on; default: <b>off</b></td>> | |||
<td>Forces intervals to accept last day of month as valid option if selected day doesn't exist in ongoing month.</td> | |||
</tr> | |||
<tr> | |||
<td>Retry</td> | |||
<td>off {{!}} <span style="color:olive">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:olive">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:olive">Timeout</span></td> | |||
<td>Default: <b>1</b></td> | |||
<td>Timeout in second between retry attempts</td> | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Format type</td> | <td>Format type</td> | ||
<td>JSON {{!}} <span style="color:red">custom</span>; default: <b>JSON</b></td> | <td>JSON {{!}} <span style="color:red">custom</span> {{!}} <span style="color:lightgreen">Lua script</span>; default: <b>JSON</b></td> | ||
<td>Data collection objects formatting.</td> | <td>Data collection objects formatting.</td> | ||
</tr> | </tr> | ||
| Line 314: | Line 375: | ||
<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> | ||
<tr> | |||
<td> | <td><span style="color:lightgreen">Lua format example script</span></td> | ||
<td>-(interactive button)</td> | |||
<td>Download the Lua script.</td> | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: | <td><span style="color:lightgreen">Lua format script</span></td> | ||
<td> | <td>-(interactive button)</td> | ||
<td>Upload the Lua script.</td> | |||
</tr> | </tr> | ||
</table> | </table> | ||
===Server configuration=== | |||
---- | ---- | ||
| Line 365: | Line 416: | ||
<tr> | <tr> | ||
<td>Enable secure connection</td> | <td>Enable secure connection</td> | ||
<td> | <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td> | ||
<td>Enables the use of TLS certificates.</td> | <td>Enables the use of TLS certificates.</td> | ||
</tr> | </tr> | ||
| Line 396: | Line 447: | ||
* 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>}}{{#ifeq:{{{MQTT}}}|1| | ||
<tr> | <tr> | ||
<td> | <td><span style="color:red">Allow insecure connection</span></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> | ||
| Line 428: | Line 474: | ||
</tr>{{#ifeq:{{{MQTT}}}|1| | </tr>{{#ifeq:{{{MQTT}}}|1| | ||
<tr> | <tr> | ||
<td>Use credentials</td> | <td><span style="color:red">Use credentials</span></td> | ||
<td>off {{!}} <span style="color:darkgreen">on</span>; default: '''off'''</td> | <td>off {{!}} <span style="color:darkgreen">on</span>; default: '''off'''</td> | ||
<td>Enables use of username and password for authentication.</td> | <td>Enables use of username and password for authentication.</td> | ||
| Line 441: | Line 487: | ||
<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]] | ||
Latest revision as of 09:45, 3 December 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 collection first. To add a new collection, click the 'Add' button.
After this you should be redirected to the newly added data configuration page.
Data configuration
Refer to the table below for descriptions on data configuration fields.
Note: these tables have coloring schemes to indicate which fields can be seen with different configuration.
| Field | Value | Description |
|---|---|---|
| Name | string; default: input1 | Name of data input. |
| Type | Base | Lua script | ; default: Base | Data input type. |
| Format type | Json | Custom | Lua script; default: Json | Arranges the format of the sent JSON segment. |
| Values | list; default: All values included | Select values based on the data input type. If no values are selected, all values will be included. |
| 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. |
| Lua format example script | -(interactive button) | Download the Lua script. |
| Lua format script | -(interactive button) | Upload the Lua script. |
| 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.
|
| Lua data example script | -(interactive button) | Download Lua data example script. |
| Lua script | -(interactive button) | Upload Lua data script. |
* This is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.
Collection configuration
| Field | Value | Description |
|---|---|---|
| Enabled | off | on; default: on | Enables data to server collection instance. |
| Timer | Period | Scheduler | None; default: Period | Strategy for collecting/sending data to destination. |
| Period | integer; default: 60 | Interval in seconds for collecting/sending data to destination. |
| Day time | string; default: none | Day time when action should be executed. Use '*' to indicate every hour or minute, (e.g., 12:15, *:15, 12:*, or *:*). |
| Interval type | Weekdays | Month days; default: Weekdays | Allows selecting between week and month days for instance intervals. |
| Weekdays | list; default: Every day is selected | Weekdays, when data should be sent/collected. If nothing is selected, every day of the week will be included. |
| Month day | list; default: Every day is selected | Month days, when data should be sent/collected. If nothing is selected, every day of the month will be included. |
| Month day: Force last day | off | on; default: off | Forces intervals to accept last day of month as valid option if selected day doesn't exist in ongoing month. |
| 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 |
| Format type | JSON | custom | Lua script; 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 |
| Lua format example script | -(interactive button) | Download the Lua script. |
| Lua format script | -(interactive button) | Upload the Lua script. |
Server configuration
| Field | Value | Description |
|---|---|---|
| Type | HTTP ; 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 | off | on; default: off | Enables the use of TLS certificates. |
| Certificate files from device | off | on; default: off | Specify where the certificates will be used from. |
| Certificate authority 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. |
| 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. |
| Client Private Keyfile | .key file; default: none | File containing private key for this client. This file needs to be not encrypted. |
[[Category:{{{name}}} Services section]]