-### Theengs Plug, BLE gateway and Smart Plug
-
-[Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) brings the following features:
-* BLE to MQTT gateway, tens of [Bluetooth devices](https://decoder.theengs.io/devices/devices.html) supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,
-* Smart plug that can be controlled remotely,
-* Energy consumption monitoring,
-* Device tracker,
-* Presence detection (beta),
-* Local connectivity first.
-
-
-
-
-
+
+
The material and information contained in this documentation is for general information purposes only. You should not rely upon it as a basis for making any business, legal or any other decisions. There is no warranty given on this documentation content; if you decide to follow the information and materials given it is at your own risk.
-Support the project by purchasing the [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) or the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption)
+
diff --git a/docs/participate/quick_start.md b/docs/participate/quick_start.md
index 11c3b19..ea96b94 100644
--- a/docs/participate/quick_start.md
+++ b/docs/participate/quick_start.md
@@ -1,11 +1,13 @@
---
-title: Quick Start to Develop OpenMQTTGateway
+title: Contributor Quick Start
permalink: /participate/quick_start.html
sidebarDepth: 2
lang: en-US
---
-# Quick Start to Develop OpenMQTTGateway
+# Contributor Quick Start
+
+Looking to **use** OpenMQTTGateway rather than develop it? Head to the [Getting Started guide](../getting-started.md) instead.
This document helps a new contributor. Maybe this is your first time with:
diff --git a/docs/participate/support.md b/docs/participate/support.md
index 86cc933..f6501f6 100644
--- a/docs/participate/support.md
+++ b/docs/participate/support.md
@@ -11,12 +11,12 @@ If you like the project, you can help in different ways. Choose what fits you be
- Improve docs or examples if you spot unclear steps.
## Financial support
-- Purchase the [Theengs mobile application](https://app.theengs.io) or the [Theengs plug](https://shop.theengs.io).
+- Purchase the [Theengs mobile application](https://app.theengs.io) or the [Theengs Bridge](https://shop.theengs.io).
- Sponsor the project [developers](https://github.com/1technophile/OpenMQTTGateway/graphs/contributors).
- Make a video or blog article about what you built with [OpenMQTTGateway](https://docs.openmqttgateway.com) and share it.
-Support open-source development through sponsorship and gain exclusive access to our private forum. Your questions, issues, and feature requests receive priority attention, plus you'll see the roadmap early.
+Support open-source development through sponsorship, it helps keep the project healthy and evolving.
-
+
diff --git a/docs/prerequisites/board.md b/docs/prerequisites/board.md
index 6f259ca..9fa7305 100644
--- a/docs/prerequisites/board.md
+++ b/docs/prerequisites/board.md
@@ -6,48 +6,32 @@ aside: false
OpenMQTTGateway is not closed to one board or type of board, by using the power of the Arduino framework and libraries that are cross compatibles it let you many choice of hardware, from an ESP8266 to an ESP32.
+## Which board do I need?
+
+For the most common use cases, the choice is simple:
+
+|I want to...|Recommended board|Extra hardware|
+|-|-|:-:|
+|Bring Bluetooth sensors into my home automation|Any ESP32 development board|None|
+|Receive RF devices โ 433/315/868/915MHz (weather stations, door/PIR sensors...)|LILYGOยฎ LoRa32 V2.1 or Heltec LoRa V2, matching your devices' frequency|None|
+|Send and receive RF remotes and switches (433/315MHz)|ESP32 + SRX882/STX882 or CC1101 modules|[Wiring](../setitup/rf.md)|
+|Control my TV or AC through infrared|ESP32 + IR emitter/receiver|[Wiring](../setitup/ir.md)|
+|Reach far-away sensors with LoRa|LILYGOยฎ LoRa32 or Heltec LoRa board|None|
+|Skip flashing and wiring entirely|[Theengs Bridge](https://shop.theengs.io/), a pre-flashed BLE gateway|None|
+
+::: tip Running on a computer
+If you want to use the BLE decoding capabilities of OpenMQTTGateway with a Raspberry Pi, Windows or Unix PC you can use [Theengs Gateway](https://gateway.theengs.io/), and on a tablet or smartphone the [Theengs App](https://app.theengs.io/).
+:::
+
+## Exploring further
+
Moreover the gateways capacities can be extended with sensors; DHT, HC SR501, ADC, I2C bus, INA226, MQ2, TEMT6000, TSL2561, BME280/BMP280, HTU21D, AHTx0, DS1820
or actuators; LED, relays, PWM.
-::: tip Running on a computer
-If you want to use the BLE decoding capabilities of OpenMQTTGateway with a Raspberry Pi, Windows or Unix PC you can use [Theengs Gateway](https://gateway.theengs.io/).
-:::
-
-::: tip Running on a tablet or phone
-If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use [Theengs App](https://app.theengs.io/).
-:::
-
-[Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerful BLE to MQTT gateway for over [100 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity.
-
-
-
-[Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) is available flashed with OpenMQTTGateway, and brings the functions below:
-* BLE to MQTT gateway, tens of Bluetooth devices supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,
-* Smart plug that can be controlled remotely,
-* Energy consumption monitoring,
-* Device tracker,
-* Presence detection (beta),
-* Local connectivity first.
-
-
-
-Support the project by purchasing the [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) or the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption)
-The plug is available in North America only, other regions are planned.
-
Choosing your board depends heavily on the technologies you want to use with it.
-
The choice between these boards will depend on your knowledge and your requirements in terms of reliability, situation, modules wanted and devices you already have. Use the table below to explore the latest environments.
-
diff --git a/docs/prerequisites/broker.md b/docs/prerequisites/broker.md
index 3d10d9b..3f8c9d9 100644
--- a/docs/prerequisites/broker.md
+++ b/docs/prerequisites/broker.md
@@ -3,6 +3,11 @@ The broker will act as an intermediary between OpenMQTTGateway and your [control
All the events or commands could pass by the broker.
+::: tip Recommended setup
+* **You use Home Assistant**: install the **Mosquitto broker add-on** (Settings โ Add-ons โ Add-on store), enable the MQTT integration, and create a dedicated user for the gateway. This is the path followed by the [Getting Started guide](../getting-started.md).
+* **You don't**: install [Mosquitto](https://mosquitto.org/) on any always-on machine (Raspberry Pi, NAS, server), it is lightweight, open source and well documented.
+:::
+
There are many choices of brokers, here are some of the most popular:
* [Mosquitto](https://mosquitto.org/) (Open source)
* [Moquette](https://moquette-io.github.io/moquette/) (Open source)
diff --git a/docs/prerequisites/devices.md b/docs/prerequisites/devices.md
index 1aefec8..222ccb9 100644
--- a/docs/prerequisites/devices.md
+++ b/docs/prerequisites/devices.md
@@ -1,6 +1,6 @@
# Devices
-Here is an overview of devices supported by OpenMQTTGateway:
+For Bluetooth, the maintained list of supported devices is the [Theengs Decoder compatible devices list](https://decoder.theengs.io/devices/devices.html). For the other technologies, the sections below give an overview of what is supported:
## For radio frequency devices
OpenMQTTGateway can support a wide range of 433mhz/315mhz devices, all the ones with SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527, HS1527 chipsets are supported by the RF gateway. Added to that RF2 support Kaku and Pilight an [huge list](https://wiki.pilight.org/devices).
diff --git a/docs/setitup/actuators.md b/docs/setitup/actuators.md
index b05ce75..87a33a5 100644
--- a/docs/setitup/actuators.md
+++ b/docs/setitup/actuators.md
@@ -1,11 +1,11 @@
# Actuators
## Compatible parts
-|Module|Purpose|Where to Buy|
-|-|-|-|
-|LED|Basic led|-|
-|FASTLED|RGB Leds management|-|
-|BUZZER|-|-|
-|RELAY|Switch power circuit|-|
+|Module|Purpose|
+|-|-|
+|LED|Basic led|
+|FASTLED|RGB Leds management|
+|BUZZER|-|
+|RELAY|Switch power circuit|
## Pinout
|Module| Boards|
diff --git a/docs/setitup/gsm.md b/docs/setitup/gsm.md
index 0d02a05..f472fed 100644
--- a/docs/setitup/gsm.md
+++ b/docs/setitup/gsm.md
@@ -1,10 +1,10 @@
# GSM 2G gateway
## Compatible parts
-|Module|Purpose|Where to Buy|
-|-|-|-|
-|A6|GSM GPRS module|-|
-|A7|GSM GPRS module with GPS|-|
+|Module|Purpose|
+|-|-|
+|A6|GSM GPRS module|
+|A7|GSM GPRS module with GPS|
## Hardware setup
diff --git a/docs/setitup/ir.md b/docs/setitup/ir.md
index a7ab960..ee9f865 100644
--- a/docs/setitup/ir.md
+++ b/docs/setitup/ir.md
@@ -1,12 +1,12 @@
# IR gateway
## Compatible parts
-|Module|Purpose|Where to Buy|
-|-|-|-|
-|IR diode|Emitting|-|
-|IR receiver|Receiving|-|
-|transistor 2N2222|Amplify uC signal for the IR diode|-|
-|330 ohms resistor|-|-|
-|220 ohms resistor|limit current to LED|-|
+|Module|Purpose|
+|-|-|
+|IR diode|Emitting|
+|IR receiver|Receiving|
+|transistor 2N2222|Amplify uC signal for the IR diode|
+|330 ohms resistor|-|
+|220 ohms resistor|limit current to LED|
The IR setup can work with bc547 and a 4x3 LED-Matrix.
diff --git a/docs/setitup/rf.md b/docs/setitup/rf.md
index 5482c36..e4f41b3 100644
--- a/docs/setitup/rf.md
+++ b/docs/setitup/rf.md
@@ -1,4 +1,4 @@
-# RF gateway (433mhz/315mhz)
+# RF gateway (433/315/868/915MHz)
## Protocols, modules and library
@@ -21,13 +21,13 @@ If you want to try the RTL_433 module with a combination or a board outside of t
Heltec LORA V3 is not compatible with RTL_433 library as it is based on an SX1262 module.
## Assembly/soldering required parts
-|Module|Purpose|Compatible modules|Receiver Switching|Where to Buy|
-|-|-|-|-|-|
-|SRX882 or SRX882S (recommended)|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|-|
-|STX882 (recommended)|433Mhz Transmitter|RF(RCSwitch), RF2(KaKu), Pilight|Supported|-|
-|CC1101|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders), RF(RCSwitch), RF2(KaKu), Pilight|Supported|-|
-|SX1276/SX1278|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|-|
-|LilyGo/Heltec|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|-|
+|Module|Purpose|Compatible modules|Receiver Switching|
+|-|-|-|-|
+|SRX882 or SRX882S (recommended)|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|
+|STX882 (recommended)|433Mhz Transmitter|RF(RCSwitch), RF2(KaKu), Pilight|Supported|
+|CC1101|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders), RF(RCSwitch), RF2(KaKu), Pilight|Supported|
+|SX1276/SX1278|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|
+|LilyGo/Heltec|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|
### SRX STX Pinout
|Board| Receiver Pin| Emitter Pin|
@@ -72,9 +72,9 @@ When **all** these variables are defined, OpenMQTTGateway will use your custom p

## ESP8266 Hardware setup
-The default receiver pin is D2 (gpio 4). Avoid D3 (gpio 0): it is a boot strapping pin, a receiver holding it low at reset forces the ESP8266 into flash mode and the board never starts.
+If the gateway works only when serial monitor is connected don't use D3 use D2 instead (gpio 4) and modify config_RF.h accordingly.
-With SRX882 some users reported issues on D2, use D1 instead in this case and modify config_RF.h accordingly.
+With SRX882 some users reported that D3 is not working use D1 instead in this case and modify config_RF.h accordingly.

diff --git a/docs/setitup/sensors.md b/docs/setitup/sensors.md
index e18fb9b..3fc55d0 100644
--- a/docs/setitup/sensors.md
+++ b/docs/setitup/sensors.md
@@ -1,21 +1,21 @@
# Sensors
## Compatible sensors
-|Module|Purpose|Where to Buy|
-|-|-|-|
-|DHT11|Temperature, Humidity|-|
-|DHT22|Temperature, Humidity|-|
-|HCSR501|PIR|-|
-|BH1750|Digital light|-|
-|BME280|Temperature, Humidity, Pressure|-|
-|BMP280|Temperature, Pressure|-|
-|C-37, YL-83, HM-RD|Leak, Water|-|
-|HTU21|Temperature, Humidity|-|
-|GPIO Input|Inputs|-|
-|GPIO KeyCode|Keycode|-|
-|INA226|Current, Voltage|-|
-|MQ2|Gas (flammable)|-|
-|TEMT6000|Luminosity|-|
-|TSL2561|Luminosity|-|
+|Module|Purpose|
+|-|-|
+|DHT11|Temperature, Humidity|
+|DHT22|Temperature, Humidity|
+|HCSR501|PIR|
+|BH1750|Digital light|
+|BME280|Temperature, Humidity, Pressure|
+|BMP280|Temperature, Pressure|
+|C-37, YL-83, HM-RD|Leak, Water|
+|HTU21|Temperature, Humidity|
+|GPIO Input|Inputs|
+|GPIO KeyCode|Keycode|
+|INA226|Current, Voltage|
+|MQ2|Gas (flammable)|
+|TEMT6000|Luminosity|
+|TSL2561|Luminosity|
## Pinout
|Module|Arduino Pin| ESP8266 Pin|ESP32 Pin|
diff --git a/docs/upload/board-selector.md b/docs/upload/board-selector.md
index c4a920c..e31a913 100644
--- a/docs/upload/board-selector.md
+++ b/docs/upload/board-selector.md
@@ -1,3 +1,5 @@
+
+
Board photos courtesy of their manufacturers. ESP32 Feather photo ยฉ Adafruit Industries, CC BY-SA.
diff --git a/docs/upload/gitpod.md b/docs/upload/gitpod.md
deleted file mode 100644
index 4cc9a8a..0000000
--- a/docs/upload/gitpod.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# (Option 4) Build from the web
-
-To build OpenMQTTGateway from the web and download the binary, follow these steps:
-
-1. Use Gitpod by clicking on the link below:
-[https://gitpod.io#https://github.com/1technophile/OpenMQTTGateway/tree/development](https://gitpod.io#https://github.com/1technophile/OpenMQTTGateway/tree/development)
-
-2. This will generate a development environment in your browser and install [platformio](https://platformio.org/) as a build environment.
-
-3. A first build for `esp32dev-ble` will be launched automatically. To modify the environment configuration, go to the environments.ini file in the root folder and launch the command like the one shown at the bottom of the image below:
-`platformio run -e
`
-
-
-
-4. Wait for the server to build the binary. Once you see [SUCCESS], you can go to `.pio/build/` and download `firmware.bin` and `partitions.bin` by right-clicking on each and selecting "Download."
-
-
-5. Finally, follow [Option 2](binaries.md) to upload the binary.
diff --git a/docs/upload/index.md b/docs/upload/index.md
index 7ec95e2..f7b0586 100644
--- a/docs/upload/index.md
+++ b/docs/upload/index.md
@@ -1,79 +1,159 @@
-# Upload
-
-OpenMQTTGateway provides several installation approaches suited for different use cases. The quickest path uses pre-built binaries that work with standard configurations. For custom parameters or specific gateway module combinations, you can build firmware using your development environment. Alternatively, you can flash devices directly from your web browser without installing any software.
-
-
-
-
-
-## Choosing Your Upload Method
-
-### Web-Based Installation
-
-The [web installation](web-install.md) method represents the easiest way to get started with OpenMQTTGateway. You can flash your device directly from your browser without downloading files or installing development tools. This method works on Windows, macOS, and Linux with Chrome, Edge, or Opera browsers.
-
-The web installer displays available environments for different boards and gateway configurations. Select your board type, connect via USB, and click the connect button. The installer handles everything automatically, including erasing old firmware and writing the new one. The web installer uses [ESP Web Tools](https://esphome.github.io/esp-web-tools/) technology to communicate directly with your ESP device.
-
-### Ready-to-Go Binary Installation
-
-[Downloading and installing pre-built binaries](binaries.md) offers control over the flashing process using desktop tools. Download the binary files for your board from the [GitHub releases page](https://github.com/1technophile/OpenMQTTGateway/releases).
-
-For ESP32 devices, you need the firmware binary, bootloader, and boot application partition files written to specific memory addresses. Windows users can use the ESP32 Flash Download Tool from Espressif. On Linux and macOS, the esptool.py command-line utility provides a straightforward upload method.
-
-This method works well for standard configurations without modifying source code. After flashing, you can still configure WiFi, MQTT broker settings, and basic parameters through the configuration portal.
-
-### Custom Build and Upload
-
-[Building from source](builds.md) becomes necessary when you need specific pin assignments, custom MQTT topics, or particular gateway module combinations not available in pre-built binaries.
-
-[PlatformIO](https://platformio.org/) provides the recommended build environment. After downloading the [source code from GitHub](https://github.com/1technophile/OpenMQTTGateway), you will find a `platformio.ini` file defining build environments for various hardware combinations.
-
-The configuration system uses a layering approach where default values from [`User_config.h`](https://github.com/1technophile/OpenMQTTGateway/blob/development/main/User_config.h) and [`config_XX.h`](https://github.com/1technophile/OpenMQTTGateway/tree/development/main) files can be overridden by build flags in `platformio.ini` or `environments.ini`. You can embed WiFi credentials and MQTT settings at build time for automatic connection on first boot.
-
-### Browser-Based Building with Gitpod
-
-For those who want to build custom firmware without setting up a local development environment, [Gitpod](gitpod.md) offers a cloud-based solution. By clicking on the [Gitpod link](https://gitpod.io#https://github.com/1technophile/OpenMQTTGateway/tree/development), you get a complete development environment running in your browser with PlatformIO already installed and configured.
-
-After the automatic initial build completes, modify the environment configuration by editing `environments.ini` and run build commands in the browser terminal. Download the generated firmware files and flash them using the binary installation method.
-
-## Configuring Network and MQTT Settings
-
-After flashing firmware, configure network connectivity and MQTT broker settings using either runtime or build-time approaches.
-
-### Runtime Configuration Portal
-
-When you power on a freshly flashed device, it creates a WiFi access point named OpenMQTTGateway or starting with OMG_. You can find detailed information about the [configuration portal here](portal.md).
-
-Connecting to this access point opens a portal where you configure your WiFi network, MQTT broker details, and optional security settings including TLS encryption and certificates. For devices with Ethernet, access the portal through the LAN IP address and configure WiFi as fallback connectivity.
-
-The portal accepts broker IP addresses or hostnames with mDNS support like homeassistant.local. Set a gateway password to protect future configuration changes, OTA updates, and web interface access.
-
-### Build-Time Configuration
-
-Alternatively, embed network and MQTT settings directly in firmware during the build process. Set parameters in `User_config.h` or add them as build flags in your PlatformIO environment definition. Store sensitive information in a separate `_env.ini` file excluded from version control.
-
-## Advanced Configuration Options
-
-Beyond basic connectivity, OpenMQTTGateway supports several [advanced features](advanced-configuration.md) that enhance security and integration capabilities.
-
-### Secure MQTT Connections
-
-For deployments over the internet or public networks, enable TLS encryption to secure communication between the gateway and MQTT broker. Configure your broker with a valid certificate and obtain the Certificate Authority certificate. The gateway can verify server identity against this certificate or connect with encryption without validation.
-
-Provide the CA certificate at build time in `default_server_cert.h` or paste it into the configuration portal. The gateway supports both self-signed certificates and those from public certificate authorities.
-
-### Home Assistant Auto-Discovery
-
-When you use [Home Assistant](https://www.home-assistant.io/) as your home automation platform, OpenMQTTGateway automatically creates device entries and sensors through Home Assistant's MQTT discovery protocol, enabled by default in all standard builds.
-
-Enable discovery in your Home Assistant MQTT integration settings and create a dedicated MQTT user. The gateway registers itself as a device and creates sensor entities automatically, appearing in Configuration โ Devices section.
-
-### Topic Customization
-
-The gateway publishes messages to MQTT topics following the format `home/OpenMQTTGateway/GATEWAYtoMQTT`. Enable the `valueAsATopic` feature to append received values to the topic path, making topic-based filtering easier and avoiding warnings in certain controllers.
-
-## Next Steps
-
-After successfully uploading firmware and configuring your gateway, you can proceed to configure specific gateway modules for [RF](../setitup/rf.md), [IR](../setitup/ir.md), [Bluetooth](../setitup/ble.md), [LoRa](../setitup/lora.md), or other protocols you want to use. Each module has configuration options adjustable through MQTT commands or the web interface without rebuilding firmware.
-
-The [troubleshooting section](troubleshoot.md) covers common issues, but if you encounter problems not addressed here, the [OpenMQTTGateway community forum](https://community.openmqttgateway.com) provides an active place to ask questions and share solutions with other users.
+# 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
+
+
โ
+
+
+
+## Choose your installation method
+
+
+
+| | 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](portal.md) 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](builds.md), so the gateway connects automatically on first boot.
+
+## Going further
+
+* [Advanced configuration](advanced-configuration.md) โ TLS-secured MQTT connections, certificates, OTA updates.
+* [Home Assistant integration](../integrate/home_assistant.md) โ auto-discovery is enabled by default; your gateway and sensors appear automatically.
+* [Gateway configuration](../use/gateway.md) โ MQTT topic structure and runtime commands per module.
+
+Stuck? Check the [troubleshooting page](troubleshoot.md), or ask on the [community forum](https://community.openmqttgateway.com).
+
+
diff --git a/docs/upload/troubleshoot.md b/docs/upload/troubleshoot.md
index d5c4158..6911009 100644
--- a/docs/upload/troubleshoot.md
+++ b/docs/upload/troubleshoot.md
@@ -1,7 +1,7 @@
# Troubleshooting
## Compilation/build error
-This badge [](https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Amaster+workflow%3ABuild) show you the state of the compilation of the master and this one [](https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Adevelopment+workflow%3ABuild) for the development branch.
+This badge [](https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Adevelopment+workflow%3ABuild) show you the state of the compilation of the development branch, from which the releases are made.
If you see a green badge this means that the code compilation is OK with the configuration given in the `docs/platformio.ini`.
Check your environment, boards , libraries before submitting an issue or a question.
diff --git a/docs/upload/web-install.md b/docs/upload/web-install.md
index fc0e8c8..56a28d6 100644
--- a/docs/upload/web-install.md
+++ b/docs/upload/web-install.md
@@ -2,6 +2,27 @@
aside: false
---
+# (Option 1) Upload from the web
+
+This is the easiest way to install OpenMQTTGateway: no software to download, no development environment.
+
+## Before you flash
+
+* Use a **data** USB cable โ many cables are charge-only and the board won't show up with one.
+* Use **Chrome, Edge or Opera** โ Firefox and Safari don't support web flashing.
+* Most boards need a **USB serial driver**. Recent operating systems often include it; if your board doesn't appear in the port list, see below.
+
+::: details My board doesn't show up in the port list
+1. Try another USB cable (data, not charge-only) and another USB port.
+2. Install the driver matching your board's USB chip (check the board's product page if unsure):
+ * **CP210x** (Silicon Labs): [driver download](https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers)
+ * **CH340 / CH341** (WCH): [driver download](https://www.wch-ic.com/downloads/CH341SER_ZIP.html)
+ * **CH9102** (WCH): [macOS driver](https://github.com/WCHSoftGroup/ch34xser_macos), [Windows driver](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
+3. On macOS, complete the driver installation by confirming it in the **Security** section of **System Preferences**, then restart. For a LilyGo LoRa32 V2.1 board, the correct port to select is `/dev/cu.wchusbserialXXXXXXXXXXX`.
+4. Some boards need the **BOOT** button held down while plugging in the cable to enter flash mode.
+5. On Linux, add your user to the `dialout` group (`sudo usermod -a -G dialout $USER`) and log in again.
+:::
+
## Select your firmware
To upload firmware to your ESP device directly from this page, first connect your ESP device to a USB port on your computer. Then, choose the appropriate firmware from the available options. Next, click the **Connect** button and select the USB port where your ESP is plugged in. Wait for the upload process to finish. After the upload completes, you can set up your [WiFi and MQTT credentials](portal.md).
@@ -10,25 +31,15 @@ To upload firmware to your ESP device directly from this page, first connect you
selectorPath="/upload/board-selector.html"
/>
+Board photos courtesy of their manufacturers. ESP32 Feather photo ยฉ Adafruit Industries, CC BY-SA.
+
::: tip Running on a tablet or phone
If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use [Theengs App](https://app.theengs.io/).
:::
-::: warning Note
-If you are on macOS and have a LilyGo LoRa32 V2.1 board, make sure you have the [correct driver for the CH9102 Serial Chip](https://github.com/WCHSoftGroup/ch34xser_macos) installed and selected in the popup when initiating the web install.
-To finalise the driver installation don't forget the confirmation in the **Security** section of **System Preferences** after the restart.
-The correct driver to then select in the popup of this web install is
-`/dev/cu.wchusbserialXXXXXXXXXXX`
-:::
+## Next step
-
-
-## Using OpenMQTTGateway ?
-Support open-source development through sponsorship and gain exclusive access to our private forum. Your questions, issues, and feature requests will receive priority attention, plus you'll gain insider access to our roadmap.
-
-
-
-
+Once the upload is complete, connect the gateway to your WiFi network and MQTT broker through the [configuration portal](portal.md).
diff --git a/docsgen/boards-info.js b/docsgen/boards-info.js
index 72717b9..ce52d05 100644
--- a/docsgen/boards-info.js
+++ b/docsgen/boards-info.js
@@ -214,11 +214,27 @@ function collectBoardsInformations(sections, { includeTests = false } = {}) {
return rows;
}
+// pio project config resolves extra_configs, which pulls in user-specific
+// files like prod_env.ini; only environments declared in environments.ini
+// belong in the published boards list.
+function publicEnvironmentNames() {
+ const fs = require('fs');
+ const path = require('path');
+ const ini = fs.readFileSync(path.resolve(__dirname, '..', 'environments.ini'), 'utf8');
+ const names = new Set();
+ for (const match of ini.matchAll(/^\[env:([^\]]+)\]/gm)) {
+ names.add(match[1].trim());
+ }
+ return names;
+}
+
function loadBoardsInfo(options = {}) {
const { includeTests = false } = options;
const config = rowConfigFromPlatformIO();
const sections = convertJsonToSections(config);
- return collectBoardsInformations(sections, { includeTests });
+ const rows = collectBoardsInformations(sections, { includeTests });
+ const publicEnvs = publicEnvironmentNames();
+ return rows.filter(row => publicEnvs.has(row.Environment));
}
function ensureDir(dir) {
diff --git a/environments.ini b/environments.ini
index 845cbbf..979d70a 100644
--- a/environments.ini
+++ b/environments.ini
@@ -24,6 +24,7 @@ board_build.ldscript = eagle.flash.1m64.ld ;this frees more space for firmware u
;extra_scripts = scripts/compressFirmware.py ;uncomment this to compress the firmware. This helps updating e.g. Sonoff RF Bridge via OTA flash by saving space for the uploaded firmware.
custom_description = RF gateway for the Sonoff RF Bridge relying on the internal decoder
custom_hardware = RFBridge v1
+custom_img = img/boards/sonoff-rf-bridge.jpg
[env:rfbridge-direct]
platform = ${com.esp8266_platform}
@@ -48,6 +49,7 @@ board_build.ldscript = eagle.flash.1m64.ld ;this frees more space for firmware u
;extra_scripts = scripts/compressFirmware.py ;uncomment this to compress the firmware. This helps updating e.g. Sonoff RF Bridge via OTA flash by saving space for the uploaded firmware.
custom_description = 'RF gateway for the Sonoff RF Bridge requiring direct hack, relying on ESPilight library, tutorial.'
custom_hardware = RFBridge v1
+custom_img = img/boards/sonoff-rf-bridge.jpg
[env:theengs-bridge]
platform = ${com.esp32_platform}
@@ -88,6 +90,7 @@ build_flags =
'-mfix-esp32-psram-cache-strategy=memw'
custom_description = 'BLE gateway with external antenna and Ethernet/WiFi connectivity, user guide'
custom_hardware = Theengs Bridge gateway ethernet
+custom_img = img/Theengs-Bridge-ble-gateway.png
[env:theengs-bridge-v11]
platform = ${com.esp32_platform}
@@ -289,6 +292,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_RF"'
'-DvalueAsATopic=true'
custom_description = RF gateway using RCSwitch library
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-pilight]
platform = ${com.esp32_platform}
@@ -306,6 +310,7 @@ build_flags =
'-DZgatewayPilight="Pilight"'
'-DGateway_Name="OMG_ESP32_Pilight"'
custom_description = RF gateway using ESPilight library
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-pilight-cc1101]
platform = ${com.esp32_platform}
@@ -325,6 +330,7 @@ build_flags =
'-DZradioCC1101="CC1101"'
'-DGateway_Name="OMG_ESP32_Pilight-CC1101"'
custom_description = Gateway using ESPilight library only, need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-somfy-cc1101]
platform = ${com.esp32_platform}
@@ -341,6 +347,7 @@ build_flags =
'-DZradioCC1101="CC1101"'
'-DGateway_Name="OMG_ESP32_Somfy-CC1101"'
custom_description = Gateway using Somfy Remote library, need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-pilight-somfy-cc1101]
platform = ${com.esp32_platform}
@@ -362,6 +369,7 @@ build_flags =
'-DZradioCC1101="CC1101"'
'-DGateway_Name="OMG_ESP32_Pilight-Somfy-CC1101"'
custom_description = Gateway using Somfy Remote and ESPilight library, need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-weatherstation]
platform = ${com.esp32_platform}
@@ -376,6 +384,7 @@ build_flags =
'-DZgatewayWeatherStation="WeatherStation"'
'-DGateway_Name="OMG_ESP32_WeatherStation"'
custom_description = Gateway to retrieve weather station data Ventus W174/W132 (tested), Auriol H13726, Hama EWS 1500, Meteoscan W155/W160 using WeatherStationDataRx
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-gf-sun-inverter]
platform = ${com.esp32_platform}
@@ -391,6 +400,7 @@ build_flags =
'-DZgatewayGFSunInverter="GFSunInverter"'
'-DGateway_Name="OMG_ESP32_GFSunInverter"'
custom_description = RS232 reading of GridFree Sun Inverter
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-ir]
platform = ${com.esp32_platform}
@@ -405,6 +415,7 @@ build_flags =
'-DZgatewayIR="IR"'
'-DGateway_Name="OMG_ESP32_IR"'
custom_description = Infrared (Emitting and receiving) using IRremoteESP8266
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-ble]
platform = ${com.esp32_platform}
@@ -422,6 +433,7 @@ build_flags =
'-DLED_PIN_ON=0'
'-DGateway_Name="OMG_ESP32_BLE"'
custom_description = Regular BLE gateway with adaptive scanning activated, automatically adapts the scan parameters depending on your devices
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-ble-broker]
platform = ${com.esp32_platform}
@@ -440,6 +452,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_BLE"'
'-DMQTT_BROKER_MODE=true'
custom_description = MQTT Broker with BLE gateway with adaptive scanning activated, automatically adapts the scan parameters depending on your devices
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-ble-mqtt-undecoded]
platform = ${com.esp32_platform}
@@ -458,6 +471,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_BLE"'
'-DMQTTDecodeTopic="undecoded"'
custom_description = BLE gateway with the decoding offloaded to Theengs Gateway
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-ble-aws]
platform = ${com.esp32_platform}
@@ -484,6 +498,7 @@ build_flags =
'-DMQTT_PASS=""'
'-DAWS_IOT=true'
custom_description = BLE gateway with AWS integration capability
+custom_img = img/boards/esp32dev.jpg
[env:esp32feather-ble]
platform = ${com.esp32_platform}
@@ -502,6 +517,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_FTH_BLE"'
custom_description = BLE Gateway
custom_hardware = ESP32 Feather Adafruit
+custom_img = img/boards/esp32-feather.jpg
[env:esp32-lolin32lite-ble]
platform = ${com.esp32_platform}
@@ -532,6 +548,7 @@ build_flags =
; '-Dwifi_password="WIFI_PASSWORD"'
custom_description = 'Suitable for low power with BLE gateway, tutorial'
custom_hardware = LOLIN 32 Lite
+custom_img = img/boards/lolin32-lite.jpg
[env:esp32-olimex-gtw-ble-eth]
platform = ${com.esp32_platform}
@@ -552,6 +569,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_OLM_GTWE"'
custom_description = BLE gateway using ethernet or wifi
custom_hardware = OLIMEX ESP32 Gateway
+custom_img = img/boards/olimex-esp32-gateway.jpg
[env:esp32-olimex-gtw-ble-poe]
platform = ${com.esp32_platform}
@@ -569,6 +587,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_OLM_POE"'
custom_description = BLE gateway using ethernet, need to be configured through PIO
custom_hardware = OLIMEX ESP32 Gateway with POE
+custom_img = img/boards/olimex-esp32-poe.jpg
[env:esp32-olimex-gtw-ble-poe-iso]
platform = ${com.esp32_platform}
@@ -586,6 +605,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_OLM_POE"'
custom_description = BLE gateway using ethernet, need to be configured through PIO
custom_hardware = OLIMEX ESP32 Gateway with POE and ISO
+custom_img = img/boards/olimex-esp32-poe-iso.jpg
[env:esp32-wt32-eth01-ble-eth]
platform = ${com.esp32_platform}
@@ -606,6 +626,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_WT32-ETH01"'
custom_description = BLE gateway using ethernet, need to be configured through PIO
custom_hardware = WT32
+custom_img = img/boards/wt32-eth01.jpg
[env:esp32-olimex-gtw-ble-wifi]
platform = ${com.esp32_platform}
@@ -625,6 +646,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_OLM_GTWW"'
custom_description = BLE gateway using wifi
custom_hardware = OLIMEX ESP32 Gateway
+custom_img = img/boards/olimex-esp32-gateway.jpg
[env:esp32-m5stick-ble]
platform = espressif32@6.1.0
@@ -648,6 +670,7 @@ build_flags =
board_upload.speed = 921600
custom_description = Expandable module with BLE gateway, display, and little IR emitter
custom_hardware = M5Stick Grey
+custom_img = img/boards/m5stick.webp
[env:esp32-m5stack-ble]
platform = espressif32@6.1.0
@@ -672,6 +695,7 @@ build_flags =
board_upload.speed = 921600
custom_description = Expandable module with BLE gateway and display
custom_hardware = M5Stack Core
+custom_img = img/boards/m5stack-core.webp
[env:esp32-m5tough-ble]
platform = espressif32@6.1.0
@@ -690,6 +714,7 @@ build_flags =
board_upload.speed = 921600
custom_description = Expandable module with BLE gateway and display, suitable for outdoor
custom_hardware = M5Tough rugged
+custom_img = img/boards/m5tough.webp
[env:esp32-m5stick-c-ble]
platform = espressif32@6.1.0
@@ -720,6 +745,7 @@ build_flags =
board_upload.speed = 1500000
custom_description = Expandable module with BLE gateway, display, and little IR emitter
custom_hardware = M5Stick C
+custom_img = img/boards/m5stick-c.webp
[env:esp32-m5stick-cp-ble]
platform = espressif32@6.1.0
@@ -750,6 +776,7 @@ build_flags =
board_upload.speed = 1500000
custom_description = Expandable module with BLE gateway, display, and little IR emitter
custom_hardware = M5Stick CP
+custom_img = img/boards/m5stick-c-plus.webp
[env:esp32-m5atom-matrix]
platform = ${com.esp32_platform}
@@ -781,6 +808,7 @@ build_flags =
board_upload.speed = 1500000
custom_description = Compact enclosure ESP32 with BLE gateway
custom_hardware = M5 ATOM Matrix
+custom_img = img/boards/m5atom-matrix.webp
[env:esp32-m5atom-lite]
platform = ${com.esp32_platform}
@@ -807,6 +835,7 @@ build_flags =
board_upload.speed = 1500000
custom_description = Compact enclosure ESP32 with BLE gateway
custom_hardware = M5 ATOM Lite
+custom_img = img/boards/m5atom-lite.webp
[env:esp32doitv1-aithinker-r01-sx1278]
platform = espressif32@6.1.0
@@ -858,6 +887,7 @@ board_upload.speed = 921600
board_upload.port = /dev/cu.usbserial-0001
board_monitor.speed = 921600
board_monitor.port = /dev/cu.usbserial-0001
+custom_img = img/boards/esp32doitv1.jpg
[env:esp32doitv1-aithinker-r01-sx1278-hcsr501-test]
extends = env:esp32doitv1-aithinker-r01-sx1278
@@ -926,6 +956,7 @@ build_flags =
; '-DRADIOLIB_DEBUG=true'
; '-DRADIOLIB_VERBOSE=true'
custom_description = Gateway using RTL_433_ESP library, need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-rtl_433-fsk]
platform = espressif32@6.1.0
@@ -970,6 +1001,7 @@ build_flags =
; '-DRADIOLIB_DEBUG=true'
; '-DRADIOLIB_VERBOSE=true'
custom_description = Gateway using RTL_433_ESP library and RadioLib with FSK modulation (beta), need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:heltec-rtl_433]
platform = espressif32@6.1.0
@@ -999,6 +1031,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = Gateway using RTL_433_ESP and RadioLib
custom_hardware = ESP32 HELTEC LORA32 V2
+custom_img = img/boards/heltec-wifi-lora-32.png
[env:heltec-rtl_433-fsk]
platform = espressif32@6.1.0
@@ -1032,6 +1065,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = Gateway using RTL_433_ESP and RadioLib with FSK modulation (beta)
custom_hardware = ESP32 HELTEC LORA32 V2
+custom_img = img/boards/heltec-wifi-lora-32.png
[env:heltec-ble]
platform = ${com.esp32_platform}
@@ -1057,6 +1091,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = Heltec BLE gateway with adaptive scanning activated, automatically adapts the scan parameters depending on your devices
custom_hardware = ESP32 HELTEC LORA32 V2
+custom_img = img/boards/heltec-wifi-lora-32.png
[env:lilygo-rtl_433]
platform = espressif32@6.1.0
@@ -1086,6 +1121,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = For ESP32, Gateway using RTL_433_ESP and RadioLib
custom_hardware = ESP32 LILYGO LoRa32 V2.1
+custom_img = img/boards/lilygo-lora32-v21.jpg
[env:lilygo-rtl_433-fsk]
platform = espressif32@6.1.0
@@ -1119,6 +1155,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = For ESP32, Gateway using RTL_433_ESP and RadioLib with FSK modulation (beta)
custom_hardware = ESP32 LILYGO LoRa32 V2.1
+custom_img = img/boards/lilygo-lora32-v21.jpg
[env:lilygo-t3-s3-rtl_433]
platform = espressif32@6.10.0
@@ -1165,6 +1202,7 @@ build_flags =
'-DRF_MODULE_DIO5=36'
custom_description = For ESP32, Gateway using RTL_433_ESP and RadioLib with FSK modulation (beta)
custom_hardware = ESP32 LILYGO T3-S3 SX1276 v1.0
+custom_img = img/boards/lilygo-t3-s3.jpg
[env:lilygo-t3-s3-rtl_433-fsk]
platform = espressif32@6.10.0
@@ -1215,6 +1253,7 @@ build_flags =
'-DRF_MODULE_DIO5=36'
custom_description = For ESP32, Gateway using RTL_433_ESP and RadioLib with FSK modulation (beta)
custom_hardware = ESP32 LILYGO T3-S3 SX1276 v1.0
+custom_img = img/boards/lilygo-t3-s3.jpg
[env:lilygo-ble]
platform = ${com.esp32_platform}
@@ -1240,6 +1279,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = LilyGo BLE gateway with adaptive scanning activated, automatically adapts the scan parameters depending on your devices
custom_hardware = ESP32 LILYGO LoRa32 V2.1
+custom_img = img/boards/lilygo-lora32-v21.jpg
[env:esp32dev-multi_receiver]
platform = espressif32@6.1.0
@@ -1266,6 +1306,7 @@ build_flags =
'-DRF_MODULE_GDO2=27' ; CC1101 pin GDO2
; '-DRF_MODULE_INIT_STATUS=true' ; Display transceiver config during startup
custom_description = Multi RF library with the possibility to switch between RTL_433_ESP, NewRemoteSwitch and RCSwitch, need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:esp32dev-multi_receiver-pilight]
platform = ${com.esp32_platform}
@@ -1296,6 +1337,7 @@ build_flags =
'-DRF_MODULE_GDO2=27' ; CC1101 pin GDO2
; '-DRF_MODULE_INIT_STATUS=true' ; Display transceiver config during startup
custom_description = Multi RF library with the possibility to switch between ESPilight, NewRemoteSwitch and RCSwitch, need CC1101
+custom_img = img/boards/esp32dev.jpg
[env:tinypico-ble]
platform = ${com.esp32_platform}
@@ -1313,6 +1355,7 @@ build_flags =
board_build.flash_mode = dio
custom_description = BLE gateway
custom_hardware = ESP32 TinyPICO
+custom_img = img/boards/tinypico.jpg
[env:ttgo-lora32-v1]
platform = ${com.esp32_platform}
@@ -1335,6 +1378,7 @@ build_flags =
'-DGateway_Name="OMG_ESP32_LORA"'
custom_description = LORA communication using arduino-LoRA configurable frequency
custom_hardware= ESP32 TTGO LORA V1
+custom_img = img/boards/ttgo-lora32-v1.jpg
[env:ttgo-lora32-v21]
platform = ${com.esp32_platform}
@@ -1362,6 +1406,7 @@ build_flags =
; '-DDISPLAY_METRIC=false'
custom_description = For ESP32, Gateway using LORA
custom_hardware = ESP32 LILYGO LoRa32 V2.1
+custom_img = img/boards/lilygo-lora32-v21.jpg
[env:ttgo-t-beam]
# See version pinout differences here
@@ -1394,6 +1439,7 @@ build_flags =
'-DTimeBetweenReadingADC=60000'
custom_description = BLE gateway with battery holder
custom_hardware = TTGO T BEAM
+custom_img = img/boards/ttgo-t-beam.jpg
[env:heltec-wifi-lora-32] ; Heltec ESP32 Board with SSD1306 display
platform = ${com.esp32_platform}
@@ -1425,6 +1471,7 @@ custom_description = LORA communication using arduino-LoRA
custom_hardware = ESP32 HELTEC LORA32
; For testing only, not for production use
+custom_img = img/boards/heltec-wifi-lora-32.png
[env:shelly-plus1]
platform = ${com.esp32_solo_platform}
board = esp32-solo1
@@ -1457,6 +1504,7 @@ build_flags =
'-DGATEWAY_MODEL="SPLUS1"'
custom_description = BLE, Relay control, Switch
custom_hardware = Shelly Plus 1
+custom_img = img/boards/shelly-plus1.jpg
[env:nodemcuv2-all-test]
platform = ${com.esp8266_platform}
@@ -1545,6 +1593,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_2G"'
board_build.flash_mode = dout
custom_description = SMS gateway, need A6/A7 GSM module
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-ir]
platform = ${com.esp8266_platform}
@@ -1560,6 +1609,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_IR"'
board_build.flash_mode = dout
custom_description = Infrared gateway using IRremoteESP8266
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-serial]
platform = ${com.esp8266_platform}
@@ -1574,6 +1624,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_SERIAL"'
board_build.flash_mode = dout
custom_description = SERIAL gateway
+custom_img = img/boards/nodemcuv2.jpg
[env:avatto-bakeey-ir]
platform = ${com.esp8266_platform}
@@ -1614,6 +1665,7 @@ build_flags =
'-DvalueAsATopic=true'
board_build.flash_mode = dout
custom_description = The historic RF gateway using RCSwitch library
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-rf-cc1101]
platform = ${com.esp8266_platform}
@@ -1632,6 +1684,7 @@ build_flags =
'-DvalueAsATopic=true'
board_build.flash_mode = dout
custom_description = RF gateway using RCSwitch library with CC1101
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-somfy-cc1101]
platform = ${com.esp8266_platform}
@@ -1649,6 +1702,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_Somfy-CC1101"'
board_build.flash_mode = dout
custom_description = Somfy RF gateway using Somfy Remote library, need CC1101
+custom_img = img/boards/nodemcuv2.jpg
[env:manual-wifi-test]
platform = ${com.esp8266_platform}
@@ -1696,6 +1750,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_RF2"'
board_build.flash_mode = dout
custom_description = KAKU RF gateway using NewRemoteSwitch library
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-rf2-cc1101]
platform = ${com.esp8266_platform}
@@ -1713,6 +1768,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_RF2-CC1101"'
board_build.flash_mode = dout
custom_description = KAKU RF gateway using NewRemoteSwitch library, need CC1101
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-pilight]
platform = ${com.esp8266_platform}
@@ -1729,6 +1785,7 @@ build_flags =
'-fcommon'
board_build.flash_mode = dout
custom_description = Gateway using ESPilight without the need of CC1101
+custom_img = img/boards/nodemcuv2.jpg
[env:nodemcuv2-weatherstation]
platform = ${com.esp8266_platform}
@@ -1744,6 +1801,7 @@ build_flags =
'-DGateway_Name="OMG_ESP8266_RF3"'
board_build.flash_mode = dout
custom_description = RF gateway using WeatherStationDataRx library
+custom_img = img/boards/nodemcuv2.jpg
[env:sonoff-basic]
platform = ${com.esp8266_platform}
@@ -1766,6 +1824,7 @@ build_flags =
board_build.flash_mode = dout
custom_description = Basic Sonoff wifi relay
custom_hardware = Sonoff Basic R1, R2
+custom_img = img/boards/sonoff-basic.jpg
[env:sonoff-basic-rfr3]
platform = ${com.esp8266_platform}
@@ -1791,6 +1850,7 @@ build_flags =
board_build.flash_mode = dout
custom_description = 'Wifi relay and RF receiver using RCSwitch library, tutorial'
custom_hardware = 'Sonoff Basic RFR3, tutorial'
+custom_img = img/boards/sonoff-rfr3.jpg
[env:esp32dev-ble-datatest]
platform = ${com.esp32_platform}
@@ -1812,6 +1872,7 @@ build_flags =
'-DpubBLEAdvData=true'
'-DGateway_Name="OMG_ESP32_BLE"'
custom_description = Default BLE gateway with additional servicedata, manufacturerdata and service uuid for analysing decoding issues
+custom_img = img/boards/esp32dev.jpg
[env:esp32s3-dev-c1-ble]
platform = ${com.esp32_platform}
@@ -1831,6 +1892,7 @@ build_flags =
'-DNO_INT_TEMP_READING=true' ; Internal temperature reading not building on ESP32 C3 or S3
'-DGateway_Name="OMG_ESP32_BLE"'
custom_description = BLE gateway on the S3
+custom_img = img/boards/esp32s3-devkit-c1.png
[env:esp32s3-m5stack-stamps3]
platform = ${com.esp32_platform}
@@ -1850,6 +1912,7 @@ build_flags =
'-DNO_INT_TEMP_READING=true' ; Internal temperature reading not building on ESP32 C3 or S3
'-DGateway_Name="OMG_ESP32_BLE"'
custom_description = BLE gateway on the M5Stack StampS3
+custom_img = img/boards/m5stamp-s3.webp
[env:esp32s3-atomS3U]
platform = ${com.esp32_platform}
@@ -1875,6 +1938,7 @@ build_flags =
board_upload.speed = 921600
custom_description = USB module with BLE gateway, and IR emitter
custom_hardware = AtomS3U ESP32S3
+custom_img = img/boards/m5atoms3u.webp
[env:esp32c3-dev-m1-ble]
platform = ${com.esp32_platform}
@@ -1895,6 +1959,7 @@ build_flags =
'-DNO_INT_TEMP_READING=true' ; Internal temperature reading not building on ESP32 C3 or S3
'-DGateway_Name="OMG_ESP32_BLE"'
custom_description = BLE gateway on the C3
+custom_img = img/boards/esp32c3-devkit-m1.png
[env:airm2m_core_esp32c3]
platform = ${com.esp32_platform}
@@ -1916,6 +1981,7 @@ custom_description = BLE gateway on the C3
custom_hardware = AirM2M ESP32C3-CORE
; Espressiv ESP32-C3-DevKitC-02
+custom_img = img/boards/airm2m.png
[env:esp32c3-dev-c2-ble]
platform = ${com.esp32_platform}
platform_packages = ${com.esp32_platform_packages}
@@ -1938,6 +2004,7 @@ build_flags =
'-DTRIGGER_GPIO=7'
'-DGateway_Name="OpenMQTTGateway_ESP32C3_DKC02"'
custom_description = BLE gateway on Espressiv ESP32-C3-DevKitC-02
+custom_img = img/boards/esp32c3-devkit-c02.png
[env:esp32c3-dev-c2-ble-no-serial]
extends = env:esp32c3-dev-c2-ble
@@ -1948,6 +2015,7 @@ build_flags =
custom_description = BLE gateway on Espressiv ESP32-C3-DevKitC-02 without logging
; Wemos Lolin C3 mini v2.1.0
+custom_img = img/boards/esp32c3-devkit-c02.png
[env:esp32c3_lolin_mini]
platform = ${com.esp32_platform}
platform_packages = ${com.esp32_platform_packages}
@@ -1978,6 +2046,7 @@ build_flags =
'-DWM_DEBUG=0' ; disable serial logging.
custom_description = BLE gateway on ESP32C3
custom_hardware = Wemos Lolin C3 mini v2.1.0
+custom_img = img/boards/lolin-c3-mini.jpg
[env:esp32c3_lolin_mini_with_serial]
extends = env:esp32c3_lolin_mini
@@ -1987,6 +2056,7 @@ build_flags =
; Serial output via USB
'-DCONFIG_ESP_CONSOLE_USB_SERIAL_JTAG=true'
'-DCONFIG_ESP_CONSOLE_UART=ESP_CONSOLE_USB_SERIAL_JTAG'
+custom_img = img/boards/lolin-c3-mini.jpg
[env:esp32c3-m5stamp]
; https://docs.m5stack.com/en/core/stamp_c3
@@ -2011,6 +2081,7 @@ build_flags =
'-DUSE_MAC_AS_GATEWAY_NAME'
custom_description = BLE gateway on ESP32C3
custom_hardware = M5Stamp C3
+custom_img = img/boards/m5stamp-c3.webp
[env:esp32c3u-m5stamp]
; https://docs.m5stack.com/en/core/stamp_c3u
@@ -2035,6 +2106,7 @@ build_flags =
'-DUSE_MAC_AS_GATEWAY_NAME'
custom_description = BLE gateway on ESP32C3
custom_hardware = M5Stamp C3U
+custom_img = img/boards/m5stamp-c3u.webp
[env:thingpulse-espgateway]
platform = ${com.esp32_platform}
@@ -2069,6 +2141,7 @@ build_flags =
; '-DsimplePublishing=true'
custom_description = BLE Gateway using ethernet or wifi with external antenna
custom_hardware = ThingPulse gateway single ESP32
+custom_img = img/boards/thingpulse-espgateway.jpg
[env:esp32dev-ble-idf]
platform = ${com.esp32_platform}
@@ -2095,3 +2168,4 @@ build_flags =
'-DUSE_BLUFI=1'
'-DenableMultiGTWSync=false'
custom_description = Regular BLE gateway based on esp-idf with adaptive scanning activated, automatically adapts the scan parameters depending on your devices
+custom_img = img/boards/esp32dev.jpg