Merge branch 'develop'

Author: GOB52

README.ja.md

@@ -44,10 +44,12 @@ lib_deps=m5stack/M5Unit-foo ;使用したいユニットのライブラリ
 
 ## 使い方
 
-各ユニットのレポジトリの例も参照のこと。
+各ユニットのリポジトリの例も参照のこと。
 
 ### Unit コンポーネントを UnitUnified とともに使用する (標準的な使用法)
 
+#### Wire 使用のユニット
+
 ```cpp
 // 他のユニットを使用する場合、インクルードファイル (*1)、インスタンス (*2)、値の取得 (*3) を変更する
 #include <M5Unified.h>
@@ -74,15 +76,107 @@ void setup() {
 }
 
 void loop() {
+    M5.update();
+    Units.update();
+    if (unit.updated()) {
+        // *3 ユニット固有の計測値の取得
+        M5.Log.printf("CO2:%u Temp:%f Hum:%f\n", unit.co2(), unit.temperature(), unit.humidity());
+    }
+}
+```
+
+#### GPIO 使用のユニット
+
+```cpp
+// 他のユニットを使用する場合、インクルードファイル (*1)、インスタンス (*2)、値の取得 (*3) を変更する
+#include <M5Unified.h>
+#include <M5UnitUnified.h>
+#include <M5UnitUnifiedTUBE.h> // *1 使用するユニットのヘッダ
+
+m5::unit::UnitUnified Units;
+m5::unit::UnitTubePressure unit; // *2 使用するユニットのインスタンス
+
+void setup()
+{
     M5.begin();
+
+    // PortB if available, PortA if not
+    auto pin_num_gpio_in  = M5.getPin(m5::pin_name_t::port_b_in);
+    auto pin_num_gpio_out = M5.getPin(m5::pin_name_t::port_b_out);
+    if (pin_num_gpio_in < 0 || pin_num_gpio_out < 0) {
+        M5_LOGW("PortB is not available");
+        Wire.end();
+        pin_num_gpio_in  = M5.getPin(m5::pin_name_t::port_a_pin1);
+        pin_num_gpio_out = M5.getPin(m5::pin_name_t::port_a_pin2);
+    }
+
+    if (!Units.add(unit, pin_num_gpio_in, pin_num_gpio_out) // Add unit to UnitUnified manager
+        || !Units.begin()) { // Begin each unit
+        M5_LOGE("Failed to add/begin");
+    }
+}
+
+void loop()
+{
+    M5.update();
     Units.update();
     if (unit.updated()) {
         // *3 ユニット固有の計測値の取得
-        M5_LOGI("CO2:%u Temp:%f Hum:%f", unit.co2(), unit.temperature(), unit.humidity());
+        M5.Log.printf("Pressure:%.2f\n", unit.pressure());
     }
 }
 ```
 
+#### UART(Serial) 使用のユニット
+
+```cpp
+// 他のユニットを使用する場合、インクルードファイル (*1)、インスタンス (*2)、API呼び出し (*3) を変更する
+#include <M5Unified.h>
+#include <M5UnitUnified.h>
+#include <M5UnitUnifiedFINGER.h> // *1 使用するユニットのヘッダ
+
+m5::unit::UnitUnified Units;
+m5::unit::UnitFinger unit; // *2 使用するユニットのインスタンス
+
+void setup()
+{
+    M5.begin();
+
+    // PortC if available, PortA if not
+    auto pin_num_in  = M5.getPin(m5::pin_name_t::port_c_rxd);
+    auto pin_num_out = M5.getPin(m5::pin_name_t::port_c_txd);
+    if (pin_num_in < 0 || pin_num_out < 0) {
+        M5_LOGW("PortC is not available");
+        Wire.end();
+        pin_num_in  = M5.getPin(m5::pin_name_t::port_a_pin1);
+        pin_num_out = M5.getPin(m5::pin_name_t::port_a_pin2);
+    }
+
+#if SOC_UART_NUM > 2
+    auto& s = Serial2;
+#elif SOC_UART_NUM > 1
+    auto& s = Serial1;
+#else
+#error "Not enough Serial"
+#endif
+    s.end();
+    // 備考: ユニットによって初期化パラメータは異なる
+    s.begin(19200, SERIAL_8N1, pin_num_in, pin_num_out);
+
+    if (!Units.add(unit, s) // Add unit to UnitUnified manager
+        || !Units.begin()) { // Begin each unit
+        M5_LOGE("Failed to begin");
+    }
+}
+
+void loop() {
+    M5.update();
+    Units.update();
+    // *3 任意の API 呼び出し...
+}
+
+```
+
 - 標準外の使い方
   - [自分でユニットの更新を行う例](examples/Basic/SelfUpdate)
   - [UnitUnified マネージャを使用せず、コンポーネントのみでの例](examples/Basic/ComponentOnly)

README.md

@@ -48,9 +48,7 @@ See also examples for each unit repositry too.
 
 ### UnitComponent with UnitUnified (Standard usage)
 
