Merge branch 'develop'

Author: GOB52

README.ja.md

@@ -1,14 +1,10 @@
-
-# M5UnitUnified(α リリース)
+# M5UnitUnified
 
 [English](README.md)
 
 **M5Stack に色々な M5 ユニットをつないで扱う為の新たなアプローチ**  
 M5Stack シリーズ、 M5Unitシリーズの為のライブラリです。
 
-**注意: 現在αバージョンです**  
-ご意見ご要望などは Issue または PR にてお願いします。
-
 ## 概要
 M5UnitUnified は、様々な M5 ユニット製品を統一的に扱うためのライブラリです。
 
@@ -25,9 +21,8 @@ M5UnitUnified は、様々な M5 ユニット製品を統一的に扱うため
 各ユニットの外部ライブラリのライセンスは様々な物が混在しています。  
 すべてのM5UnitUnifiedおよび関連ライブラリは、[MITライセンス](LICENSE)下にあります。
 
-
 ## インストール方法
-アルファ版ですが Arduino/PlatformIO のライブラリマネージャーに登録されています
+Arduino/PlatformIO のライブラリマネージャーに登録されています
 
 ### ArduinoIDE
 1. ライブリマネージャから使用したいユニットのライブラリ (M5Unit-Foo) を選択してください
@@ -177,6 +172,48 @@ void loop() {
 
 ```
 
+#### SPI 使用のユニット
+
+```cpp
+// 他のユニットを使用する場合、インクルードファイル (*1)、インスタンス (*2)、API呼び出し (*3) を変更する
+#include <M5Unified.h>
+#include <M5UnitUnified.h>
+#include <M5UnitUnifiedFoo.h> // *1 Include the header of the unit to be used
+
+m5::unit::UnitUnified Units;
+m5::unit::UnitFoo unit; // *2 使用するユニットのインスタンス
+
+void setup()
+{
+    M5.begin();
+
+    if (!SPI.bus()) {
+        auto spi_sclk = M5.getPin(m5::pin_name_t::sd_spi_sclk);
+        auto spi_mosi = M5.getPin(m5::pin_name_t::sd_spi_mosi);
+        auto spi_miso = M5.getPin(m5::pin_name_t::sd_spi_miso);
+        M5_LOGI("getPin: %d,%d,%d", spi_sclk, spi_mosi, spi_miso);
+        SPI.begin(spi_sclk, spi_miso, spi_mosi);
+    }
+
+    // 備考: ユニットによって初期化パラメータは異なる
+    SPISettings settings = {10000000, MSBFIRST, SPI_MODE1};
+    if (!Units.add(cap, SPI, settings) || !Units.begin()) {
+        M5_LOGE("Failed to begin");
+        lcd.fillScreen(TFT_RED);
+        while (true) {
+            m5::utility::delay(10000);
+        }
+    }
+}
+
+void loop() {
+    M5.update();
+    Units.update();
+    // *3 任意の API 呼び出し...
+}
+```
+
+
 - 標準外の使い方
   - [自分でユニットの更新を行う例](examples/Basic/SelfUpdate)
   - [UnitUnified マネージャを使用せず、コンポーネントのみでの例](examples/Basic/ComponentOnly)
@@ -189,10 +226,10 @@ void loop() {
 ESP-IDF は将来対応予定です。
 
 ### サポートされる通信
-- TwoWire による I2C 通信
+- Wire TwoWire class による
 - GPIO (現在は各ユニットに必要な機能のみ搭載）
-
-UART は将来対応予定です。
+- UART HardwareSerial class による
+- SPI SPI class による
 
 ### サポートされるデバイス,ユニット
 [Wiki](https://github.com/m5stack/M5UnitUnified/wiki/)を参照

README.md

@@ -5,9 +5,6 @@
 **A new approach to connect and handle various M5 units in the M5Stack**  
 Library for M5Stack Series and M5Unit Series
 
-**Notice: Now α version**  
-Please send your comments and requests to Issue or PR.
-
 ## Overview
 M5UnitUnified is a library for unified handling of various M5 units products.
 
@@ -26,7 +23,7 @@ All M5UnitUnified and related libraries are under the [MIT license](LICENSE).
 
 
 ## How to install
-Alpha version, but registered in the Library Manager
+The library is registered with the library manager.
 
 ### Arduino IDE
 
@@ -175,6 +172,47 @@ void loop() {
 
 ```
 
+#### Unit using SPI
+
+```cpp
+// If you use other units, change include files(*1), instances(*2), and call any API(*3)
+#include <M5Unified.h>
+#include <M5UnitUnified.h>
+#include <M5UnitUnifiedFoo.h> // *1 Include the header of the unit to be used
+
+m5::unit::UnitUnified Units;
+m5::unit::UnitFoo unit; // *2 Instance of the unit
+
+void setup()
+{
+    M5.begin();
+
+    if (!SPI.bus()) {
+        auto spi_sclk = M5.getPin(m5::pin_name_t::sd_spi_sclk);
+        auto spi_mosi = M5.getPin(m5::pin_name_t::sd_spi_mosi);
+        auto spi_miso = M5.getPin(m5::pin_name_t::sd_spi_miso);
+        M5_LOGI("getPin: %d,%d,%d", spi_sclk, spi_mosi, spi_miso);
+        SPI.begin(spi_sclk, spi_miso, spi_mosi);
+    }
+
+    // Note that the depending on the target unit
+    SPISettings settings = {10000000, MSBFIRST, SPI_MODE1};
+    if (!Units.add(cap, SPI, settings) || !Units.begin()) {
+        M5_LOGE("Failed to begin");
+        lcd.fillScreen(TFT_RED);
+        while (true) {
+            m5::utility::delay(10000);
+        }
+    }
+}
+
+void loop() {
+    M5.update();
+    Units.update();
+    // *3 Arbitrary API calls to the unit...
+}
+```
+
 - Nonstandard usage
   - [To update the unit yourself usage example](examples/Basic/SelfUpdate)
   - [Using only unit component without UnitUnified manager](examples/Basic/ComponentOnly)
@@ -186,9 +224,10 @@ void loop() {
 Support ESP-IDF with M5HAL in the future.
 
 ### Supported connection
-- I2C with TwoWire
+- I2C with TwoWire class
 - GPIO (Currently only functions required for the units are included)
-- UART with HardwareSerial
+- UART with HardwareSerial class
+- SPI with SPI class
 
 ### Supported devices, units
 See also [Wiki](https://github.com/m5stack/M5UnitUnified/wiki/)

library.json

@@ -11,10 +11,10 @@
         "url": "https://github.com/m5stack/M5UnitUnified.git"
     },
     "dependencies": {
-        "m5stack/M5Utility": "*",
+        "m5stack/M5Utility": ">=0.0.9",
         "m5stack/M5HAL": "*"
     },
-    "version": "0.2.0",
+    "version": "0.3.0",
     "frameworks": [
         "arduino"
     ],

library.properties

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

src/M5UnitComponent.cpp

@@ -59,12 +59,23 @@ bool Component::canAccessUART() const
     return attribute() & attribute::AccessUART;
 }
 
-bool Component::add(Component& c, const int16_t ch)
+bool Component::canAccessSPI() const
+{
+    return attribute() & attribute::AccessSPI;
+}
+
+bool Component::add(Component& c, const int16_t ch16)
 {
     if (childrenSize() >= _component_cfg.max_children) {
         M5_LIB_LOGE("Can't connect any more");
         return false;
     }
+    if (ch16 < 0 || ch16 > 255) {
+        M5_LIB_LOGE("Invalid channel %d", ch16);
+        return false;
+    }
+
+    const uint8_t ch = static_cast<uint8_t>(ch16);
     if (existsChild(ch)) {
         M5_LIB_LOGE("Already connected an other unit at channel:%u", ch);
         return false;
@@ -134,24 +145,36 @@ bool Component::assign(TwoWire& wire)
 {
     if (canAccessI2C() && _addr) {
         _adapter = std::make_shared<AdapterI2C>(wire, _addr, _component_cfg.clock);
+        return static_cast<bool>(_adapter);
     }
-    return static_cast<bool>(_adapter);
+    return false;
 }
 
 bool Component::assign(const int8_t rx_pin, const int8_t tx_pin)
 {
     if (canAccessGPIO()) {
         _adapter = std::make_shared<AdapterGPIO>(rx_pin, tx_pin);
+        return static_cast<bool>(_adapter);
     }
-    return static_cast<bool>(_adapter);
+    return false;
 }
 
 bool Component::assign(HardwareSerial& serial)
 {
     if (canAccessUART()) {
         _adapter = std::make_shared<AdapterUART>(serial);
+        return static_cast<bool>(_adapter);
     }
-    return static_cast<bool>(_adapter);
+    return false;
+}
+
+bool Component::assign(SPIClass& spi, const SPISettings& settings)
+{
+    if (canAccessSPI()) {
+        _adapter = std::make_shared<AdapterSPI>(spi, settings, address() /* CS */);
+        return static_cast<bool>(_adapter);
+    }
+    return false;
 }
 
 bool Component::selectChannel(const uint8_t ch)

src/M5UnitComponent.hpp

@@ -21,6 +21,8 @@
 
 class TwoWire;
 class HardwareSerial;
+class SPIClass;
+struct SPISettings;
 
 namespace m5 {
 namespace unit {
@@ -185,6 +187,7 @@ class Component {
     bool canAccessI2C() const;
     bool canAccessGPIO() const;
     bool canAccessUART() const;
+    bool canAccessSPI() const;
     ///@}
 
     ///@name Periodic measurement
@@ -227,6 +230,8 @@ class Component {
     virtual bool assign(const int8_t rx_pin, const int8_t tx_pin);
     /*! @brief Assgin UART */
     virtual bool assign(HardwareSerial& serial);
+    /*! @brief Assgin SPI */
+    virtual bool assign(SPIClass& spi, const SPISettings& settings);
     ///@}
 
     ///@note For daisy-chaining units such as hubs
@@ -256,13 +261,6 @@ class Component {
     {
         return _parent;
     }
-#if 0
-    //! @brief Gets the parent unit
-    inline const Component* parent() const
-    {
-        return _parent;
-    }
-#endif
     //! @brief Gets the device connected to the specified channel
     Component* child(const uint8_t chhanle) const;
     //! @brief Connect the unit to the specified channel
@@ -343,6 +341,8 @@ class Component {
     //! @brief Output information for debug
     virtual std::string debugInfo() const;
 
+    ////// TODO : Split interface (I2C, GPIO, UART, SPI)
+
     // I2C R/W
     ///@cond 0
     m5::hal::error::error_t readWithTransaction(uint8_t* data, const size_t len);

src/M5UnitUnified.cpp

@@ -95,6 +95,25 @@ bool UnitUnified::add(Component& u, HardwareSerial& serial)
     return false;
 }
 
+bool UnitUnified::add(Component& u, SPIClass& spi, const SPISettings& settings)
+{
+    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(spi, settings)) {
+        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

@@ -27,6 +27,8 @@
 
 class TwoWire;
 class HardwareSerial;
+class SPIClass;
+struct SPISettings;
 
 /*!
   @namespace m5
@@ -87,7 +89,14 @@ class UnitUnified {
       @param serial HardwareSerial to be used
       @return True if successful
     */
-    bool add(Component& u, HardwareSerial& wire);
+    bool add(Component& u, HardwareSerial& serial);
+    /*!
+      @brief Adding unit to be managed (SPI)
+      @param u Unit Component
+      @param spi SPI to be used
+      @return True if successful
+    */
+    bool add(Component& u, SPIClass& spi, const SPISettings& settings);
     /*!
       @brief Adding unit to be managed (M5HAL)
       @param u Unit Component

src/m5_unit_component/adapter.hpp

@@ -20,5 +20,6 @@
 #include "adapter_gpio_v1.hpp"
 #endif
 #include "adapter_uart.hpp"
+#include "adapter_spi.hpp"
 
 #endif