Merge branch 'feature/esp-idf-native-support' into develop

Author: GOB52

.gitignore

@@ -54,3 +54,10 @@ tmp/
 *.pem
 *.key
 *.cert
+
+# ESP-IDF artifacts (local idf.py runs)
+managed_components/
+build/
+dependencies.lock
+sdkconfig
+sdkconfig.old

CMakeLists.txt

@@ -0,0 +1,38 @@
+# ESP-IDF component manifest for M5UnitUnified.
+# Upstream: https://github.com/m5stack/M5UnitUnified
+#
+# Notes
+# - All Arduino-specific code paths (TwoWire / HardwareSerial / Wire.h /
+#   HardwareSerial.h) are guarded with `#if defined(ARDUINO)` upstream, so
+#   under pure ESP-IDF those branches are skipped. The ESPIDFMasterBus path
+#   (i2c_master_bus_handle_t) is the one used in non-Arduino builds.
+# - googletest helpers (src/googletest/*) are EXCLUDED — they pull in
+#   <M5Unified.h> for test scaffolding only and are not needed at runtime.
+include($ENV{IDF_PATH}/tools/cmake/version.cmake)
+
+file(GLOB_RECURSE SRCS "src/*.cpp")
+list(FILTER SRCS EXCLUDE REGEX "/googletest/")
+
+set(public_requires driver M5HAL)
+set(private_requires esp_adc esp_timer M5Utility)
+
+# Keep IDF 5.x on the driver meta-component. IDF v6 no longer exposes all split
+# driver include paths transitively, so add only the v6-specific component deps.
+if("${IDF_VERSION_MAJOR}" VERSION_GREATER_EQUAL "6")
+    list(APPEND public_requires esp_driver_gpio esp_driver_i2c esp_driver_rmt esp_driver_spi esp_driver_uart esp_hw_support)
+    list(APPEND private_requires esp_driver_ledc esp_ringbuf)
+endif()
+
+idf_component_register(
+    SRCS ${SRCS}
+    INCLUDE_DIRS "src"
+    REQUIRES ${public_requires}
+    PRIV_REQUIRES ${private_requires}
+)
+
+# Optionally link M5Unified only when it is already part of the build (e.g. a M5Unified-based
+# app or example). This puts M5GFX's <utility/I2C_Class.hpp> on adapter_i2c.cpp's include path,
+# so the real m5::I2C_Class adapter is compiled instead of the stub. Pure ESP-IDF builds without
+# M5Unified are unaffected (the component is simply skipped). Available since IDF v5.0.
+# Both names are listed: m5stack__M5Unified (registry/git) and M5Unified (local components/).
+idf_component_optional_requires(PRIVATE m5stack__M5Unified M5Unified)

README.ja.md

