Commit Graph
41 Commits
Author SHA1 Message Date
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 2065d57e11 [BOARDS] Remove Arduino boards (#1929) 2024-04-10 15:48:05 -05:00
Florian a845d772f9 [DOCS] Fix image sizing and path (#1926) 2024-04-08 07:18:52 -05:00
Florian 6c62858093 [DOCS] Page speed optimizations (#1922)
* [DOCS] Page speed optimizations

* Fix img path
2024-04-04 11:38:41 -05:00
Florian 29ecda720b [DOCS} Add alt texts to images on the first page (#1893) 2024-02-07 19:46:06 -06:00
Florian 11b8990564 [DOCS] Optimize landing page loading (#1890) 2024-02-07 16:47:36 -06:00
DigiH 60a571ebb2 [BT] Device Tracker & Presence separation and clarification (#1880) 2024-02-01 21:21:29 +01:00
Florian ffffda1840 [DOCS] Add sponsorship button (#1854) 2024-01-09 07:51:33 -06:00
Florian d79d630b44 [DOCS] Remove Zigbee (#1835) 2023-12-14 12:41:56 -06:00
DigiH 4c633da151 [BT] Bump Theengs Decoder to 1.6.4 & NUTALE added as presence tracker (#1818)
• Bump Theengs Decoder to 1.6.4
• NUTALE added as presence tracker
• Small doc changes
2023-12-06 10:56:47 -06:00
DigiH 5421f0e995 [DOCS] typo fixes (#1816) 2023-11-26 13:07:18 -06:00
Florian 54b0eaeebf [DOCS] Add Theengs bridge (#1807) 2023-11-15 14:46:10 -06:00
Florian 8de824b6fa [DOCS) Readme improvements (#1743)
* [DOCS) Readme improvements
2023-09-14 11:47:24 -05: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
Florian e83bfb0e4d [DOCS] Add video link and fix existing one (#1486) 2023-02-25 11:06:18 -06:00
Florian bf95ae13e8 [DOCS] Add media references (#1464) 2023-02-16 13:45:13 -06:00
Florian 9bdfeca2f7 [DOCS] Add Theengs Plug links (#1416)
* [DOCS] Add Theengs Plug links
2023-01-23 13:45:15 -06:00
Florian a243b12397 Add links to Theengs gateway (#1190) 2022-03-20 10:14:39 -05:00
Florian c2107da1c7 Add BLE TPMS sensors (#1031)
* Add BLE TPMS sensors

tire pressure monitoring system
2021-07-27 06:34:45 -05:00
Florian c06a6c9ceb [DOCS] Add new devices, parameters and LORA tutorial (#1028)
* Add new devices and parameters
* Update readme and lora use
2021-07-18 14:18:40 -05:00
Florian bce9bf3e00 Minor readme update (#1025)
* readme and BLE update
2021-07-16 20:09:47 -05:00
Florian 7564cf082b Docs improvements/corrections (#1018) 2021-07-13 17:27:04 -05:00
Gabriel M. Schuyler 8cbd1984af Fix a couple typos (#999) 2021-06-27 14:26:32 -05:00
Stephen Littman 67823d22af Update readme for better understanding in English (#861)
Not sure if these changes affect other translations... But I made a few corrections for better understanding in english
2021-02-05 21:05:30 -06: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 2fdaf8463c Add Andreas Spiess video for Xiaomi Mi Scale to ESP32 use case 2020-07-01 05:55:10 -05:00
Florian bb8ba4ba60 update (#489)
add fastled doc

add links to bootloaders and boot app0

Arduino IDE upload instructions add

add community
2019-11-08 22:03:52 +01:00
Florian aa263dc559 Docs vuepress (#476)
Convert docs to vuepress
2019-10-30 22:15:40 +01:00
Florian 98066b0694 Update README.md 2019-03-10 13:04:19 +01:00
Florian c1caf8f36e Update README.md 2018-09-30 15:58:54 +02:00
Florian d0820eb2db Update README.md 2018-05-21 19:08:15 +02:00
Florian 70b4ddc0a4 Update README.md 2018-04-29 23:59:18 +02:00
Florian cccfcba3ff add 2G gateway 2018-04-29 23:56:35 +02:00
Florian 1b9c7d0fba Update README.md 2018-01-07 13:18:20 +01:00
Florian d677e24745 Update README.md 2018-01-02 16:28:34 +01:00
Florian 55dc048384 Update README.md 2017-12-02 14:34:27 +01:00
Florian 9c1bad0578 Update README.md 2017-12-02 14:30:48 +01:00
Florian e13b512229 Update README.md 2017-12-02 14:28:37 +01:00
Florian adafb26a17 Update README.md 2017-12-02 14:26:35 +01:00
Florian 9c96526d92 Update README.md 2017-12-02 14:23:07 +01:00
Florian 9127ae8964 Rename README to README.md 2017-12-02 14:21:35 +01:00