mirror of
https://github.com/1technophile/OpenMQTTGateway.git
synced 2026-03-12 10:18:12 +01:00
98481c5145
* 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
OpenMQTTGateway LoRa Node Example
This repository contains an example of a LoRa node program designed for the ESP32 platform. The program reads the DHT22 temperature and humidity, the battery level and water consumption via reed switch, packages the data into a JSON format, and sends it over LoRa.
Features:
- Uses an SX12XX LoRa module.
- Displays packet sending status, counter and battery level data on an SSD1306 OLED display.
- Sends the ESP32's MAC address as the node ID.
- Sends temperature data in Celsius.
Hardware Requirements:
- ESP32 development board.
- SX12XX LoRa module.
- SSD1306 OLED display.
Pin Configuration: (Lilygo LoRa32 V2.1_1.6)
- SCK - GPIO5
- MISO - GPIO19
- MOSI - GPIO27
- SS - GPIO18
- RST - GPIO23
- DI0 - GPIO26
Setup:
Hardware Setup:
Connect the SX1278 LoRa module and the SSD1306 OLED display to the ESP32 according to the pin configuration. Ensure that the OLED display is powered correctly.
Software Setup:
- Clone this repository.
- Open the provided node program with PlatformIO
- Upload the program to your ESP32.
Usage:
Power on the ESP32. The OLED display will show the status of the packet being sent and the current temperature reading. The built-in LED on the ESP32 will blink once every time a packet is sent. Monitor the serial output (at 115200 baud rate) to see the JSON formatted data being sent.
If you use arduino load ino file.
Data Format:
The data is sent in the following JSON format:
{
"model": "ESP32CNT",
"id": "ESP32_MAC_ADDRESS",
"count": "COUNTER_IN_LITER",
"tempc": "TEMPERATURE_IN_CELSIUS",
"hum": "HUMIDITY_IN_PERCENTAGE",
"batt": "BATTERY_IN_PERCENTAGE"
}
Troubleshooting:
LoRa Initialization Failed: Ensure that the SX1278 LoRa module is connected correctly and powered on. OLED Display Not Working: Check the connections and ensure that the display is powered correctly. No Temperature Data: Ensure that the ESP32's internal temperature sensor is functional. Contributing: Feel free to contribute to this example by opening issues or submitting pull requests. Any feedback or improvements are welcome!
I hope this README helps users understand and use your program! Adjustments can be made as necessary to fit any additional details or changes.