Touch and display driver subsystems reworked (and more) (#302)

- Refactored `TouchDevice`: it can now start/stop LVGL separately, and it has an optional `TouchDriver` interface
- Refactored `DisplayDevice`: it can now start/stop LVGL separately, and it has an optional `DisplayDriver` interface
- Updated all boards and drivers for above changes
- LVGL can now be stopped and (re)started on the fly
- Fixed issues with restarting Gui and Statusbar services
- Refactored `Gui` service to be class and renamed `Gui` to `GuiService`
- Fixed `Statusbar` service: forgot to deregister one of the icons
- Updated `esp_lcd_st7701` to v1.1.3
- `lv_textarea_create()` now automatically registers the hardware keyboard hooks (by wrapping the function)
- Fixed and updated `tactility.py`
- Cleanup of a lot of code
- `BootInitLvglBegin` and `BootInitLvglEnd` are replaced by `LvglStarted` and `LvglStopped`.
- Introduced `tt::service::State` which is accessible via `tt::service::getState()` (and internally via `ServiceInstance`)
- Started replacing `#define TAG` with `constexpr auto TAG = "..";`

Drivers/XPT2046/CMakeLists.txt

@@ -1,5 +1,5 @@
 idf_component_register(
     SRC_DIRS "Source"
     INCLUDE_DIRS "Source"
-    REQUIRES Tactility esp_lcd_touch esp_lcd_touch_xpt2046
+    REQUIRES Tactility EspLcdCompat esp_lcd_touch_xpt2046
 )

Drivers/XPT2046/Source/Xpt2046Power.cpp

@@ -2,11 +2,28 @@
 #include "Xpt2046Touch.h"
 
 #include <Tactility/Log.h>
+#include <Tactility/hal/Device.h>
 
-#define TAG "xpt2046_power"
+constexpr auto TAG = "Xpt2046Power";
+constexpr auto BATTERY_VOLTAGE_MIN = 3.2f;
+constexpr auto BATTERY_VOLTAGE_MAX = 4.2f;
+constexpr auto MAX_VOLTAGE_SAMPLES = 15;
 
-#define BATTERY_VOLTAGE_MIN 3.2f
-#define BATTERY_VOLTAGE_MAX 4.2f
+static std::shared_ptr<Xpt2046Touch> findXp2046TouchDevice() {
+    // Make a safe copy
+    auto touch = tt::hal::findFirstDevice<tt::hal::touch::TouchDevice>(tt::hal::Device::Type::Touch);
+    if (touch == nullptr) {
+        TT_LOG_E(TAG, "Touch device not found");
+        return nullptr;
+    }
+
+    if (touch->getName() != "XPT2046") {
+        TT_LOG_E(TAG, "Touch device name mismatch");
+        return nullptr;
+    }
+
+    return std::reinterpret_pointer_cast<Xpt2046Touch>(touch);
+}
 
 static uint8_t estimateChargeLevelFromVoltage(uint32_t milliVolt) {
     float volts = std::min((float)milliVolt / 1000.f, BATTERY_VOLTAGE_MAX);
@@ -47,25 +64,26 @@ bool Xpt2046Power::getMetric(MetricType type, MetricData& data) {
     }
 }
 
-bool Xpt2046Power::readBatteryVoltageOnce(uint32_t& output) const {
-    // Make a safe copy
-    auto touch = Xpt2046Touch::getInstance();
-    if (touch != nullptr) {
-        float vbat;
-        if (touch->getVBat(vbat)) {
-            // Convert to mV
-            output = (uint32_t)(vbat * 1000.f);
-            return true;
+bool Xpt2046Power::readBatteryVoltageOnce(uint32_t& output) {
+    if (xptTouch == nullptr) {
+        xptTouch = findXp2046TouchDevice();
+        if (xptTouch == nullptr) {
+            TT_LOG_E(TAG, "XPT2046 touch device not found");
+            return false;
         }
     }
 
-    return false;
+    float vbat;
+    if (!xptTouch->getVBat(vbat)) {
+        return false;
+    }
+
+    // Convert to mV
+    output = (uint32_t)(vbat * 1000.f);
+    return true;
 }
 
-
-#define MAX_VOLTAGE_SAMPLES 15
-
-bool Xpt2046Power::readBatteryVoltageSampled(uint32_t& output) const {
+bool Xpt2046Power::readBatteryVoltageSampled(uint32_t& output) {
     size_t samples_read = 0;
     uint32_t sample_accumulator = 0;
     uint32_t sample_read_buffer;

Drivers/XPT2046/Source/Xpt2046Power.h

@@ -1,8 +1,8 @@
 #pragma once
 
 #include <Tactility/hal/power/PowerDevice.h>
-#include <memory>
 
+class Xpt2046Touch;
 using tt::hal::power::PowerDevice;
 
 /**
@@ -11,9 +11,13 @@ using tt::hal::power::PowerDevice;
  */
 class Xpt2046Power : public PowerDevice {
 
+    std::shared_ptr<Xpt2046Touch> xptTouch;
+
+    bool readBatteryVoltageOnce(uint32_t& output);
+    bool readBatteryVoltageSampled(uint32_t& output);
+
 public:
 
-    Xpt2046Power() = default;
     ~Xpt2046Power() = default;
 
     std::string getName() const final { return "XPT2046 Power Measurement"; }
@@ -22,10 +26,6 @@ public:
     bool supportsMetric(MetricType type) const override;
     bool getMetric(MetricType type, MetricData& data) override;
 
-private:
-
-    bool readBatteryVoltageOnce(uint32_t& output) const;
-    bool readBatteryVoltageSampled(uint32_t& output) const;
 };
 
 std::shared_ptr<PowerDevice> getOrCreatePower();

Drivers/XPT2046/Source/Xpt2046Touch.cpp

@@ -7,19 +7,19 @@
 #include <esp_lcd_touch_xpt2046.h>
 #include <esp_lvgl_port.h>
 
-#define TAG "xpt2046_touch"
-
 Xpt2046Touch* Xpt2046Touch::instance = nullptr;
 
-bool Xpt2046Touch::start(lv_display_t* display) {
+bool Xpt2046Touch::createIoHandle(esp_lcd_panel_io_handle_t& outHandle) {
     const esp_lcd_panel_io_spi_config_t io_config = ESP_LCD_TOUCH_IO_SPI_XPT2046_CONFIG(configuration->spiPinCs);
+    return esp_lcd_new_panel_io_spi(SPI2_HOST, &io_config, &outHandle) == ESP_OK;
+}
 
-    if (esp_lcd_new_panel_io_spi(SPI2_HOST, &io_config, &ioHandle) != ESP_OK) {
-        TT_LOG_E(TAG, "Touch IO SPI creation failed");
-        return false;
-    }
+bool Xpt2046Touch::createTouchHandle(esp_lcd_panel_io_handle_t ioHandle, const esp_lcd_touch_config_t& config, esp_lcd_touch_handle_t& panelHandle) {
+    return esp_lcd_touch_new_spi_xpt2046(ioHandle, &config, &panelHandle) == ESP_OK;
+}
 
-    esp_lcd_touch_config_t config = {
+esp_lcd_touch_config_t Xpt2046Touch::createEspLcdTouchConfig() {
+   return {
         .x_max = configuration->xMax,
         .y_max = configuration->yMax,
         .rst_gpio_num = GPIO_NUM_NC,
@@ -38,61 +38,20 @@ bool Xpt2046Touch::start(lv_display_t* display) {
         .user_data = nullptr,
         .driver_data = nullptr
     };
-
-    if (esp_lcd_touch_new_spi_xpt2046(ioHandle, &config, &touchHandle) != ESP_OK) {
-        TT_LOG_E(TAG, "XPT2046 driver init failed");
-        cleanup();
-        return false;
-    }
-
-    const lvgl_port_touch_cfg_t touch_cfg = {
-        .disp = display,
-        .handle = touchHandle,
-    };
-
-    TT_LOG_I(TAG, "Adding touch to LVGL");
-    deviceHandle = lvgl_port_add_touch(&touch_cfg);
-    if (deviceHandle == nullptr) {
-        TT_LOG_E(TAG, "Adding touch failed");
-        cleanup();
-        return false;
-    }
-
-    instance = this;
-    return true;
-}
-
-bool Xpt2046Touch::stop() {
-    instance = nullptr;
-    cleanup();
-    return true;
-}
-
-void Xpt2046Touch::cleanup() {
-    if (deviceHandle != nullptr) {
-        lv_indev_delete(deviceHandle);
-        deviceHandle = nullptr;
-    }
-
-    if (touchHandle != nullptr) {
-        esp_lcd_touch_del(touchHandle);
-        touchHandle = nullptr;
-    }
-
-    if (ioHandle != nullptr) {
-        esp_lcd_panel_io_del(ioHandle);
-        ioHandle = nullptr;
-    }
 }
 
 bool Xpt2046Touch::getVBat(float& outputVbat) {
-    if (touchHandle != nullptr) {
-        // Shares the SPI bus with the display, so we have to sync/lock as this method might be called from anywhere
-        if (tt::lvgl::lock(50 / portTICK_PERIOD_MS)) {
-            esp_lcd_touch_xpt2046_read_battery_level(touchHandle, &outputVbat);
-            tt::lvgl::unlock();
-            return true;
-        }
+    auto touch_handle = getTouchHandle();
+    if (touch_handle == nullptr) {
+        return false;
     }
-    return false;
+
+    // Shares the SPI bus with the display, so we have to sync/lock as this method might be called from anywhere
+    if (!tt::lvgl::lock(50 / portTICK_PERIOD_MS)) {
+        return false;
+    }
+
+    esp_lcd_touch_xpt2046_read_battery_level(touch_handle, &outputVbat);
+    tt::lvgl::unlock();
+    return true;
 }

Drivers/XPT2046/Source/Xpt2046Touch.h

@@ -1,13 +1,10 @@
 #pragma once
 
-#include "Tactility/hal/touch/TouchDevice.h"
+#include <Tactility/hal/touch/TouchDevice.h>
 
-#include <Tactility/TactilityCore.h>
+#include <EspLcdTouch.h>
 
-#include <esp_lcd_panel_io_interface.h>
-#include <esp_lcd_touch.h>
-
-class Xpt2046Touch : public tt::hal::touch::TouchDevice {
+class Xpt2046Touch : public EspLcdTouch {
 
 public:
 
@@ -45,11 +42,12 @@ private:
     static Xpt2046Touch* instance;
 
     std::unique_ptr<Configuration> configuration;
-    esp_lcd_panel_io_handle_t _Nullable ioHandle = nullptr;
-    esp_lcd_touch_handle_t _Nullable touchHandle = nullptr;
-    lv_indev_t* _Nullable deviceHandle = nullptr;
 
-    void cleanup();
+    bool createIoHandle(esp_lcd_panel_io_handle_t& outHandle) override;
+
+    bool createTouchHandle(esp_lcd_panel_io_handle_t ioHandle, const esp_lcd_touch_config_t& configuration, esp_lcd_touch_handle_t& panelHandle) override;
+
+    esp_lcd_touch_config_t createEspLcdTouchConfig() override;
 
 public:
 
@@ -58,14 +56,8 @@ public:
     }
 
     std::string getName() const final { return "XPT2046"; }
-    std::string getDescription() const final { return "I2C touch driver"; }
 
-    bool start(lv_display_t* display) override;
-    bool stop() override;
-    lv_indev_t* _Nullable getLvglIndev() override { return deviceHandle; }
+    std::string getDescription() const final { return "XPT2046 I2C touch driver"; }
 
     bool getVBat(float& outputVbat);
-
-    /** Used for accessing getVBat() in Power driver */
-    static Xpt2046Touch* getInstance() { return instance; }
 };