feat(t-dongle-s3): Move button into TDongleS3 as interrupt (#377)

* Add built-in support for configuring the button on the T-Dongle-S3 using the interrupt class, similar to qtpy and others
* Fix docs
* Simplify t dongle s3 example using new button API

Author: finger563

components/qtpy/example/main/qtpy_example.cpp

@@ -13,7 +13,7 @@ extern "C" void app_main(void) {
     logger.info("starting example");
 
     //! [qtpy ex1]
-    auto& qtpy = espp::QtPy::get();
+    auto &qtpy = espp::QtPy::get();
 
     // Initialize the Button
     logger.info("Initializing the button");
@@ -96,7 +96,6 @@ extern "C" void app_main(void) {
     } else {
       logger.info("Found devices at addresses: {::#02x}", found_addresses);
     }
-
     //! [qtpy ex1]
 
     while (true) {

components/qtpy/include/qtpy.hpp

@@ -14,15 +14,17 @@ namespace espp {
 /// ESP32-S3 development boards.
 ///
 /// The class provides access to the following features:
+/// - Button (boot button)
 /// - RGB LED
 /// - I2C (qwiic)
 ///
 /// The class is a singleton and can be accessed using the get() method.
 ///
 /// \section qtpy_example Example
-/// \snippet qtpy_example.cpp qtpy example
+/// \snippet qtpy_example.cpp qtpy ex1
 class QtPy : public BaseComponent {
 public:
+  /// Alias for the button callback function
   using button_callback_t = espp::Interrupt::event_callback_fn;
 
   /// @brief Access the singleton instance of the QtPy class
@@ -124,7 +126,7 @@ class QtPy : public BaseComponent {
   static constexpr auto qwiic_sda_io = GPIO_NUM_41;
   static constexpr auto qwiic_scl_io = GPIO_NUM_40;
 #else
-  #error "Unsupported target"
+#error "Unsupported target"
 #endif
 
   // button (boot button)

components/qtpy/src/qtpy.cpp

@@ -13,8 +13,7 @@ espp::Interrupt &QtPy::interrupts() { return interrupts_; }
 // Button Functions   //
 ////////////////////////
 
-bool QtPy::initialize_button(
-    const QtPy::button_callback_t &callback) {
+bool QtPy::initialize_button(const QtPy::button_callback_t &callback) {
   logger_.info("Initializing button");
 
   // save the callback
@@ -37,7 +36,7 @@ bool QtPy::button_state() const {
 // I2C Functions      //
 ////////////////////////
 
-bool QtPy::initialize_qwiic_i2c(const espp::I2c::Config& i2c_config) {
+bool QtPy::initialize_qwiic_i2c(const espp::I2c::Config &i2c_config) {
   if (qwiic_i2c_) {
     logger_.warn("Qwiic I2C already initialized");
     return false;
@@ -64,19 +63,15 @@ bool QtPy::initialize_led() {
   }
 
   logger_.info("Initializing LED");
-  led_ = std::make_shared<espp::Neopixel>(espp::Neopixel::Config{
-      .data_gpio = led_data_io,
-      .power_gpio = led_power_io
-    });
+  led_ = std::make_shared<espp::Neopixel>(
+      espp::Neopixel::Config{.data_gpio = led_data_io, .power_gpio = led_power_io});
   return true;
 }
 
 /// Set the color of the LED
 /// \param hsv The color of the LED in HSV format
 /// \return True if the LED was set, false otherwise
-bool QtPy::led(const Hsv &hsv) {
-  return led(hsv.rgb());
-}
+bool QtPy::led(const Hsv &hsv) { return led(hsv.rgb()); }
 
 /// Set the color of the LED
 /// \param rgb The color of the LED in RGB format

components/t-dongle-s3/CMakeLists.txt

@@ -2,6 +2,6 @@
 idf_component_register(
   INCLUDE_DIRS "include"
   SRC_DIRS "src"
-  REQUIRES driver base_component display display_drivers i2c led_strip task
+  REQUIRES driver base_component display display_drivers i2c interrupt led_strip task
   REQUIRED_IDF_TARGETS "esp32s3"
   )

components/t-dongle-s3/Kconfig

@@ -0,0 +1,8 @@
+menu "T-Dongle-S3 Configuration"
+    config T_DONGLE_S3_INTERRUPT_STACK_SIZE
+        int "Interrupt stack size"
+        default 4096
+        help
+            Size of the stack used for the interrupt handler. Used by the
+            button callback.
+endmenu

components/t-dongle-s3/example/CMakeLists.txt

@@ -11,7 +11,7 @@ set(EXTRA_COMPONENT_DIRS
 
 set(
   COMPONENTS
-  "main esptool_py t-dongle-s3 button"
+  "main esptool_py t-dongle-s3"
   CACHE STRING
   "List of components to include"
   )

components/t-dongle-s3/example/main/t_dongle_s3_example.cpp

@@ -2,7 +2,6 @@
 #include <stdlib.h>
 #include <vector>
 
-#include "button.hpp"
 #include "t-dongle-s3.hpp"
 
 using namespace std::chrono_literals;
@@ -40,28 +39,19 @@ extern "C" void app_main(void) {
   }
 
   // initialize the button, which we'll use to cycle the rotation of the display
-  espp::Button button(espp::Button::Config{
-      .name = "Boot Button",
-      .interrupt_config =
-          espp::Interrupt::PinConfig{.gpio_num = GPIO_NUM_0,
-                                     .callback =
-                                         [](const auto &event) {
-                                           if (event.active) {
-                                             // lock the display mutex
-                                             std::lock_guard<std::mutex> lock(lvgl_mutex);
-                                             static auto rotation = LV_DISPLAY_ROTATION_0;
-                                             rotation = static_cast<lv_display_rotation_t>(
-                                                 (static_cast<int>(rotation) + 1) % 4);
-                                             fmt::print("Setting rotation to {}\n", (int)rotation);
-                                             lv_display_t *disp = _lv_refr_get_disp_refreshing();
-                                             lv_disp_set_rotation(disp, rotation);
-                                           }
-                                         },
-                                     .active_level = espp::Interrupt::ActiveLevel::LOW,
-                                     .interrupt_type = espp::Interrupt::Type::ANY_EDGE,
-                                     .pullup_enabled = false,
-                                     .pulldown_enabled = false},
-  });
+  logger.info("Initializing the button");
+  auto on_button_pressed = [&](const auto &event) {
+    if (event.active) {
+      // lock the display mutex
+      std::lock_guard<std::mutex> lock(lvgl_mutex);
+      static auto rotation = LV_DISPLAY_ROTATION_0;
+      rotation = static_cast<lv_display_rotation_t>((static_cast<int>(rotation) + 1) % 4);
+      fmt::print("Setting rotation to {}\n", (int)rotation);
+      lv_display_t *disp = _lv_refr_get_disp_refreshing();
+      lv_disp_set_rotation(disp, rotation);
+    }
+  };
+  tdongle.initialize_button(on_button_pressed);
 
   // set the LED to be red
   espp::Hsv hsv(150.0f, 1.0f, 1.0f);

components/t-dongle-s3/include/t-dongle-s3.hpp

@@ -9,6 +9,7 @@
 #include <hal/spi_types.h>
 
 #include "base_component.hpp"
+#include "interrupt.hpp"
 #include "led_strip.hpp"
 #include "st7789.hpp"
 
@@ -17,6 +18,7 @@ namespace espp {
 /// development board.
 ///
 /// The class provides access to the following features:
+/// - Button (boot button)
 /// - Display
 /// - RGB LED
 ///
@@ -26,6 +28,9 @@ namespace espp {
 /// \snippet t_dongle_s3_example.cpp t-dongle-s3 example
 class TDongleS3 : public BaseComponent {
 public:
+  /// Alias for the button callback function
+  using button_callback_t = espp::Interrupt::event_callback_fn;
+
   /// Alias for the pixel type used by the T-Dongle-S3 display
   using Pixel = lv_color16_t;
 
@@ -41,6 +46,23 @@ class TDongleS3 : public BaseComponent {
   TDongleS3(TDongleS3 &&) = delete;
   TDongleS3 &operator=(TDongleS3 &&) = delete;
 
+  /// Get a reference to the interrupts
+  /// \return A reference to the interrupts
+  espp::Interrupt &interrupts();
+
+  /////////////////////////////////////////////////////////////////////////////
+  // Button
+  /////////////////////////////////////////////////////////////////////////////
+
+  /// Initialize the button
+  /// \param callback The callback function to call when the button is pressed
+  /// \return true if the button was successfully initialized, false otherwise
+  bool initialize_button(const button_callback_t &callback = nullptr);
+
+  /// Get the button state
+  /// \return The button state (true = button pressed, false = button released)
+  bool button_state() const;
+
   /////////////////////////////////////////////////////////////////////////////
   // RGB LED
   /////////////////////////////////////////////////////////////////////////////
@@ -208,6 +230,32 @@ class TDongleS3 : public BaseComponent {
   static constexpr gpio_num_t backlight_io = GPIO_NUM_38;
   using DisplayDriver = espp::St7789;
 
+  // button (boot button)
+  static constexpr gpio_num_t button_io = GPIO_NUM_0; // active low
+
+  // Interrupts
+  espp::Interrupt::PinConfig button_interrupt_pin_{
+      .gpio_num = button_io,
+      .callback =
+          [this](const auto &event) {
+            if (button_callback_) {
+              button_callback_(event);
+            }
+          },
+      .active_level = espp::Interrupt::ActiveLevel::LOW,
+      .interrupt_type = espp::Interrupt::Type::ANY_EDGE,
+      .pullup_enabled = true};
+
+  // we'll only add each interrupt pin if the initialize method is called
+  espp::Interrupt interrupts_{
+      {.interrupts = {},
+       .task_config = {.name = "t-dongle-s3 interrupts",
+                       .stack_size_bytes = CONFIG_T_DONGLE_S3_INTERRUPT_STACK_SIZE}}};
+
+  // button
+  std::atomic<bool> button_initialized_{false};
+  button_callback_t button_callback_{nullptr};
+
   // led
   std::shared_ptr<LedStrip> led_;
   spi_bus_config_t led_spi_bus_config_;

components/t-dongle-s3/src/t-dongle-s3.cpp

@@ -5,6 +5,31 @@ using namespace espp;
 TDongleS3::TDongleS3()
     : BaseComponent("TDongleS3") {}
 
+espp::Interrupt &TDongleS3::interrupts() { return interrupts_; }
+
+///////////////////////
+// Button Functions  //
+///////////////////////
+
+bool TDongleS3::initialize_button(const TDongleS3::button_callback_t &callback) {
+  logger_.info("Initializing button");
+
+  // save the callback
+  button_callback_ = callback;
+
+  // configure the button
+  interrupts_.add_interrupt(button_interrupt_pin_);
+  button_initialized_ = true;
+  return true;
+}
+
+bool TDongleS3::button_state() const {
+  if (!button_initialized_) {
+    return false;
+  }
+  return interrupts_.is_active(button_interrupt_pin_);
+}
+
 ///////////////////////
 // RGB LED Functions //
 ///////////////////////