Hello Worldのサンプルの解説

環境構築 (PlatformIO) のHello Worldから

include文

#include <Arduino.h>
#include <M5Unified.h>

#include <XXXX.h> は指定したファイルの内容をソースコードに差し込む命令 (ヘッダファイルの読み込みを行うプリプロセッサ命令)

このサンプルでは, Arduino.hというファイルと, M5Unified.hというファイルを展開している

• Arduino.h はArduinoの関数を利用するための必須ライブラリ
• M5Unified.h はM5Stackシリーズの共通ライブラリ

<aside> 💡

プリプロセスはコンパイルする前の前処理のこと

# を使ったキーワードを見つけると, コンパイルす前に特定の処理を行ってから, コンパイラに結果を返す (#define , #undef , #if , #ifdef など)

#include <M5Unified.h> はプリプロセス時に, /.pio/libdeps/m5stack-core2/M5Unified/src/M5Unified.h の内容をmain.cppに差し込む

Arduino.hの実体は, おそらく.platformio/packages/framework-arduinoespressif32/cores/esp32/Arduino.h

</aside>

setup関数

void setup() {                      // マイコンの起動時に1度だけ呼び出される関数
	auto cfg = M5.config();           // 初期化オプションを取得する. M5Unifiedでは必須
	M5.begin(cfg);                    // M5Stackの初期化. 引数として直前の初期化オプション(cfg)が必要
	
	M5.Display.print("Hello World");  // M5Stackのディスプレイに文字列"Hello World"を出力する
}

void setup(){ 処理 } はマイコンの起動時に1度だけ呼び出される関数. 通常, マイコン, センサの初期化や, 無線通信のセットアップなどを行う

setup()内の処理はM5Stackの固有の処理である

• auto cfg = M5.config(); はM5Stackの初期化オプションの取得を行う
  • この初期設定の中には, M5Stackに搭載されているハードウェアの設定が含まれている
    • ディスプレイや, ボタン, IMU, スピーカーなど
  • それらのハードウェアの一部だけを初期化したい場合や, 特定の設定を変更したい場合に有効である
    • 内蔵のIMUの初期化を無効化する: cfg.internal_imu = false;
    • 外部ディスプレイを使用する(HDMIモジュール): cfg.external_display.module_display = true;
  • auto は, 型推論のキーワード. コンパイラが変数の型を自動的に推論する
• M5.begin(cfg); はM5Stackの初期化を行う関数. 引数に先に取得した初期化オプションを取る
• M5.Display.print(”Hello World”); はM5Stackの内蔵ディスプレイに”Hello World”を出力する
  • 内蔵ディスプレイの操作にはM5.Displayクラスを使い行う
  • 詳細はM5Stack Core2のディスプレイを使う にて

<aside> 💡

M5は, M5Unifiedクラスのグローバルインスタンスであり, M5のメンバ変数に, Display, Imu, Btnなどの内蔵機能にアクセスするためのクラスが存在する

M5Unified/src/M5Unified.hpp の65行目以降を参照

</aside>

loop関数