Commit Graph
52 Commits
Author SHA1 Message Date
Florian 2459e1c29b [RF] Change ESP8266 default RF_RECEIVER_GPIO from 0 to 4 (#2240) (#2323)
GPIO0 (D3) is the ESP8266 boot strapping pin: an RF receiver holding the
data line low at reset forces the board into flash mode, so a stock
nodemcuv2-rf build never starts after a restart with the receiver wired
to the documented default pin. Default to GPIO4 (D2) instead, which the
docs already recommend as the workaround. Environments that need other
pins (srfb-direct, sonoff-rfr3, rf-wifi-gateway) already override the
value explicitly and are unaffected.
2026-06-14 16:28:01 -05:00
Alessandro Staniscia 98481c5145 [SITE] Renew the web board presentation and the ESP32 web upload + [SYS] Security checks (#2277)
* 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
2026-03-09 07:47:30 -05:00
Alessandro Staniscia c6b2aae965 Refactor RF Configuration Management (#2245)
- Introduced RFConfiguration class to encapsulate RF settings and operations.
- Replaced direct usage of RFConfig structure with iRFConfig instance across multiple files.
- Updated frequency handling in actuatorSomfy, gatewayPilight, gatewayRF, and gatewayRF2 to use iRFConfig.
- Modified webUI to interact with iRFConfig for RF settings management.
- Removed deprecated RFConfig structure and related functions.
- Enhanced JSON handling for RF configuration loading and saving.
- Improved logging for RF configuration operations.
2025-12-07 09:56:15 -06:00
FlorianandFlorian 32174e37a5 [SYS] Reduce Logs flash footprint (#2232)
By building only the log level required into LOG_LEVEL

Co-authored-by: Florian <1technophile@users.noreply.github.com>
2025-08-19 09:15:41 -05:00
Ryan Powell 585df9a420 [SYS] Update arduino core to 3.1.1 + refactor ino to cpp (#2177)
* Update arduino core to 3.1.1

* Fix Blufi build

* Update arduinojson, fix build errors with idf

* Fix narrowing

* fix RF builds

* WIP-Convert ino files to cpp

* Fix pilight build

* Fix Somfy actuator build.

* Update esp32dev-rf partition

* Fix Weatherstation build

* Fix GFSunInverter build

* Fix esp32dev-ir build

* Fix ble-aws build

* Fix eth builds

* Fix m5Stack missing pins_arduino.h

* Fix build errors for M5 stack/tough, others are upstream issues.

* Fix RTL 433 build - remaining errors are from radolib

* Fix nodemcu build

* fix 2g builds

* Fix serial build

* Fix actuator on off builds

* Fix SSD1306 build - remaining errors are from radiolib

* Fix multiple definition of OTAserver_cert

* Fix nodemcu rf2 build

* Fix ADC builds

* Fix sensor builds

* Fix LORA builds

* Fix multi-receiver builds - remaining errors are in radiolib

* Fix fastled builds

* Fix theegns board builds

* Fix broker builds

* Update fastled - old version failed all-test build

* Fix RN8209 builds

* Fix max temp actuator builds

* Fix PWM builds

* Fix C37 sensor builds

* Fix HTU21 builds

* Fix INA266 builds

* Fix undefined variables in mqtt discovery

* Fix webui build

* Fix fastled invalid pin error

* Fix wifi manual setup builds

* Fix onewire/all-test build - bin too big error remaining

* Fix theengs plug build

* Fix rfbridge builds

* Fix blufi builds

* Fix undefined functions in serial

* Fix preprocessor definition checks

* Set IDF log level to erre

* Add delay in loop to prevent watchdog timeout

* Use xTaskCreateUniveral to support single core processors

* Remove old HTTPUpdate files - upsteam fixed.

* Cleanup and move common declarations to header file

* Use custom partiton table to fix builds where bin is too large

* Update M5StickC - fixs esp32-m5stick-c-ble build

* Revert to Arduino core 2.x for builds with incompatible libs

* Remove "Z" from file names and rename omg_common to TheengsCommon

* Fix gateway name when using MAC with new Arduino core

* Update IDF config to reduce loop task stack use

* Update esp-nimble-cpp version, corrects BLE uppercase ID's

* Update wifi manager to fix watchdog timeout error
2025-05-06 19:35:50 -05:00
Alessandro Staniscia e683fbbd18 [RF] Proposal fix for issue #2139 + Extra documentation (#2157)
* Refactor announceDeviceTrigger function to improve parameter handling and documentation for optional device information
Fix null pointer references in RFtoMQTTdiscovery and update logging levels for RF signal handling
Refactor RF to MQTT discovery functions for improved clarity and parameter handling

* Update documentation for RF auto discovery and MQTT integration, correcting terminology and enhancing clarity

* Refactor enableRFReceive function to accept parameters for frequency and GPIOs, enhancing flexibility
2025-03-07 16:47:33 -06:00
peshovec d837dfd32a [RF] HA: RF modules as sensors. Subscribe topic, according valueAsATopic (#2134) 2025-01-25 12:53:24 -06:00
DigiH 5e1860abd9 [DISC] rtl_433 UV amendments (#2144) 2025-01-02 14:56:18 +01:00
FlorianandFlorian 3187ed6154 [SERIAL] Enable SERIAL to X communication (#2068)
Add Serial as a communication layer so as to transmit data to/from serial
Enable discovery of BT sensors through serial
Add serial heartbeat

Change discovery principle for interval and intervalacts, keep them always discovered and deactivate adaptivescan when changed. Instead of removing their discovery when adaptive scan is activated

Increase JSON_MSG_BUFFER_MAX as we are now using const char* and it requires more memory for Arduino Json Deserialization

Co-authored-by: Florian <1technophile@users.noreply.github.com>
2024-09-26 06:55:26 -05:00
DigiH 4bb7c5502d [DISC] reorder UVI for correct auto-discovery (#1968)
To avoid auto-discovery issues due to substring comparison at
https://github.com/1technophile/OpenMQTTGateway/blob/development/main/ZgatewayRTL_433.ino#L128

strcmp instead of substring only strstr
2024-06-17 13:37:39 -05:00
riegelbrau 23b3123b97 [RTL] Correct string handling for type key in NAMING_KEYS (#1960)
* Correct string handling for type key in NAMING_KEYS

Extend class structure RTL_433device and modify code to create correct state topic in discovery message to support sensors, that send type key as well as sensors, that don't. Actually only TPMS sensors use type=TPMS.

* Try to correct format failure.

* Remove trailing spaces
2024-06-12 06:11:02 -05:00
DigiH 6e906702ed [DISC] battery_ok discovery differentiation (#1958)
Differentiation between 0%-100% float battery_ok devices' discovery and binary_sensor devices battery_ok
2024-06-10 11:49:43 -05:00
DigiH 417d28fb20 [DISC] Consistent upper case discovery property names (#1957)
And property name change of 'light' and 'lux' to Illuminance
2024-05-30 19:52:33 +02:00
DigiH 33511b5b25 [DISC] Nexa additional auto-discovery properties (#1953) (#1955)
* [DISC] Nexa additional discovery properties (#1953)

* State as binary_sensor ON/OFF

* Alphabetical sorting
2024-05-29 21:55:56 +02:00
Florian 2065d57e11 [BOARDS] Remove Arduino boards (#1929) 2024-04-10 15:48:05 -05:00
DigiH b884ee8883 [DISC] Additional RF discovery keys and device classes (#1927) 2024-04-05 17:34:02 +02:00
DigiH 781f7af90c [DISC] uv/uvi discovery fix and device classes added (#1923) 2024-04-04 20:00:14 +02:00
Florian 7db2e93c28 [RTL_433][BREAKING] Beta support for FSK modulation, webUI frequency and active receiver change (#1812)
* [FSK] Add Lilygo Heltec environment with FSK modulation

Enable RTL_433 frequency and active receiver change with WebUI
Add FSK environment for Heltec and Lilygo
2023-12-01 13:16:03 -06:00
DigiH 7405499f15 [RF] rain_rate_mm_h fix (#1713) 2023-07-14 17:23:06 +02:00
Northern Man 7f7eed8812 [RF] rtl_433_ESP to version 0.3.0 (#1668)
Update to rtl_433_ESP 0.3.0
Resolves issue with sx127x chipset and receiving higher frequencies
Includes support for receiving FSK signals, requires compiler directive OOK_MODULATION=false to switch to FSK mode
Adds unit of measure for rtl_433/battery_ok devices RTL_433_ESP Battery Auto Discovery Missing Unit of Measurement #1644
Updates value template for rtl_433/battery_ok in openHab mode
Resolves out of stack space crash lilygo-rtl_433 crash after chacon remote control button pressed #1655
2023-06-08 08:40:38 -05:00
Tamas DAJKA e3e700449b [RF] Added Pilight RAW packet return support (#1604)
* Added Pilight RAW packet return support - can be enabled in User_config.h
2023-04-25 17:13:01 -05:00
Northern Man 9b6133ff03 WebUI - First Release (#1586)
* WebUI - First Release

* Lint / Build Issues

* Add WebUI as a default module

* Fix ESP8266 builds
2023-04-05 14:17:08 -05:00
Northern Man bf004b078b Fixing headers for gateway modules (#1554)
* Fixing red squiggles in VSCode/PlatformIO

* Lint issues
2023-03-28 10:33:16 -05:00
Florian 86744b283b [SYS] Bump ESP32 platform to v6.1.0 and ESP8266 to v4.1.0 (#1547)
* Bump ESP32 platform to v6.1.0 and ESP8266 to v4.1.0

* Fix ESP32 not connecting to Ethernet

And remove check updates as it is now done every hour

* Do not define LED pins if not explicitly stated

* OLED need to be reset for Heltec Lora 32 V2

* Fix issue with SSD1306 saving
2023-03-23 11:24:49 -05:00
Northern Man 7c4c90d777 [RTL_433] Update to rtl_433_ESP v0.1.8 (#1552) 2023-03-20 07:37:04 -05:00
Florian 578f522356 [RTL_433 Discovery] Add Govee water sensor Status entity (#1499)
* [RTL_433 Discovery] Add Govee water sensor Status entity

Add Govee water status sensor auto discovery as a binary_sensor, the entity will detect Water Leak Event and go back to Off state after 60seconds

* Format and comment
2023-03-03 14:51:55 -06:00
Northern Man dcb4d5551e Add device_class to MQTT Discovery for rtl_433_ESP (#1419)
* Add device_class to rtl_433_ESP discovery
2023-01-25 09:58:18 -06:00
Dattel 5fcf02af5a Small fix on BME280 Config & CC1101-TXPower Throttle (#1382)
* https://github.com/1technophile/OpenMQTTGateway/issues/1380
CC1101 TXPower selection

* Creates the possability the define SDA/SCL Pins correct through a compiler switch from the platformio.ini
Sample:
  '-DBME280_PIN_SDA=0'
  '-DBME280_PIN_SCL=2'
2023-01-10 20:13:06 +01:00
FlorianandNorthernMan54 16815f51da Add RTL_433 discovery with Home Assistant convention inspired from rtl_433_mqtt_hass.py (#1379)
This also changes the topic structure when using the macro valueAsATopic=true, it adds as sub-topics the `type, subtype, and channel` when they exist.
The id is the last subtopic to facilitate filtering, as it may change when replacing the batteries.

Co-authored-by: NorthernMan54 <19808920+NorthernMan54@users.noreply.github.com>
2023-01-07 20:34:43 -06:00
DigiH 807c668489 Small typo fixes (#1359)
A few small typo fixes
2022-12-12 22:58:51 +01:00
Northern Man 8bc65d62dc Update of rtl_433_ESP to version 0.1.3 - Support for SX127X transceiver module (#1291)
The main features of the upgrade to 0.1.3 of rtl_433_ESP are

1 - Change Transceiver Library to RadioLib

2 - Add support for SX127X transceiver module ( I used the 433 Mhz version of this Heltec module for development ).

3 - Added automatic calibration of the RSSI Signal detection Threshold

4 - Removed dependency on loop for start and end of signal detection, and moved to a ESP32 Task

5 - Moved received signal decoding to a ESP32 Task

6 - Identified Blueline PowerCost Monitor decoder as source of significant memory overhead and disabled.

7 - Multi Receiver support has been validated with RF, RF2 and PiLight
2022-10-20 11:14:45 -05:00
DigiH c4300a002f MQTT-MAC-IP-mDNS (#1245) 2022-07-19 12:10:51 -05:00
steadramonandPaul 5b697e0306 Add Pilight limitProtocols support (#1223)
* Add ability to limit protocols

* Make serial feedback notice

Co-authored-by: Paul <steadramon@local>
2022-06-05 11:47:56 -05:00
Thomas Kern afd7a96537 only restore an active receiver if it is available (#1115)
* only restore an active receiver if it is available
2021-12-20 19:36:13 -06:00
Thomas KernandKern, Thomas c5f7a3a55e Save currently active receiver and restore on reboot (#1091)
* save active receiver and restore on reboot

Co-authored-by: Kern, Thomas <thomas@kernwelt.de>
2021-10-29 16:53:05 -05:00
Alessandro Staniscia e9ce921717 Add support for discovery device trigger (#1090)
* Add announce of DeviceTrigger +  Update doc
2021-10-24 08:30:36 -05:00
Chris van Marle f84a878400 Configurable amount of RF2 repeats (#990)
* Make number of RF2 repeats configurable

* Reduce number of repeats

Number of repeats in NewRemoteTransmitter is by default 16, which takes
quite some time to send.

It actually runs 2^R repeats, where R is the configured amount.

https://github.com/1technophile/NewRemoteSwitch/blob/86f1c8486c80919ef70e86504e8a9580c34b4fab/NewRemoteTransmitter.cpp#L20
2021-10-20 06:08:58 -05:00
Florian ff089923da Deactivate RF switch discovery per default (#1026)
* Deactivate RF switch discovery per default

To prevent creating many switches into Home Assistant
2021-07-17 17:18:53 -05:00
Northern ManandNorthern Man f69906861d Active Receiver Switching (#936)
* PR #934

* Active Receiver Switching

Switching of the active receiver module is available between the RF,
RF2, RTL_433 and Pilight Gateway modules, allowing for changing of
signal decoders without redploying the openMQTTGateway package.
Sending a JSON message to the command topic of the desired receiver
will change the active receiver module.

Other minor adjustments/improvements

1 - Improved startup serial logging that includes
- OpenMQTTGateway Version
- OpenMQTTGateway Modules

2 - Trace logging of full Gateway module command topic
 - Enabled in RF, RF2, PiLight and RTL_433

3 - Updated RTL_433 Documentation to only include enabled ASK/OOK
device decoders

4 - Trace logging of MQTT Callback topic

* Regression testing

* Adding valueAsASubject support to rtl_433_ESP
- model and id keys are appended to message topic

* Increased memory size for receiver switching in blocking build all

Co-authored-by: Northern Man <sgracey@Heisenberg.local>
2021-05-10 19:36:25 -05:00
Northern ManandNorthernMan54 57bc108da4 Initial pull request for rtl_433 support (#886)
* Initial pull request for rtl_433 support

Co-authored-by: NorthernMan54 <sgracey@Bart.local>
2021-03-11 12:43:05 -06:00
Chris van Marle 2c6526fcdb Publish state to same channel as received signals (#855)
Received signals are published to the subjectRF2toMQTT topic (/RF2toMQTT). However, echos of mqtt messages are published to the topic subjectGTWRF2toMQTT (/433toMQTT). That seems quite inconsistent.
2021-01-30 14:53:45 -06:00
Northern Man 25ea909c08 Support for changing CC1101 Receive and Transmit Frequency (#847)
* Support for changing CC1101 Receive and Transmit Frequency

* Docs

* Resolve feedback

* Update Somfy module to use Global receiveMhz

ELECHOUSE_cc1101.SpiStrobe(CC1101_SIDLE); // Idle receiver prior to
setting a new frequency
2021-01-22 05:53:39 -06:00
melyux fd2d25bf31 Add ability to specify repeats for raw Pilight strings (#803)
* Add ability to specify repeats for raw Pilight strings

* Updated RF Pilight doc to add raw transmission tut

Added information about transmitting raw messages using the MQTTtoPilight topic, including using the new repeats functionality. Fixed some scattered English mistakes.
2020-11-24 21:58:03 -05:00
JonandJonathan Michael Wells 40152d6a02 Rf receive only (#701)
* Disable RF transmit

* Added definition example (commented out)

Co-authored-by: Jonathan Michael Wells <jonathan-wells@oist.jp>
2020-07-19 06:29:49 -05:00
Florian c9e6de1a1c Replace pin by gpio (#631)
* replace _PIN by _GPIO

* add mention about the goal of -all binaries

* [breaking] change json key from "pin" to "gpio" for actuatorONOFF
2020-06-13 20:04:36 -05:00
Florian c9de14e51a correct config files
remove list of protocols from config_RF and retrieve the correct key for the version building in CI
2020-06-13 15:58:52 -05:00
Leon Kiefer 10a9d00aaf Added clang-format (#623)
* added .clang-format
* added names to travis jobs
removed deprecated travis option
* check github action
* added .gitignore
2020-06-09 16:09:23 -05:00
orrpan ac743ed350 CC1101 433.92MHz support for pilight, rf and rf2 (#585)
* adds CC1101 (433mhz) support esp32 and esp8266
2020-04-23 14:23:47 -05:00
1technophile 7f9d8d18da Apply VSC auto format to the code and indent macros for readability 2019-12-14 17:14:36 +01:00
Florian 4b1f09b06b Wifi managers improvements (#503)
* Add parameters to wifi manager: gateway name and base topic
Enable to restart the ESP and erase the parameters by MQTT
2019-12-07 10:18:42 +01:00