f5b33104ef
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>
4.7 KiB
RF gateway (433/315/868/915MHz)
Protocols, modules and library
RTL_433 covers OOK protocols detailed here and supports auto-discovery following Home Assistant convention. The other libraries/modules are more for advanced users.
| Board | Protocols | Assembly/Soldering required |
|---|---|---|
| Heltec LORA V2 433Mhz | RTL_433, receiving only | No |
| LILYGO® LoRa32 V2.1_1.6.1 433 Mhz | RTL_433, receiving only | No |
| ESP32 + SX127X | RTL_433, receiving only | Yes |
| ESP32 + CC1101 | RTL_433, RF(RCSwitch), RF2(KaKu), Pilight | Yes |
| ESP8266 + Basic RF modules (SRX, STX, XD RF, FS1000A | RF(RCSwitch), RF2(KaKu), Pilight | Yes |
| ESP8266 + CC1101 (might have lower range than with SRX/STX above) | RF(RCSwitch), RF2(KaKu), Pilight | Yes |
| ESP32 + Basic RF modules (SRX, STX, XD RF, FS1000A | RF(RCSwitch), RF2(KaKu), Pilight | Yes |
:::tip If you want to try the RTL_433 module with a combination or a board outside of this list, verify that it has an SX1278 or a SX1276 :::
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 |
|---|---|---|---|
| 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, RF(RCSwitch), RF2(KaKu), Pilight | Supported |
| SX1276/SX1278 | 433Mhz Transceiver | RTL_433 | Not Supported |
| LilyGo/Heltec | 433Mhz Transceiver | RTL_433 | Not Supported |
SRX STX Pinout
| Board | Receiver Pin | Emitter Pin |
|---|---|---|
| ESP8266 | D2/D1/D8 | RX/D2 |
| ESP32 | 27/26 | 12 |
| RF BRIDGE | - | - |
| RF BRIDGE DIRECT HACK | 4 | 5 |
| SONOFF RFR3 | 4 | - |
| RF WIFI GATEWAY | 5 | - |
Connect the Emitter and Receiver to a 5V or 3.3V supply source, check datasheet of your modules to confirm (3.3V for CC1101), and the ground of your supply source to the ground of your board.
:::tip With SRX882S receiver connect the CS pin to 3.3V :::
CC1101 Pinout
| Board | Receiver Pin(GDO2) | Emitter Pin(GDO0) | SCK | VCC | MOSI | MISO | CSN | GND |
|---|---|---|---|---|---|---|---|---|
| ESP8266 | D2/D1/D8 | RX/D2 | D5 | 3V3 | D7 | D6 | D8 | GND |
| ESP32 | D27 | D12 | D18 | 3V3 | D23 | D19 | D5 | GND |
To use the CC1101 module, ZradioCC1101 must be uncomment in the User_config.h or added to the build_flags.
More information about the CC1101 wiring.
:::tip Please note that with OMG we are recommending CC1101 GDO2 to be connected to ESP32 D27 and GDO0 to be connected to D12, this is different than the LSatan diagram. This is due to the ESP32 using D2 as part of the boot process.
If you want to use custom SPI pins for the CC1101 module, you can define the following variables in your User_config.h or as build_flags in platformio.ini:
RF_CC1101_SCK: SPI clock pin (SCK)RF_CC1101_SCK: SPI clock pin (SCK)RF_CC1101_MISO: SPI MISO pin (Master In Slave Out)RF_CC1101_MOSI: SPI MOSI pin (Master Out Slave In)RF_CC1101_CS: SPI chip select pin (CSN)
When all these variables are defined, OpenMQTTGateway will use your custom pinout for the CC1101 connection. This is useful if your board does not use the default pins or if you want to avoid conflicts with other devices. :::
ESP32 Hardware setup
ESP8266 Hardware setup
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 that D3 is not working use D1 instead in this case and modify config_RF.h accordingly.
SONOFF RF Bridge Hardware setup
Per default there is no need on modifying the RF Bridge hardware, unless you don't want to use the provided RF controller (EFM8BB1). Indeed if you want to extend the protocols supported by the bridge you can bypass this controller and use the ESP8255 capacities to decode RF Signal. The RF processing can be achieved after the modification by either RF, RF2 or Pilight gateways.
SONOFF RFR3 Hardware setup
Connect GPIO4 of the ESP8255 to the pin D0 of SYN470
WIFI RF GATEWAY Hardware setup
This board doesn't require any hardware modifications.