Upload
Getting OpenMQTTGateway onto your board takes three steps, whichever method you pick:
Choose your installation method
1. Web installer
Choose this if you want the fastest path: flash directly from your browser, nothing to install.
Needs Chrome, Edge or Opera and a data USB cable. Standard configurations only.
2. Ready-to-go binaries
Choose this if you prefer a desktop flashing tool (esptool.py, Espressif Flash Download Tool), or web flashing doesn't work for you.
Same pre-built firmware as the web installer, flashed from your computer.
3. Build from source
Choose this if you need custom pin assignments, module combinations, or credentials embedded at build time.
Needs PlatformIO. Full control over the configuration.
| Web installer | Binaries | From source | |
|---|---|---|---|
| No software to install | ✅ | ❌ | ❌ |
| Custom configuration | ❌ | ❌ | ✅ |
| Difficulty | Easiest | Easy | Advanced |
After flashing: configure your gateway
However you flashed, a freshly installed gateway starts its own WiFi access point (named OpenMQTTGateway or starting with OMG_). Connect to it and the configuration portal lets you set your WiFi network, MQTT broker, and optional security settings — no rebuild needed.
If you build from source you can alternatively embed the network and MQTT settings at build time, so the gateway connects automatically on first boot.
Going further
- Advanced configuration — TLS-secured MQTT connections, certificates, OTA updates.
- Home Assistant integration — auto-discovery is enabled by default; your gateway and sensors appear automatically.
- Gateway configuration — MQTT topic structure and runtime commands per module.
Stuck? Check the troubleshooting page, or ask on the community forum.