@@ -284,7 +284,8 @@ void loop() {
 
 ## サポートされているもの
 ### サポートされるフレームワーク
-- Arduino
+- Arduino (Arduino-ESP32)
+- ESP-IDF (>=5.0)
 
 将来的には Wire クラス等を直接使わず、全て M5HAL 経由で接続を行えるようになる予定です。
 

README.md

@@ -285,7 +285,8 @@ void loop() {
 
 ## Supported things
 ### Supported frameworks
-- Arduino
+- Arduino (Arduino-ESP32)
+- ESP-IDF (>=5.0)
 
 In the future, all connections will be made through M5HAL, eliminating the need to use Wire class etc. directly.
 

idf_component.yml

@@ -0,0 +1,33 @@
+description: Unified library for handling various M5 unit products (sensors, actuators, peripherals).
+url: https://github.com/m5stack/M5UnitUnified
+issues: https://github.com/m5stack/M5UnitUnified/issues
+license: MIT
+version: "0.4.6"
+
+dependencies:
+  idf: ">=5.0"
+  m5stack/M5HAL:
+    git: https://github.com/m5stack/M5HAL.git
+    version: main
+  m5stack/M5Utility:
+    git: https://github.com/m5stack/M5Utility.git
+    version: main
+
+targets:
+  - esp32
+  - esp32s3
+  - esp32c3
+  - esp32c6
+  - esp32p4
+  - esp32h2
+
+files:
+  exclude:
+    - "docs/**"
+    - "test/**"
+    - ".github/**"
+    - "boards/**"
+    - "src/googletest/**"
+    - "platformio.ini"
+    - "library.json"
+    - "library.properties"

library.json

@@ -11,12 +11,13 @@
         "url": "https://github.com/m5stack/M5UnitUnified.git"
     },
     "dependencies": {
-        "m5stack/M5Utility": ">=0.0.13",
-        "m5stack/M5HAL": ">=0.0.4"
+        "m5stack/M5Utility": ">=0.1.0",
+        "m5stack/M5HAL": ">=0.1.0"
     },
     "version": "0.4.8",
     "frameworks": [
-        "arduino"
+        "arduino",
+        "espidf"
     ],
     "platforms": [
         "espressif32"

library.properties

@@ -3,9 +3,9 @@ version=0.4.8
 author=M5Stack
 maintainer=M5Stack
 sentence=M5UnitUnified is a library for unified handling of various M5 units products.
-paragraph=
+paragraph=Unified hardware abstraction for M5Stack units with common APIs for I2C, GPIO, UART, and SPI communications.
 category=Device Control
 url=https://github.com/m5stack/M5UnitUnified
 architectures=esp32
 includes=M5UnitUnified.h
-depends=M5Utility (>=0.0.13),M5HAL (>=0.0.4)
+depends=M5Utility,M5HAL

src/M5UnitComponent.cpp

@@ -166,6 +166,7 @@ bool Component::assign(m5::hal::bus::Bus* bus)
     }
 }
 
+#if defined(ARDUINO)
 bool Component::assign(TwoWire& wire)
 {
     if (canAccessI2C() && _addr) {
@@ -174,6 +175,7 @@ bool Component::assign(TwoWire& wire)
     }
     return false;
 }
+#endif
 
 bool Component::assign(m5::I2C_Class& i2c)
 {
@@ -184,6 +186,26 @@ bool Component::assign(m5::I2C_Class& i2c)
     return false;
 }
 
