feat(esp-box): Add interrupts for mute and boot buttons (#398)

* feat(esp-box): Add interrupts for mute and boot buttons
* Update esp-box to have optional registration of interrupt callbacks for mute and boot buttons
* Update esp-box to check sound initialized before dealing with sound functions
* Update qtpy to only register button interrupt if not already registered

Fleshes out more of the hardware functionality in esp-box; ensures the API cannot be misued and handles cases where mute button is initialized but sound is not.

* add missing character

Author: finger563

components/esp-box/include/esp-box.hpp

@@ -34,15 +34,19 @@ namespace espp {
 /// - Display
 /// - Audio
 /// - Interrupts
+/// - Buttons (boot and mute)
 /// - I2C
-/// - IMU (Inertial Measurement Unit)
+/// - IMU (Inertial Measurement Unit), 6-axis ICM42607
 ///
 /// The class is a singleton and can be accessed using the get() method.
 ///
 /// \section esp_box_example Example
 /// \snippet esp_box_example.cpp esp box example
 class EspBox : 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 ESP-Box display
   using Pixel = lv_color16_t;
 
@@ -233,6 +237,28 @@ class EspBox : public BaseComponent {
   ///      if there is an ongoing SPI transaction
   void write_lcd_lines(int xs, int ys, int xe, int ye, const uint8_t *data, uint32_t user_data);
 
+  /////////////////////////////////////////////////////////////////////////////
+  // Button
+  /////////////////////////////////////////////////////////////////////////////
+
+  /// Initialize the boot button (side of the box)
+  /// \param callback The callback function to call when the button is pressed
+  /// \return true if the button was successfully initialized, false otherwise
+  bool initialize_boot_button(const button_callback_t &callback = nullptr);
+
+  /// Get the boot button state
+  /// \return The button state (true = button pressed, false = button released)
+  bool boot_button_state() const;
+
+  /// Initialize the mute button (top of the box)
+  /// \param callback The callback function to call when the button is pressed
+  /// \return true if the button was successfully initialized, false otherwise
+  bool initialize_mute_button(const button_callback_t &callback = nullptr);
+
+  /// Get the mute button state
+  /// \return The button state (true = button pressed, false = button released)
+  bool mute_button_state() const;
+
   /////////////////////////////////////////////////////////////////////////////
   // Audio
   /////////////////////////////////////////////////////////////////////////////
@@ -351,6 +377,9 @@ class EspBox : public BaseComponent {
   bool touch_interrupt_pullup_enabled;
 
   // common:
+  // button (boot button)
+  static constexpr gpio_num_t boot_button_io = GPIO_NUM_0; // active low
+
   // internal i2c (touchscreen, audio codec)
   static constexpr auto internal_i2c_port = I2C_NUM_0;
   static constexpr auto internal_i2c_clock_speed = 400 * 1000;
@@ -408,6 +437,29 @@ class EspBox : public BaseComponent {
                      .sda_pullup_en = GPIO_PULLUP_ENABLE,
                      .scl_pullup_en = GPIO_PULLUP_ENABLE}};
 
+  espp::Interrupt::PinConfig boot_button_interrupt_pin_{
+      .gpio_num = boot_button_io,
+      .callback =
+          [this](const auto &event) {
+            if (boot_button_callback_) {
+              boot_button_callback_(event);
+            }
+          },
+      .active_level = espp::Interrupt::ActiveLevel::LOW,
+      .interrupt_type = espp::Interrupt::Type::ANY_EDGE,
+      .pullup_enabled = true};
+  espp::Interrupt::PinConfig mute_button_interrupt_pin_{
+      .gpio_num = mute_pin,
+      .callback =
+          [this](const auto &event) {
+            mute(event.active);
+            if (mute_button_callback_) {
+              mute_button_callback_(event);
+            }
+          },
+      .active_level = espp::Interrupt::ActiveLevel::LOW,
+      .interrupt_type = espp::Interrupt::Type::ANY_EDGE,
+      .pullup_enabled = true};
   // NOTE: the active level, interrupt type, and pullup configuration is set by
   // detect(), since it depends on the box type
   espp::Interrupt::PinConfig touch_interrupt_pin_{
@@ -430,6 +482,12 @@ class EspBox : public BaseComponent {
        .task_config = {.name = "esp-box interrupts",
                        .stack_size_bytes = CONFIG_ESP_BOX_INTERRUPT_STACK_SIZE}}};
 
+  // button
+  std::atomic<bool> boot_button_initialized_{false};
+  button_callback_t boot_button_callback_{nullptr};
+  std::atomic<bool> mute_button_initialized_{false};
+  button_callback_t mute_button_callback_{nullptr};
+
   // touch
   std::shared_ptr<Gt911> gt911_;     // only used on ESP32-S3-BOX-3
   std::shared_ptr<Tt21100> tt21100_; // only used on ESP32-S3-BOX
@@ -451,6 +509,7 @@ class EspBox : public BaseComponent {
   uint8_t *frame_buffer1_{nullptr};
 
   // sound
+  std::atomic<bool> sound_initialized_{false};
   std::atomic<float> volume_{50.0f};
   std::atomic<bool> mute_{false};
   std::unique_ptr<espp::Task> audio_task_{nullptr};

components/esp-box/src/audio.cpp

@@ -111,7 +111,10 @@ bool EspBox::initialize_i2s(uint32_t default_audio_rate) {
 
 bool EspBox::initialize_sound(uint32_t default_audio_rate,
                               const espp::Task::BaseConfig &task_config) {
-
+  if (sound_initialized_) {
+    logger_.warn("Sound already initialized");
+    return true;
+  }
   if (!initialize_i2s(default_audio_rate)) {
     logger_.error("Could not initialize I2S driver");
     return false;
@@ -131,6 +134,8 @@ bool EspBox::initialize_sound(uint32_t default_audio_rate,
       .task_config = task_config,
   });
 
+  sound_initialized_ = true;
+
   return audio_task_->start();
 }
 
@@ -154,6 +159,9 @@ bool EspBox::audio_task_callback(std::mutex &m, std::condition_variable &cv, boo
 }
 
 void EspBox::update_volume_output() {
+  if (!sound_initialized_) {
+    return;
+  }
   if (mute_) {
     es8311_codec_set_voice_volume(0);
   } else {

components/esp-box/src/buttons.cpp

@@ -0,0 +1,49 @@
+#include "esp-box.hpp"
+
+using namespace espp;
+
+////////////////////////
+// Button Functions   //
+////////////////////////
+
+bool EspBox::initialize_boot_button(const EspBox::button_callback_t &callback) {
+  logger_.info("Initializing boot button");
+
+  // save the callback
+  boot_button_callback_ = callback;
+
+  // configure the button
+  if (!boot_button_initialized_) {
+    interrupts_.add_interrupt(boot_button_interrupt_pin_);
+  }
+  boot_button_initialized_ = true;
+  return true;
+}
+
+bool EspBox::boot_button_state() const {
+  if (!boot_button_initialized_) {
+    return false;
+  }
+  return interrupts_.is_active(boot_button_interrupt_pin_);
+}
+
+bool EspBox::initialize_mute_button(const EspBox::button_callback_t &callback) {
+  logger_.info("Initializing mute button");
+
+  // save the callback
+  mute_button_callback_ = callback;
+
+  // configure the button
+  if (!mute_button_initialized_) {
+    interrupts_.add_interrupt(mute_button_interrupt_pin_);
+  }
+  mute_button_initialized_ = true;
+  return true;
+}
+
+bool EspBox::mute_button_state() const {
+  if (!mute_button_initialized_) {
+    return false;
+  }
+  return interrupts_.is_active(mute_button_interrupt_pin_);
+}

components/qtpy/src/qtpy.cpp

@@ -20,7 +20,9 @@ bool QtPy::initialize_button(const QtPy::button_callback_t &callback) {
   button_callback_ = callback;
 
   // configure the button
-  interrupts_.add_interrupt(button_interrupt_pin_);
+  if (!button_initialized_) {
+    interrupts_.add_interrupt(button_interrupt_pin_);
+  }
   button_initialized_ = true;
   return true;
 }