Commit Graph
78 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
DigiH a52296a97d [DOCS] BLE compatible devices clarification (#1921)
BLE compatible devices clarification and link to listing
2024-04-08 10:18:20 -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
DigiH 5421f0e995 [DOCS] typo fixes (#1816) 2023-11-26 13:07:18 -06:00
Florian 9adff6fb09 [DOCS] Add prerequisite Theengs Bridge listing (#1808) 2023-11-15 20:15:36 -06:00
Florian 5a36034a2f [BT] - Bump decoder to v1.6.2 (#1797)
* [BT] Bump decoder to v1.6.2

* Replace separators / by commas for consistency with Theengs
2023-11-12 13:00:28 -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
Florian e27e055bf8 [DOCS] Update devices from new decoder version (#1675) 2023-06-10 15:01:17 -05:00
zhouzb 624243d0dc [DOCS] Add recommendation for EMQX (#1641)
* [DOCS] Add recommendation for EMQX

* [DOCS] Adjust the position and size of the sponsor logo
2023-05-16 09:52:07 -05:00
Florian b1667190d5 [BLE] Add moving beacon detection (#1636) 2023-05-11 07:42: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 3ceb19f7be [DOCS] Improbe BLE gateway guide (#1530)
Add images, intro and reorganize sections
2023-03-13 19:28:32 -05:00
Florian f35baa9da0 [BT] Add BM2 voltage (#1495)
* [BT] Add BM2 voltage

Voltage retrieval through a BLE connection, frequency of the BLE connection is defined by `intervalcnct`

* Add doc

Credits to https://github.com/KrystianD/bm2-battery-monitor
2023-03-02 11:02:03 -06:00
Florian 37dfe8008c [BT] Bump decoder to v1.2.0 (#1454) 2023-02-12 16:27:10 -06:00
Florian 8d2aacc358 [BT] Bump Theengs Decoder to v1.1.0 (#1425) 2023-01-26 13:43:16 -06:00
Florian 9bdfeca2f7 [DOCS] Add Theengs Plug links (#1416)
* [DOCS] Add Theengs Plug links
2023-01-23 13:45:15 -06:00
Die Peter Pan 9687f605c8 Added board ESP32 DOIT DevKit V1 with SX1278 module Ai-Thinker Ra01 (#1411)
* Added board ESP32 DOIT DevKit V1 with SX1278 module Ai-Thinker Ra01

Gateway using RTL_433_ESP library, need SX1278
ESP32 DOIT DevKit V1 & external Ai Thinker Ra01 Loraboard SX1278 on VPSI and (DIO0=15, DIO1=4, DIO2=16 and RST=17)
2023-01-23 11:40:27 -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 ad97e9a677 [DOCS] Small fixes (#1388)
Remove HM10 mention
2023-01-12 16:24:56 -06:00
Florian c1ea227501 Bump decoder to v1.0.0 (#1387)
* Bump decoder to v1.0.0

* Fix tempo disc model
2023-01-12 10:49:07 -06:00
DigiH 8a767cf4b8 Typo fixes (#1381) 2023-01-08 07:43:15 -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 7f228647f0 Bump Theengs Decoder to v095 (#1298)
* Bump Theengs Decoder to v095

* IBT-4XC inclusion by @DigiH in #208
* ThermoPro TP359 by @DigiH in #210
* IBS-TH1 external probe differentiation by @DigiH in #211
* CGG1 firmware extension by @DigiH in #218
* Otio/BeeWi BSDOO by @DigiH in #214
2022-10-23 15:55:23 -05:00
Florian b0fc25bfe0 [DOCS] Remove HM10 (#1284) 2022-10-11 19:43:15 -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 aea3ac2577 Bump decoder to v0.9.0 (#1280)
* Bump decoder to v0.9.0

* Add parameters update
2022-10-10 13:54:19 -05:00
Florian b323f25fda Bump Theengs Decoder (#1262)
to 0.8.0
2022-09-03 18:52:41 -05:00
DigiH 25029c7c85 Devices Clarification (#1252) 2022-08-08 23:01:53 +02:00
FlorianandDigiH fbab2427e4 Bump Theengs Decoder to v0.6.2 (#1248)
* Bump Theengs Decoder to v0.6.1

* Differentiate a FASTLed environment

* remove BT from the nodemcuv2-all-test env as it is already tested into nodemcuv2-ble

* Decoder 0.6.2

Co-authored-by: DigiH <github@digih.net>
2022-07-29 13:04:04 -05:00
Florian 9ea985cf55 Add Theengs links (#1249) 2022-07-28 16:48:41 -05:00
DigiH c4300a002f MQTT-MAC-IP-mDNS (#1245) 2022-07-19 12:10:51 -05:00
DigiH 1c62d74e56 Typo-fixes (#1244) 2022-07-19 07:53:38 +02:00
Florian bf99823861 [DOCS] Add switchbot control 2022-05-04 06:15:17 -05:00
Florian 141e33e7c6 Bump theengs decoder to 0.3.0 (#1201) 2022-04-16 18:01:16 -05:00
Florian a243b12397 Add links to Theengs gateway (#1190) 2022-03-20 10:14:39 -05:00
Amy Nagle 257b39da81 Add support for XMWSDJ04MMC (#1162) 2022-02-09 16:16:41 -06:00
Florian 66c12d6e6b Add esp32-olimex-poe (#1157)
Add esp32-olimex-poe-iso
2022-02-05 11:02:59 -06:00
h2zeroandFlorian 0a8458f156 Update decoder version. (#1151)
* Update decoder version.

* Add new devices and sort list

Co-authored-by: Florian <1technophile@users.noreply.github.com>
2022-01-27 15:48:29 -06:00
Florian 749c1592b4 Add M5Tough board (#1135) 2022-01-17 19:22:26 -06:00
Florian ce66cf0b81 Bump theengs decoder to v0.1.4 (#1113)
* Bump theengs decoder to v0.1.4

* Add new devices to doc
Govee H5102
Inkbird IBT-6XS
2021-12-15 19:49:14 -06:00
Florian 7dc49165a0 Discovery with theengs decoder (#1106)
* Discovery with theengs decoder

* Add devices to doc

* Correct missing suffix for DT24
2021-12-11 11:54:08 -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 c2107da1c7 Add BLE TPMS sensors (#1031)
* Add BLE TPMS sensors

tire pressure monitoring system
2021-07-27 06:34:45 -05:00
Florian 7564cf082b Docs improvements/corrections (#1018) 2021-07-13 17:27:04 -05:00