Merge branch 'develop'

Author: GOB52

.github/workflows/doxygen-gh-pages.yml

@@ -11,5 +11,5 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: gh-pages
-          folder: doc/html
-          config_file: doc/Doxyfile
+          folder: docs/html
+          config_file: docs/Doxyfile

README.ja.md

@@ -6,7 +6,10 @@
 
 ## 概要
 物理ボタン、タッチボタンを持たない CoreS3、Tough 上にソフトウェアタッチボタンを追加し、 M5.BtnX 経由で状態を取得できるようにしたライブラリです。  
-将来的に [M5Unified](https://github.com/m5stack/M5Unified) に同様の機能がつくまでの暫定としてお使いください。  
+
+~~将来的に [M5Unified](https://github.com/m5stack/M5Unified) に同様の機能がつくまでの暫定としてお使いください。~~  
+M5Unified 0.2.3 より、 **M5.setTouchButtonHeightByRatio(uint8_t ratio)** が追加され、画面を M5.BtnX として使用できるようになりました。  
+今後はこちらの機能を使うと良いでしょう。
 
 CoreS3、Tough 以外では処理をしないので、Basic, Gray, Core2 等と共通のソースで作っている方にも有用です。  
 
@@ -17,7 +20,7 @@ CoreS3、Tough 以外では処理をしないので、Basic, Gray, Core2 等と
 * [M5Unified](https://github.com/m5stack/M5Unified) 0.1.16 以降
 * [M5GFX](https://github.com/m5stack/M5GFX) 0.1.16 以降
 
-**M5Unified 前提ですので、 M5Core3.h を使用した物には適用できません。**
+**M5Unifiedを前提としているため、M5Core3.hなどデバイス固有のヘッダを使用している場合は適用できません。**
 
 ## 導入
 環境によって適切な方法でインストールしてください
@@ -79,7 +82,7 @@ begin で指定、または changeAppearance で変更できます。
 |transparent_all|画面全体に透明ボタンを配置(縦3分割)|
 
 ## ボタンのカスタマイズ
-LGFX_Button\* を取得できます。  
+LGFX\_Button\* を取得できます。  
 ```cpp
 void setup()
 {
@@ -93,14 +96,14 @@ void setup()
 	btnA->setLabelText("Own");
 }
 ```
-LGFX_Button については[こちら](https://github.com/m5stack/M5GFX/blob/master/src/lgfx/v1/LGFX_Button.hpp)を参照してください。
+LGFX\_Button については[こちら](https://github.com/m5stack/M5GFX/blob/master/src/lgfx/v1/LGFX_Button.hpp)を参照してください。
 
 
 ## ドキュメント
-[Doxygen](https://www.doxygen.nl/) 用の[設定ファイル](doc/Doxyfile)と[シェルスクリプト](doc/doxy.sh)で作成できます。  
+[Doxygen](https://www.doxygen.nl/) 用の[設定ファイル](docs/Doxyfile)と[シェルスクリプト](docs/doxy.sh)で作成できます。  
 出力先は doc/html です。
 ```
-bash doc/doxy.sh
+bash docs/doxy.sh
 ```
 
 または[GitHub Pages](https://gob52.github.io/gob_unifiedButton/)を参照してください。

README.md

@@ -6,7 +6,10 @@
 
 ## Overview
 This library adds software touch buttons on CoreS3 and Tough, which does not have physical buttons or touch buttons, and enables the user to acquire the status via M5.BtnX.  
-Please use this as an interim feature until a similar feature is added to [M5Unified](https://github.com/m5stack/M5Unified) in the future.  
+~~Please use this as an interim feature until a similar feature is added to [M5Unified](https://github.com/m5stack/M5Unified) in the future.~~  
+
+Since M5Unified 0.2.3, **M5.setTouchButtonHeightByRatio(uint8_t ratio)** has been added, allowing the screen to be used as button (M5.BtnX)  
+You may want to use this feature.
 
 It is also useful for those who are making a common source for Basic, Gray, Core2 and more, as it does not process anything other than CoreS3 and Tough.  
 
@@ -16,7 +19,7 @@ In CoreS3SE, if M5Unified is used, the off-screen part functions as a button, as
 * [M5Unified](https://github.com/m5stack/M5Unified) 0.1.16 or later
 * [M5GFX](https://github.com/m5stack/M5GFX) 0.1.16 or later
 
-**M5Unified is assumed, so it cannot be applied to those using M5Core3.h.**
+**M5Unified is assumed, it is not applicable when device-specific headers such as M5Core3.h are used.**
 
 ## How to install
 Install in an appropriate way depending on your environment.
@@ -77,7 +80,7 @@ You can specify it with begin or change it with changeAppearance.
 |transparent_all|Transparent buttons are placed on the entire screen (three vertical sections)|
 
 ## Customize Buttons
-You can get LGFX_Button\*.
+You can get LGFX\_Button\*.
 
 ```cpp
 void setup()
@@ -93,9 +96,10 @@ void setup()
     btnA->setLabelText("Own");
 }
 ```
+Click [here](https://github.com/m5stack/M5GFX/blob/master/src/lgfx/v1/LGFX_Button.hpp) for more information about LGFX\_Button].
 
 ## Document
-Can be created from a [configuration file](doc/Doxyfile) and [shell script](doc/doxy.sh) for [Doxygen](https://www.doxygen.nl/).  
+Can be created from a [configuration file](docs/Doxyfile) and [shell script](docs/doxy.sh) for [Doxygen](https://www.doxygen.nl/).  
 Output is to doc/html
 ```
 bash doc/doxy.sh

doc/Doxyfile renamed to docs/Doxyfile

@@ -1,27 +1,27 @@
 {
-  "name": "gob_unifiedButton",
-  "description": "Add touch buttons for CoreS3 / Tough and commonality with conventional buttons (M5.BtnX)",
-  "keywords": "CoreS3, M5Tough, M5Stack, M5Unified, M5GFX",
-  "authors": {
-    "name": "GOB",
-    "url": "https://github.com/GOB52",
-    "maintainer": true
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/GOB52/gob_unifiedButton.git"
-  },
-  "version": "0.1.6",
-  "headers": "gob_unifiedButton.hpp",
-  "license": "MIT",
-  "platforms": "espressif32",
-  "frameworks": "arduino",
-  "dependencies": {
-    "m5stack/M5Unified": "^0.1.16"
-  },
-  "export": {
-    "exclude": [
-      "doc/html"
-    ]
-  }
-}
+    "name": "gob_unifiedButton",
+    "description": "Add touch buttons for CoreS3 / Tough and commonality with conventional buttons (M5.BtnX)",
+    "keywords": "CoreS3, M5Tough, M5Stack, M5Unified, M5GFX",
+    "authors": {
+        "name": "GOB",
+        "url": "https://github.com/GOB52",
+        "maintainer": true
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/GOB52/gob_unifiedButton.git"
+    },
+    "version": "0.1.7",
+    "headers": "gob_unifiedButton.hpp",
+    "license": "MIT",
+    "platforms": "espressif32",
+    "frameworks": "arduino",
+    "dependencies": {
+        "m5stack/M5Unified": ">=0.1.16"
+    },
+    "export": {
+        "exclude": [
+            "doc/html"
+        ]
+    }
+}

doc/doxy.sh renamed to docs/doxy.sh

@@ -1,5 +1,5 @@
 name=gob_unifiedButton
-version=0.1.6
+version=0.1.7
 author=GOB 
 maintainer=GOB
 sentence=Add touch buttons for CoreS3 / Tough and commonality with conventional buttons (M5.BtnX)

library.json

@@ -5,7 +5,7 @@
 platform = espressif32
 framework = arduino
 
-lib_deps = m5stack/M5Unified @^0.1.16
+lib_deps = m5stack/M5Unified @>=0.1.16
 ;lib_deps = https://github.com/m5stack/M5Unified.git#develop
 ;  https://github.com/m5stack/M5GFX.git#develop
 

library.properties

@@ -6,6 +6,13 @@
 #include <M5Unified.h>
 #include "gob_unifiedButton.hpp"
 
+#define GUB_M5UNIFIED_VERSION                                           \
+    ((M5UNIFIED_VERSION_MAJOR << 16) | (M5UNIFIED_VERSION_MINOR << 8) | M5UNIFIED_VERSION_PATCH)
+
+#if GUB_M5UNIFIED_VERSION >= 0x0203
+#define USING_M5UNIFIED_023_OR_LATER
+#endif
+
 namespace
 {
 constexpr char labelA[] = "BtnA";
@@ -27,14 +34,26 @@ void UnifiedButton::begin(LovyanGFX* gfx, const appearance_t app)
 
     auto bd = M5.getBoard();
     _enable = (bd ==  m5::board_t::board_M5StackCoreS3 || bd ==  m5::board_t::board_M5Tough)
-               && M5.Touch.isEnabled();
+            && M5.Touch.isEnabled();
     _rotation = _gfx->getRotation();
     if(_enable) { create_buttons(_appearance); }
 
-    if(M5.Touch.isEnabled() && !_enable)
+    if(!_enable)
     {
         M5_LOGW("Unsupported devices. getBoard() %u\n", bd);
+        return;
     }
+
+    M5_LOGD("M5Unified [%X] %u.%u.%u",
+            GUB_M5UNIFIED_VERSION, M5UNIFIED_VERSION_MAJOR,M5UNIFIED_VERSION_MINOR,M5UNIFIED_VERSION_PATCH);
+
+    _m5btns[0] = M5.BtnA;
+    _m5btns[1] = M5.BtnB;
+    _m5btns[2] = M5.BtnC;
+
+#if defined(USING_M5UNIFIED_023_OR_LATER)
+    M5.setTouchButtonHeightByRatio(0); // Disable M5Unified virtual screen buttons (0.2.3 or later)
+#endif
 }
 
 void UnifiedButton::create_buttons(const appearance_t app)
@@ -89,7 +108,7 @@ void UnifiedButton::update()
             if (M5.BtnC.isPressed()) { btn_bits |= 1 << 2; }
             if (btn_bits || !(det.state & m5::touch_state_t::mask_moving))
             {
-                // Correct coordinates to match rotation.
+                // Correct coordinates to match rotation
                 auto x = raw.x;
                 auto y = raw.y;
                 const uint32_t rot = _gfx->getRotation();
@@ -115,11 +134,15 @@ void UnifiedButton::update()
             }
         }
     }
-    // Set status to M5.BtnX
-    M5.BtnA.setRawState(ms, btn_bits & 1);
-    M5.BtnB.setRawState(ms, btn_bits & 2);
-    M5.BtnC.setRawState(ms, btn_bits & 4);
 
+    // Set status to M5.BtnX
+    _m5btns[0].setRawState(ms, btn_bits & 1);
+    _m5btns[1].setRawState(ms, btn_bits & 2);
+    _m5btns[2].setRawState(ms, btn_bits & 4);
+    M5.BtnA = _m5btns[0];
+    M5.BtnB = _m5btns[1];
+    M5.BtnC = _m5btns[2];
+    
     _dirty |= (prev != _press_bits);
 }
 

platformio.ini

@@ -132,6 +132,7 @@ class UnifiedButton
     appearance_t _appearance{appearance_t::bottom};
     const lgfx::IFont* _font{};
     uint_fast8_t _rotation{(uint_fast8_t)-1}; // Same as M5GFX
+    m5::Button_Class _m5btns[3];
 };
 //
 }