+#if defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>)
+bool Component::assign(i2c_master_bus_handle_t bus)
+{
+    if (canAccessI2C() && _addr && bus) {
+        _adapter = std::make_shared<AdapterI2C>(bus, _addr, _component_cfg.clock);
+        return static_cast<bool>(_adapter);
+    }
+    return false;
+}
+#elif defined(ESP_PLATFORM)
+bool Component::assign(const i2c_port_t port, const gpio_num_t sda, const gpio_num_t scl)
+{
+    if (canAccessI2C() && _addr) {
+        _adapter = std::make_shared<AdapterI2C>(port, sda, scl, _addr, _component_cfg.clock);
+        return static_cast<bool>(_adapter);
+    }
+    return false;
+}
+#endif
+
 bool Component::assign(const int8_t rx_pin, const int8_t tx_pin)
 {
     if (canAccessGPIO()) {
@@ -193,6 +215,7 @@ bool Component::assign(const int8_t rx_pin, const int8_t tx_pin)
     return false;
 }
 
+#if defined(ARDUINO)
 bool Component::assign(HardwareSerial& serial)
 {
     if (canAccessUART()) {
@@ -205,11 +228,35 @@ bool Component::assign(HardwareSerial& serial)
 bool Component::assign(SPIClass& spi, const SPISettings& settings)
 {
     if (canAccessSPI()) {
-        _adapter = std::make_shared<AdapterSPI>(spi, settings, address() /* CS */);
+        // address() is reused as the CS GPIO number on SPI units (see CapST25R3916 etc.)
+        _adapter = std::make_shared<AdapterSPI>(spi, settings, static_cast<gpio_num_t>(address()) /* CS */);
+        return static_cast<bool>(_adapter);
+    }
+    return false;
+}
+#endif
+
+#if defined(ESP_PLATFORM)
+bool Component::assign(const uart_port_t uart_num)
+{
+    if (canAccessUART() && uart_is_driver_installed(uart_num)) {
+        _adapter = std::make_shared<AdapterUART>(uart_num);
+        return static_cast<bool>(_adapter);
+    }
+    return false;
+}
+
+bool Component::assign(spi_device_handle_t handle, const gpio_num_t cs)
+{
+    if (canAccessSPI()) {
+        // If cs is omitted (GPIO_NUM_NC), use address() as the CS pin (same convention as Arduino SPI).
+        const gpio_num_t actual_cs = (cs == GPIO_NUM_NC) ? static_cast<gpio_num_t>(address()) : cs;
+        _adapter                   = std::make_shared<AdapterSPI>(handle, actual_cs);
         return static_cast<bool>(_adapter);
     }
     return false;
 }
+#endif
 
 bool Component::selectChannel(const uint8_t ch)
 {

src/M5UnitComponent.hpp

@@ -12,17 +12,28 @@
 
 #include "m5_unit_component/types.hpp"
 #include "m5_unit_component/adapter.hpp"
+#if defined(ESP_PLATFORM)
+#include <driver/uart.h>        // for uart_port_t
+#include <driver/spi_master.h>  // for spi_device_handle_t
+#endif
+#if defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>)
+#include <driver/i2c_master.h>  // for i2c_master_bus_handle_t
+#elif defined(ESP_PLATFORM)
+#include <driver/i2c.h>  // for i2c_port_t / gpio_num_t
+#endif
 #include <cstdint>
 #include <vector>
 #include <algorithm>
 #include <iterator>
 #include <type_traits>
 #include <memory>
 
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
 class TwoWire;
 class HardwareSerial;
 class SPIClass;
 struct SPISettings;
+#endif
 
 namespace m5 {
 class I2C_Class;
@@ -287,12 +298,32 @@ class Component {
 
     ///@name Assign(I2C)
     ///@{
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Assign TwoWire as the communication bus
       @param wire TwoWire to be used
       @return True if successful
     */
     virtual bool assign(TwoWire& wire);
+#endif
+#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>))
+    /*!
+      @brief Assign I2C master bus (ESP-IDF native driver)
+      @param bus ESP-IDF I2C master bus handle
+      @return True if successful
+     */
+    virtual bool assign(i2c_master_bus_handle_t bus);
+#endif
+#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && !__has_include(<driver/i2c_master.h>))
+    /*!
+      @brief Assign I2C (ESP-IDF legacy driver, pre-installed port)
+      @param port I2C port (the driver must be installed beforehand via i2c_param_config / i2c_driver_install)
+      @param sda SDA GPIO
+      @param scl SCL GPIO
+      @return True if successful
+     */
+    virtual bool assign(const i2c_port_t port, const gpio_num_t sda, const gpio_num_t scl);
+#endif
     /*!
       @brief Assign I2C_Class as the communication bus
       @param i2c I2C_Class to be used (e.g. M5.In_I2C)
@@ -314,23 +345,46 @@ class Component {
 
     ///@name Assign(UART)
     ///@{
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Assign HardwareSerial as the communication bus
       @param serial HardwareSerial to be used
       @return True if successful
     */
     virtual bool assign(HardwareSerial& serial);
+#endif
+#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
+    /*!
+      @brief Assign UART (ESP-IDF native driver, pre-installed port)
+      @param uart_num UART port number (the driver must be installed beforehand via
+                      uart_driver_install / uart_param_config / uart_set_pin)
+      @return True if successful
+     */
+    virtual bool assign(const uart_port_t uart_num);
+#endif
     ///@}
 
     ///@name Assign(SPI)
     ///@{
+#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
     /*!
       @brief Assign SPIClass as the communication bus
       @param spi SPIClass to be used
       @param settings SPI settings to be applied
       @return True if successful
     */
     virtual bool assign(SPIClass& spi, const SPISettings& settings);
+#endif
+#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
+    /*!
+      @brief Assign SPI device handle (ESP-IDF native driver, borrowed)
+      @param handle ESP-IDF SPI device handle (create with spics_io_num = -1; init bus with SPI_DMA_DISABLED)
+      @param cs CS GPIO controlled manually by this library. If `GPIO_NUM_NC` (default), uses `address()` as the CS pin
+      (same convention as Arduino SPI)
+      @return True if successful
+     */
+    virtual bool assign(spi_device_handle_t handle, const gpio_num_t cs = GPIO_NUM_NC);
+#endif
     ///@}
 
     ///@name Assign(M5HAL)