Skip to content

Commit

Permalink
Merge pull request #20 from 3110/develop
Browse files Browse the repository at this point in the history 
Develop
  • Loading branch information
@3110
3110 authored Apr 7, 2024
2 parents e3e46c7 + 27b4652 commit 924d172
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 54 deletions.
3 changes: 2 additions & 1 deletion .vscode/settings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
"unordered_set": "cpp",
"vector": "cpp",
"string_view": "cpp",
"initializer_list": "cpp"
"initializer_list": "cpp",
"span": "cpp"
},
"cSpell.words": [
"coreink",
Expand Down
50 changes: 26 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,29 @@

## 対応機種

| 機種名 | 環境名 | 備考 |
| :-------------- | :------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| M5Stack BASIC | env:m5stack-basic | |
| M5Stack Fire | env:m5stack-fire | |
| M5Stack M5GO | env:m5stack-m5go | |
| M5Stack CORE2 | env:m5stack-core2 | |
| M5Stack CORES3 | env:m5stack-cores3 <br> env:m5stack-cores3-m5unified | 公式ライブラリを使用<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5StickC | env:m5stack-c | |
| M5StickC Plus | env:m5stack-c-plus | |
| M5ATOM Matrix | env:m5stack-atom-matrix <br> env:m5stack-atom-matrix-m5unified | 公式ライブラリを使用<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM Lite | env:m5stack-atom-lite <br> env:m5stack-atom-lite-m5unified | 公式ライブラリを使用<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM Echo | env:m5stack-atom-echo <br> env:m5stack-atom-echo-m5unified | 公式ライブラリを使用<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM U | env:m5stack-atom-u <br> env:m5stack-atom-u-m5unified | 公式ライブラリを使用<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOMS3 | env:m5stack-atoms3 <br> env:m5stack-atoms3-m5unified | 公式ライブラリを使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。|
| M5ATOMS3 Lite | env:m5stack-atoms3-lite <br> env:m5stack-atoms3-lite-m5unified | 公式ライブラリを使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。|
| M5ATOMS3 U | env:m5stack-atoms3-u <br> env:m5stack-atoms3-u-m5unified | 公式ライブラリを使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。|
| M5Stack CoreInk | env:m5stack-core-ink | |
| M5Stack Paper | env:m5stack-paper | |
| M5StampS3 | env:m5stack-stamps3 <br> env:m5stack-stamps3-m5unified | 公式ライブラリはなし<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5Capsule | env:m5stack-capsule-m5unified | [M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5Dial | env:m5stack-dial <br> env:m5stack-dial-m5unified | 公式ライブラリを使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）<br>[M5Unified](https://github.com/m5stack/M5Unified)を使用。USB CDC On Boot が有効。 |
| M5NanoC6 | env:m5stack-nanoc6 | 公式ライブラリを使用 |
| 機種名 | 環境名 | 備考 |
| :-------------- | :------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| M5Stack BASIC | env:m5stack-basic | [公式ライブラリ](https://github.com/m5stack/M5Stack)を使用。 |
| M5Stack Fire | env:m5stack-fire | [公式ライブラリ](https://github.com/m5stack/M5Stack)を使用。 |
| M5Stack M5GO | env:m5stack-m5go | [公式ライブラリ](https://github.com/m5stack/M5Stack)を使用。 |
| M5Stack CORE2 | env:m5stack-core2 | [公式ライブラリ](https://github.com/m5stack/M5Core2)を使用（不具合があるため[M5Unified](https://github.com/m5stack/M5Unified)ベースではないv0.1.8に固定）。 |
| M5Stack CORES3 | env:m5stack-cores3 <br> env:m5stack-cores3-m5unified | [公式ライブラリ](https://github.com/m5stack/M5CoreS3)を使用。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5StickC | env:m5stack-c | [公式ライブラリ](https://github.com/m5stack/M5StickC)を使用。 |
| M5StickC Plus | env:m5stack-c-plus | [公式ライブラリ](https://github.com/m5stack/M5StickC-Plus)を使用。 |
| M5ATOM Matrix | env:m5stack-atom-matrix <br> env:m5stack-atom-matrix-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM Lite | env:m5stack-atom-lite <br> env:m5stack-atom-lite-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM Echo | env:m5stack-atom-echo <br> env:m5stack-atom-echo-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM U | env:m5stack-atom-u <br> env:m5stack-atom-u-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOMS3 | env:m5stack-atoms3 <br> env:m5stack-atoms3-m5unified | [公式ライブラリ](https://github.com/m5stack/M5AtomS3)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。|
| M5ATOMS3 Lite | env:m5stack-atoms3-lite <br> env:m5stack-atoms3-lite-m5unified | [公式ライブラリ](https://github.com/m5stack/M5AtomS3)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。|
| M5ATOMS3 U | env:m5stack-atoms3-u <br> env:m5stack-atoms3-u-m5unified | [公式ライブラリ](https://github.com/m5stack/M5AtomS3)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。|
| M5Stack CoreInk | env:m5stack-core-ink | [公式ライブラリ](https://github.com/m5stack/M5Core-Ink)を使用。 |
| M5Stack Paper | env:m5stack-paper | [公式ライブラリ](https://github.com/m5stack/M5EPD)を使用。 |
| M5StampS3 | env:m5stack-stamps3 <br> env:m5stack-stamps3-m5unified | 公式ライブラリはなし。<br>[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5Capsule | env:m5stack-capsule-m5unified | [M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5Dial | env:m5stack-dial <br> env:m5stack-dial-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Dial)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。<br>[M5Unified](https://github.com/m5stack/M5Unified)を使用。USB CDC On Boot が有効。 |
| M5Cardputer | env:m5stack-cardputer | [公式ライブラリ](https://github.com/m5stack/M5Cardputer)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。 |
| M5NanoC6 | env:m5stack-nanoc6 | [公式ライブラリ](https://github.com/m5stack/M5NanoC6)を使用。 |

## 事前準備

Expand Down Expand Up @@ -85,6 +86,7 @@ default_envs = m5stack-basic
; default_envs = m5stack-capsule-m5unified
; default_envs = m5stack-dial
; default_envs = m5stack-dial-m5unified
; default_envs = m5stack-cardputer
; default_envs = m5stack-nanoc6
```

Expand All @@ -101,8 +103,8 @@ lib_deps =

`main.cpp`の`setup()`，`loop()`にコードを書きます。必要なヘッダファイルは`main.hpp`で環境名に合わせて実機に合ったヘッダファイルをインクルードするようにしています。

各機種で`M5.begin()`の引数がまちまちでわかりにくいので，`M5_BEGIN`というマクロを定義しています。定義内容に関しては`main.hpp`を参照してください。
また，CoreS3の公式ライブラリでは`M5.update()`が定義されていないので，各機種共通で扱えるように`M5_UPDATE`というマクロで吸収しています。
各機種で`M5.begin()`の引数がまちまちでわかりにくく，`CoreS3.begin()`のように機種固有の名前が付いている場合もあるので，`M5_BEGIN`と`M5_UPDATE`というマクロで差異を吸収しています。
それぞれの定義内容に関しては`main.hpp`を参照してください。

注意：M5Unified で`SD.h`や`SPIFFS.h`を使用する場合は，`#include "main.hpp"`より前に入れてください。

Expand Down
Loading

0 comments on commit 924d172

Please sign in to comment.