Update readme

This commit is contained in:
Brian Shea 2024-07-23 16:44:34 -04:00 committed by GitHub
parent eb1e4bf3fb
commit a402aaa90d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,2 +1,43 @@
# [MeshMap.net](https://meshmap.net/)
A nearly live map of Meshtastic nodes seen by the official Meshtastic MQTT server
A nearly live map of [Meshtastic](https://meshtastic.org/) nodes seen by the official Meshtastic MQTT server
## Features
- Shows all position-reporting nodes heard by Meshtastic's [official MQTT server](https://meshtastic.org/docs/configuration/module/mqtt/#connect-to-the-default-public-server)
- Includes nodes self-reporting to MQTT or heard by another node reporting to MQTT
- Node data is updated every minute
- Nodes are removed from the map if their position is not updated after 24 hours
- Search for nodes by name or ID
## FAQs
### How do I get my node on the map?
These are general requirements. Refer to the [official docs](https://meshtastic.org/docs/configuration/) or reach out to the fantastic Meshtastic community
(such as at [r/meshtastic](https://www.reddit.com/r/meshtastic/)) for additional support.
- Use the default primary channel and encryption key
- Enable position reports from your node
- This may mean enabling your node's built-in GPS, sharing your phone's location via the app, or setting a fixed position
If your node can be heard by another node already reporting to MQTT, that's it!
To enable MQTT reporting:
- Enable the MQTT module, using all default settings, possibly with a custom root topic
- View nodes around your area on the map to find MQTT topics being used
- Configure your node to connect to wifi or otherwise connect to the internet
- Enable MQTT uplink on your primary channel
- It is not necessary, and not recommended unless you know what you're doing, to enable MQTT downlink
### Does the map allow manual/self-reported nodes (not over MQTT)?
No, and that's a feature. The goal of this map is to provide a reasonably up-to-date, reliable data source for node locations.
This is also why nodes are removed if no position reports are heard after 24 hours.
### Can you add this awesome new feature I just came up with? (Or you'd like to report a bug)
Maybe! Open a GitHub issue and let's discuss it. Pull requests welcome!
### Can I use your code for my own map?
Sure! But please pay attention to the license so we can all benefit from your improvements. :)
### Why do I get an error when trying to build the Docker image?
The included Dockerfile is for building the `meshobserv` program, which is responsible for connecting to the MQTT server and handling node messages.
Meshtastic nodes use [Protocol Buffers](https://protobuf.dev/) to serialize their messages.
The Meshtastic protobuf definitions must be compiled before building `meshobserv`.
See the `scripts` directory for helpful build scripts.