uploaded 1 year ago
C++ wrapper classes around ESP IDF components

readme

# ESP-IDF-C++

This project provides C++ wrapper classes around some components of [esp-idf](https://github.com/espressif/esp-idf). It is organized as a component. For more information how to use ESP-IDF components and how to set up ESP-IDF, please refer to [esp-idf](https://github.com/espressif/esp-idf).

## *NOTE*

This repository hasn't been released yet. After the code is in a state that is convincing, we will release it for the component manager. Before the release, there might be breaking changes.

Some bits that are still missing (non-exhaustive list):
* MQTT C++ classes
* Default pin definition on Kconfig for some examples
* Upload into the component registry (need to be done together with release)

That being said, suggestions are very welcome. To use the project in the current state, follow the usual process for setting up the IDF environment (i.e., `. ./export.sh` inside [esp-idf](https://github.com/espressif/esp-idf)). Then checkout this repository and change to the examples or unit tests and try them right away. The component manager is set up for these to find the esp-idf-cxx component locally.

## Requirements

* ESP-IDF and its requirements

No other special requirements are necessary.

Links

Supports all targets

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "espressif/esp-idf-cxx^1.0.0-beta"

or download archive

Dependencies

  • ESP-IDF >=5.0
  • Examples:

    blink_cxx

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp-idf-cxx^1.0.0-beta:blink_cxx"

    or download archive

    esp_event_async_cxx

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp-idf-cxx^1.0.0-beta:esp_event_async_cxx"

    or download archive

    esp_timer_cxx

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp-idf-cxx^1.0.0-beta:esp_timer_cxx"

    or download archive

    simple_i2c_rw_example

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp-idf-cxx^1.0.0-beta:simple_i2c_rw_example"

    or download archive

    simple_spi_rw_example

    To create a project from this example, run:

    idf.py create-project-from-example "espressif/esp-idf-cxx^1.0.0-beta:simple_spi_rw_example"

    or download archive

    Stats

    • Downloaded in total
      Downloaded in total 4.0k times
    • Downloaded this version
      This version: 1.5k times

    Badge

    espressif/esp-idf-cxx version: 1.0.0-beta
    |