SW: add instructions to configure IDE

[mgiugliano]

I am deeply sorry for my stupid request. I would love to tinker the code (currently adding some delay() statement). I failed to have my Arduino IDE up and running to compile and flash the firmware on the microcontroller.

I understand Arduino IDE (or VSCode extension) is not the one in use/recommended. Even creating an empty software.ino file (i.e. touch software.ino) in the folder 'software', the IDE does not like the location of ./lib etc. etc.

Any hints would be helpful. I volunteer to create step by step instructions for newbie like me ;)

[mgiugliano]

:-(

[Elektroarzt]

Hi Mike … I‘ve seen your request, but I’m „only“ the hardware developer. Gurkenflieger is the software guy. Maybe you ask again in the issue. I can’t really help you in this point … sorry.

[mgiugliano]

I would love @Gurkenflieger to be up and running recompiling the code. I apologize for my ignorance. I am really keen to contribute and collaborate.

A quick and dirty pointer to "how do I compile" would be fantastic !

[mgiugliano]

@Gurkenflieger may I ask you to quickly go through the steps I noted down and concisely described below? They might be beneficial for other "beginners" like me who would love to contribute to this project.

Accept my apologies in advance for wasting your time: your feedback would be precious. My text, after your validation or correction, might be then added to some documentation in a simple README.txt file or part of a wiki page.

How to contribute (firmware-wise)

• install Visual Studio Code: see here

• install PlatformIO as an extension to VSCode: see here

• restart VSCode

• click on PlatformIO icon, on the left toolbar

• Create a "New Project", selecting

  • "Seeed Studio XIAO ESP32C3" as Board, and
  • "Espidf" as Framework
    (this procedure may take several minutes)

• copy main.cpp to the root folder of the New Project

• copy the content of lib/ to the root folder of the New Project

Note: your platformio.ini should (automatically) look like this:

[env:seeed_xiao_esp32c3]
platform = espressif32
board = seeed_xiao_esp32c3
framework = espidf

• On top right button, shaped as a thick mark, select "Build". You should have an output similar to the one below (in a terminal window that will be spawn in the bottom part of the VSCode window):

[...]
Creating esp32c3 image...
Merged 2 ELF sections
Successfully created esp32c3 image.
Linking .pio/build/seeed_xiao_esp32c3/firmware.elf
Retrieving maximum program size .pio/build/seeed_xiao_esp32c3/firmware.elf
Checking size .pio/build/seeed_xiao_esp32c3/firmware.elf
Advanced Memory Usage is available via "PlatformIO Home > Project Inspect"
RAM: [ ] 2.6% (used 8652 bytes from 327680 bytes)
Flash: [== ] 17.1% (used 179378 bytes from 1048576 bytes)
Building .pio/build/seeed_xiao_esp32c3/firmware.bin
esptool.py v4.5.1
Creating esp32c3 image...
Merged 2 ELF sections
Successfully created esp32c3 image.
===================================================== [SUCCESS] Took 26.93 seconds =====================================================

• Terminal will be reused by tasks, press any key to close it.

[Gurkenflieger]

Those steps are correct. You can also work with lib deps in the project.

[Elektroarzt]

@mgiugliano if you like to release your information, please make a pull request for a file named 'IDE setup.md' or similar in the software folder containing your information. Please support future upcoming questions of the community concerning your content.
Thanks!