🐡

【ESP32 × PlatformIO】フレームワークをArduinoからESP-IDFに変更する方法

2024/06/02に公開

Arduino

はじめに

方言を話す、おしゃべり猫型ロボット「ミーア」を開発中。

https://mia-cat.com/

前回、こちらの記事で、AWS IoT関連の設定ファイルをLittleFS領域からNVS領域に移動するのを実装した。

ただ、このままだとセキュリティ的に脆弱なので、今回はNVS暗号化の実装を試みようとしたところ、下記記載に遭遇。

Flash EncryptionとSecure BootはArduino IDEでは提供されていないし、今後も提供する予定がないとのことorz

というわけで、まずは、今使用しているArduinoフレームワークからESP-IDFフレームワークヘ変更する必要がある。

ちなみに、現在のplatform.iniファイルでの設定は下記。

; PlatformIO Project Configuration File
; https://docs.platformio.org/page/projectconf.html
[env]
platform = espressif32
framework = arduino
board = esp32dev

今回は、フレームワーク変更をPlatformIOでどのように行うかに関して記載。

下記Espressif公式サイトの説明参照

下記順番で進めていく

platform.iniのframeworkにespidfを追加
CmakeLists.txtファイルをルートとsrcディレクトリに追加
sdkconfig.defaultsファイルを追加し、arduinoでも起動できるように必要な設定を追加
arduinoライブラリでesp-idfでも起動するのに必要なものは追加

ESP-IDFフレームワーク概要

CmakeLists.txtファイルとは？

ESP-IDFフレームワークはCMakeというビルドシステムを用いている。

CMakeLists.txtファイルは、CMakeビルドシステムに対してプロジェクトのビルド方法を指示するファイル。ESP-IDFを使用する際、プロジェクトの構成とビルドプロセスを管理するために必要となる。

PlatformIOでESP-IDFを使用するプロジェクトは、通常、以下の構造を持つ。

project_dir/
├── include/
├── src/
│   ├── CMakeLists.txt
│   └── main.c
├── CMakeLists.txt
└── platformio.ini

ルートディレクトリ、srcディレクトリの2つのCmakeLists.txtファイルが存在することがわかる。それぞれの用途と記載方法を見ていく。

ルートディレクトリにある`CMakeLists.txt`

プロジェクト全体の設定を行う。一般的に、このファイルには以下のような内容が含まれる。

# The following lines of boilerplate have to be in your project's CMakeLists
# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.16.0)

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(project-name)

project-name は CMake の中で設定するプロジェクトの名前で、これは任意の名前を指定することができる。この名前は、CMake はこの名前を使用してプロジェクト固有の変数を生成し、ビルドプロセスを管理する。

PlatformIO のプロジェクト名は主に PlatformIO の環境内で使用され、CMake の project-name は CMake と ESP-IDF のビルドシステム内で使用されるので、PlatformIOのプロジェクト名を一致させる必要はないが、一致させた方が可読性が高まる。

`src`ディレクトリ内の`CMakeLists.txt`

特定のコンポーネント（この場合はアプリケーションのメインコンポーネント）のビルドプロセスを制御する。最小限の設定では、以下のようにコンポーネントをビルドシステムに登録する

idf_component_register(SRCS "main.c")

これらのCMakeLists.txtファイルは、プロジェクトがESP-IDFのビルドシステムを使用して正しくビルドされるために必要。また、追加のコンポーネントや特別なビルド設定が必要な場合には、これらのファイルに対応する設定を追加する。

sdkconfig.defaults

**platformio.ini**ファイルは、PlatformIOプロジェクトの主要な設定ファイルであり、プロジェクトのビルド設定、使用するボード、フレームワーク、ライブラリ依存関係などを定義する。

一方、**sdkconfig.defaults**はESP-IDF固有の設定ファイルで、ESP-IDFフレームワークの様々な設定を事前に定義できる。システムの動作、機能の有効化/無効化、パフォーマンスのチューニングなどが含まれる。プロジェクトのルートディレクトリに設置する。

ESP-IDFフレームワークの概要を把握したところで、実際に現在の設定を置き換えていく。

platformio.iniの更新：frameworkにespidfを追加

platformio.iniファイルのframeworkの部分をarduinoからespidfに変更する。

