98481c5145
* Refactor GitHub Actions workflows for build, documentation, and linting - Consolidated build logic into reusable workflows (`task-build.yml` and `task-docs.yml`) to reduce duplication across multiple workflows. - Introduced `environments.json` to centralize the list of PlatformIO build environments, improving maintainability and clarity. - Updated `build.yml` and `build_and_docs_to_dev.yml` to utilize the new reusable workflows and environment definitions. - Enhanced `release.yml` to streamline the release process and integrate documentation generation. - Created reusable linting workflow (`task-lint.yml`) to standardize code formatting checks across the repository. - Simplified manual documentation workflow by leveraging the new reusable documentation workflow. - Improved artifact management and retention policies across workflows. - Updated dependencies and versions in workflows to ensure compatibility and performance. CI/CD pipeline agnostic of Workflow Engine and integrated on github actions - Implemented ci.sh for orchestrating the complete build pipeline. - Created ci_00_config.sh for centralized configuration of build scripts. - Created ci_build_firmware.sh for building firmware for specified PlatformIO environments. - Created ci_prepare_artifacts.sh for preparing firmware artifacts for upload or deployment. - Created ci_set_version.sh for updating version tags in firmware configuration files. - Created ci_build.sh to orchestrate the complete build pipeline. - Created ci_qa.sh for code linting and formatting checks using clang-format. - Created ci_site.sh for building and deploying VuePress documentation with version management. - Implemented checks for required tools and dependencies in the new scripts. - Improved internal scripts for better error handling and logging. UPDATE the web installer manifest generation and update documentation structure - Enhanced ci_list-env.sh to list environments from a JSON file. - Replaced common_wu.py and gen_wu.py scripts with new npm scripts for site generation and previewing on docsgen/gen_wu.js - Replaced generate_board_docs.py with docsgen/generated_board_docs.js - Added new npm scripts for integration of site generation on build phase. - Created preview_site.js to serve locally generated site over HTTPS with improved error handling. - Added new CI environments for CI builds in environments.json. - Deleted lint.yml as part of workflow cleanup. - Enhanced task-build.yml to include linting as a job and added support for specifying PlatformIO version. - Improved task-docs.yml to handle versioning more effectively and added clean option. Enhance documentation - ADD CLEAR Mark of development version of site - Updated README.md to include detailed workflow dependencies and relationships using mermaid diagrams. - Improved development.md with a quick checklist for contributors and clarified the code style guide. - Enhanced quick_start.md with tips for contributors and streamlined the workflow explanation. LINT FIX - Refined User_config.h for better formatting consistency. - Adjusted blufi.cpp and gatewayBT.cpp for improved code readability and consistency in formatting. - Updated gatewaySERIAL.cpp and mqttDiscovery.cpp to enhance logging error messages. - Improved sensorDS1820.cpp for better logging of device information. Add security scan workflows for vulnerability detection Add SBOM generation and upload to release workflow; update security scan summary handling Add shellcheck suppor + FIX shellcheck warning Enhance documentation for CI/CD scripts and workflows, adding details for security scanning and SBOM generation processes Fix formatting and alignment in BLE connection handling Reviewed the full web board presentation and the ESP32 web upload. The project uses a modern pattern where data is divided from the presentation layer. - Removed the `generate_board_docs` script. - Updated the `gen_wu` script in order to generate `boards-info.json`: the fail that containe all information about the configuration - Created and isolate the file `boards-info.js` to streamline the parsing of PlatformIO dependencies, modules, environments and improve the handling of library information. - Introduced vuepress component `BoardEnvironmentTable.vue` that render `boards-info.json` as UI card component - Introduced vuepress component `FlashEnvironmentSelector.vue` that render a selectred environment from `boards-info.json` and provide esp-web-upload feature on it - Introduced a new board page `board-selector.md` for improved firmware selection. - Updated `web-install.md` to enhance the firmware upload process, including a new board environment table. - Enhanced custom descriptions in `environments.ini` to include HTML links for better user guidance and board image link Add CC1101 initialization improvements and logging enhancements Add installation step for PlatformIO dependencies in documentation workflow Remove ci_set_version.sh script and associated versioning functionality * Fix comment provisined Fix PlatformIO version input reference in documentation workflow Remove outdated Squeezelite-ESP32 installer documentation
5.1 KiB
RF gateway (433mhz/315mhz)
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 | Where to Buy |
|---|---|---|---|---|
| SRX882 or SRX882S (recommended) | 433Mhz Receiver | RF(RCSwitch), RF2(KaKu), Pilight | Supported | compatible parts list |
| STX882 (recommended) | 433Mhz Transmitter | RF(RCSwitch), RF2(KaKu), Pilight | Supported | compatible parts list |
| CC1101 | 433Mhz Transceiver | RTL_433, RF(RCSwitch), RF2(KaKu), Pilight | Supported | compatible parts list |
| SX1276/SX1278 | 433Mhz Transceiver | RTL_433 | Not Supported | compatible parts list |
| LilyGo/Heltec | 433Mhz Transceiver | RTL_433 | Not Supported | compatible parts list |
SRX STX Pinout
| Board | Receiver Pin | Emitter Pin |
|---|---|---|
| ESP8266 | D2/D3/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/D3/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.