Commit Graph
33 Commits
Author SHA1 Message Date
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
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
Florian 9f5bf3ec57 [DOCS] Remove dead compatible.openmqttgateway.com links (#2205) (#2322)
The compatible.openmqttgateway.com site is offline (TLS connection reset),
leaving 38 dead links across the docs and README. Repoint BLE device lists
to the canonical Theengs Decoder devices page already used by the navbar,
point boards/devices/parts references to the corresponding docs pages, and
drop the affiliate-site mentions and 'Where to Buy' links that have no live
equivalent. Also fix a malformed markdown link in docs/use/ble.md.
2026-06-14 15:26:02 -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
Florian 8a28bb2cf8 [SERIAL][BREAKING] RS232 change to SERIAL GATEWAY (#2008)
Make the RS232 more generic by converting it to a Serial Gateway
Add the capability to decode BLE data coming through Serial
2024-08-16 11:23:39 -05:00
Florian 2065d57e11 [BOARDS] Remove Arduino boards (#1929) 2024-04-10 15:48:05 -05:00
DigiH 5421f0e995 [DOCS] typo fixes (#1816) 2023-11-26 13:07:18 -06:00
Florian 7a2bb04a1b [DOCS] Theengs Plug highlight and SEO improvements (#1730)
* [DOCS] Theengs Plug highlight

* Add alt content for images and description
2023-08-11 13:04:52 -05:00
Die Peter Pan abeef870c7 [HM-RD] Added leak/water detection sensor with ESP32 deep sleep / sensor wake (#1615)
Added leak/water detection sensor with ESP32 deep sleep / sensor wake
2023-04-25 17:14:49 -05:00
Florian 38af4b86ca [DOCS] RF update (#1602)
Add srx882s and improve overall
remove FS1000A and XD RF
2023-04-09 18:46:01 -05:00
Die Peter Pan 0ece563a52 [MQ2] Gas sensor & tweak DHT config to avoid editing source when PIN is different (#1576)
Add MQ2 Gas sensor & tweak DHT config to avoid editing source when PIN is different
2023-03-26 17:21:05 -05:00
Die Peter Pan 7bae999435 [TEMT] Added Temt6000 light sensor using a d1 mini (#1550)
Added light sensor TEMPT6000
2023-03-18 09:33:35 -05:00
DigiH df020efd8b [DOCS] RF documentation addions (#1524) 2023-03-12 12:17:51 -05:00
Florian 9e642de3aa [DOCS] Clarify RF (#1503) 2023-03-09 09:53:05 -06:00
DigiH 8a767cf4b8 Typo fixes (#1381) 2023-01-08 07:43:15 -06:00
Northern Man 2e0d1708c3 Update to rtl_433_ESP 0.1.5 and support for LILYGO® LoRa32 V2.1_1.6.1 433 Mhz (#1371)
* Update to rtl_433_ESP 0.1.5

Includes support for LILYGO® LoRa32 V2.1_1.6.1 433 Mhz

* Fix lint issue

* Fix build and lint issues

* Add lilygo-rtl_433 to build.yml
2022-12-26 13:48:08 -06:00
melyux b2666dcc83 Add BMP280 support, compiler directive support for oversampling (#1344) 2022-12-05 09:51:45 -06:00
Florian fa88862081 Update RF module wiring (#1315)
to suggest 3.3V wiring instead of Vin, as Vin may not be always connected to the USB port on the development boards, also remove ESP8266 BT images (not supported anymore), also add mention to Heltec SX127X boards
2022-11-10 06:19:30 -06:00
Florian b0fc25bfe0 [DOCS] Remove HM10 (#1284) 2022-10-11 19:43:15 -05:00
DigiH 1c62d74e56 Typo-fixes (#1244) 2022-07-19 07:53:38 +02:00
wst-tdb c5f2c1ca6f [DOCS] Correct pin assignment (#1068) 2021-08-24 05:13:50 -05:00
Florian 7564cf082b Docs improvements/corrections (#1018) 2021-07-13 17:27:04 -05:00
Northern ManandNorthern Man bdaf097c04 Resolve incorrect wiring instructions (#984)
As identified in this forum post (
https://community.openmqttgateway.com/t/rtl-433-esp32-bme280-but-what-ra
dio/1563) , the default builds have incorrect connections for the
RTL_433 module.  This fixes the default build configuration and
crispness the documentation.

Co-authored-by: Northern Man <sgracey@Heisenberg.local>
2021-06-11 20:33:10 -04:00
Leon Kiefer a7575b2c3a added ZactuatorSomfy (#816)
* added ZactuatorSomfy
* added Somfy RTS docs
2020-12-13 12:46:10 -06:00
DieKatzchen 3df16d2d52 Basic RS232 Communication (#780)
* Added ZGateway RS232
2020-10-19 13:48:58 -05:00
Florian 4b265384b2 DOCS improvements 2020-09-17 13:43:05 -05:00
Florian 605da549b9 Docs improvements (#742)
and link to https://compatible.openmqttgateway.com
instead off spreadsheet
2020-08-25 05:42:53 -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 f6fa1e52da Hm10 details (#614)
* Add infos and change HM10 speed to a macro
* remove unnecessaries macros
2020-05-12 20:27:05 -05:00
JonathanandJonathan Wells cf641851af Added HTU21 Sensor (#588)
* Added HTU21 Sensor Support

Co-authored-by: Jonathan Wells <jonathan-wells@oist.jp>
2020-04-29 08:22:17 -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
Florian a05fd01505 remove default path when cliking on sidebar menus (#502)
change link to sources

add credits and some shape for readme

add cleargrass with air pressure and mi band

add PWA

add plugins

Add new boards

improve doc with boars and ble devices
2019-12-04 21:18:32 +01:00
Florian aa263dc559 Docs vuepress (#476)
Convert docs to vuepress
2019-10-30 22:15:40 +01:00