API | UDP Connector

UDP Connector

UDP Connector is dedicated for Tags positions upload for very high speed, with minimal latency where other connectors are too slow. UDP was designed with simplicity in mind, so there is no need to subscribe, no need for polling, etc. If there is some new position for any tag, this position will be sent via UDP to designated IP:port.
Example of UDP packet:

{"id":"18","datastreams":[{"id":"posX","current_value":"6.5","at":"2016-08-24 14:14:24.233226"},{"id":"posY","current_value":"2.6","at":"2016-08-24 14:14:24.233226"}]}

Complete list of examples can be found here.

Enabling UDP upload

  1.  Access “RTLS Server” tab in RTLS Manager: udp1
  2. There are three settings which can be configured: Udp Upload Port, Udp Upload Address and most important Upload via Udp. Calculated positions will be sent to  Udp Upload Address:Udp Upload Port, if Upload Via Udp is set to Yes. After setting these three values press Apply and restart RTLS Server.udp2

Example: Your host computer has IP and you have your application which listens on port 5300, then you have to set these three parameters to, port 5300 and Upload via Udp to yes. Afterwards you should be able to receive positions from tags.
Note: You can have both uploads enabled (both WebSockets and UDP), however when your system hit the performance limit, which WebSockets can handle, it is recommended to disable WebSockets upload connector in order to reduce overhead. It can be done with setting Upload To Sensmapserver to Disabled. Keep in mind that this will also disable visualization in Sensmap software, which uses WebSockets.