-Simple example of the UnitCO2  
-UnitCO2 is started with default settings in Units.begin(), and loop() print logs measurement data.
-
+#### Unit using Wire
 ```cpp
 // If you use other units, change include files(*1), instances(*2), and get values(*3)
 #include <M5Unified.h>
@@ -66,24 +64,115 @@ void setup() {
     auto pin_num_sda = M5.getPin(m5::pin_name_t::port_a_sda);
     auto pin_num_scl = M5.getPin(m5::pin_name_t::port_a_scl);
     M5_LOGI("getPin: SDA:%u SCL:%u", pin_num_sda, pin_num_scl);
+    Wire.end();
     Wire.begin(pin_num_sda, pin_num_scl, 400 * 1000U);
 
-    M5.Display.clear(TFT_DARKGREEN);
     if (!Units.add(unit, Wire)  // Add unit to UnitUnified manager
         || !Units.begin()) {    // Begin each unit
         M5_LOGE("Failed to add/begin");
-        M5.Display.clear(TFT_RED);
     }
 }
 
 void loop() {
+    M5.update();
+    Units.update();
+    if (unit.updated()) {
+        // *3 Obtaining unit-specific measurements
+        M5.Log.printf("CO2:%u Temp:%f Hum:%f\n", unit.co2(), unit.temperature(), unit.humidity());
+    }
+}
+```
+
+#### Unit using GPIO
+
+```cpp
+// If you use other units, change include files(*1), instances(*2), and get values(*3)
+#include <M5Unified.h>
+#include <M5UnitUnified.h>
+#include <M5UnitUnifiedTUBE.h> // *1 Include the header of the unit to be used
+
+m5::unit::UnitUnified Units;
+m5::unit::UnitTubePressure unit; // *2 Instance of the unit
+
+void setup()
+{
     M5.begin();
+
+    // PortB if available, PortA if not
+    auto pin_num_gpio_in  = M5.getPin(m5::pin_name_t::port_b_in);
+    auto pin_num_gpio_out = M5.getPin(m5::pin_name_t::port_b_out);
+    if (pin_num_gpio_in < 0 || pin_num_gpio_out < 0) {
+        M5_LOGW("PortB is not available");
+        Wire.end();
+        pin_num_gpio_in  = M5.getPin(m5::pin_name_t::port_a_pin1);
+        pin_num_gpio_out = M5.getPin(m5::pin_name_t::port_a_pin2);
+    }
+
+    if (!Units.add(unit, pin_num_gpio_in, pin_num_gpio_out) // Add unit to UnitUnified manager
+        || !Units.begin()) { // Begin each unit
+        M5_LOGE("Failed to add/begin");
+    }
+}
+
+void loop()
+{
+    M5.update();
     Units.update();
     if (unit.updated()) {
         // *3 Obtaining unit-specific measurements
-        M5_LOGI("CO2:%u Temp:%f Hum:%f", unit.co2(), unit.temperature(), unit.humidity());
+        M5.Log.printf("Pressure:%.2f\n", unit.pressure());
+    }
+}
+```
+
+#### Unit using UART(Serial)
+
+```cpp
+// If you use other units, change include files(*1), instances(*2), and call any API(*3)
+#include <M5Unified.h>
+#include <M5UnitUnified.h>
+#include <M5UnitUnifiedFINGER.h> // *1 Include the header of the unit to be used
+
+m5::unit::UnitUnified Units;
+m5::unit::UnitFinger unit; // *2 Instance of the unit
+
+void setup()
+{
+    M5.begin();
+
+    // PortC if available, PortA if not
+    auto pin_num_in  = M5.getPin(m5::pin_name_t::port_c_rxd);
+    auto pin_num_out = M5.getPin(m5::pin_name_t::port_c_txd);
+    if (pin_num_in < 0 || pin_num_out < 0) {
+        M5_LOGW("PortC is not available");
+        Wire.end();
+        pin_num_in  = M5.getPin(m5::pin_name_t::port_a_pin1);
+        pin_num_out = M5.getPin(m5::pin_name_t::port_a_pin2);
+    }
+
+#if SOC_UART_NUM > 2
+    auto& s = Serial2;
+#elif SOC_UART_NUM > 1
+    auto& s = Serial1;
+#else
+#error "Not enough Serial"
+#endif
+    s.end();
+    // Note that the argument varies depending on the target unit
+    s.begin(19200, SERIAL_8N1, pin_num_in, pin_num_out);
+
+    if (!Units.add(unit, s) // Add unit to UnitUnified manager
+        || !Units.begin()) { // Begin each unit
+        M5_LOGE("Failed to begin");
     }
 }
+
+void loop() {
+    M5.update();
+    Units.update();
+    // *3 Arbitrary API calls to the unit...
+}
+
 ```
 
 - Nonstandard usage
@@ -99,8 +188,7 @@ Support ESP-IDF with M5HAL in the future.
 ### Supported connection
 - I2C with TwoWire
 - GPIO (Currently only functions required for the units are included)
-
-Support UART in the future.
+- UART with HardwareSerial
 
 ### Supported devices, units
 See also [Wiki](https://github.com/m5stack/M5UnitUnified/wiki/)

library.json

@@ -14,7 +14,7 @@
         "m5stack/M5Utility": "*",
         "m5stack/M5HAL": "*"
     },
-    "version": "0.1.6",
+    "version": "0.2.0",
     "frameworks": [
         "arduino"
     ],

library.properties

@@ -1,5 +1,5 @@
 name=M5UnitUnified
-version=0.1.6
+version=0.2.0
 author=M5Stack
 maintainer=M5Stack
 sentence=M5UnitUnified is a library for unified handling of various M5 units products. (Alpha version)

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);