Commit Graph
35 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
DigiH a4ba937553 [DOCS] image optimisation (#2192) 2025-05-21 16:30:29 +02:00
Alessandro Staniscia e683fbbd18 [RF] Proposal fix for issue #2139 + Extra documentation (#2157)
* Refactor announceDeviceTrigger function to improve parameter handling and documentation for optional device information
Fix null pointer references in RFtoMQTTdiscovery and update logging levels for RF signal handling
Refactor RF to MQTT discovery functions for improved clarity and parameter handling

* Update documentation for RF auto discovery and MQTT integration, correcting terminology and enhancing clarity

* Refactor enableRFReceive function to accept parameters for frequency and GPIOs, enhancing flexibility
2025-03-07 16:47:33 -06:00
Florian 25c3da7ee9 [DOCS] Fix image path (#2006)
* [DOCS] Fix image path

Those images are directly stored into the assets directory now for optimization purposes

* Add back the images
2024-08-15 18:52:00 -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 7a3fae61e2 [DOCS] Optim first image size (#1894) 2024-02-07 19:52:38 -06:00
Florian 11b8990564 [DOCS] Optimize landing page loading (#1890) 2024-02-07 16:47:36 -06:00
Florian 54b0eaeebf [DOCS] Add Theengs bridge (#1807) 2023-11-15 14:46:10 -06:00
Florian 246423a8a8 [LORA] Improvements, change frequency, webUI, Oled support, add boards (#1742)
* [LORA] Capability to change LORA frequency and Add OLED

Merge of the 2 environments for TTGO V1

* Merge messages keys with upper level json

* Id as a sub topic

* Add display and state measures

* Add frequency configuration through WebUI

* Add parameters

* Add auto discovery

* Add node example for ttgo lora32 v1

* Add environments and fix scope

* Support for sync word as a byte

* Fix TX Power setting

* Add LoRa gateway description

* Add onlyknown filter
2023-09-27 11:12:55 -05:00
zhouzb b3a6559b87 [DOCS] Replaced with logo visible in dark mode (#1643) 2023-05-17 07:26:57 -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
Florian 85650a6204 [BT] Device tracker presence detection (#1548)
Add device tracker detection and automatic creation following HA discovery convention
So as to trigger the away state, add an offline status to the identified BLE trackers
2023-03-20 07:31:00 -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 68a556161f [BUILD] Add gitpod to build the firmware (#1515)
Allow to build OMG from a web browser and download the binary
2023-03-09 08:55:05 -06:00
Florian 454a062b3b [OTA] Enable 2 clicks OTA update / one simple MQTT command (#1485)
* [OTA] Add automatic OTA updates

This feature will enable to update the gateway with one button or a simple MQTT command.

* [CI] Enable automatic OTA for nightly development builds

And integrate the latest_version file creation into the CI

Enable to specify a particular version
and switch between dev and production builds
2023-02-27 12:54:30 -06:00
Florian 9bdfeca2f7 [DOCS] Add Theengs Plug links (#1416)
* [DOCS] Add Theengs Plug links
2023-01-23 13:45:15 -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
Bad 8f9db357e9 Initial doc for Jeedom integration (#1255)
* Initial doc for Jeedom integration

* Fix Daemon-OK img name
2022-08-13 09:32:22 -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 3fb34af2ce [DOC] Configure the favicon properly (#1195) 2022-04-04 17:36:03 -05:00
Florian dcbce352be AWS IOT compatibility
implement compatibility with Amazon Web Services IOT through an MQTT connection with certificates. (#1099)
2021-11-07 07:44:50 -06:00
Florian 4f1960a566 node-red tutorial (#1024)
* node-red tutorial for ble temperature sensor
2021-07-16 20:53:04 -05:00
Florian 7564cf082b Docs improvements/corrections (#1018) 2021-07-13 17:27:04 -05:00
Florian adc5f157cd Add hass auto discovery gif and img (#916)
and update M5Stack docs
2021-04-04 14:53:00 -05:00
Florian b22870c620 [DOC] Replace transparent background by white
better display with github dark mode
2021-03-19 05:49:05 -05:00
Florian 4d03aa441b [DOCS] Add Home Assistant user creation note (#831)
#793
2020-12-11 16:18:33 -06:00
Florian 9a66c9ef09 HASS gateway Discovery improvements (#792)
* MQTT discovery improvements

-remove gatewayBT
-remove device class formaldehyde (not existing in HASS)
-add SYStoMQTT new parameters
-attach connectivity parameter to the device
-add BT gateway infos and switches
-refactor modules storage and publication
2020-11-04 11:53:55 -06:00
DieKatzchen 3df16d2d52 Basic RS232 Communication (#780)
* Added ZGateway RS232
2020-10-19 13:48:58 -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
Florian 489ce99659 Implement OpenHAB autodiscovery (#612) 2020-05-12 15:05:37 -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 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