Skip to content

StepByStep Tutorial for ESP32-Projects with VS-Code

License

Notifications You must be signed in to change notification settings

Gustice/ESP32Tutorial

Repository files navigation

ESP32Tutorial

StepByStep Tutorial for ESP32-Projects with VS-Code.

Note: Each part shows the result of the lection. The instruction is given in Readme. I tried to describe also parts for completely new user. But it will certainly help if you also accomplish a VS-Code C/C++ Tutorial. This also describes most concepts i'm using to build and unit test my projects.

Preconditions

Installed programs:

  • Visual Studio Code with following extensions:
    • C/C++ (Microsoft)
    • CMake Tools
    • CMake (twxs)
  • Installed Espressif toolchain with IDF (IoT-Development-Framework)
    • See Getting started for details
    • Register path to cloned IDF as Environment variable %IDF_PATH%
  • To compile and run tests you need also to install on you machine

Notes

  • You may use the Espressif plugin on VS Code but actually i wasn't able to get this thing to work.
  • You may also use the platform IO extension (this would be great to start), but i suspect this leaves you less opportunities to maintain projects that relay on different IDF-Versions

Gists

The following gist may help you.

Start a Project

To start a new project you generally search of a example that aims your target application. Lets say you want to build a small web server. In this case on can copy the example in %IDF_PATH%\examples\wifi\getting_started\softAP and start to modify it. However one must be at least a little aware of the underlying build system in order to add components properly. This is what this tutorial is about. Note that in this tutorial i use only the hello-world example, for no reasons. You can take any project from examples for your targeted project.

Reference

The documentation for the API is pretty good and useful. See API Reference.

There are also useful guides to dig further into the whole system. API Guides.

Final notes

If you are using this tutorial please give me feedback so i can revise this tutorial.

About

StepByStep Tutorial for ESP32-Projects with VS-Code

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages