esp-cpp · finger563 · May 9, 2025 · May 9, 2025 · May 9, 2025
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,6 +8,7 @@ on:
       - 'external/**'
       - '.github/workflows/build.yml'
       - '!**/idf_component.yml'
+      - '!**/README.md'
 
 jobs:
   build:

diff --git a/components/adc/README.md b/components/adc/README.md
@@ -1,5 +1,7 @@
 # ADC (Analog to Digital Converter) Component
 
+[![Badge](https://components.espressif.com/components/espp/adc/badge.svg)](https://components.espressif.com/components/espp/adc)
+
 This component provides some classes which encapsulate analog value sampling
 using the ESP's built-in ADC hardware and peripheral drivers.
 

diff --git a/components/ads1x15/README.md b/components/ads1x15/README.md
@@ -1,5 +1,7 @@
 # Ads1x15 I2C ADC Expander
 
+[![Badge](https://components.espressif.com/components/espp/ads1x15/badge.svg)](https://components.espressif.com/components/espp/ads1x15)
+
 The `ADS1x15` provides a class for communicating with the ADS1x15 (ADS1015 and
 ADS1115) family of I2C ADC chips with configurable gain and sampling rate.
 

diff --git a/components/ads7138/README.md b/components/ads7138/README.md
@@ -1,5 +1,7 @@
 # Ads7138 I2C ADC Expander
 
+[![Badge](https://components.espressif.com/components/espp/ads7138/badge.svg)](https://components.espressif.com/components/espp/ads7138)
+
 The `Ads7138` class implements support for the Texas Instruments ADS7138 12-bit
 8-channel ADC. The ADS7138 is a 12-bit, 8-channel, low-power, successive
 approximation register (SAR) analog-to-digital converter (ADC) which can

diff --git a/components/as5600/README.md b/components/as5600/README.md
@@ -1,5 +1,7 @@
 # As5600 Magnetic Encoder
 
+[![Badge](https://components.espressif.com/components/espp/as5600/badge.svg)](https://components.espressif.com/components/espp/as5600)
+
 The `AS5600` magnetic encoder component provides the user a convenient way to
 measure
 

diff --git a/components/aw9523/README.md b/components/aw9523/README.md
@@ -1,5 +1,7 @@
 # AW9523 I2C I/O Expander and LED Driver
 
+[![Badge](https://components.espressif.com/components/espp/aw9523/badge.svg)](https://components.espressif.com/components/espp/aw9523)
+
 The `AW9523` I/O expander component allows the user to configure inputs,
 outputs, interrupts, etc. via a serial interface such as I2C. It also supports
 dimming control for LEDs attached to the expander's port pins, when those pins

diff --git a/components/base_component/README.md b/components/base_component/README.md
@@ -1,5 +1,7 @@
 # Base Component
 
+[![Badge](https://components.espressif.com/components/espp/base_component/badge.svg)](https://components.espressif.com/components/espp/base_component)
+
 The `espp::BaseComponent` provides a simple base class for all components in the
 ESP-CPP package. It provides a simple interface for the component to be
 initialized and to be updated.

diff --git a/components/base_peripheral/README.md b/components/base_peripheral/README.md
@@ -1,5 +1,7 @@
 # Base Peripheral
 
+[![Badge](https://components.espressif.com/components/espp/base_peripheral/badge.svg)](https://components.espressif.com/components/espp/base_peripheral)
+
 The `espp::BasePeripheral` class is a base class for all peripherals. It
 provides a common interface for all peripherals and is used to access the
 peripheral's registers. It is primarily designed to be used as a base class for

diff --git a/components/binary-log/README.md b/components/binary-log/README.md
@@ -1,5 +1,7 @@
 # Binary Logging Component
 
+[![Badge](https://components.espressif.com/components/espp/binary_log/badge.svg)](https://components.espressif.com/components/espp/binary_log)
+
 The binary log component provides a wrapper around
 https://github.com/p-ranav/binary_log for enabling compact binary logging of
 basic integer, floating point, and string data types.

diff --git a/components/bldc_driver/README.md b/components/bldc_driver/README.md
@@ -1,5 +1,7 @@
 # BLDC (Brushless DC) Motor Driver Component
 
+[![Badge](https://components.espressif.com/components/espp/bldc_driver/badge.svg)](https://components.espressif.com/components/espp/bldc_driver)
+
 The `BldcDriver` component wraps around the `ESP MCPWM Peripheral
 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/mcpwm.html>`_
 to provide full 6 PWM control over a 3 phase brushless dc motor.

diff --git a/components/bldc_haptics/README.md b/components/bldc_haptics/README.md
@@ -1,5 +1,7 @@
 # BLDC (Brushless DC) Motor Haptics Component
 
+[![Badge](https://components.espressif.com/components/espp/bldc_haptics/badge.svg)](https://components.espressif.com/components/espp/bldc_haptics)
+
 The `BldcHaptics` class is a high-level interface for controlling a BLDC motor
 with a haptic feedback loop. It is designed to be used to provide haptic
 feedback as part of a rotary input device (the BLDC motor). The component

diff --git a/components/bldc_motor/README.md b/components/bldc_motor/README.md
@@ -1,5 +1,7 @@
 # BLDC (Brushless DC) Motor Component
 
+[![Badge](https://components.espressif.com/components/espp/bldc_motor/badge.svg)](https://components.espressif.com/components/espp/bldc_motor)
+
 The `BldcMotor` implements the Field-Oriented Control (FOC) algorithm with
 support for multiple transforms to drive voltage (such as Sinusoidal and Space
 Vector). It supports the following motion control configurations (which can be

diff --git a/components/ble_gatt_server/README.md b/components/ble_gatt_server/README.md
@@ -1,5 +1,7 @@
 # BLE GATT Server Component
 
+[![Badge](https://components.espressif.com/components/espp/ble_gatt_server/badge.svg)](https://components.espressif.com/components/espp/ble_gatt_server)
+
 The `ble_gatt_server` component provides a few different classes for
 implementing standard / common GATT server requirements, including the server
 itself, the Device Information Service, and the Battery Service.

diff --git a/components/bm8563/README.md b/components/bm8563/README.md
@@ -1,5 +1,7 @@
 # BM8563 Real-Time Clock (RTC) Component
 
+[![Badge](https://components.espressif.com/components/espp/bm8563/badge.svg)](https://components.espressif.com/components/espp/bm8563)
+
 The `Bm8563` component provides a driver for the Bm8563 RTC chip to be able to
 set and query the clock time using a battery-backed up real-time clock (RTC).
 

diff --git a/components/button/README.md b/components/button/README.md
@@ -1,5 +1,7 @@
 # Button Component
 
+[![Badge](https://components.espressif.com/components/espp/button/badge.svg)](https://components.espressif.com/components/espp/button)
+
 The `Button` class provides a simple way to read the state of a button. There
 are two ways to configure the functionality of the button.
 

diff --git a/components/chsc6x/README.md b/components/chsc6x/README.md
@@ -1,5 +1,7 @@
 # CHSC6X I2C Touch Controller Component
 
+[![Badge](https://components.espressif.com/components/espp/chsc6x/badge.svg)](https://components.espressif.com/components/espp/chsc6x)
+
 The `Chsc6x` class provides an interface to the CHSC6X touch controller. It
 provides methods for querying the touchpad data to see where the user is
 touching.

diff --git a/components/cli/README.md b/components/cli/README.md
@@ -1,5 +1,7 @@
 # CLI (Command Line Interface) Component
 
+[![Badge](https://components.espressif.com/components/espp/cli/badge.svg)](https://components.espressif.com/components/espp/cli)
+
 The `cli.hpp` header provides a convenience include / wrapper around
 `daniele77/cli <https://github.com/daniele77/cli>`_. It also exposes `cli`'s
 include folder, so including `"cli.hpp"` is completely equivalent to including

diff --git a/components/codec/README.md b/components/codec/README.md
@@ -1,5 +1,7 @@
 # Codec (Audio) Component
 
+[![Badge](https://components.espressif.com/components/espp/codec/badge.svg)](https://components.espressif.com/components/espp/codec)
+
 The `codec` component contains a couple audio codec components copied and
 modified from [esp-adf](https://github.com/espressif/esp-adf), specifically from
 the

diff --git a/components/color/README.md b/components/color/README.md
@@ -1,5 +1,7 @@
 # Color Component
 
+[![Badge](https://components.espressif.com/components/espp/color/badge.svg)](https://components.espressif.com/components/espp/color)
+
 The `color.hpp` header provides two classes for performing color management,
 interpolation, and conversion - `espp::Rgb` and `espp::Hsv` which can be
 converted between each other. The RGB color space provides support for additive

diff --git a/components/controller/README.md b/components/controller/README.md
@@ -1,5 +1,7 @@
 # Controller Component
 
+[![Badge](https://components.espressif.com/components/espp/controller/badge.svg)](https://components.espressif.com/components/espp/controller)
+
 The `Controller` class provides a convenience for reading multiple GPIOs at once
 and mapping their state to common controller buttons. It can optionally be
 configured to support joystick select, as well as to convert analog joystick

diff --git a/components/cst816/README.md b/components/cst816/README.md
@@ -1,5 +1,7 @@
 # CST816 I2C Touch Controller Component
 
+[![Badge](https://components.espressif.com/components/espp/cst816/badge.svg)](https://components.espressif.com/components/espp/cst816)
+
 The `Cst816` class provides an interface to the CST816 touch controller. It
 allows you to query the data for the touch points on the touchscreen.
 

diff --git a/components/csv/README.md b/components/csv/README.md
@@ -1,5 +1,7 @@
 # Comma-Separated Value (CSV) Parsing Component
 
+[![Badge](https://components.espressif.com/components/espp/csv/badge.svg)](https://components.espressif.com/components/espp/csv)
+
 The `csv.hpp` header provides a convenience include / wrapper around
 `p-ranav/csv2 <https://github.com/p-pranav/csv2`_. It also exposes `csv2`'s
 include folder, so including `csv.hpp` is completely equivalent to including

diff --git a/components/display/README.md b/components/display/README.md
@@ -1,5 +1,7 @@
 # Display Component
 
+[![Badge](https://components.espressif.com/components/espp/display/badge.svg)](https://components.espressif.com/components/espp/display)
+
 The `display` component is responsible for managing the memory associated the
 display buffer / video RAM (vram). It ensures that the LVGL subsystem is
 configured appropriately.
diff --git a/components/display_drivers/README.md b/components/display_drivers/README.md
@@ -1,5 +1,7 @@
 # Display Drivers Components
 
+[![Badge](https://components.espressif.com/components/espp/display_drivers/badge.svg)](https://components.espressif.com/components/espp/display_drivers)
+
 This component contains a few different display drivers, corresponding to common
 display drivers on espressif development boards. These display drivers are
 designed to be used with the `display` component.

diff --git a/components/drv2605/README.md b/components/drv2605/README.md
@@ -1,5 +1,7 @@
 # Drv2605 I2C Haptic Motor Driver Component
 
+[![Badge](https://components.espressif.com/components/espp/drv2605/badge.svg)](https://components.espressif.com/components/espp/drv2605)
+
 The `DRV2605` haptic motor driver component allows the user to configure and
 play custom or preconfigured haptic feedback sequences via a serial interface
 such as I2C. It supports directly driving ECM (eccentric rotating mass) and LRA

diff --git a/components/encoder/README.md b/components/encoder/README.md
@@ -1,5 +1,7 @@
 # ABI Encoder Component
 
+[![Badge](https://components.espressif.com/components/espp/encoder/badge.svg)](https://components.espressif.com/components/espp/encoder)
+
 The `AbiEncoder` allow the user a configurable container wrapping the `pulse
 count
 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-reference/peripherals/pcnt.html>`_

diff --git a/components/esp-box/README.md b/components/esp-box/README.md
@@ -1,5 +1,7 @@
 # ESP-BOX Board Support Package (BSP) Component
 
+[![Badge](https://components.espressif.com/components/espp/esp-box/badge.svg)](https://components.espressif.com/components/espp/esp-box)
+
 The ESP32-S3-BOX and ESP32-S3-BOX-3 are development boards for the ESP32-S3
 module. They feature a nice touchscreen display, an IMU, a speaker, microphones,
 and expansion headers.

diff --git a/components/esp32-timer-cam/README.md b/components/esp32-timer-cam/README.md
@@ -1,5 +1,7 @@
 # ESP32-TIMER-CAM Board Support Package (BSP) Component
 
+[![Badge](https://components.espressif.com/components/espp/esp32-timer-cam/badge.svg)](https://components.espressif.com/components/espp/esp32-timer-cam)
+
 The ESP32 TimerCam is a little usb-c webcamera using the ESP32. It has a little
 blue LED, a real-time clock (RTC), and supports battery operation with battery
 voltage monitoring as well.

diff --git a/components/event_manager/README.md b/components/event_manager/README.md
@@ -1,5 +1,7 @@
 # Event Manager Component
 
+[![Badge](https://components.espressif.com/components/espp/event_manager/badge.svg)](https://components.espressif.com/components/espp/event_manager)
+
 The `EventManager` class enables anonymous publish/subscribe interactions
 between different software components and contexts in the system. It provides a
 singleton class which manages the registry of publishers and subscribers in the

diff --git a/components/file_system/README.md b/components/file_system/README.md
@@ -1,5 +1,7 @@
 # File System Component
 
+[![Badge](https://components.espressif.com/components/espp/file_system/badge.svg)](https://components.espressif.com/components/espp/file_system)
+
 The `FileSystem` class provides a simple interface for interacting with the
 filesystem. It provides a singleton class which manages the filesystem and also
 includes the relevant POSIX, newlib, and C++ standard library headers providing

diff --git a/components/filters/README.md b/components/filters/README.md
@@ -1,5 +1,7 @@
 # Filters Component
 
+[![Badge](https://components.espressif.com/components/espp/filters/badge.svg)](https://components.espressif.com/components/espp/filters)
+
 The `filters` component contains various types of filters that can be used for
 various signal processing and state estimation tasks.
 

diff --git a/components/format/README.md b/components/format/README.md
@@ -1,5 +1,7 @@
 # Format Component
 
+[![Badge](https://components.espressif.com/components/espp/format/badge.svg)](https://components.espressif.com/components/espp/format)
+
 Format is a simple component which exposes `libfmt` for use within esp-idf as a
 single include.
 
diff --git a/components/ft5x06/README.md b/components/ft5x06/README.md
@@ -1,5 +1,7 @@
 # FT5x06 I2C Touch Controller Component
 
+[![Badge](https://components.espressif.com/components/espp/ft5x06/badge.svg)](https://components.espressif.com/components/espp/ft5x06)
+
 The FT5x06 is a capacitive touch controller that supports up to 5 touch points.
 
 ## Example

diff --git a/components/ftp/README.md b/components/ftp/README.md
@@ -1,5 +1,7 @@
 # FTP (File Transfer Protocol) Component
 
+[![Badge](https://components.espressif.com/components/espp/ftp/badge.svg)](https://components.espressif.com/components/espp/ftp)
+
 The `ftp` component provides an implementation of various parts of the file
 transfer protocol.
 

diff --git a/components/gfps_service/README.md b/components/gfps_service/README.md
@@ -1,5 +1,7 @@
 # Google Fast Pair Service (GFPS) Service BLE Service Component
 
+[![Badge](https://components.espressif.com/components/espp/gfps_service/badge.svg)](https://components.espressif.com/components/espp/gfps_service)
+
 The `GfpsService` implements the Google Fast Pair Service, allowing first-party
 fast-pair experience on Android devices using the google nearby framework. This
 also supports app matching / launching, as well as Google's `Find My Device`

diff --git a/components/gt911/README.md b/components/gt911/README.md
@@ -1,5 +1,7 @@
 # GT911 I2C Touch Controller Component
 
+[![Badge](https://components.espressif.com/components/espp/gt911/badge.svg)](https://components.espressif.com/components/espp/gt911)
+
 The `Gt911` class provides an interface to the GT911 touch controller, allowing
 the user to query the touch data, including the detection of whether the home
 button (if any) is pressed.

diff --git a/components/hid-rp/README.md b/components/hid-rp/README.md
@@ -1,5 +1,7 @@
 # HID-RP Component
 
+[![Badge](https://components.espressif.com/components/espp/hid-rp/badge.svg)](https://components.espressif.com/components/espp/hid-rp)
+
 The `hid-rp` component provides a wrapper around
 https://github.com/intergatedcircuits/hid-rp and also provides an example
 implementation of a configurable HID Gamepad using hid-rp.

diff --git a/components/hid_service/README.md b/components/hid_service/README.md
@@ -1,5 +1,7 @@
 # BLE HID Service Example
 
+[![Badge](https://components.espressif.com/components/espp/hid_service/badge.svg)](https://components.espressif.com/components/espp/hid_service)
+
 The `HidService` implements the standard BLE HID service, providing dynamic and
 configurable HID input, output, and feature reports from a BLE peripheral to a
 BLE central.

diff --git a/components/i2c/README.md b/components/i2c/README.md
@@ -1,5 +1,7 @@
 # I2C Component
 
+[![Badge](https://components.espressif.com/components/espp/i2c/badge.svg)](https://components.espressif.com/components/espp/i2c)
+
 The `I2C` class provides a simple interface to the I2C bus. It is a wrapper
 around the esp-idf I2C driver.
 

diff --git a/components/icm20948/README.md b/components/icm20948/README.md
@@ -1,5 +1,7 @@
 # ICM20948 9-Axis IMU Component
 
+[![Badge](https://components.espressif.com/components/espp/icm20948/badge.svg)](https://components.espressif.com/components/espp/icm20948)
+
 The `Icm20948` component provides a driver for the ICM20948 9-Axis Inertial
 Measurement Unit (IMU). 
 

diff --git a/components/icm42607/README.md b/components/icm42607/README.md
@@ -1,5 +1,7 @@
 # ICM42607 Example
 
+[![Badge](https://components.espressif.com/components/espp/icm42607/badge.svg)](https://components.espressif.com/components/espp/icm42607)
+
 The `Icm42607` component provides a driver for the ICM42607 and ICM42670 6-Axis
 Inertial Measurement Units (IMUs).
 

diff --git a/components/input_drivers/README.md b/components/input_drivers/README.md
@@ -1,5 +1,7 @@
 # Input Drivers Component for LVGL
 
+[![Badge](https://components.espressif.com/components/espp/input_drivers/badge.svg)](https://components.espressif.com/components/espp/input_drivers)
+
 This component provides a set of convenience classes for configuring various
 types of input for LVGL displays.
 

diff --git a/components/interrupt/README.md b/components/interrupt/README.md
@@ -1,5 +1,7 @@
 # Interrupt Component
 
+[![Badge](https://components.espressif.com/components/espp/interrupt/badge.svg)](https://components.espressif.com/components/espp/interrupt)
+
 The `Interrupt` class provides APIs to register interrupt handlers for GPIO and
 configure the interrupts. Interrupts can be configured to trigger on rising
 edge, falling edge, high level, low level, or any change in the input signal. A

diff --git a/components/joystick/README.md b/components/joystick/README.md
@@ -1,5 +1,7 @@
 # Joystick Component
 
+[![Badge](https://components.espressif.com/components/espp/joystick/badge.svg)](https://components.espressif.com/components/espp/joystick)
+
 The `Joystick` class provides a wrapper around a 2-axis analog joystick, with an
 associated reader function for grabbing the raw values. When the joystick
 `update()` is called, the raw values are mapped into the range `[-1,1]` for each

diff --git a/components/kts1622/README.md b/components/kts1622/README.md
@@ -1,5 +1,7 @@
 # KTS1622 I2C I/O Expander
 
+[![Badge](https://components.espressif.com/components/espp/kts1622/badge.svg)](https://components.espressif.com/components/espp/kts1622)
+
 The `KTS1622` I/O expander component allows the user to configure inputs,
 outputs, interrupts, etc. via a serial interface such as I2C.
 

diff --git a/components/led/README.md b/components/led/README.md
@@ -1,5 +1,7 @@
 # LED Component
 
+[![Badge](https://components.espressif.com/components/espp/led/badge.svg)](https://components.espressif.com/components/espp/led)
+
 The LED provides a convenient and thread-safe wrapper around the [ESP-IDF LEDC
 perhipheral](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/ledc.html#led-control-ledc).
 

diff --git a/components/led_strip/README.md b/components/led_strip/README.md
@@ -1,5 +1,7 @@
 # LED Strip Component 
 
+[![Badge](https://components.espressif.com/components/espp/led_strip/badge.svg)](https://components.espressif.com/components/espp/led_strip)
+
 The `LedStrip` component provides APIs to control LED strips. It supports
 various LED strip types, such as WS2812, WS2811, WS2813, SK6812, APA102, etc.
 You can use it directly with an SPI driver to talk to APA102 LED strips, or you

diff --git a/components/logger/README.md b/components/logger/README.md
@@ -1,5 +1,7 @@
 # Logger Component
 
+[![Badge](https://components.espressif.com/components/espp/logger/badge.svg)](https://components.espressif.com/components/espp/logger)
+
 The logger provides a cross-platform wrapper around `libfmt` for providing
 configurable log output with different levels that can be turned on / off at
 runtime.

diff --git a/components/math/README.md b/components/math/README.md
@@ -1,5 +1,7 @@
 # Math Component
 
+[![Badge](https://components.espressif.com/components/espp/math/badge.svg)](https://components.espressif.com/components/espp/math)
+
 The `math` component provides various classes and static functions for commonly
 used math operations.
 

diff --git a/components/matouch-rotary-display/README.md b/components/matouch-rotary-display/README.md
@@ -1,5 +1,7 @@
 # Matouch-Rotary-Display Board Support Package (BSP) Component
 
+[![Badge](https://components.espressif.com/components/espp/matouch-rotary-display/badge.svg)](https://components.espressif.com/components/espp/matouch-rotary-display)
+
 The Matouch Rotary Display is a development board for the ESP32-S3 module. It
 features a nice touchscreen display, a rotary encoder, a push button behind the
 screen, and some expansion headers along with other peripherals like a micro-SD