MultiGeiger 🛰️

The MultiGeiger is an ESP32-based radioactivity measurement device designed for citizen science projects. It features a modern web interface, multiple connectivity options (WiFi, LoRa, BLE), and environmental sensors for comprehensive environmental monitoring.

✨ Key Features

📊 Radiation Measurement - Accurate detection using Geiger-Müller tubes with real-time CPM/CPS/µSv/h display
🌐 Modern Web Interface - Single-page application (SPA) with live updates and responsive design
🔐 Secure Access - Session-based authentication protects configuration and OTA updates
📡 Multiple Connectivity - WiFi, LoRaWAN/TTN, BLE, MQTT with TLS support
🌡️ Environmental Sensors - Optional temperature, humidity, pressure, and air quality monitoring (BMP280/BME280/BME680)
☁️ Cloud Integration - MQTT + TTN/LoRaWAN forwarding with OpenSenseMap compatibility
⏰ Time Synchronization - Automatic browser-to-device time sync for accurate timestamps
🔋 Low Power Design - Optimized for battery operation with deep sleep support

🚀 Quick Start

Default Credentials:

WiFi Access Point:

SSID: MultiGeiger-XXXXXX (last 6 digits of MAC address)
Password: ESP32Geiger

Web Interface Login:

Username: admin
Password: admin
⚠️ Change these immediately in the Settings page!

Steps:

🔌 Power on your MultiGeiger device
📶 Connect to the WiFi access point MultiGeiger-XXXXXX
🌐 Open http://192.168.4.1 in your browser
📊 View live data on the Dashboard (no login required)
⚙️ Click "Settings" → Login with admin/admin → Configure device
🔐 Important: Change password in Settings → Authorization section!

🖥️ Web Interface

The MultiGeiger features a modern, single-page web application (SPA) with session-based authentication, real-time updates, and a mobile-optimized design:

Dashboard	Status	Settings

Real-time monitoring: • 📈 Live radiation levels • 🌡️ Environmental data • ⏱️ Uptime & system info • ⚠️ HV error warnings	Connectivity status: • 📶 WiFi signal strength • 📡 MQTT connection • 🛰️ LoRa transmissions • 📲 BLE advertising	Secure configuration: • 🔐 Login-protected access • 📶 WiFi setup • 📡 MQTT & LoRa credentials • ⚙️ Device settings

Key Features

🔐 Session Authentication - Secure login with HttpOnly cookies (30min session timeout)
🔄 Live Updates - Real-time polling (2s interval) for instant feedback
⏰ Time Sync - Automatic browser-to-device time synchronization
🎨 Modern UI - Clean, responsive design built with vanilla JavaScript (no frameworks!)
📱 Mobile-First - Touch-friendly interface optimized for smartphones and tablets
🧪 Mock API - Local development mode with simulated device data

Access Points:

AP Mode: http://192.168.4.1/
Network Mode: http://multigeiger.local/ (mDNS)
Direct IP: http://<device-ip>/

Default Login:

Username: admin
Password: admin
⚠️ Change these immediately after first setup!

🔐 Security & Authentication

Session-Based Authentication

Protected endpoints (configuration, OTA updates) require login:

Session Management: HttpOnly cookies with 30-minute sliding expiration
CSRF Protection: SameSite=Lax cookie attribute
AP Mode: Authentication skipped (WiFi password provides access control)
Default Credentials: admin / admin (⚠️ Change immediately!)

Protected Endpoints

/config - Configuration page
/api/config - Configuration API (GET/POST)
/api/config/ping - Heartbeat for session keep-alive
/update - OTA firmware upload

Security Best Practices

✅ Change default password immediately after first setup
✅ Use strong credentials (min. 8 characters, mixed case + numbers)
✅ Enable WiFi encryption (WPA2 or better)
⚠️ HTTP only - ESP32 doesn't support HTTPS (use VPN for remote access)
🔒 AP Mode Security - Strong AP password acts as first authentication layer

API Access

Login:

curl -X POST http://multigeiger.local/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"admin"}' \
  -c cookies.txt

Authenticated Request:

curl http://multigeiger.local/api/config \
  -b cookies.txt

📡 Connectivity Options

WiFi 📶

Standard 802.11 b/g/n connectivity for:

Web interface access
MQTT data publishing
OTA firmware updates

LoRaWAN 🛰️

Long-range connectivity via The Things Network (TTN v3):

Activation Mode: ABP (Activation By Personalization)
Frequency Plan: EU868 (868.1 MHz)
Payload: 10 bytes (radiation data) + 5 bytes (environmental data)
Compatibility: Works with single-channel gateways (e.g., Dragino LG01-N)

Note: MultiGeiger uses ABP instead of OTAA to ensure compatibility with single-channel LoRaWAN gateways which cannot reliably handle OTAA join procedures.

See LoRa Setup Guide for TTN configuration.

MQTT 📨

Publish data to any MQTT broker (Mosquitto, HiveMQ, etc.):

