Global coverage map for The Things Network
Switch branches/tags
Nothing to show
Clone or download
frankleonrose Further attempt at fixing batch test
Compiling with 1.9.0 showed the errors.
Latest commit da5f1e0 Oct 19, 2018

README.md

Build Status

MapTheThings-Server

The server portion of MapTheThings, the global coverage map for The Things Network (TTN).

Server Responsibilities

  • Handle messages from MapTheThings devices (nodes) routed via TTN.
  • Handle messages from mobile apps indicating failed message attempts.
  • Import coverage data submitted by the global user base.
  • Generate summary of GIS data at multiple scales to support map display
  • Serve single page MapTheThings Web app that shows coverage
  • Serve data to MapTheThings Web app - different resolution depending on zoom

Data Formats

The server supports some different data packet formats. Each packet starts with a tag byte that indicates how the rest should be interpreted.

  • 01 001122 001122 (little endian 24bit lat, lon. Untracked.)
  • 02 001122 001122 (little endian 24bit lat, lon. Tracked.)
  • 03 Unused (SMS message experiment)
  • 04 Unused (multi-part packets)
  • 05 221100 221100 1100 1100 64 (network byte order 24bit lat, lon, 16bit alt, hdop, 8bit battery) (Manhattan Mapper)
  • 81 001122 001122 (little endian 24bit lat, lon. Untracked. Test message.)

lat = lat / 93206.0; (More precision expanding 180° (-90° - 90°) into 24bits. Probably not a decision I would repeat.) lon = lon / 46603.0; (Less precision expanding 360° (-180° - 180°) into 24bits.) hdop = hdop / 1000.0;

Contributing Data

  1. MapTheThings - App & Node (Pending) Use the Map The Things iOS app and hardware node to submit coverage samples.

  2. Custom Nodes You are welcome to create your own TTN nodes and use them to transmit GPS coordinates to the Map The Things server.

    • AppEUI: 70B3D57ED00001B0
    • Data: Send lat/lon in 7 byte packets with the structure Byte 00: Value 0x01 - Format indicator. Byte 01-03: Latitude encoding. Little endian integer. latitude = (encoding / 93206.0) Byte 04-06: Longitude encoding. Little endian integer. longitude = (encoding / 46603.0)
    • Send me a DevEUI and I'll register it with the app and give you an app key.
  3. Upload Data If you want to upload existing map data, submit a pull request with your data in a reasonable format (CSV, JSON, XML, YAML, EDN) in the project/data directory. Make certain to include GPS coordinates, RSSI and SNR values for successful TTN messages. Samples missing RSSI or SNR indicate failed transmissions.

Contributing Code

This is a current work in progress as of Summer 2016. We welcome pull requests.

TODO

  • Support "lat,lng" parsed TTN messages
  • Support partitioning grid update work
  • Record histogram of number of gateways receiving a message: {1 40 2 3 5 1}
  • Use mock S3 and SQS for testing
  • Collect distance to gateway stats (for gateways that report their position)
  • Ensure that once a grid has dropped out of the cache, the version loaded from S3 is the latest.
  • Support requesting lower depth within Geobox - client can then do higher resolution pass if desired
  • Support uploading CSV of existing data
  • Write task that sends 1000's of messages to test API.
  • Login with Firebase Authentication (or something else enabling Twitter, Facebook, Github, Google)
  • Deliver APP key for each user to use - may be revoked
  • BUG - "clojure.lang.PersistentHashMap cannot be cast to clojure.lang.IPersistentStack" doing big import. Memory related?
  • Include Gateways from https://thethingsnetwork.org/api/v0/gateways/
  • Load TTNmapper data: ttnmapper.org/dumps
  • Share our data in an S3 bucket
  • Include histogram of spreading factor in summary data
  • Accept latitude, longitude, altitude, and HDOP (horizontal dilution of precision)
  • Plot shape of points (d3.delauney filtered by alpha)
  • Make map take entire viewport with text in overlays

DONE

  • DONE - Subscribe to TTN MQQT broker at staging.thethingsnetwork.org:1883
  • DONE - Update global hierarchy of grids
  • DONE - API serves list of URL's covering Geobox
  • DONE - Web app renders rectangles in JSON: Loads from public S3 and plots lat/lon boxes
  • DONE - Support TTN message with plain text for testing (it already worked)
  • DONE - Accept sent messages that indicate an attempt to write from a location.
  • DONE - Post messages to SQS first thing
  • DONE - Store raw messages to S3 (we'll want to replay them sometime)
  • DONE - Import JSON array of samples
  • DONE - BUG - Zooming too quickly leads to undeleted rectangles
  • DONE - Drive grid updates from SQS
  • DONE - Import data from http://ttn-utrecht.ltcm.net/
  • DONE - Record stats as :rssi {:cnt x :q y :avg z} rather than {:rssi-cnt x :rssi-q y :rssi-avg z}
  • DONE - Restart MQTT connection periodically. Saw "org.eclipse.paho.client.mqttv3.internal.ClientState checkForActivity SEVERE: frank.1464903570129: Timed out as no activity, keepAlive=60,000 lastOutboundActivity=1,464,905,984,787 lastInboundActivity=1,464,905,130,918". Suffered from connection having been dropped when testing node. Rely on :keep-alive-interval to trigger failure, but then actually reconnect and re-subscribe.
  • DONE - Accept binary data packets. Fixed point reals: lat,lon
  • DONE - BUG - Markers (like European samples) disappear at zoom levels 0, 1, and 2. Pan and they sometimes show.

Hosting

The server is hosted on Heroku and uses Amazon S3 and SQS for storage and queuing.

License

Source code for Map The Things is released under the MIT License, which can be found in the LICENSE file.