espressif / esp-idf-cxx Goto Github PK

C++ wrapper classes for ESP-IDF components.

License: Apache License 2.0

CMake 3.33% C++ 96.39% Python 0.28%

esp-idf-cxx's Introduction

ESP-IDF-C++

This project provides C++ wrapper classes around some components of esp-idf. It is organized as a component for the IDF component manager. You can find this component in the component registry.

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 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). 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.

esp-idf-cxx's People

Contributors

Stargazers

Watchers

Forkers

gtjoseph esp-cpp jordeam bitsforpeople cyrilb1531 aaron71680 jk128 euripedesrocha jgraulle pae11 sylvainleris

esp-idf-cxx's Issues

release plan?

wow, this sounds like a breaking change for esp-idf developers! is there a kind of plan for a stable and comprehensive release?

9esp_timer_is_active ?

Hi,

in the Timer Wrapper,

we cannot ask if a Timer is active ?

https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/esp_timer.html#_CPPv419esp_timer_is_active18esp_timer_handle_t

can this be added somehow ?

Naming convention in GPIO

All classes defined in gpio_cxx uses the following naming convention:
GPIO
but Output and OpenDrain use
GPIO_

As the project follows esp-idf coding style, these classes should be GPIOOutput and GPIOOpenDrain

use fmt library for C++ logging (IDFGH-8779)

Is your feature request related to a problem?

More powerful formatting for log messages

Describe the solution you'd like.

If using C++11/14/17: https://github.com/fmtlib/fmt
For C++20 it is part of the standard https://en.cppreference.com/w/cpp/utility/format

Describe alternatives you've considered.

No response

Additional context.

This would only work for C++

Why the function name style change from GPIOInput() vs GPIO_Output()

Hello,

Is there a reason for the change in the name style between these two classes? Could we make a PR to change the class name, and provide a using statement to allow existing code to continue to compile?

If I find the time I could make the refactoring. But I would like some feedback concerning whether there was some rationale behind the current naming...

Thank you,
Michael Uman
Sr Software/Firmware Engineer
UmanSoft.ddns.net

Using esp-idf-cxx with ESP8266 SDK

Hi, I was wondering if it's possible to use this C++ wrapper for ESP8266?
I'm a bit new to ESP. I did configure the ESP8266 SDK in Qt Creator but didn't manage to use this C++ wrapper.
The idf.py add-dependency command doesn't work as there is no add-dependency option in the ESP8266 SDK's idf.py.

So, if the answer is yes, could you please provide a working example for it?

How to install

Hi! Should one put the github repo in the idf_component.yml?
I can not find this awesome component in the component registry

Thank you for the great work

ESP32-C6 Support

The library currently fails to compile for the ESP32-C6 target. Part of it seems to be the missing declaration of INVALID_GPIOS, but it looks like there's also something about the number of I2C that needs adjustment.