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 8a28bb2cf8 [SERIAL][BREAKING] RS232 change to SERIAL GATEWAY (#2008)
Make the RS232 more generic by converting it to a Serial Gateway
Add the capability to decode BLE data coming through Serial
2024-08-16 11:23:39 -05:00
Florian 2065d57e11 [BOARDS] Remove Arduino boards (#1929) 2024-04-10 15:48:05 -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 a2d3951532 [DOCS] Optim config (#1892) 2024-02-07 16:48:06 -06:00
Florian f616c18ee4 [DOCS] Add robots txt (#1870) 2024-01-16 17:05:47 -06:00
Florian a90f4c86c6 [DOCS] Fix config.js for sitemap (#1869) 2024-01-16 11:00:11 -06:00
Florian 67136efbe2 [DOCS] Add sitemap (#1868) 2024-01-16 09:32:47 -06:00
Florian fc1ce0758b [DOCS] Update navbar and sidebar tyle (#1865)
Apply only to the upload page and add navbar
2024-01-12 17:22:52 -06: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 8fa47d2bde [BOARD] Add Web Upload for ESP32-C3 family (#1861) 2024-01-09 17:35:41 -06:00
Florian 2c3d98729a [DOCS] Factorize documentation configuration into one file (#1856) 2024-01-09 09:57:08 -06:00
DigiH 01a9cdfa2a Favicon transparency (#1702) 2023-06-28 16:04:12 +02:00
Northern Man acc0d91ca8 [WebUI] Added Basic Authentication (#1618)
* [WebUI] Added Basic Authentication

* Make the security option a MACRO to avoid typos in future updates
2023-04-27 16:49:09 -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
DigiH a6e0f6094c Inverted position shifting idle logo (#1484)
* Inverted idle logo

Back on white background start-up logo.
Inverted idle logo with random positioning.

* Idle Logo display default true

DISPLAY_IDLE_LOGO true as burn-in screens saver, especially fo the constant heading and line

* Display Brightness added

* SSD1306toMQTT / MQTTtoSSD1306

Additional "onstate" and "brightness" setting and regular display state reporting

Docs - separate Displays section
2023-03-01 14:36:05 -06:00
Florian f5ef267d02 [DOCS] Move base outside of ThemeConfig (#1354) 2022-12-09 09:15:20 -06:00
Florian 0e76170a55 [DOCS] Add base directory (#1353) 2022-12-08 15:31:50 -06:00
Florian 62553dc2dd Add link to shop (#1317)
and remove the link to Board to avoid overloading the top bar
2022-11-11 13:38:20 -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 9ea985cf55 Add Theengs links (#1249) 2022-07-28 16:48:41 -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 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 67df8589c6 [DOC] Point to upload section (#1051) 2021-08-04 05:36:14 -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
melyux 1de93d3f1d Enable the BME280 options to be settable using PlatformIO build flags, add and organize documentation (#942)
* Allow BME280 options to be build flaggable

* Update and clarify documentation for configurations and builds
2021-05-07 05:50:55 -05:00
DieKatzchen 3df16d2d52 Basic RS232 Communication (#780)
* Added ZGateway RS232
2020-10-19 13:48:58 -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 519eb73dee Documentation update (#723)
-add JQJCY01YM
-add protocol add guidelines
-minor changes
2020-08-06 18:42:34 -05:00
Leon Kiefer b5527d2e7b added support for secure TLS connections (#699)
* added support for secure TLS connections
on ESP32 and ESP8266 close #101

* added TLS test builds

* added documentation for TLS
fixed some some issues in the documentation

* added documentation for error code=54
2020-08-02 11:29:28 -05:00
Florian cf2eaa9c6c [DOC] Add support methods and contributors (#646)
* [DOC] Add support methods and contributors link
2020-07-01 09:24:53 -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
1technophile 1eebf138c2 add version tag to documentation 2019-12-14 20:48:39 +01:00
Florian 4b1f09b06b Wifi managers improvements (#503)
* Add parameters to wifi manager: gateway name and base topic
Enable to restart the ESP and erase the parameters by MQTT
2019-12-07 10:18:42 +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
1technophile 34d31600ee Correct vuepress config error and add code auto deployment 2019-11-08 22:44:48 +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