Protocols: MQTT 3.1.1, MQTT over TLS
Topics: Configurable (default: multigeiger/<chip-id>/data)
Payload: JSON format with all sensor readings
QoS: Configurable (0, 1, or 2)

Bluetooth Low Energy (BLE) 📲

Local data access for mobile apps and nearby devices.

🌐 Cloud Integration & Data Forwarding

The MultiGeiger can send data to various platforms. Beyond direct uploads, you can leverage TTN's MQTT server to forward data to additional services.

TTN MQTT Server 🔄

The Things Network provides an MQTT server that pushes real-time uplink messages. You can use this to forward MultiGeiger data to other platforms like OpenSenseMap.

Setup:

🔑 Create an API key in your TTN Application:
- Go to Applications → Your Application → API keys
- Click + Add API key
- Grant rights: Read application traffic
- Copy the generated key
📡 Connect to TTN MQTT broker:
- Host: <region>.cloud.thethings.network (e.g., eu1.cloud.thethings.network)
- Port: 8883 (TLS) or 1883 (plain)
- Username: <application-id>@ttn
- Password: <api-key>
- Topic: v3/<application-id>/devices/+/up
🔀 Forward data using Node-RED, n8n, or custom scripts

OpenSenseMap Integration 🗺️

Forward TTN data to OpenSenseMap for public visualization:

Step 1: Create OpenSenseMap Sensor

Register at https://opensensemap.org/
Create a new senseBox (manual configuration)
Add a sensor for radiation (phenomenon: "Ionizing Radiation", unit: "µSv/h")
Note your senseBoxId and sensorId

Step 2: n8n Workflow for Data Forwarding

Use n8n (or Node-RED) to subscribe to TTN MQTT and forward to OpenSenseMap:

n8n Code Node Example:

const senseBoxId = '<your-sensebox-id>';  // Your Box-ID from OpenSenseMap
const sensorId = '<your-sensor-id>';      // Your Sensor-ID for radiation

// Extract decoded payload from TTN
const rawValue = $input.first().json.message.uplink_message.decoded_payload.uSvph;
const roundedValue = parseFloat(rawValue.toFixed(3));  // Round to 3 decimals

const data = { value: roundedValue };

// POST to OpenSenseMap ingress API
const response = await this.helpers.httpRequest({
  method: 'POST',
  url: `https://ingress.opensensemap.org/boxes/${senseBoxId}/${sensorId}`,
  headers: {
    'Content-Type': 'application/json'
  },
  body: data,
  options: {
    response: { fullResponse: true }
  }
});

return [{ json: {
  status: response.statusCode,
  data: data
}}];

Workflow Overview:

📨 MQTT Trigger Node: Subscribe to TTN uplink topic
🔧 Code Node: Extract and transform payload
🌐 HTTP Request: POST to OpenSenseMap API

Direct Uploads 📤

Legacy HTTP uploads (sensor.community/madavi/custom) have been removed. Use MQTT or TTN/LoRaWAN forwarding pipelines for cloud ingestion.

🔧 Development & Building

Requirements 📋

PlatformIO: For ESP32 firmware compilation
Python 3.11+: For build tools and documentation
uv: Modern Python package manager (pip install uv)

Makefile Commands 🛠️

The project uses a Makefile for common tasks:

make setup     # prepare config + docs venv
make build     # build web assets + compile firmware
make flash     # upload firmware
make monitor   # serial console
make docs      # build Sphinx docs
make clean     # clean build artifacts
make release v=1.23.0  # tag + push release (injects VERSION/core.hpp)

More details and additional targets: see docs/source/development.rst.

Project Structure 📁

MultiGeiger/
├── src/                     # ESP32 firmware (C++)
│   ├── app/                 # Application logic
│   ├── comm/                # Communication modules
│   │   ├── wifi/            # WiFi, HTTP, mDNS
│   │   ├── lora/            # LoRaWAN (LMIC)
│   │   └── mqtt/            # MQTT client
│   ├── sensors/             # Geiger tube, BMP280/BME280/BME680
│   └── main.cpp             # Entry point
├── web/                     # Web interface (Single-Page Application)
│   ├── index.html           # SPA entry point (Dashboard + Status + Settings)
│   ├── src/                 # JavaScript/CSS sources
│   │   ├── main.js          # Entry point & initialization
│   │   ├── app.js           # Main application class (MultiGeigerApp)
│   │   └── style.css        # Responsive UI styles
│   ├── public/              # Static assets
│   │   └── mock/api.js      # Mock API for local development
│   ├── vite.config.js       # Vite build configuration
│   └── package.json         # Web dependencies
├── docs/                    # Sphinx documentation
│   ├── source/              # reStructuredText files
│   ├── images/              # Screenshots
│   └── assembly/            # Assembly PDFs
├── tools/                   # Build & data tools
│   ├── ttn_fetcher/         # TTN data downloader
│   │   ├── fetch_ttn_data.py    # CLI tool
│   │   ├── ttn_daemon.py        # Background daemon
│   │   └── README.md        # TTN fetcher docs
│   └── mqtt_logger/         # MQTT to SQLite logger
├── scripts/                 # Helper scripts
│   └── web_to_header.py     # dist/ → gzip Header (genutzt im Makefile)
├── .github/                 # CI/CD workflows
│   └── workflows/
│       └── build.yml        # Automated builds
├── platformio.ini           # PlatformIO configuration
├── Makefile                 # Build automation
└── README.md                # This file

