Template:Networking rutos manual data to server

Template:Networking rutos manual fw disclosure

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 Services → [[{{{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 data sender first. To add a new data sender, click the 'Add' button.

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.

Note: these tables have coloring schemes to indicate which fields can be seen with different configuration.

General

Field	Value	Description
Enabled	off \| on; default: off	Turns the data sender on or off.
Name	string; default: none	Name of the data sender. Used for easier data senders management purposes only (optional).
Data source	Modbus data \| DNP3; default: Modbus data*	Source of the data to be sent to server.
Protocol	HTTP(S) \| MQTT* \| Kinesis; default: HTTP(S)	Protocol used for sending the data to server.
JSON format	string; default: {"TS": "%t", "D": "%d", "data": %a}	Arranges the format of the sent JSON segment.
Segment count	integer [1..10]; 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.
URL/Host/Connection string	string; default: none	URL for HTTP(S); Host for MQTT; Connection string for Azure MQTT.
Period	integer [1..86400]; default: 60	Data sending frequency (in seconds).
Data filtering	All data \| By slave ID \| By slave IP; default: All data	If Data source: Modbus data. Choose which data this sender will send to server.
By slave ID: Slave ID	integer [1..255]; default: none	ID of the Modbus slave whose collected data will be sent to server.
By slave IP: Slave IP	ip; default: none	IP address of the Modbus slave whose collected data will be sent to server (for Modbus TCP slaves).
Data filtering	All data \| DNP3 Address \| DNP3 IP; default: All data	If Data source: DNP3. Choose which data this sender will send to server.
DNP3 Address: DNP3 Address	integer [0..65519]; default: none	DNP3 address of device whose collected data will be sent to server.
DNP3 IP: DNP3 IP	ip \| domain; default: none	IP address of DNP3 device whose collected data will be sent to server.
Retry on fail	off \| on; default: off	When turned on, the data sender retries failed sending attempts until the are successfully delivered.

* This is additional software that can be installed from the Services → [[{{{name}}} Package Manager|Package Manager]] page.

Protocol HTTP(S)

Field	Value	Description
Custom Header	string; default: none	Allows to add custom headers to the HTTP requests.
Use TLS	off \| on; default: off	Enables the use of TLS certificates.
On: TLS type	Certificate based; default: Certificate based	Select type of TLS.
On: CA 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.
On: 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.
On: Private Key	.key file; default: none	File containing private key for this client. This file needs to be not encrypted.

Protocol MQTT

Field	Value	Description
Port	integer [0..65535]; default: 1883	Port number for connecting to MQTT.
Keepalive	integer [1..640]; default: 60	MQTT Keepalive period in seconds.
Topic	string; default: none	MQTT topic to be used for publishing the data.
Client ID	string; default: none	Client ID to send with the data. If empty, a random client ID will be generated
QoS	integer [0..2]; default: 0	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.
Use TLS	off \| on; default: off	Enables the use of TLS certificates.
On: TLS type	Certificate based \| Pre-shared key based; default: Certificate based	Select type of TLS.
Certificate based: CA 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.
Certificate based: 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.
Certificate based: Private Key	.key file; default: none	File containing private key for this client. This file needs to be not encrypted.
Pre-shared key based: Pre-Shared-Key	string; default: none	The pre-shared-key in hex format with no leading "0x".
Pre-shared key based: Identity	string; default: none	The identity of this client. May be used as the username depending on the server settings.
Use Credentials	off \| on; default: off	Enables use of username and password for authentication.
On: Username	string; default: none	Username used in authentication.
On: Password	string; default: none	Password used in authentication.

Protocol Kinesis

Field	Value	Description
Stream name	string; default: none	The name of the stream for which to start encrypting records.
Partition key	string; default: none	The partition key is used by Kinesis Data Streams as input to a hash function that maps the partitionkey and associated data to a specific shard.
API version	positive integer; default: none	Optional. Used version of the Kinesis API.
Region	string; default: none	Region code of the Kinesis server.
Domain	domain; default: none	Domain of the Kinesis server. E.g. 'amazonaws.com'
Access key	string; default: none	Access key ID is a part of Access keys used for authentication.
Secret key	string; default: none	Secret access key is a part of Access keys used for authentication.
Use TLS	off \| on; default: off	Enables the use of TLS certificates.
On: TLS type	Certificate based; default: Certificate based	Select type of TLS.
On: CA 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.
On: 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.
On: Private Key	.key file; default: none	File containing private key for this client. This file needs to be not encrypted.

[[Category:{{{name}}} Services section]]