https://github.com/espressif/esp-idf-cxx

C++ wrapper classes for ESP-IDF components.
https://github.com/espressif/esp-idf-cxx

Last synced: 2 days ago
JSON representation

C++ wrapper classes for ESP-IDF components.

• Host: GitHub
• URL: https://github.com/espressif/esp-idf-cxx
• Owner: espressif
• License: apache-2.0
• Created: 2022-05-04T10:35:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-05T10:04:30.000Z (7 months ago)
• Last Synced: 2024-09-18T15:59:14.656Z (8 days ago)
• Language: C++
• Size: 120 KB
• Stars: 77
• Watchers: 13
• Forks: 13
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

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 the [IDF component manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html). You can find this component [in the component registry](https://components.espressif.com/components/espressif/esp-idf-cxx). 

## *NOTE*

This component is in a beta-release phase. Some bits that are still missing (non-exhaustive list):

* MQTT C++ classes

* Default pin definition on Kconfig for some examples

A road map and detailed release document will be announced soon.

## Requirements

* ESP-IDF and its requirements.

  Please follow the [ESP-IDF "Get Started" Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html) to download, install and setup esp-idf.

No other special requirements are necessary.

## Usage

Set up the IDF environment (i.e., `. ./export.sh` inside [esp-idf](https://github.com/espressif/esp-idf)). Then go to your project directory, use `idf.py add-dependency espressif/esp-idf-cxx^1.0.0-beta ` (should only be done once) and you should be able to use this component.