ESP-IDF Components library

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

[1] Use "idf.py set-target esp32s2" or "idf.py set-target esp32c3" before "idf.py menuconfig" to change the chip type.

[2] Due to the incompatibility of ESP8266 drivers and hardware, some libraries are not supported on ESP8266 (see "ESP8266" column in the tables).

How to use

ESP32

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
include $(IDF_PATH)/make/project.mk

or in CMakeLists.txt:

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 := max7219 mcp23x17 led_strip max31865 ls7366r max31855
include $(IDF_PATH)/make/project.mk

See GitHub examples or GitLab examples.

Documentation

• Documentation
• Frequently asked questions

Components

ADC/DAC libraries

Air quality sensors

Common libraries

Current and power sensors

GPIO expanders

Gas sensors

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

• Tomoyuki Sakurai, developer of the LM75 and SK9822/APA102 drivers, author of the RTOS SDK ESP82666 support, master CI
• Gunar Schorcht, developer of SHT3x, BME680 and CCS811 drivers
• Brian Schwind, developer of TS2561 and TSL4531 drivers
• Andrej Krutak, developer of BH1750 driver
• Frank Bargstedt, developer of BMP180 driver
• sheinz, developer of BMP280 driver
• Jonathan Hartsuiker, developer of DHT driver
• Grzegorz Hetman, developer of DS18B20 driver
• Alex Stewart, developer of DS18B20 driver
• Richard A Burton, developer of DS3231 driver
• Bhuvanchandra DV, developer of DS3231 driver
• Zaltora, developer of INA3231 driver
• Bernhard Guillon, developer of MS5611-01BA03 driver
• Pham Ngoc Thanh, developer of PCF8591 driver
• Lucio Tarantino, developer of ADS111x driver
• Julian Dörner, developer of TSL2591 driver
• FastLED community, developers of lib8tion, color and noise libraries
• Erriez, developer of MH-Z19B driver
• David Douard, developer of MH-Z19B driver
• Nate Usher, developer of SCD30 driver
• Josh Kallus, developer of LS7366R driver
• saasaa, developer of HTS221 driver
• Timofei Korostelev, developer of HT16K33 driver
• Jose Manuel Perez, developer of LC709203F driver
• Weslley Duarte, developer of ADS130E08 driver
• Jan Veeh, developer of ICM42670 driver
• Marc Luehr, developer of VEML7700 driver