Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3110/m5stack-platformio-boilerplate-code
PlatformIO IDE 向け M5Stack 定型コード環境 / Boilerplate Code for M5Stack in PlatformIO IDE Environment
https://github.com/3110/m5stack-platformio-boilerplate-code
m5stack platformio
Last synced: 3 months ago
JSON representation
PlatformIO IDE 向け M5Stack 定型コード環境 / Boilerplate Code for M5Stack in PlatformIO IDE Environment
- Host: GitHub
- URL: https://github.com/3110/m5stack-platformio-boilerplate-code
- Owner: 3110
- License: mit
- Created: 2022-08-09T08:39:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T10:46:25.000Z (4 months ago)
- Last Synced: 2024-10-11T22:47:56.535Z (4 months ago)
- Topics: m5stack, platformio
- Language: C++
- Homepage:
- Size: 121 KB
- Stars: 15
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Support: support_framework_arduino.py
Awesome Lists containing this project
README
[In English](README_en_US.md)
# PlatformIO IDE 向け M5Stack 定型コード環境
[Arduino IDE](https://www.arduino.cc/en/software) 環境と同じように [PlatformIO IDE](https://platformio.org/platformio-ide) 環境でも `setup()`と`loop()`の中身を書いてすぐにコンパイルして実行できます。
## 対応機種
| 機種名 | 環境名 | 備考 |
| :-------------- | :------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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
env:m5stack-core2-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Core2)を使用（ライブラリ廃止予定）。
[M5Unified](https://github.com/m5stack/M5Unified)を使用。 |
| M5Stack CORES3 | env:m5stack-cores3
env:m5stack-cores3-m5unified | [公式ライブラリ](https://github.com/m5stack/M5CoreS3)を使用。
[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
env:m5stack-atom-matrix-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。
[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM Lite | env:m5stack-atom-lite
env:m5stack-atom-lite-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。
[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM Echo | env:m5stack-atom-echo
env:m5stack-atom-echo-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。
[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOM U | env:m5stack-atom-u
env:m5stack-atom-u-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Atom)を使用。
[M5Unified](https://github.com/m5stack/M5Unified) を使用。 |
| M5ATOMS3 | env:m5stack-atoms3
env:m5stack-atoms3-m5unified | [公式ライブラリ](https://github.com/m5stack/M5AtomS3)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。
[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5ATOMS3R | env:m5stack-atoms3r-m5unified | [M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5ATOMS3 Lite | env:m5stack-atoms3-lite
env:m5stack-atoms3-lite-m5unified | [公式ライブラリ](https://github.com/m5stack/M5AtomS3)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。
[M5Unified](https://github.com/m5stack/M5Unified) を使用。USB CDC On Boot が有効。 |
| M5ATOMS3 U | env:m5stack-atoms3-u
env:m5stack-atoms3-u-m5unified | [公式ライブラリ](https://github.com/m5stack/M5AtomS3)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。
[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
env:m5stack-stamps3-m5unified | 公式ライブラリはなし。
[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
env:m5stack-dial-m5unified | [公式ライブラリ](https://github.com/m5stack/M5Dial)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。
[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 が有効。 |
| M5DinMeter | env:m5stack-din-meter | [公式ライブラリ](https://github.com/m5stack/M5DinMeter)を使用（[M5Unified](https://github.com/m5stack/M5Unified)ベース）。USB CDC On Boot が有効。 |
| M5NanoC6 | env:m5stack-nanoc6 | [公式ライブラリ](https://github.com/m5stack/M5NanoC6)を使用。 |
## 事前準備
### コード整形の設定
コードの整形は`.vscode/settings.json`で`"C_Cpp.clang_format_style": "file"`にしているため，`.clang-format`で設定できます。ご自身の好きな設定に変更してください。
### 環境設定
#### 接続ポートの設定
`platformio.ini`の`[platformio]`セクションにある`upload_port`と`monitor_port`のコメントを外し，`upload_port`に設定するポートを実機が接続しているポートに変更します。
```platformio.ini
upload_port = COM16
monitor_port = ${env.upload_port}
```
※PlatformIO IDE [v3.0.0](https://github.com/platformio/platformio-vscode-ide/releases/tag/v3.0.0)より，ステータスバーからポートの切り替えができるようになりました。
#### 環境の設定
「Switch PlatformIO Project Environment」（VSCode のステータスバーにある）で機種に合った環境名を設定します。
`platformio.ini`の`[platformio]`セクションで`default_envs`を明示的に指定することでも環境を設定できます（既に書いてあるので，いずれかのコメントを外す）。以下の例では`m5stack-basic`を指定しています。
```platformio.ini
[platformio]
default_envs = m5stack-basic
; default-envs = m5stack-fire
; default-envs = m5stack-m5go
; default_envs = m5stack-core2
; default_envs = m5stack-cores3
; default_envs = m5stack-cores3-m5unified
; default_envs = m5stick-c
; default_envs = m5stick-c-plus
; default_envs = m5stack-atom-matrix
; default_envs = m5stack-atom-lite
; default_envs = m5stack-atom-echo
; default_envs = m5stack-atom-u
; default_envs = m5stack-atom-matrix-m5unified
; default_envs = m5stack-atom-lite-m5unified
; default_envs = m5stack-atom-echo-m5unified
; default_envs = m5stack-atom-u-m5unified
; default_envs = m5stack-atoms3
; default_envs = m5stack-atoms3r-m5unified
; default_envs = m5stack-atoms3-lite
; default_envs = m5stack-atoms3-u
; default_envs = m5stack-atoms3-m5unified
; default_envs = m5stack-atoms3-lite-m5unified
; default_envs = m5stack-atoms3-u-m5unified
; default_envs = m5stack-coreink
; default_envs = m5stack-paper
; default_envs = m5stack-stamps3
; default_envs = m5stack-stamps3-m5unified
; default_envs = m5stack-capsule-m5unified
; default_envs = m5stack-dial
; default_envs = m5stack-dial-m5unified
; default_envs = m5stack-cardputer
; default_envs = m5stack-din-meter
; default_envs = m5stack-nanoc6
```
### 外部ライブラリの追加
外部ライブラリを使用する場合は，`[env]`セクションにある`lib_deps`に追加します。
```ini
lib_deps =
fastled/FastLED
```
### コードの記述
`main.cpp`の`setup()`，`loop()`にコードを書きます。必要なヘッダファイルは`main.hpp`で環境名に合わせて実機に合ったヘッダファイルをインクルードするようにしています。
各機種で`M5.begin()`の引数がまちまちでわかりにくく，`CoreS3.begin()`のように機種固有の名前が付いている場合もあるので，`M5_BEGIN`と`M5_UPDATE`というマクロで差異を吸収しています。
また，機種によっては`M5`のインスタンスに機種固有の名前（M5Stack CoreS3 の公式ライブラリの場合は`M5`ではなく`CoreS3`）がついている場合があるので，どの場合でも同じ`M5DEV`でアクセスできるように設定しています。
共通の書き方でログの出力をするために，`M5DEV_LOGE()`，`M5DEV_LOGW()`，`M5DEV_LOGI()`，`M5DEV_LOGD()`，`M5DEV_LOGV()`を定義しました。
それぞれの定義内容に関しては`main.hpp`を参照してください。
注意：M5Unified で`SD.h`や`SPIFFS.h`を使用する場合は，`#include "main.hpp"`より前に入れてください。
```c++
// clang-format off
#include
#include "main.hpp"
// clang-format on
```
### 実機へのアップロード
PlatformIO: Upload（VSCode のステータスバーにある → ボタン）を実行します。