yellowcooln/meshcore-mqtt-live-map
1
0
Fork 0
mirror of https://github.com/yellowcooln/meshcore-mqtt-live-map.git synced 2026-04-20 23:23:36 +00:00
Code Issues Projects Releases Packages Wiki Activity
Live Map of Meshcore MQTT feed https://live.bostonme.sh/
1 commit 2 branches 16 tags 43 MiB
Find a file
yellowcooln 3dae93f885 Initial commit
2025-12-24 04:32:48 +00:00
backend Initial commit 2025-12-24 04:32:48 +00:00
data Initial commit 2025-12-24 04:32:48 +00:00
.env.example Initial commit 2025-12-24 04:32:48 +00:00
.gitignore Initial commit 2025-12-24 04:32:48 +00:00
docker-compose.yaml Initial commit 2025-12-24 04:32:48 +00:00
docs.md Initial commit 2025-12-24 04:32:48 +00:00
LICENSE Initial commit 2025-12-24 04:32:48 +00:00
README.md Initial commit 2025-12-24 04:32:48 +00:00

README.md

Mesh Live Map

Live MeshCore traffic map that renders nodes, routes, and activity in real time on a Leaflet map. The backend subscribes to MQTT over WebSockets + TLS, decodes MeshCore packets with @michaelhart/meshcore-decoder, and streams updates to the browser via WebSockets.

Features

  • Live node markers with roles (Repeater, Companion, Room Server, Unknown)
  • Animated route/trace lines and message fanout
  • Heat map for the last 10 minutes of message activity
  • Persistent device state and trails
  • UI controls: legend toggle, dark map, topo map
  • Embeddable metadata (Open Graph/Twitter tags) driven by env vars

Project Structure

  • backend/app.py: FastAPI server, MQTT ingest, MeshCore decoding, persistence
  • backend/static/index.html: Leaflet UI, map rendering, route/heat display
  • docker-compose.yaml: runtime configuration (reads from .env)
  • data/: runtime state (created at first run)

Quick Start

  1. Copy env template:
cp .env.example .env
  1. Edit .env with your MQTT broker and site metadata.
  2. Build and run:
docker compose up -d --build
  1. Open: http://localhost:8080/

Configuration (.env)

Required MQTT settings:

  • MQTT_HOST
  • MQTT_PORT
  • MQTT_USERNAME
  • MQTT_PASSWORD
  • MQTT_TRANSPORT (websockets)
  • MQTT_WS_PATH (usually / or /mqtt)
  • MQTT_TLS (true)
  • MQTT_TOPIC (e.g. meshcore/#)

Site metadata (used in page title + embeds):

  • SITE_TITLE
  • SITE_DESCRIPTION
  • SITE_OG_IMAGE (optional; leave blank to omit embed image)
  • SITE_URL (public URL)
  • SITE_ICON
  • SITE_FEED_NOTE

Runtime tuning:

  • DEVICE_TTL_SECONDS (node expiry)
  • TRAIL_LEN (points per device trail)
  • ROUTE_TTL_SECONDS
  • HEAT_TTL_SECONDS
  • MESSAGE_ORIGIN_TTL_SECONDS
  • DEBUG_PAYLOAD (verbose decoding logs)

Common Commands

  • Rebuild/restart: docker compose up -d --build
  • Logs: docker compose logs -f meshmap-live
  • Snapshot: curl -s http://localhost:8080/snapshot
  • Stats: curl -s http://localhost:8080/stats

Notes

  • The map can only draw routes for hops that appear in your MQTT feed.
  • To see full paths, the feed must include Path/Trace packets (payload types 8/9) or multiple observers for fanout.
  • Runtime state is persisted to data/state.json.

License

Add your license here.

This project was entirely vibe coded with Codex.