This is the repository for some c++ components developed for the ESP-IDF framework.
Each component has an example
folder which contains c++ code showing how to
use the component and which has a README including instructions for how to run
the example
Table of Contents
The components in this repository are targeted towards ESP-IDF >=5.0, though they are mainly tested against 5.2 right now.
To use the components in this repository, you have a few options:
You can use the esp-cppp/template
repository as a starting point, which is very similar to the esp-idf
template, but is geared towards c++ development and already has espp
as a
submodule, along with the appropriate configuration in the top-level
CMakeLists.txt.
If you have an existing project with a components
directory, then you can
clone espp
as a submodule within that directory e.g. git submodule add https://github.com/esp-cpp/espp components/espp
, then make sure to run git submodule update --init --recursive
. Afterwards, simply update your
CMakeLists.txt
to add
# add the component directories that we want to use
set(EXTRA_COMPONENT_DIRS
"components/espp/components"
)
You can clone espp somewhere on your computer and then point your project to
its components
directory to use any of the components it contains, similar
to the step above.
In the future (as part of #312), we may publish espp components (or even the whole espp repo) as an IDF component via the idf-component-registry.
docker build -t esp-docs doc
once before running
build_docs.sh
. This is only required if you want to build the documentation
locally.Many components in this repo contain example code (referenced in the
documentation above) that shows some basic usage. This example code can be found
in that component's example
directory. NOTE: many component examples also make
use of other components (esp. some of the foundational components such as
format
, logger
, and task
.
The esp-cpp github organization contains other repositories that build specific demonstrations with these (and other) components.
One such example is the esp-box-emu repository, which builds upon these components to create a multiplatform emulation system using the ESP32-S3-BOX hardware.
If you plan to develop espp components, then it is recommended to configure your development environment:
clang-format
is installedSet up pre-commit
for this repository:
pre-commit install
This helps ensure that consistent code formatting is applied.
If you wish to build the documentation, you should have docker installed, then you can run
docker build -t esp-docs doc
To build the docker container which you will use to build the documentation locally (for testing).
Thereafter, you can use the included build script to build the documentation locally.
./build_docs.sh