Commit Graph
29 Commits
Author SHA1 Message Date
8273617c17 [DOCS] Migrate documentation from VuePress 1.x to VitePress (#2299)
- Replace VuePress 1.9.10 with VitePress 1.6.4
- Convert config from CommonJS to ESM TypeScript (config.mts)
- Convert shared Theengs nav config to ESM (commonConfig.mts)
- Rewrite BoardEnvironmentTable in Vue 3 Composition API
- Rewrite FlashEnvironmentSelector in Vue 3 Composition API
- Enable built-in local search and dark mode
- Add medium-zoom for image zoom
- Use VitePress CSS variables for dark mode compatibility
- Update CI script paths from .vuepress to .vitepress
- Update .gitignore for VitePress build artifacts
- Rename README.md files to index.md (VitePress convention)
- Fix markdown compatibility (angle-bracket escaping, image paths)
- Drop PWA plugin (not needed)

Co-authored-by: Florian <1technophile@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-30 07:00:20 -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 bb135aa0bf [DOCS] Remove hits (#2175) 2025-04-09 05:36:23 -05:00
Florian d7d5d0879f [CI] Web upload factorizing and ESP Web Tools update (#1862)
Update esp web tools
Simplify scripts
Add serial console
2024-01-10 18:54:42 -06:00
Florian ffffda1840 [DOCS] Add sponsorship button (#1854) 2024-01-09 07:51:33 -06:00
DigiH 561de90c94 [DOCS] Typo fixes (#1688) 2023-06-16 20:45:31 +02:00
Florian 6e8ada44b5 [SSD1306] Add discovery (#1505) 2023-03-06 12:52:40 -06:00
DigiH 3b6b758098 [SSD1306] Save/load/init/erase SSD1306 configs (#1501)
* Save/load/init/erase SSD1306 configs

Save/load/init/erase SSD1306 configs to stick across restarts, overwrite defaults

* SSD1306 combinable
2023-03-06 10:19:31 -06:00
DigiH 84f5029b14 [DOCS] LilyGo LoRa32 V2.1 driver (#1500)
LilyGo LoRa32 V2.1 driver addition with link
2023-03-03 11:29:41 -06:00
Florian 5297dff7bb [DOCS] - Generate board documentation automaticaly from platformio.ini (#1405)
* [DOCS] - Generate board documentation automaticaly from platformio.ini

To reduce maintenance effort

* [CI] Differentiate boards from platformio.ini

So that only one line can be commented to use customs environments
2023-01-20 09:04:18 -06:00
Florian cc81b0ba44 [DOCS] Add warning for Shelly Plus 1 (#1392)
This board firmware is for testing only, not for production use
2023-01-12 18:11:26 -06:00
Florian 31ffdf1e2b Add SHELLY PLUS 1 board with support of relay, switch, BT gateway (#1349)
So that you know, the overtemperature protection is not implemented in the firmware.
2023-01-10 07:18:59 -06:00
Florian ba70d364b1 [CI and DOC] Add LilyGO RTL 433 (#1373)
board to documentation and web upload script
2022-12-26 13:56:24 -06:00
Florian 33e162111a Add RGB Led management for errors, infos, and send receive events (#1320)
* Add RGB Led management for errors, infos, and send receive events

Add RGB led management for indicators, integrate it for M5 Atom and ESP32 C3 and S3 dev board
Update Fastled version to 3.5.0.

The default behavior is with regular LED, to use RGB Led the macro RGB_INDICATORS needs to be define, along with the FASTLED_IND_TYPE, FASTLED_IND_DATA_GPIO and FASTLED_IND_NUM_LEDS
Note that some RGB led need to have a different color scheme, so in this case it can be entered along with the data PIN definition: -DFASTLED_IND_DATA_GPIO=27,GRB

* Add FastLed library to the environments
2022-11-16 12:58:22 -06:00
Florian b2a757f28b [DOCS] Add RadioLib mention (#1304) 2022-10-26 06:16:02 -05:00
Florian 7837369993 Add Heltec board into the default env (#1300)
and list it in the web uploader
2022-10-23 16:10:59 -05:00
Florian b0fc25bfe0 [DOCS] Remove HM10 (#1284) 2022-10-11 19:43:15 -05:00
FlorianandDigiH 63e3dd9530 Add OpenHAB3 tutorial and BLE binary (#1254)
* Add OpenHAB3 tutorial and BLE binary

* Small text changes

Just a few small text changes, also writing out OMG as OpenMQTTGateway, probably clearer for new to OMG users.

Co-authored-by: DigiH <github@digih.net>
2022-08-13 08:57:08 -05:00
Florian 9ea985cf55 Add Theengs links (#1249) 2022-07-28 16:48:41 -05:00
DigiH 3088d800e0 undecoded env renaming (#1247)
environment/binary build env:esp32dev-ble-mqtt-decode renamed to esp32dev-ble-mqtt-undecoded for clarification
2022-07-24 03:25:37 +02:00
DigiH 1c62d74e56 Typo-fixes (#1244) 2022-07-19 07:53:38 +02:00
DigiH c04c62916f ble-datatest-environment (#1235) 2022-07-15 04:37:04 -05:00
Florian 6efc90b19f Fix default env undecoded topic and doc changes (#1227)
* Fix default env undecoded topic

as BTtoMQTT is not automatically added

* Fix links and doc
2022-06-20 19:04:11 -05:00
Florian a243b12397 Add links to Theengs gateway (#1190) 2022-03-20 10:14:39 -05:00
Florian 66c12d6e6b Add esp32-olimex-poe (#1157)
Add esp32-olimex-poe-iso
2022-02-05 11:02:59 -06:00
Amy Nagle 6dce04d65a Add TinyPICO board (#1154) 2022-02-04 14:46:00 -06:00
Florian 8d793a8b50 Add board configuration descrption (#1142) 2022-01-22 09:46:19 -06:00
Florian 35e8d6c196 Remove download count and replace it with hit badge on upload pages (#1077)
as the binary download from the release page doesn't show all the download sources
2021-09-14 17:42:03 -05:00
h2zero 2601d72017 Add uploading from documentation option. (#1048)
This allows for directly uploading OMG to ESP32 and ESp8266 devices from the upload section of the documentation.

This will upload the latest release binary for the device selected in the dropdown menu on the webpage.

A script has been added to generate the upload page when a new release is issued.
2021-08-02 15:50:19 -05:00