TRB143 Data to Server

Wiki mirrorView source
The information in this page is updated in accordance with firmware version TRB1_R_00.07.22.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 some devices, Data to Server is additional software that can be installed from the System → Package Manager page.}}

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.
FieldValueDescription
Namestring; default: input1Name of data input.
TypeBase | GSM | SMS | Impulse counter | Lua script | M-Bus| Mobile usage| MNF info | Modbus* | Modbus Alarms | DNP3* | MQTT | OPC UA* | DLMS* | Input/Output; default: BaseData input type.
Format typeJson | Custom | Lua script (Some data input types may not work correctly with the provided Lua format example script. Review and adapt the script as needed to ensure compatibility.); default: JsonArranges the format of the sent JSON segment.
Values
  • Base - Time now, Local Time, Time (ISO8601), Firmware version, The name of the sender, ID of the sender
  • GSM - Connection state, Package domain service state, Network link state, IMEI, SIM ICCID, Model, Manufacturer, Serial number, Revision number, IMSI, SIM card state, PIN state, Operator station time (GMT), RSSI, RSCP, EC/IO, RSRP, SINR, RSRQ, Cell ID, Operator name, Operator number, Data carrier type, Modem temperature, PIN/PUK count, Network information, Serving cell information, Modem ID, Interface IP, Interface IPV6
  • SMS - SMS index, SMS text, Sender's phone number, SMS date, SMS timestamp, Date (ISO 8601)
  • Impulse counter - Impulse counter pin, Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Impulse counter count
  • Lua script - N/A
  • M-Bus - M-Bus group name, Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Binary Date (binary Linux timestamp, UINT32BE), M-Bus data size in bytes, M-Bus group data
  • Mobile usage - Total data transferred, Total data received
  • MNF info - Device name, Serial number, MAC address, WAN MAC address, Batch, Hardware version
  • Modbus - Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Binary Date (binary Linux timestamp, UINT32BE), MODBUS server ID, MODBUS server name, MODBUS server ID (binary UINT8), MODBUS server IP, Request name, Start register, Start register (binary UINT16BE), Full MODBUS register address, Register data (JSON object), Raw data, Data size
  • Modbus Alarms - Date (Linux timestamp), Alarm configuration ID, MODBUS server ID, Values to be compared against, Condition for comparing values, Values from server that were checked, MODBUS register or coil number
  • DNP3 - Request name, Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Quality bits, Outstation IP, Outstation Port, Outstation remote address, Data object group, Index, DNP3 data
  • MQTT - MQTT message payload, MQTT topic, MQTT retain flag
  • OPC UA - OPC UA value group name, Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Binary Date (binary Linux timestamp, UINT32BE), Data size in bytes, OPC UA value group data
  • DLMS - DLMS value group name, Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Binary Date (binary Linux timestamp, UINT32BE), DLMS data size in bytes, DLMS value group data
  • Input/Output - I/O pin name, Pin type, Pin state, I/O pin custom name, Floating point pin value for Analog input/current loop pins
  • Format stringstring; default: noneSpecifies custom format string.
    Empty valuestring; default: N/AA string which will be placed if any value cannot be received.
    Delimeterstring (Maximum length of value is 1 bytes); default: N/ASpecifies 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 countinteger [1..64]; 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.
    • Object syntax --> {input1:{}...}
    • JSON Array of Objects syntax --> {input1:[{},{}...]}
    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 filtering All | Server IP address | Server ID | Request name ; default: AllIf Data type: Modbus data. Choose which data this sender will send to server. Note: 20 filtering entries with Modbus data are allowed.
    Data filteringAll | Name; default: AllIf Data type: M-Bus. 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.
    I/O pinPIN list; default: depends on the deviceI/O pin name.
    Data filteringAll | Pin Name; default: AllIf Data type: Impulse counter. Choose which data this sender will send to server.
    Data filtering: Impulse counter pinlist; default: noneFilter data by defined impulse counter pin.
    Data filtering: Invert filteroff | on; default: offInverts filter condition.
    Data periodDay | Week | Month; default: DayChoose for which time period to send info from.
    Currentoff | on; default: offCurrent data.
    SIM cardSelect SIM card if device supports multiple SIM cards; default: none
    Data filteringAll | Name; default: AllIf Data type: DLMS. Choose which data this sender will send to server.
    Invert filteroff | on; default: offIf Data type: DLMS. Inverts filter condition.
    Data filteringAll | Address | IP; default: AllIf Data type: DNP3. Choose which data this sender will send to server.
    DatabaseRAM | Flash; default: RAMDatabase location
    Data filteringAll | Name ; default: AllIf Data type: OPC UA. Choose which data this sender will send to server.
    Server addressDefault: emptyHostname or ip address of the broker to connect to.
    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: Allow insecure connectionoff | on; default: offBypasses server authenticity verification.
    Certificate based: Certificate files from deviceoff | on; default: offSpecify where the certificates will be used from.
    Certificate based: Store keys in TPMoff | on; default: onWhen enabled, keys will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support.
    Certificate based: Certificate authority 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: Client private keyfile.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.
    Usernamestring; default: noneUsername used in authentication.
    Require passwordon | off; default: offEnables password for authentication.
    Passwordstring; default: nonePassword used in authentication.

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

    Collection configuration

    FieldValueDescription
    Enabledoff | on; default: onEnables data to server collection instance.
    TimerPeriod | Scheduler | None; default: PeriodStrategy for collecting/sending data to destination.
    Periodinteger; default: 60Interval in seconds for collecting/sending data to destination.
    Day timestring; default: noneDay time when action should be executed. Use '*' to indicate every hour or minute, (e.g., 12:15, *:15, 12:*, or *:*).
    Interval typeWeekdays | Month days; default: WeekdaysAllows selecting between week and month days for instance intervals.
    Weekdayslist; default: Every day is selectedWeekdays, when data should be sent/collected. If nothing is selected, every day of the week will be included.
    Month daylist; default: Every day is selectedMonth days, when data should be sent/collected. If nothing is selected, every day of the month will be included.
    Month day: Force last dayoff | on; default: offForces intervals to accept last day of month as valid option if selected day doesn't exist in ongoing month.
    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
    Format typeJSON | custom | Lua script; 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
    Lua format example script-(interactive button)Download the Lua script.
    Lua format script-(interactive button)Upload the Lua script.
    EncoderNone | Base64; default: NoneEncoder used for all sent data.

    Server configuration

    Note: on some devices it is necessary to install an additional package to see additional server types Advanced data to server modules.
    FieldValueDescription
    TypeHTTP | MQTT | Azure IoT Hub (requires to install package from Package Manager) | Lua | SMTP | Socket | FTP | SMS; default: HTTPInterval in seconds for collecting/sending data to destination.
    CompressionNone | Gzip | Deflate; default: NoneThe algorithm used to compress data. Compression may be inefficient for small amounts of data due to added overhead. Note: compresion can be used with these server types (HTTP, MQTT, Lua, Socket, FTP).
    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 connectionoff | on; 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.
    TLS typeCertificate based | Pre-Shared-Key based; default: Certificate basedChoose TLS type.
    Pre-Shared-Keyhexadecimal string; default: noneThe pre-shared-key in hex format with no leading “0x”.
    Identitystring; default: noneThe identity of this client.
    Allow insecure connectionoff | on; default: offBypasses server authenticity verification.
    Certificate files from deviceoff | on; default: offSpecify where the certificates will be used from.
    Store keys in TPMoff | on; default: onWhen enabled, keys will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support.
    Certificate authority 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.
    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.
    Client private keyfile.key file; default: noneFile containing private key for this client. This file needs to be not encrypted.
    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.
    Configuration typeUnique Azure Iot Hub configuration | Existing Azure Iot Hub configuration; default: Unique Azure Iot Hub configuration
    Configuration typeUnique Azure Iot Hub configuration | Existing Azure Iot Hub configuration; default: Unique Azure Iot Hub configuration
    Unique Azure Iot Hub configuration: Connection typeShared Access Signature (SAS) key | Device Provisioning Service (DPS); default: Shared Access Signature (SAS) key
    Unique Azure Iot Hub configuration: Connection Stringstring; default: noneConnection string based on primary key used in API calls which allows device to communicate with IoT Hub.
    Unique Azure Iot Hub configuration: ID Scopestring; default: noneUnique identifier that is assigned to an Azure IoT Hub during its creation and is used to uniquely identify the specific provisioning service the device will register through.
    Unique Azure Iot Hub configuration: Registration IDstring; default: noneThe registration ID is used to uniquely identify a device registration with the Device Provisioning Service. Registration ID is the X.509 certificate common name (CN) field of the individual device's certificate.
    Unique Azure Iot Hub configuration: Global Device Endpointstring; default: global.azure-devices-provisioning.netDestination for messages sent by IoT devices to the Azure IoT Hub (will default to global.azure-devices-provisioning.net if not set).
    Unique Azure Iot Hub configuration: Attestation mechanismX.509 Certificates | Symmetric Key; default: X.509 CertificatesMethod used to confirm a device's identity in Device Provisioning Service.
    Unique Azure Iot Hub configuration: X.509 Certificates: Use certificate files from deviceoff | on; default: offChoose this option if you want to select certificate files from device. Certificate files can be generated here.
    Unique Azure Iot Hub configuration: X.509 Certificates: Store keys in TPMoff | on; default: onWhen enabled, keys will be stored in TPM2 secure storage if space is available. Note: this option is only available on devices with TPM support.
    Unique Azure Iot Hub configuration: X.509 Certificates: X.509 Certificate-(interactive) button; default: noneUpload the "leaf" certificate file.
    Unique Azure Iot Hub configuration: X.509 Certificates: X.509 Private Key-(interactive) button; default: noneUpload the "leaf" key file.
    Unique Azure Iot Hub configuration: Symmetric Key: Symmetric Keystring; default: noneThe the derived device key from the DPS Primary Key.
    Lua data example script-(interractive button)Downloads an example of script.
    Lua script-(interractive button)Path to the lua script.
    Subjectstring; default:noneSubject of an email.
    Recipient's email addressA valid email address is accepted; default: noneSubject of an email.
    Email accountlist; default: noneSender's email configuration. Configure email account here.
    Server addressstring; default: noneSocket's server address.
    Server portinteger [1..65535]; default: noneSocket's server port.
    UDPoff | on; default: offUse UDP as the protocol.
    Timeoutinteger; default: 10Specifies the receiving or sending data timeout.
    The directory of the filepath; default: noneRemote FTP directory to upload file to.
    Hoststring; default: noneThe domain name or IP address of the server.
    Portinteger [1..65535]; default: 21The TCP/IP port of the server.
    Usernamestring; default: noneThe username of the FTP server.
    Passwordstring; default: noneThe password of the FTP server.
    Extra prefix to file namestring; default: noneExtra information to be added to file name.
    Buffer sizeinteger; default: 1024The size of the buffer to be used for uploading to FTP server.
    Overflowoff | on; default: onUpload file to FTP server if buffer overflowed.
    ModeInterval | Fixed; default: IntervalThe schedule mode to be used for uploading to FTP server.
    Interval: Intervalinteger; default: 10Upload files to server every x seconds.
    Fixed: Minuteminutes; default: every minuteUploading will be performed on this specific minute only.
    Fixed: Hourhours; default: every minuteUploading will be performed on this specific hour only.
    Fixed: Daydays; default: every dayUploading will be performed on this day only.
    Directory traversing methodMulti CWD | No CWD | Single CWD; default: Multi CWDDirectory traversing method for FTP (multicwd, nocwd, cwd).
    RecipientsSingle | Group; default: SingleYou can choose to add a single number or use a phone group list.
    Single: Recipient's phone numberphone number; default: noneTo whom the message will be sent. The number must be specified in full format, country code included. e.g., +37000000000.
    Group: Phone grouplist; default: noneRecipient's phone number users group. Configure it here.