Jump to content
  • EN

TAP200 Data to Server

From Teltonika Networks Wiki
Main Page > TAP Access Points > TAP200 > TAP200 Manual > TAP200 WebUI > TAP200 Services section > TAP200 Data to Server



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. This page can be found under Services → Data to Server → Overview.

Overview

Inside the Overview page you can create Data to Server collections instances that gather and periodically send collected data to a specified server. The Data to server collections list contains no values 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 | MNF info | Wifi scanner* | MQTT* |  ; default: Base Data input type.
Format type Json | 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: Json Arranges 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
  • Lua script - N/A
  • MNF info - Device name, Serial number, MAC address, WAN MAC address, Batch, Hardware version
  • Wifi scanner - Date (Linux timestamp), Date (Day/Month/Year Hour:Minute:Second), Date (ISO 8601), Wifi device MAC address, Wifi device hostname, Signal strength
  • MQTT - MQTT message payload, MQTT topic, MQTT retain flag
    		•
    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.
    • Object syntax --> {input1:{}...}
    • JSON Array of Objects syntax --> {input1:[{},{}...]}
    Lua data example script -(interactive button) Download Lua data example script.
    Lua script -(interactive button) Upload Lua data script.
    Data filtering All | Name | MAC address | Signal strength; default: All If Data type: Wifi scanner. 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 subscribe. Supports wildcards.
    Show/Hide topic wildcard list string list;
    • %rn - Router name
    • %sn - Serial number
    • %lm - LAN MAC address.
    		 Shows topic wildcard list.
    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.
    Enable secure connection off | on; default: off Enables the use of TLS certificates. For improved security it is advised to enable this option.
    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 Bypasses server authenticity verification. For improved security it is advised to not enable this option.
    Certificate based: Certificate files from device off | on; default: off Specify where the certificates will be used from.
    Certificate based: 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.
    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 keyfile .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. For improved security it is advised to enable this option.
    Password string; default: none Password used in authentication.


    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.
    Encoder None | Base64; default: None Encoder used for all sent data.

    Server configuration


    Field Value Description
    Type HTTP | MQTT | Lua | SMTP | Socket | FTP ; default: HTTP Interval in seconds for collecting/sending data to destination.
    Compression None | Gzip | Deflate; default: None The 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 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. For improved security it is advised to enable this option.
    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 for publishing the data. Supports wildcards.
    Show/Hide topic wildcard list string list;
    • %rn - Router name
    • %sn - Serial number
    • %lm - LAN MAC address.
    		 Shows topic wildcard list.
    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.
    TLS type Certificate based | Pre-Shared-Key based; default: Certificate based Choose TLS type.
    Pre-Shared-Key hexadecimal string; default: none The pre-shared-key in hex format with no leading “0x”.
    Identity string; default: none The identity of this client.
    Allow insecure connection off | on; default: off Bypasses server authenticity verification. For improved security it is advised to not enable this option.
    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.
    Lua data example script -(interractive button) Downloads an example of script.
    Lua script -(interractive button) Path to the lua script.
    Subject string; default:none Subject of an email.
    Recipient's email address A valid email address is accepted; default: none Subject of an email.
    Email account list; default: none Sender's email configuration. Configure email account here.
    Server address string; default: none Socket's server address.
    Server port integer [1..65535]; default: none Socket's server port.
    UDP off | on; default: off Use UDP as the protocol.
    Timeout integer; default: 10 Specifies the receiving or sending data timeout.
    Server protocol FTP | SFTP | FTPS ; default: FTP The protocol that will be used to connect to the server.
    Key authentification on | off; default: off Use SSH key authentication for SFTP connections instead of password.
    Strict host key checking on | off; default: off Enable strict host key checking for SFTP connections. With this option enabled, the server's public key will be verified against the provided key. If the keys do not match, the connection will be aborted.
    Allow insecure connection on | off; default: off Bypasses server authenticity verification. For improved security it is advised to not enable this option.
    Certificate files from device on | off; default: off Choose this option if you want to select certificate files from device. Certificate files can be generated here
    Certificate authority file .ca file; default: none Insert file
    Client certificate .crt file; default: none Insert file
    Client private keyfile .key file; default: none Insert file
    The directory of the file path; default: none Remote FTP directory to upload file to.
    Host string; default: none The domain name or IP address of the server.
    Port integer [1..65535]; default: 21 The TCP/IP port of the server.
    Username string; default: none The username of the FTP server.
    Password string; default: none The password of the FTP server.
    Extra prefix to file name string; default: none Extra information to be added to file name.
    Buffer size integer; default: 1024 The size of the buffer to be used for uploading to FTP server.
    Overflow off | on; default: on Upload file to FTP server if buffer overflowed.
    Mode Interval | Fixed; default: Interval The schedule mode to be used for uploading to FTP server.
    Interval: Interval integer; default: 10 Upload files to server every x seconds.
    Fixed: Minute minutes; default: every minute Uploading will be performed on this specific minute only.
    Fixed: Hour hours; default: every minute Uploading will be performed on this specific hour only.
    Fixed: Day days; default: every day Uploading will be performed on this day only.
    Directory traversing method Multi CWD | No CWD | Single CWD; default: Multi CWD Directory traversing method for FTP (multicwd, nocwd, cwd).
    Recipients Single | Group; default: Single You can choose to add a single number or use a phone group list.
    Single: Recipient's phone number phone number; default: none To whom the message will be sent. The number must be specified in full format, country code included. e.g., +37000000000.
    Group: Phone group list; default: none Recipient's phone number users group. Configure it here.

    Status

    The Data to Server status section provides a visual representation of the active Data to Server collection's data flow, together with live status and diagnostic information.

    The status diagram displays the configured inputs, data formatting stages, collection, and output in the order in which data is processed.

    Field Value Description
    Data input -(interactive button) Displays the configured input instance and its type. Pressing the input redirects to the Overview page and opens that input's configuration window.
    Format Format type Displays the data format applied to the corresponding input or output.
    TX Transferred data Displays the amount of data processed or transmitted by the corresponding object.
    Errors Error count Displays the number of errors detected by the corresponding object. Hovering over the value displays the latest error message.
    Collection -(interactive button) Displays the active collection instance and its runtime information: Name, uptime, period, next run. Pressing the object redirects to the Overview page and opens the collection's configuration window.
    Change -(interactive button) Allows switching between collection diagrams. Pressing the button opens a window where another enabled collection can be selected.
    Trigger -(interactive button) Manually triggers the collection and sends the collected data. Can be used for testing purposes.
    Output -(interactive button) Displays the configured output instance and its type. Pressing the object redirects to the Overview page and opens the collection's configuration window.
    Show recent data -(interactive button) Displays the most recently sent data.
    Retrieved from "https://wiki.teltonika-networks.com/index.php?title=TAP200_Data_to_Server&oldid=183907"