当初、framework = espidfと指定しなければいけないと思っていたし、公式サイトにもそのように記載されていたのでその手順で進めていた。

その場合、下記作業が発生して、大変になる（実際途中まで進めてしまいかなり大変だった）

Arduinoライブラリの管理:

Arduinoのライブラリを使用するためには、componentsフォルダ配下にArduinoライブラリを全てgit cloneする必要があり、これにより、プロジェクトのファイル容量が数GBになる可能性がある。

コードの書き換え

espidfフレームワークを指定してビルドすると、arduinoライブラリ関連は全てエラーが出るので、ArduinoライブラリがArduino.hでインクルードされている部分をすべて書き換える必要がある。

In file included from src/app_config.cpp:1:
src/app_config.h:1:10: fatal error: FS.h: No such file or directory

************************************************************
* Looking for FS.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:FS.h"
* Web  > https://registry.platformio.org/search?q=header:FS.h
*
************************************************************

    1 | #include <FS.h>
      |          ^~~~~~
compilation terminated.
Compiling .pio/build/release/src/donwload.cpp.o
In file included from src/button_manager.cpp:1:
src/button_manager.h:1:10: fatal error: Arduino.h: No such file or directory

*****************************************************************
* Looking for Arduino.h dependency? Check our library registry!
*
* CLI  > platformio lib search "header:Arduino.h"
* Web  > https://registry.platformio.org/search?q=header:Arduino.h
*
*****************************************************************

しかし下記の記述で、PlatformIOでArduinoとESP-IDFのフレームワークを併用することができるとのこと。自分の場合は、途中でこれに気づいて、かなり時間を食ってしまった。

[env]
platform = espressif32 @ 6.7.0
framework = arduino, espidf

このように指定することで、既存の多くのArduinoライブラリを直接利用できるため、コードのポーティングや書き直しの手間を省くことができる。

というわけで、framework = arduino, espidf を設定する。

実際にespidf公式でも、espidfとarduinoをplatform.iniで併用しているexample（blink, wifiscan）が記載されている

CMakeLists.txtの作成（ルート・src）

プロジェクトのルートディレクトリにCMakeLists.txtファイルを作成する。以下の内容を記述。

cmake_minimum_required(VERSION 3.16.0)
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(clocky_platformio)  #プロジェクト名

srcフォルダにもう1つのCMakeLists.txtファイルを作成する。以下の内容を記述。

file(GLOB_RECURSE app_sources *.cpp)
idf_component_register(SRCS ${app_sources}
					INCLUDE_DIRS "."
                    INCLUDE_DIRS "json"
                    )

まず、ワイルドカードを使ってsrcディレクトリ内のすべての.cppファイルをビルド対象として指定する。

file: CMakeの組み込みコマンドで、ファイルシステムの操作を行う。
GLOB_RECURSE: ファイルパターンを再帰的に検索するオプション。ディレクトリとそのサブディレクトリを再帰的に検索し、指定されたパターンに一致するファイルを見つける。
app_sources: 検索結果を格納する変数の名前。この変数には、見つかったファイルのパスが格納される。

というわけで、以下のコードを実行すると、srcディレクトリおよびそのサブディレクトリ内のすべての.cppファイルを検索し、それらのパスをapp_sources変数に格納する。

file(GLOB_RECURSE app_sources *.cpp)

また、INCLUDE_DIRS "."により、srcディレクトリ内のヘッダーファイルがインクルードパスに含まれる。同様に、jsonサブディレクトリをビルド対象に含めたいので、INCLUDE_DIRS "json"と追加する。

sdkconfig.defaultsの作成

ESP-IDFでは、必要な設定をsdkconfig.defaultsに記載することで初期設定を行うことができる。

新規にsdkconfig.defaultsファイルをプロジェクトのルートディレクトリに作成し、下記を記載する

CONFIG_AUTOSTART_ARDUINO=y
CONFIG_FREERTOS_HZ=1000
CONFIG_MBEDTLS_PSK_MODES=y
CONFIG_MBEDTLS_KEY_EXCHANGE_PSK=y

CONFIG_AUTOSTART_ARDUINO=y

意味: Arduinoライブラリを自動的に起動する設定。

理由: この設定を有効にすることで、、、

続きはこちらで記載しています。