0 Fork 0

Files

T

f5b33104ef [DOCS] Overhaul new-user onboarding, home page, and upload flow (#2347 )

Getting started:
- New 15-minute Getting Started guide featuring the two most popular
  tracks (BLE on esp32dev-ble, RF on lilygo-rtl_433), with broker setup
  and a verification step
- Sidebar restructured around the new-user journey; upload options
  numbered by ease; Gitpod upload method removed

Home page:
- VitePress hero with clear actions, larger hero image
- How-it-works pipeline diagram shared as a component (responsive via
  container queries), use-case grid, bigger video tiles without the
  image lightbox, refreshed press coverage list, functions pills
- Support section pointing to Theengs Bridge and
  github.com/sponsors/1technophile

Upload flow:
- Decision-oriented upload landing page (journey strip, method cards,
  comparison table)
- Pre-flight checklist and driver troubleshooting on the web installer
- Guided environment picker (bridge + hardware wizard) replacing the
  filter chips, with manifest-verified recommendations
- Post-flash next-steps card linking to the portal and verification

Board images:
- custom_img key in environments.ini and board photos for all
  web-flashable environments (licenses recorded); private prod_env.ini
  environments excluded from boards-info.json

Corrections:
- RF frequency coverage stated as 433/315/868/915MHz
- Removed references to the retired compatible.openmqttgateway.com
  site (BLE list is decoder.theengs.io), the discontinued Theengs
  Plug, and the private sponsor forum


Claude-Session: https://claude.ai/code/session_01TYysQW8tpmt1dWWuzKhTLi

Co-authored-by: Florian <1technophile@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

2026-08-03 10:23:43 -05:00

Upload

Getting OpenMQTTGateway onto your board takes three steps, whichever method you pick:

1 Flash the firmware pick a method below

→

2 Configure WiFi & MQTT through the portal

→

3 Verify gateway appears on your broker & controller

Choose your installation method

Easiest

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.

5.1 KiB Raw Blame History