From bfba53c017f75d774eb62e02ff4f9dec2e78d474 Mon Sep 17 00:00:00 2001 From: Vincent Berthiaume Date: Wed, 18 Dec 2024 12:33:58 -0500 Subject: [PATCH] rebase --- README.md | 30 ++++++++++-------- basic/platformio.ini | 72 +++++++++----------------------------------- 2 files changed, 32 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index ee3afa1..31abfbd 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ -[![Build](https://github.com/Puara/puara-module-templates/actions/workflows/build.yml/badge.svg)](https://github.com/Puara/puara-module-templates/actions/workflows/build.yml) +# Puara Module Template (Module Manager) -# Puara Module template (module manager) +[![Build](https://github.com/Puara/puara-module-templates/actions/workflows/build.yml/badge.svg)](https://github.com/Puara/puara-module-templates/actions/workflows/build.yml) This repository contains several templates to be used as a base to create devices that can be controlled over the network the Puara Framework. -## How to use +## How to Use + +1. **Install PlatformIO**: [PlatformIO](https://platformio.org/) (Visual Studio Code ([VSC](https://code.visualstudio.com/)) is recommended as the code editor). + +2. **Clone this repository**: (https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) locally. + +3. **Open the project**: Open the template folder that interests you as a PlatformIO project using the **Add Existing** button in the Project Manager tab. -- Install [PlatformIO](https://platformio.org/) ([VSC](https://code.visualstudio.com/) recommended as the code editor) -- [Clone this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) locally -- Open the template folder that interests you as a PlatformIO project using the **Add Existing** button at the Project manager tab. -- You are ready to edit the template. -- Once finished, remember to change the board before uploading your firmware to the ESP32 board. This template is configured to the [TinyPico](https://www.tinypico.com/), but the firmware is compatible with any ESP32-based board. +4. **Configure the board**: Ensure the `board` variable in the `platformio.ini` file matches your board's name. + +5. **Edit the template**: You are now ready to edit the template according to your board/needs. + +6. **Upload the firmware**: Once finished, remember to change the board configuration if necessary before uploading your firmware to the ESP32 board. This template is configured for the [m5stick-c](https://shop.m5stack.com/products/stick-c), but the firmware is compatible with any ESP32-based board. ## Available Templates @@ -32,11 +38,9 @@ Use this as a base if you want to use libmapper or raw OSC messages. ## More Info on the research related with [Puara](https://github.com/Puara) -[http://www.sat.qc.ca](http://www.sat.qc.ca/) - -[http://www.idmil.org](http://www.idmil.org/) - -[https://www.edumeneses.com](https://www.edumeneses.com) +- [SAT](http://www.sat.qc.ca) +- [IDMIL](http://www.idmil.org) +- [Edu Meneses](https://www.edumeneses.com) ## Licensing diff --git a/basic/platformio.ini b/basic/platformio.ini index 7002e92..fd15381 100644 --- a/basic/platformio.ini +++ b/basic/platformio.ini @@ -11,74 +11,32 @@ [platformio] description = Puara module manager +; Common settings for all environments [common] -lib_deps = - https://github.com/Puara/puara-module.git -build_flags = - -std=gnu++2a -build_unflags = - -std=gnu++11 -std=gnu++14 -std=gnu++17 - -[env:Xiao] platform = espressif32 -board = seeed_xiao_esp32c3 framework = arduino board_build.partitions = min_spiffs_no_OTA.csv -lib_deps = ${common.lib_deps} -build_flags = ${common.build_flags} -build_unflags = ${common.build_unflags} +lib_deps = + https://github.com/Puara/puara-module.git monitor_speed = 115200 monitor_echo = yes monitor_filters = default esp32_exception_decoder -[env:tinypico] -platform = espressif32 -board = tinypico -framework = arduino -board_build.partitions = min_spiffs_no_OTA.csv -build_flags = - -DBOARD_HAS_PSRAM - -mfix-esp32-psram-cache-issue - ${common.build_flags} -build_unflags = ${common.build_unflags} -lib_deps = ${common.lib_deps} -monitor_speed = 115200 -monitor_echo = yes -monitor_filters = - default - esp32_exception_decoder +; Common build flags +[flags] +build_flags = + -std=gnu++2a +build_unflags = + -std=gnu++11 -std=gnu++14 -std=gnu++17 -[env:m5stick-c] -platform = espressif32 -board = m5stick-c -framework = arduino -board_build.partitions = min_spiffs_no_OTA.csv +; Template environment, extend this for specific boards +[env:template] +extends = common +board = m5stick-c ; Change board here, ex: tinypico, esp32-c3-devkitc-02, seeed_xiao_esp32c3 build_flags = -DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue - ${common.build_flags} -build_unflags = ${common.build_unflags} -lib_deps = ${common.lib_deps} -monitor_speed = 115200 -monitor_echo = yes -monitor_filters = - default - esp32_exception_decoder - -[env:ESP32-S3] -platform = espressif32 -board = esp32-c3-devkitc-02 -framework = arduino -board_build.partitions = min_spiffs_no_OTA.csv -build_flags = - -DBOARD_HAS_PSRAM - ${common.build_flags} -build_unflags = ${common.build_unflags} -lib_deps = ${common.lib_deps} -monitor_speed = 115200 -monitor_echo = yes -monitor_filters = - default - esp32_exception_decoder + ${flags.build_flags} +build_unflags = ${flags.build_unflags} \ No newline at end of file