はじめに

ESP32でファームを作成する場合、ESP32の開発元であるEspressif(エスプレッシフ社)が提供しているESP-IDFという純正統合開発ツールがあり、コマンドラインで開発が出来そうだったので試してみました。

先に結論として、ESP-IDFだと下記のような事象がありました。

• EdukitのGetting-Startedでビルド後の書き込みでファームにバグ
• 私が試したサンプルではsdkconfig周りで、ビルドエラー

このような事象は、PlatformIO Core (CLI)のESP-IDF向けビルドだと起こらなかったです。素人並の感想なので、なにか決定的な設定忘れの可能性はありますが、とりあえずPlatformIO Core (CLI)ベース開発を続けることになりそうです。

最近環境構築記事ばかりで、組み込み周りは選択肢が意外と多いことを実感しています。。。

ESP-IDFとは

ESP-IDF Programming Guideが非常に充実しています。

Espressifによるソフトウェア開発フレームワークは、Wi-Fi、Bluetooth、電力管理、およびその他のいくつかのシステム機能を備えたモノのインターネット（IoT）アプリケーションの開発を目的としています。

ESP-IDFの導入

Installation Step by Stepをやってみました。

Step 1. Windows、Linux、またはmacOSの前提条件をインストールする

brew install cmake ninja dfu-util

ビルドを高速化するために、ccacheもインストールが強く推奨されていたため導入します

brew install ccache

Python導入手順については割愛

Step 2. ESP-IDFの入手

mkdir -p ~/esp
cd ~/esp
git clone -b v4.3.1 --recursive https://github.com/espressif/esp-idf.git

$ cd ~/esp
$ rm -rf esp-idf
$ git clone -b v4.2 https://github.com/espressif/esp-idf.git
$ cd ~/esp/esp-idf
$ ./install.sh
# => 初回よくみたら、Pythonパッケージが追加されておらずエラーになっていた。新しいzshを立ち上げ再度実行したところ解消
$ idf.py --version
ESP-IDF v4.2

Step 3. ツールのセットアップ

cd ~/esp/esp-idf
./install.sh

Step 4. 環境変数のセットアップ

. $HOME/esp/esp-idf/export.sh

# exec ls(exa) after cd
# chpwd() { exa -ahl --git }

よく使う場合はエイリアスに登録します

alias get_idf='. $HOME/esp/esp-idf/export.sh'

Step 5. プロジェクトの開始

Step 4が実行されていないと、IDF_PATHが設定されないためうまく実行されないので注意です

cd ~/esp
cp -r $IDF_PATH/examples/get-started/hello_world .

Step 6. デバイスへの接続

macOSなので、starting with /dev/cu.xxxになります

Step 7. コンフィグ

cd ~/esp/hello_world
idf.py set-target esp32
idf.py menuconfig

Step 8. プロジェクトのビルド

idf.py build

Step 9. デバイスへ書き込み

idf.py -p /dev/cu.SLAB_USBtoUART flash

Step 10. 監視

idf.py -p /dev/cu.SLAB_USBtoUART monitor

Ctr+]で停止

次のコマンドを実行することで、ビルド、フラッシュ、モニタリングを1つのステップに組み合わせることができます。

idf.py -p /dev/cu.SLAB_USBtoUART flash monitor

ビルドはキャッシュされるので、ビルドが通らないときはcleanを試してみるのもよいかもしれません

idf.py clean

プロジェクト作成手順

ESP-IDFを導入したので、改めてプロジェクト作成手順を整理します

idf.pyの初期化

Step 4で設定したget_idfコマンドを実行します

get_idf

プロジェクトの初期化

mkdir m5stack-espidf-practice
cd m5stack-espidf-practice
idf.py create-project .

$ tree
.
├── CMakeLists.txt
└── main
    ├── ..c
    └── CMakeLists.txt

ソース、設定ファイルの変更

