ESP-IDF Components library

[!CAUTION] New project, esp-idf-lib, succeeded this project. We will NOT update this repository. All new issues and PRs will NOT be accepted here. If you find any issues, please visit the relevant component repository. For instance, ads111x's component repository is esp-idf-lib/ads111x.

Visit esp-idf-lib/core/discussions for discussions and questions.

Please do not use this repository!

Components for Espressif ESP32 ESP-IDF framework and ESP8266 RTOS SDK.

Part of them ported from esp-open-rtos.

Supported versions of frameworks and devices

See "Supported on" column for each of the components.

How to use

ESP32-xx

Clone this repository somewhere, e.g.:

cd ~/myprojects/esp
git clone https://github.com/UncleRus/esp-idf-lib.git

Add path to components in your CMakeLists.txt: e.g:

cmake_minimum_required(VERSION 3.5)
set(EXTRA_COMPONENT_DIRS /home/user/myprojects/esp/esp-idf-lib/components)
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(my-esp-project)

or with CMake FetchContent

cmake_minimum_required(VERSION 3.11)
include(FetchContent)
FetchContent_Declare(
  espidflib
  GIT_REPOSITORY https://github.com/UncleRus/esp-idf-lib.git
)
FetchContent_MakeAvailable(espidflib)
set(EXTRA_COMPONENT_DIRS ${espidflib_SOURCE_DIR}/components)
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(my-esp-project)

ESP8266 RTOS SDK

Clone this repository somewhere, e.g.:

cd ~/myprojects/esp
git clone https://github.com/UncleRus/esp-idf-lib.git

Add path to components in your project makefile, e.g:

PROJECT_NAME := my-esp-project
EXTRA_COMPONENT_DIRS := /home/user/myprojects/esp/esp-idf-lib/components
EXCLUDE_COMPONENTS := ads130e08 max7219 mcp23x17 led_strip max31865 ls7366r max31855
include $(IDF_PATH)/make/project.mk

As some Kconfig.projbuild files use rsource, which the Kconfig parser of ESP8266 RTOS SDK does not understand, run devtools/rewrite_kconfig.rb to rewrite it before building the examples.

ruby devtools/rewrite_kconfig.rb path/to/Kconfig.projbuild

See GitHub examples or GitLab examples.

Documentation

• Documentation
• Frequently asked questions

Components

ADC/DAC libraries

Air quality sensors

Battery controllers

Common libraries

Current and power sensors

Gas sensors

GPIO expanders

Humidity sensors

Inertial measurement units

Input device drivers

LED drivers

Light sensors

Magnetic sensors

Other misc libraries

Pressure sensors

Real-time clocks

Temperature sensors

Library maintainers

• Ruslan V. Uss
• Tomoyuki Sakurai

Credits

• Alex Stewart: ds18x20

• Alexander Bodenseher: hts221

• Andrej Krutak: bh1750

• Angelo Elias Dalzotto: mpu6050

• BernhardG: ms5611

• BhuvanchandraD: ds3231

• Brian Schwind: tsl2561 tsl4531

• Cedric von Gunten: qmp6988

• Christian Skjerning: sts3x

• David Douard: mhz19b

• Erriez: mhz19b

• FastLED project: color lib8tion noise

• Frank Bargstedt: bmp180

• Gabriel Boni Vicari: mpu6050

• Grupo de Pesquisa em Cultura Digital: mpu6050

• GrzegorzH: ds18x20

• Gunar Schorcht: bme680 ccs811 sht3x sts3x

• Jakub Turek: impulse_sensor l3gx lsm303 pca9632

• Jan Veeh: icm42670

• Jeff Rowberg: mpu6050

• Jose Manuel Perez: lc709203f sgm58031

• Joshua Butler: max1704x

• Joshua Kallus: ls7366r

• jsuiker: dht

• Julian Doerner: tsl2591

• Lucio Tarantino: ads111x

• Manuel Markwort: mp2660 tps63101x

• Marc Luehr: veml7700

• Nate Usher: scd30

• Pavel Merzlyakov: ds1302

• Raghav Jha: mpu6050

• RichardA: ds3231

• Ruslan V. Uss: ads111x aht am2320 bh1750 bh1900nux bme680 bmp180 bmp280 button calibration ccs811 dht ds1302 ds1307 ds18x20 ds3231 ds3502 encoder framebuffer hd44780 hdc1000 hmc5883l hx711 i2cdev ina219 ina260 ina3221 led_strip led_strip_spi max31725 max31855 max31865 max7219 mcp23008 mcp23x17 mcp342x mcp4725 mcp960x mcp9808 mpu6050 ms5611 onewire pca9557 pca9685 pcf8563 pcf8574 pcf8575 pcf8591 qmc5883l qmp6988 rda5807m scd30 scd4x sfa3x sgp40 sht3x sht4x si7021 sts21 sts3x tca6424a tca9548 tca95x5 tda74xx tsl2561 tsl4531 tsys01 ultrasonic wiegand

• Sensirion AG: scd30 scd4x sfa3x

• sheinz: bmp280

• Thanh Pham: pcf8591

• Timofei Korostelev: ht16k33

• Tomoyuki Sakurai: dps310 esp_idf_lib_helpers example led_strip_spi lm75

• Weslley Duarte: ads130e08

• xyzroe: qmi8658c

• Zaltora: ina3221

• zeroday: onewire