Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move common settings into a single section #11

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

samamou
Copy link
Member

@samamou samamou commented Nov 28, 2024

No description provided.

@jcelerier
Copy link
Collaborator

Looks like the basic template lost the ESP32-S3 section

Copy link
Member

@vberthiaume vberthiaume left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worked like a charm on Windows here -- just some minor clarifications and potentially useful screenshots in the readme

default
esp32_exception_decoder
${flags.build_flags}
build_unflags = ${flags.build_unflags}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

empty line missing at the end of the file

README.md Outdated

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.
Copy link
Member

@vberthiaume vberthiaume Nov 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just successfully went through steps 1-6 on my Windows machine, jotting down some changes that helped me 😅. Here they are:

1. **Install VSCode and PlatformIO**: We recommend using [Visual Studio Code](https://code.visualstudio.com/) as code editor with the [PlatformIO](https://platformio.org/install/ide?install=vscode) IDE extension.

2. **Clone the `puara-module-templates` repository locally**: `git clone https://github.com/Puara/puara-module-templates.git`

3. **Open a puara template in VS Code**: Open VS Code, and select the platform.IO extension on the left side. This will open the `PLATFORMIO` panel. From there select "Pick a folder", and navigate to one of the `puara-module-templates` subfolders, e.g., `puara-module-templates/basic/` (see below for a list of available templates). Click the "Select Folder" button. Wait for a bit  while Platform.IO configures your project. 
<p align="center">
  <img width="450" src="https://github.com/user-attachments/assets/1d87273a-c3e3-4d5b-890f-6fca498f09b5">
</p>

4. **Configure the board**: Ensure the `board` variable in the `platformio.ini` file matches your board's name. If needed you can find valid board IDs in [Boards](https://docs.platformio.org/en/latest/boards/index.html#boards) catalog, [Boards Explorer](https://registry.platformio.org/search?t=platform) or by using the [pio boards](https://docs.platformio.org/en/latest/core/userguide/cmd_boards.html#cmd-boards) on the command line.

5. **Edit the template**: You are now ready to edit the template according to your board/needs.

6. **Build and upload the file system and firmware**: Once ready, you can use platform.io to build and upload the file system and firmware to your board. You can access the `PLATFORMIO` Project Tasks by clicking on the extension button on the left. Make sure you upload both the filesystem (`Build`/`Upload Filesystem Image` under the `Platform` icon) and the firmware (`Build`/`Upload` under the `General` icon).
<p align="center">
  <img width="150" src="https://github.com/user-attachments/assets/d0254aa6-c1f2-400f-97c6-873a5597637b">
</p>

Copy link
Member

@edumeneses edumeneses left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that change breaks CI.

We need to change line 13 on build.yml:

environment: [ Xiao, tinypico, m5stick-c,  ESP32-S3 ]

It also might be good to remove the ble-advertising-template and libmapper-osc-template folders if not necessary (please confirm with @satmatthills).

@edumeneses
Copy link
Member

It needs rebase and then modification of build.yml for remove/add environments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants