Commit Graph
33 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
DigiH 60a571ebb2 [BT] Device Tracker & Presence separation and clarification (#1880) 2024-02-01 21:21:29 +01: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
Florian 9adff6fb09 [DOCS] Add prerequisite Theengs Bridge listing (#1808) 2023-11-15 20:15:36 -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 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
Florian 9bdfeca2f7 [DOCS] Add Theengs Plug links (#1416)
* [DOCS] Add Theengs Plug links
2023-01-23 13:45:15 -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
melyux b2666dcc83 Add BMP280 support, compiler directive support for oversampling (#1344) 2022-12-05 09:51:45 -06:00
Northern Man fd8c3a79ae Updated docs for the Heltec ESP32 Board (#1301) 2022-10-23 19:34:59 -05:00
Florian bf38bb52f6 Remove HM10 support (#1282)
Removing HM10 support as announced in the forum
2022-10-10 20:34:12 -05:00
Florian 9ea985cf55 Add Theengs links (#1249) 2022-07-28 16:48:41 -05:00
DigiH 1c62d74e56 Typo-fixes (#1244) 2022-07-19 07:53:38 +02: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
Florian 749c1592b4 Add M5Tough board (#1135) 2022-01-17 19:22:26 -06:00
Florian 0ede075843 Add esp32-wt32-eth01 ethernet board (#1064)
* Add esp32-wt32-eth01 ethernet board
2021-08-17 18:48:11 -05:00
Florian 7564cf082b Docs improvements/corrections (#1018) 2021-07-13 17:27:04 -05:00
Florian 39568d8288 [DOC] Tip correction 2021-01-29 17:23:29 -06:00
Leon Kiefer a83f725bad Npm docs setup (#834)
* added vuepress to package json
* use vuepress from package json
2020-12-13 12:49:13 -06: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 d4457f817a Enable BT use for Arduino Mega (#718)
* Enable BT use for Arduino boards

by adding a ArduinoSTL library

* Update doc
2020-08-04 11:40:16 -05:00
Florian 1ae4903af1 Add Avatto/Bakeey IR boards definition (#706)
* Add Avatto/BAKEEY IR boards definition

Tested with S06
-Emitting IR OK
-Receiving IR OK
-TRIGGER GPIO OK
-led info, brief but OK
2020-07-24 18:30:34 -05:00
FlorianandLeon Kiefer 6e9b170c00 [RF] handle 64 bits values (except for UNO) (#698)
* handle 64 bits values, except for UNO
Arduino UNO is not enough powerfull to handle properly uint64_t in terms of memory so differenciate the variable type depending on the board type
With this configuration ATMega will not be able to receive with simpleReceiving 64 bits values. Of course Json will work with 64 bits values for this board.
* Simplify jsondata.success() condition
* Renamings and optimize deduplication functions
* replace 2 dimensions array by a structure so as to handle the time with an uint32_t  when using an ESP (instead of a uint64_t)
* change storeValue and isAduplicate function names
* point to the rcswitch revision with the new 40 bits protocol

Co-authored-by: Leon Kiefer <leon.k97@gmx.de>
2020-07-18 17:14:19 -05:00
Florian 30147140bd Add M5 boards compatibility and low power mode (#586) 2020-04-26 19:56:10 -05:00
Florian 1cc12e2ecf improve documentation(#524)
add wifi manager portal screenshots
add M5stick
correct bad link
improve lora doc
2020-01-09 21:42:51 +01: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