Add UART(Serial) support

Author: GOB52

src/M5UnitComponent.cpp

@@ -54,6 +54,11 @@ bool Component::canAccessGPIO() const
     return attribute() & attribute::AccessGPIO;
 }
 
+bool Component::canAccessUART() const
+{
+    return attribute() & attribute::AccessUART;
+}
+
 bool Component::add(Component& c, const int16_t ch)
 {
     if (childrenSize() >= _component_cfg.max_children) {
@@ -141,6 +146,14 @@ bool Component::assign(const int8_t rx_pin, const int8_t tx_pin)
     return static_cast<bool>(_adapter);
 }
 
+bool Component::assign(HardwareSerial& serial)
+{
+    if (canAccessUART()) {
+        _adapter = std::make_shared<AdapterUART>(serial);
+    }
+    return static_cast<bool>(_adapter);
+}
+
 bool Component::selectChannel(const uint8_t ch)
 {
     bool ret{true};

src/M5UnitComponent.hpp

@@ -20,6 +20,7 @@
 #include <memory>
 
 class TwoWire;
+class HardwareSerial;
 
 namespace m5 {
 namespace unit {
@@ -183,6 +184,7 @@ class Component {
     ///@{
     bool canAccessI2C() const;
     bool canAccessGPIO() const;
+    bool canAccessUART() const;
     ///@}
 
     ///@name Periodic measurement
@@ -223,6 +225,8 @@ class Component {
     virtual bool assign(TwoWire& wire);
     /*! @brief Assgin GPIO */
     virtual bool assign(const int8_t rx_pin, const int8_t tx_pin);
+    /*! @brief Assgin UART */
+    virtual bool assign(HardwareSerial& serial);
     ///@}
 
     ///@note For daisy-chaining units such as hubs

src/M5UnitUnified.cpp

@@ -76,6 +76,25 @@ bool UnitUnified::add(Component& u, const int8_t rx_pin, const int8_t tx_pin)
     return false;
 }
 
+bool UnitUnified::add(Component& u, HardwareSerial& serial)
+{
+    if (u.isRegistered()) {
+        M5_LIB_LOGW("Already added");
+        return false;
+    }
+
+    M5_LIB_LOGD("Add [%s] addr:%02x children:%zu", u.deviceName(), u.address(), u.childrenSize());
+
+    u._manager = this;
+    if (u.assign(serial)) {
+        u._order = ++_registerCount;
+        _units.emplace_back(&u);
+        return add_children(u);
+    }
+    M5_LIB_LOGE("Failed to assign %s:%u", u.deviceName(), u.canAccessI2C());
+    return false;
+}
+
 // Add children if exists
 bool UnitUnified::add_children(Component& u)
 {

src/M5UnitUnified.hpp

@@ -26,6 +26,7 @@
 #include <string>
 
 class TwoWire;
+class HardwareSerial;
 
 /*!
   @namespace m5
@@ -80,6 +81,13 @@ class UnitUnified {
       @return True if successful
      */
     bool add(Component& u, const int8_t rx_pin, const int8_t tx_pin);
+    /*!
+      @brief Adding unit to be managed (UART)
+      @param u Unit Component
+      @param serial HardwareSerial to be used
+      @return True if successful
+    */
+    bool add(Component& u, HardwareSerial& wire);
     /*!
       @brief Adding unit to be managed (M5HAL)
       @param u Unit Component

src/googletest/test_helper.hpp

@@ -50,6 +50,8 @@ uint32_t test_periodic_measurement(U* unit, const uint32_t times, const uint32_t
         std::this_thread::yield();
     }
 
+    M5_LOGI("AVG:%u avgCnt:%u", avg, avgCnt);
+    
     if (!skip_after_test) {
         EXPECT_EQ(cnt, 0U);
         EXPECT_EQ(avgCnt, times - 1);

src/googletest/test_template.hpp

@@ -156,7 +156,7 @@ class GPIOComponentTestBase : public ::testing::TestWithParam<TP> {
             // TODO Not yet
             return false;
         }
-        // Using TwoWire
+        // Using GPIO
         return Units.add(*unit, pin_num_gpio_in, pin_num_gpio_out) && Units.begin();
     }
 
@@ -170,6 +170,61 @@ class GPIOComponentTestBase : public ::testing::TestWithParam<TP> {
     m5::unit::UnitUnified Units;
 };
 
+/*!
+  @class UARTComponentTestBase
+  @brief UnitComponent Derived class for testing (UART)
+  @tparam U m5::unit::Component-derived classes to be tested
+  @tparam TP parameter type for testing. see also INSTANTIATE_TEST_SUITE_P
+ */
+template <typename U, typename TP>
+class UARTComponentTestBase : public ::testing::TestWithParam<TP> {
+    static_assert(std::is_base_of<m5::unit::Component, U>::value, "U must be derived from Component");
+
+protected:
+    virtual void SetUp() override
+    {
+        unit.reset(get_instance());
+        if (!unit) {
+            FAIL() << "Failed to get_instance";
+            GTEST_SKIP();
+            return;
+        }
+        ustr = m5::utility::formatString("%s:%s", unit->deviceName(), is_using_hal() ? "HAL" : "UART");
+        if (!begin()) {
+            FAIL() << "Failed to begin " << ustr;
+            GTEST_SKIP();
+        }
+    }
+
+    virtual void TearDown() override
+    {
+    }
+
+    virtual bool begin()
+    {
+        if (is_using_hal()) {
+            // Using M5HAL
+            // TODO Not yet
+            return false;
+        }
+        // Using Serial
+        serial = init_serial();
+        return serial && Units.add(*unit, *serial) && Units.begin();
+    }
+
+    //!@brief Function returning true if M5HAL is used (decision based on TP)
+    virtual bool is_using_hal() const = 0;
+    //! @brief return m5::unit::Component-derived class instance (decision based on TP)
+    virtual U* get_instance() = 0;
+    //!@brief Initialize the serial to be used
+    virtual HardwareSerial* init_serial() = 0;
+
+    std::string ustr{};
+    std::unique_ptr<U> unit{};
+    m5::unit::UnitUnified Units;
+    HardwareSerial* serial{};
+};
+
 }  // namespace googletest
 }  // namespace unit
 }  // namespace m5

src/m5_unit_component/adapter.hpp

@@ -10,6 +10,7 @@
 */
 #ifndef M5_UNIT_COMPONENT_ADAPTER_HPP
 #define M5_UNIT_COMPONENT_ADAPTER_HPP
+
 #include "adapter_base.hpp"
 #include "adapter_i2c.hpp"
 #include "identify_functions.hpp"
@@ -18,4 +19,6 @@
 #else
 #include "adapter_gpio_v1.hpp"
 #endif
+#include "adapter_uart.hpp"
+
 #endif

src/m5_unit_component/adapter_gpio_v1.cpp

@@ -5,7 +5,7 @@
  */
 /*!
   @file adapter_gpio_v1.cpp
-  @brief Adapters to treat M5HAL and GPIO in the same way using RNT v1
+  @brief Adapters to treat M5HAL and GPIO in the same way using RMT v1
   @note  Currently handles GPIO directly, but will handle via M5HAL in the future
 */
 #include "adapter_gpio_v1.hpp"

src/m5_unit_component/adapter_gpio_v1.hpp

@@ -5,7 +5,7 @@
  */
 /*!
   @file adapter_gpio_v1.hpp
-  @brief Adapters to treat M5HAL and GPIO in the same way using RNT v1
+  @brief Adapters to treat M5HAL and GPIO in the same way using RMT v1
   @note  Currently handles GPIO directly, but will handle via M5HAL in the future
 */
 #ifndef M5_UNIT_COMPONENT_ADAPTER_GPIO_V1_HPP

src/m5_unit_component/adapter_i2c.cpp

@@ -8,13 +8,15 @@
   @brief Adapter for I2C to treat M5HAL and TwoWire in the same way
   @note  Currently handles TwoWire directly, but will handle via M5HAL in the future
 */
-#include "adapter.hpp"
-#include <cassert>
+#include "adapter_i2c.hpp"
+#if defined(ARDUINO)
 #include <Wire.h>
+#endif
 #include <M5HAL.hpp>
 #include <M5Utility.hpp>
 #include <soc/gpio_struct.h>
 #include <soc/gpio_sig_map.h>
+#include <cassert>
 
 #if defined(ARDUINO)