📊 Data Tools

TTN Data Fetcher 📡

Download and archive LoRaWAN uplink data from TTN Storage Integration API:

cd tools/ttn_fetcher

# Install dependencies
pip install -r requirements.txt

# Create config
cp ttn_config.example.json ttn_config.json
nano ttn_config.json  # Add your TTN API credentials

# Fetch data once
python3 fetch_ttn_data.py --config ttn_config.json

# Run as daemon (poll every 5 minutes)
python3 ttn_daemon.py --config ttn_config.json --interval 300

Features:

💾 SQLite database storage with automatic deduplication
📊 Parse decoded payloads (GM counts, CPM, CPS, tube info)
📤 Export to JSON or CSV
🔄 Daemon mode with systemd service support
🔍 Query historical data with SQL

See tools/ttn_fetcher/README.md for full documentation.

MQTT Logger 📝

Log MQTT data to SQLite database:

cd tools/mqtt_logger
cp .env.example .env
nano .env  # Configure MQTT broker
uv sync
uv run mqtt_logger.py

See tools/mqtt_logger/README.md for details.

🛠️ Hardware

Supported Boards 🎛️

Heltec WiFi Kit 32 (recommended)
Heltec Wireless Stick
Generic ESP32 (with modifications)

Required Components 🔩

☢️ Geiger-Müller tube (various types supported: SBM-20, SBM-19, SI-3BG, etc.)
⚡ High voltage generator (400-500V for GM tube)
🌡️ Optional: BMP280/BME280/BME680 environmental sensor (I²C)
- BMP280: Temperature + Pressure only
- BME280: Temperature + Humidity + Pressure
- BME680: Temperature + Humidity + Pressure + Air Quality (Gas)
📡 Optional: LoRa module (SX1276/RFM95W for TTN)

See hardware documentation in docs/hardware/ for schematics and PCB files.

Assembly Guide 📖

Download the detailed assembly instructions (German):

Aufbauanleitung.pdf

📚 Documentation

Online Documentation 🌐

📖 https://multigeiger.readthedocs.org/

Comprehensive documentation with:

🌍 Multi-language support (English + Deutsch) - use the language switcher in the lower right
📌 Versioned docs (latest, stable, specific releases)
🔍 Full-text search
📱 Mobile-optimized

Key Pages 📄

Setup Instructions - WiFi, MQTT, platform configuration
LoRa/TTN Setup - ABP configuration for The Things Network
Deployment Guide - Production setup and troubleshooting
FAQ - Common questions and solutions
Development Guide - Contributing and development setup

Build Locally 🏗️

make docs              # Build with Sphinx
make docs-serve        # Serve at http://localhost:8000

Generated docs: docs/build/html/index.html

🗺️ Community & Resources

🌍 Live Radiation Map: https://multigeiger.citysensor.de/ - Real-time data from deployed sensors
🏗️ Ecocurious Project Page: https://ecocurious.de/projekte/multigeiger-2/ (German)
🎥 Video Tutorials: https://play.wa.binary-kitchen.de/_/global/raw.githubusercontent.com/Friedjof/rc3_2020/main/main.json (German)
💬 Discussion & Support: GitHub Issues and Discussions

🤝 Contributing

Contributions are welcome! 🎉

🐛 Bug Reports: Open an issue with reproduction steps
✨ Feature Requests: Describe your use case
🔧 Pull Requests: Fork, branch, test, and submit

Quality Standards:

✅ Automated CI/CD: GitHub Actions runs builds and tests on all PRs
📝 Documentation: Update docs for user-facing changes
🧪 Testing: Ensure existing functionality works

See .github/README.md for CI/CD details.

📄 License

See LICENSE file for details.

👥 Authors & Credits

See AUTHORS file for contributors.

Made with ❤️ by the Ecocurious community for citizen science and environmental monitoring

Support the project: ⭐ Star this repo | 🐛 Report bugs | 📖 Improve docs | 💡 Share ideas

Name		Name	Last commit message	Last commit date
Latest commit History 780 Commits
.github/workflows		.github/workflows
.tx		.tx
docs		docs
examples/debug		examples/debug
include		include
lib		lib
patches/arduino-esp32		patches/arduino-esp32
scripts		scripts
src		src
test		test
tools		tools
web		web
.astylerc		.astylerc
.bumpversion.cfg		.bumpversion.cfg
.gitignore		.gitignore
.readthedocs.yml		.readthedocs.yml
AUTHORS		AUTHORS
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
VERSION		VERSION
platformio.ini		platformio.ini

License

Friedjof/MultiGeiger

Folders and files

Latest commit

History

Repository files navigation