Merge branch 'develop'

Author: GOB52

.github/workflows/Arduino-Lint-Check.yml

@@ -18,6 +18,12 @@ jobs:
   lint:
     name: Lint Check
     runs-on: ubuntu-latest
+    timeout-minutes: 12
+    strategy:
+      max-parallel: 20
+      matrix:
+        include:
+          - shard: 1
     steps:
       - uses: actions/checkout@v4
       - uses: arduino/arduino-lint-action@v2

.github/workflows/clang-format-check.yml

@@ -17,7 +17,7 @@ on:
       - '**.h'
       - '**.c'
       - '**.inl'
-      - '**clang-format-check.yml'
+      - '.github/workflows/clang-format-check.yml'
       - '**.clang-format'
   pull_request:
     paths:
@@ -27,7 +27,7 @@ on:
       - '**.h'
       - '**.c'
       - '**.inl'
-      - '**clang-format-check.yml'
+      - '.github/workflows/clang-format-check.yml'
       - '**.clang-format'
   workflow_dispatch:
 
@@ -43,21 +43,19 @@ jobs:
   formatting-check:
     name: Formatting Check
     runs-on: ubuntu-latest
+    timeout-minutes: 12
     strategy:
+      max-parallel: 20
       matrix:
         path:
           - check: 'src'
             exclude: ''
-          - check: 'pio_project/test'
-            exclude: ''
-          - check: 'examples/Basic'
+          - check: 'test'
             exclude: ''
 
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Run clang-format style check for C/C++/Protobuf programs.
         uses: jidicula/clang-format-action@v4.16.0 # Using include-regex 10.x or later
@@ -66,4 +64,3 @@ jobs:
           check-path: ${{ matrix.path['check'] }}
           exclude-regex: ${{ matrix.path['exclude'] }}
           include-regex: ${{ env.INCLUDE_REGEX }}
-

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

@@ -1,9 +1,8 @@
-name: Deploy Doxygen docuemnt on GitHub Pages
+name: Deploy Doxygen document on GitHub Pages
 on: [release, workflow_dispatch]
 # branches:
 #   - main
 #   - master
-
 defaults:
   run:
     shell: bash
@@ -15,6 +14,12 @@ concurrency:
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    timeout-minutes: 12
+    strategy:
+      max-parallel: 20
+      matrix:
+        include:
+          - shard: 1
     steps:
       - name: Make document
         uses: m5stack/M5Utility/.github/actions/doxygen@develop

.github/workflows/platformio-build-check.yml

