From 5a02fd2d6db03691bb9d73d545cc14804b156d78 Mon Sep 17 00:00:00 2001 From: mcuw <112967559+mcuw@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:23:47 +0200 Subject: [PATCH] Initial Release build --- CHANGELOG.md | 4 ++-- README.md | 41 ++++++++++------------------------------- src/main.cpp | 12 +++++++----- 3 files changed, 19 insertions(+), 38 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 18c1792..c0ce70b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ CHANGELOG -## v0.0.0 +## v0.0.1 -PLEASE WRITE YOUR CHANGES BEFORE YOU CREATE A RELEASE IN THE CHANGELOG.MD FILE! +Initial Release build \ No newline at end of file diff --git a/README.md b/README.md index 9d21c56..a70809c 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,27 @@ -# ESP32 project template +# ECL - ESP32 Closet Lighting with LED-Stripes, sensors and microcontroller ## Description -This is a project template to create microcontroller apps with automatized firmware builds for [esp32](https://www.espressif.com/en/products/socs/esp32), [esp32s2](https://www.espressif.com/en/products/socs/esp32-s2) and [esp32s3](https://www.espressif.com/en/products/socs/esp32-s3) microcontroller boards. It uses for that [GitHub Actions](https://github.com/features/actions) and [platformio](https://platformio.org/). +This project provides firmwares for ESP32 microcontrollers to enhance your closet with lighting. It supports [esp32](https://www.espressif.com/en/products/socs/esp32), [esp32s2](https://www.espressif.com/en/products/socs/esp32-s2) and [esp32s3](https://www.espressif.com/en/products/socs/esp32-s3) microcontroller boards. +### Sensors -## Requirements +- PIR +- Radar -- [GitHub Actions](https://github.com/features/actions) -- [platformio](https://platformio.org/) -- [python](https://www.python.org/) +### Actor +- LED-Stripe -## GitHub Actions - Workflow - -The release build happens in the `build & release` workflow: [build_release.yml](.github/workflows/build_release.yml). -It creates a release, after creation of a new git tag (named it like `v1.0.0`). - -If you want to test the build on all merge w/o creating a tag then the `build` workflow is what you looking for: [build.yml](.github/workflows/build.yml) - - -## PlatformIO - -[PlatformIO](https://platformio.org/) is a tool to create microcontroller apps for arduino platforms and compatibles (esp32). You can install the [Visual Studio Code extension](https://platformio.org/install/ide?install=vscode) in the [Visual Studio Code](https://code.visualstudio.com/) IDE. - - -## Python - -There is a tiny python script needed to customize the firmware filenames within platformio, see documentation: https://docs.platformio.org/en/stable/scripting/examples/custom_program_name.html - -The [extra_script.py](extra_script.py) script gets the platformio env (e.g. lolin32) and the git-tag for the firmware filename. -This is required to publish several firmware names in the github artifacts of a release. ## CHANGELOG -You can write your changes in the [CHANGELOG.md](CHANGELOG.md) before you create a release. It will be shown under the release page. +Release notes see [CHANGELOG.md](CHANGELOG.md). -## Example Release -see [Releases](https://github.com/mcuw/esp-ghbuild-template/releases) on the right sidemenu. - -## Usage +## Releases with build firmware -Use this repository as a template for your own esp32 repository. You can reduce and adapt your required boards in the [platformio.ini](platformio.ini). Update the [CHANGELOG.md](CHANGELOG.md) file before you are creating a new release. When you create a new git tag then a new release will always includes generated firmwares. +see [Releases](https://github.com/mcuw/esp-ghbuild-template/releases) on the right sidemenu. --- diff --git a/src/main.cpp b/src/main.cpp index e73b4d2..f9074c4 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,12 +1,14 @@ #include -void setup() { +void setup() +{ Serial.begin(115200); - while (!Serial); - + while (!Serial) + ; } -void loop() { - Serial.println("Hello World"); +void loop() +{ + Serial.println("Hello ECL"); delay(2000); } \ No newline at end of file