OTD500 Data to Server
The information in this page is updated in accordance with firmware version OTD500_R_00.07.11.1.
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 OTD500, Data to Server is additional software that can be installed from the System → 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 | GSM | Lua script | Mobile usage| MNF info | Modbus* | Modbus Alarms | DNP3* | MQTT | OPC UA* | DLMS*; 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.
|
Data filtering | All | Server ID | Alarm ID | Register number; default: All | If Data type: Modbus alarms data. Choose which data this sender will send to server. |
Data filtering | All | Server IP address | Server ID | Request name ; default: All | If Data type: Modbus data. Choose which data this sender will send to server. |
Lua data example script | -(interactive button) | Download Lua data example script. |
Lua script | -(interactive button) | Upload Lua data script. |
Data period | Day | Week | Month; default: Day | If Data type: Mobile usage. Choose for which time period to send info from. |
Current | off | on; default: off | If Data type: Mobile usage. |
Data filtering | All | Name; default: All | If Data type: DLMS. Choose which data this sender will send to server. |
Invert file | off | on; default: off | If Data type: DLMS. Inverts filter condition. |
Data filtering | All | Address | IP; default: All | If Data type: DNP3. Choose which data this sender will send to server. |
Database | RAM | Flash; default: RAM | Database location |
Data filtering | All | Name ; default: All | If Data type: OPC UA. Choose which data this sender will send to server. |
Server address | Default: empty | Hostname or ip address of the broker to connect to. |
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:
|
Enable secure connection | 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: Allow insecure connection | off | on; default: off | Allow not verifying server authentication. |
Certificate based: Certificate files from device | off | on; default: off | Specify where the certificates will be used from. |
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: CLient 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. |
Username | string; default: none | Username used in authentication. |
Require password | on | off; default: off | Enables password for authentication. |
Password | string; default: none | Password used in authentication. |
* This is additional software that can be installed from the System → 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 | MQTT; 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. |
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:
|
Allow insecure connection | off | on; default: off | Allow not verifying server authentication. |
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. |
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. |