@@ -0,0 +1,83 @@
+name: Build(platformio)
+
+on:
+  push:
+    tags-ignore:
+      - '*.*.*'
+      - 'v*.*.*'
+    branches:
+      - '*'
+    paths:
+      - 'src/**.cpp'
+      - 'src/**.hpp'
+      - 'src/**.h'
+      - 'src/**.c'
+      - 'test/**.cpp'
+      - 'test/**.hpp'
+      - 'test/**.h'
+      - 'test/**.c'
+      - '.github/workflows/platformio-build-check.yml'
+      - 'platformio.ini'
+  pull_request:
+    paths:
+      - 'src/**.cpp'
+      - 'src/**.hpp'
+      - 'src/**.h'
+      - 'src/**.c'
+      - 'test/**.cpp'
+      - 'test/**.hpp'
+      - 'test/**.h'
+      - 'test/**.c'
+      - '.github/workflows/platformio-build-check.yml'
+      - 'platformio.ini'
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: ${{ matrix.board }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 12
+
+    strategy:
+      fail-fast: false
+      max-parallel: 20
+
+      matrix:
+        board:
+          - Core
+          - Core2
+          - CoreS3
+          - Fire
+          - StampS3
+          - Dial
+          - Atom
+          - AtomS3
+          - AtomS3R
+          - NanoC6
+          - NessoN1
+          - StickCPlus
+          - StickCPlus2
+          - StickS3
+          - Cardputer
+          - Paper
+          - CoreInk
+          - Tab5
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build tests
+        uses: m5stack/M5Utility/.github/actions/pio_test_build@develop
+        with:
+          environments: test_readme_${{ matrix.board }}
+          project-dir: "./"
+          project-conf: "./platformio.ini"

.gitignore

@@ -31,9 +31,26 @@
 *.out
 *.app
 
-#
+# Doxygen
+docs/html/
+
+# PlatformIO
+.pio/
+
+# IDE
+.vscode/
+
+# macOS
 .DS_Store
-/.pio/
-/.vscode/
-/docs/html/
+
+# Temporary
+tmp/
+
+# Emacs
 .\#*
+
+# Secrets
+.env*
+*.pem
+*.key
+*.cert

README.ja.md

@@ -25,17 +25,17 @@ M5UnitUnified は、様々な M5 ユニット製品を統一的に扱うため
 Arduino/PlatformIO のライブラリマネージャーに登録されています
 
 ### ArduinoIDE
-1. ライブリマネージャから使用したいユニットのライブラリ (M5Unit-Foo) を選択してください
+1. ライブラリマネージャから使用したいユニットのライブラリ (M5Unit-Foo) を選択してください
 
-依存する M5UnitUnfied 関連のライブラリは自動で DL されます
+依存する M5UnitUnified 関連のライブラリは自動で DL されます
 
 ### PlatformIO
 1. platformio.ini の lib\_deps に記述してください
 ```ini
 lib_deps=m5stack/M5Unit-foo ;使用したいユニットのライブラリ
 ```
 
-依存する M5UnitUnfied 関連のライブラリは自動で DL されます
+依存する M5UnitUnified 関連のライブラリは自動で DL されます
 
 ## 使い方
 
@@ -282,16 +282,11 @@ void loop() {
 ```
 
 
-- 標準外の使い方
-  - [自分でユニットの更新を行う例](examples/Basic/SelfUpdate)
-  - [UnitUnified マネージャを使用せず、コンポーネントのみでの例](examples/Basic/ComponentOnly)
-
-
 ## サポートされているもの
 ### サポートされるフレームワーク
 - Arduino
 
-ESP-IDF は将来対応予定です。
+将来的には Wire クラス等を直接使わず、全て M5HAL 経由で接続を行えるようになる予定です。
 
 ### サポートされる通信
 - I2C TwoWire class による
@@ -306,8 +301,7 @@ ESP-IDF は将来対応予定です。
 
 
 ## Examples
-各ユニットのサンプルについては、各ユニットのリポジトリを参照してください。  
-[このリポジトリにあるサンプル](examples/Basic)は M5UnitUnified 全般のものです。
+使用例は各ユニットのリポジトリ (M5Unit-ENV, M5Unit-HEART 等) を参照してください。
 
 
 ## Doxygen ドキュメント

README.md

@@ -15,7 +15,7 @@ Unify basic APIs so that all units can be handled in the same way.
 ### Unified connections and communications
 Each unit's external library requires its own communication functions and assumptions.  
 Unify prerequisites and communication methods.  
-In the future, we plan to work with [M5HAL (Hardware Abstraction Layer)](https://github.com/m5stack/M5HAL) to unified communicatation  with each unit.
+In the future, we plan to work with [M5HAL (Hardware Abstraction Layer)](https://github.com/m5stack/M5HAL) to unified communication with each unit.
 
 ### Unified Licensing
 External library licenses for each unit are mixed.  
@@ -29,19 +29,19 @@ The library is registered with the library manager.
 
 1. Using library manager and select the library of the unit you want to use (e.g. M5Unit-GESTURE)
 
-Dependent M5UnitUnfied related libraries will be downloaded automatically.
+Dependent M5UnitUnified related libraries will be downloaded automatically.
 
 ### PlatformIO
 1. Write lib\_deps settings to platformio.ini
 ```ini
 lib_deps= m5stack/M5Unit-foo ; Unit to be used
 ```
-Dependent M5UnitUnfied related libraries will be downloaded automatically.
+Dependent M5UnitUnified related libraries will be downloaded automatically.
 
 
 ## How to use
 
-See also examples for each unit repositry too.
+See also examples for each unit repository too.
 
 ### UnitComponent with UnitUnified (Standard usage)
 
@@ -282,15 +282,12 @@ void loop() {
 }
 ```
 
-- Nonstandard usage
-  - [To update the unit yourself usage example](examples/Basic/SelfUpdate)
-  - [Using only unit component without UnitUnified manager](examples/Basic/ComponentOnly)
 
 ## Supported things
 ### Supported frameworks
 - Arduino
 
-Support ESP-IDF with M5HAL in the future.
+In the future, all connections will be made through M5HAL, eliminating the need to use Wire class etc. directly.
 
 ### Supported connection
 - I2C with TwoWire class
@@ -304,8 +301,7 @@ Support ESP-IDF with M5HAL in the future.
 See also [Wiki](https://github.com/m5stack/M5UnitUnified/wiki/)
 
 ## Examples
-For exampless of each unit, please refer to the respective unit's repository.  
-[The examples in this repository](examples/Basic) are for M5UnitUnified in general
+For examples, please refer to each unit's repository (e.g. M5Unit-ENV, M5Unit-HEART, etc.).
 
 ## Doxygen document
 

docs/Doxyfile

@@ -42,7 +42,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = M5UnitUnified
+PROJECT_NAME           = "M5UnitUnified"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

docs/doxy.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Please execute on repositry root
+# Please execute on repository root
 
 ## Get version from library.properties
 ## Get git rev of HEAD