RUT955 Data to Server

Wiki mirrorView source
The information in this page is updated in accordance with firmware version RUT9_R_00.07.06.21.
Note: click here for the old style WebUI (FW version RUT9XX_R_00.06.09.5 and earlier) user manual page.

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.
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.

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

FieldValueDescription
Namestring; default: noneName of the data sender. Used for easier data senders management purposes only (optional).
TypeBase | GSM | Mobile usage | MNF info | Modbus* | Modbus Alarms | Wifi scanner* |DNP3* | MQTT; default: Base Source of the data to be sent to server.
JSON formatJson | Custom; default: JsonArranges the format of the sent JSON segment.
Segment countinteger [1..10]; default: 1Max segment count in one JSON string sent to server.
Send as objectoff | on; default: offWhen turned on, sends JSON segment as object and not as an array element.
Data filteringAll | Server ID | Alarm ID | Register number; default: AllIf Data type: Modbus alarms data. Choose which data this sender will send to server.
Data filteringAll | Server IP address | Server ID | Request name ; default: AllIf Data type: Modbus data. Choose which data this sender will send to server.
Data filteringAll | Name | MAC address | Signal strength; default: AllIf Data type: Wifi scanner. Choose which data this sender will send to server.
Data periodDay | Week | Month; default: DayIf Data type: Mobile usage. Choose for which time period to send info from.
Data filteringAll | Address | IP; default: AllIf Data type: DNP3. Choose which data this sender will send to server.
DatabaseRAM | Flash; default: RAMDatabase location
Portinteger [0..65535]; default: 1883Port number for connecting to MQTT.
Keepaliveinteger [1..640]; default: 60MQTT Keepalive period in seconds.
Topicstring; default: noneMQTT topic to be used for publishing the data.
Client IDstring; default: noneClient ID to send with the data. If empty, a random client ID will be generated
QoSinteger [0..2]; default: 0MQTT 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.
Enable secure connectionoff | on; default: offEnables the use of TLS certificates.
On: TLS typeCertificate based | Pre-shared key based; default: Certificate basedSelect type of TLS.
Certificate based: CA File.ca file; default: noneCertificate 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: noneCertificate 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: noneFile containing private key for this client. This file needs to be not encrypted.
Pre-shared key based: Pre-Shared-Keystring; default: noneThe pre-shared-key in hex format with no leading "0x".
Pre-shared key based: Identitystring; default: noneThe identity of this client. May be used as the username depending on the server settings.
Require passwordoff | on; default: offEnables use of username and password for authentication.
On: Usernamestring; default: noneUsername used in authentication.
On: Passwordstring; default: nonePassword used in authentication.

* This is additional software that can be installed from the System → Package Manager page.

Collection general settings

FieldValueDescription
Enabledoff | on; default: onEnables data to server collection instance.
Format typeJson | custom; default: JsonData collection objects formatting.
Format stringDefault: Instance nameSpecifies custom format string
Empty value Default: N/AA string which will be placed if any value cannot be received

Collection advanced settings

FieldValueDescription
PeriodDefault: 60Interval in seconds for collecting/sending data to destination.
Retryoff | on; default: offIn case of a failed attempt, retry to send the same data to destination later.
Retry countDefault: 10Retry to send the same data N times
TimeoutDefault: 1Timeout in second between retry attempts

Server configuration

FieldValueDescription
TypeHTTP | MQTT; default: HTTPInterval in seconds for collecting/sending data to destination.
Server addressDefault: emptyHostname or IP address of the broker to connect to.
HTTP headersDefault: emptyAllows to add custom headers to the HTTP requests.
Enable secure connectionon | off; default: offEnables the use of TLS certificates.
Portinteger [0..65535]; default: 1883Port number for connecting to MQTT.
Keepaliveinteger [1..640]; default: 60MQTT Keepalive period in seconds.
Topicstring; default: noneMQTT topic to be used for publishing the data.
Client IDstring; default: noneClient ID to send with the data. If empty, a random client ID will be generated
QoSinteger [0..2]; default: 0MQTT 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.
Enable secure connectionoff | on; default: offEnables the use of TLS certificates.
On: TLS typeCertificate based | Pre-shared key based; default: Certificate basedSelect type of TLS.
Certificate based: CA File.ca file; default: noneCertificate 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: noneCertificate 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: noneFile containing private key for this client. This file needs to be not encrypted.
Pre-shared key based: Pre-Shared-Keystring; default: noneThe pre-shared-key in hex format with no leading "0x".
Pre-shared key based: Identitystring; default: noneThe identity of this client. May be used as the username depending on the server settings.
Use credentialsoff | on; default: offEnables use of username and password for authentication.
On: Usernamestring; default: noneUsername used in authentication.
On: Passwordstring; default: nonePassword used in authentication.