とりあえずシリアルモニターからHello Worldが見れるように最低限の準備を整えます

mv main/..c main/main.c

 void app_main(void)
 {
-
+  printf("Hello World");
 }

-project(.)
+project(m5stack-espidf-practice)

※ 本設定がないとビルドが落ちる(理由は不明)

-idf_component_register(SRCS "..c"
+idf_component_register(SRCS "main.c"
                     INCLUDE_DIRS ".")

idf.py clean
idf.py -p /dev/cu.SLAB_USBtoUART flash monitor

出力されました

I (251) heap_init: At 3FFAE6E0 len 00001920 (6 KiB): DRAM
I (257) heap_init: At 3FFB31B8 len 0002CE48 (179 KiB): DRAM
I (264) heap_init: At 3FFE0440 len 00003AE0 (14 KiB): D/IRAM
I (270) heap_init: At 3FFE4350 len 0001BCB0 (111 KiB): D/IRAM
I (276) heap_init: At 4008AC10 len 000153F0 (84 KiB): IRAM
I (284) spi_flash: detected chip: generic
I (287) spi_flash: flash io: dio
W (291) spi_flash: Detected size(16384k) larger than the size in the binary image header(2048k). Using the size in the binary image header.
I (305) cpu_start: Starting scheduler on PRO CPU.
I (0) cpu_start: Starting scheduler on APP CPU.
Hello World

その他必要ファイルを設定

clean:
	idf.py clean
build:
	idf.py build
watch: clean
	idf.py -p /dev/cu.SLAB_USBtoUART flash monitor

.cache
build

少し複雑なサンプルを動かしてみる

ライブラリの追加

基本的にgit submoduleを使うことになる

github.com/usedbytes/m5core2-basic-idfを参考にライブラリを追加します。 明らかに個人っぽいリポジトリは、削除される可能性を考慮して、私の環境にForkしたものを利用します。

lvgl_esp32_driversは、リビジョン6191d4を使いたかったが、どのブランチにも存在しないコミットでした。Forkして、HEADを6191d4と同等に書き換えました。

submodule addして、それぞれのリビジョンを調整します

git submodule add https://github.com/lvgl/lvgl.git components/lvgl
git submodule add https://github.com/shuntaka9576/axp192 components/axp192
git submodule add https://github.com/shuntaka9576/lvgl_esp32_drivers components/lvgl_esp32_drivers
git submodule add https://github.com/shuntaka9576/esp_i2c_helper components/esp_i2c_hal

# lvgl_esp32_drivers
git reset --hard 98b177a

# axp192
git reset --hard 99acd4a

# lvgl
git reset --hard f0c52b3

ソースの追加

cコードは、こちらを参考

$ make watch
(中略)
E (1604) i2c: i2c_master_cmd_begin(1166): i2c driver not installed
(中略)

github.com/usedbytes/m5core2-basic-idfのsdkconfigをコピー貼り付けて実行したら、うまくいった

もやもや

sdkconfigを削除して、下記のplatformio.iniを追加してpio runとpio --target uploadで安定して動くことを確認出来た。これが冒頭に述べた結論につながります。

; PlatformIO Project Configuration File
;
;   Build options: build flags, source filter, extra scripting
;   Upload options: custom port, speed and extra flags
;   Library options: dependencies, extra library storages
;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/page/projectconf.html

[platformio]
src_dir = main

[env:esp32dev]
platform = espressif32
framework = espidf
board = esp32dev

monitor_speed = 115200
monitor_filters = colorize
monitor_flags= --raw
upload_port = /dev/cu.SLAB_USBtoUART

最後に

そもそもですが、ArudiunoとESP-IDFのプロジェクト構成を比較すると、前者はpio lib installで依存を落とせましたが、ESP-IDFはgit submoduleを駆使しないといけないんですかね..。

それはさておき、当面の目標としてArdiunoに慣れて、ESP-IDF向けのサンプルを量産したいですね