ESP-IDF ( ESP32 開発環境 ) の使い方

ESP32のメーカーEspressif Systems社公式の開発環境、ESP-IDF の使い方を説明します。

Arduino IDEでも ESP32 ( ESP-WROOM-32 ) は開発できますが、全ての機能を使うことができません。
ESP-IDF を使うともっといろいろな機能が使えます。
簡単にサクッとESP32を開発したい方はArduino IDE。
もっとコアにガッツリ使いたい方はESP-IDFを使えば良いのではないかと思います。
（Arduino IDEでの使い方はこちらの記事をご覧ください。）

ESP-IDF の使い方はいろいろな方々が記事にされていますが、Arduino IDEをよく使う私にとっては、イマイチよく分からないことが多かったので、私なりに備忘録も兼ねてまとめてみました。
これは要するに、Linux環境を使うようなものです。
結構ハマりますので、覚悟しておいてください。
また、日々アップデートされているので、数か月後には使い方が変わっている可能性があります。
その場合はお知らせいただけると助かります。

本家、ESPRESSIF社公式以下のページに英語版使用方法がありますので、合わせてご覧ください。

https://docs.espressif.com/projects/esp-idf/en/stable/index.html

ここでの場合は Espressif社の ESP32-DevKitC ( ESP-WROOM-32 )開発ボードを使います。

waves ESP32 DevKitC V4 ESP-WROOM-32 ESP-32 WiFi BLE

waves

￥1,170（2024/11/20 20:44時点）

もちろん、スイッチサイエンスさんの ESPr® Developer 32 でも同じように使えます。
ただ、ピンヘッダは別途購入して、ハンダ付けする必要があります。

ESPr Developer 32

スイッチサイエンス(Switch Science)

ESPr Developer 32 については、過去にレビューした記事がありますので、ご参照ください。

ESPr Developer 32 ( スイッチサイエンス製 ) を使ってみました

以下、Windows10 環境の場合で説明します。

【目次】

1. ESP-IDF v4.0.1 stable版の使い方
   • ESP-IDF をインストールする
   • ESP-IDF Tools をインストールする
   • サンプルプログラムをコピーする
   • ESP32開発ボードとLEDを接続する
   • サンプルプログラムを修正する
   • 環境設定をする
   • ビルド（コンパイル）して、データをESP32のフラッシュへ書き込む
   • ビルド（コンパイル）だけする。（フラッシュに書き込まない）
2. 従来のMSYS2でESP-IDFを使う方法
   • １．MSYS2 ツールチェーンをインストール
   • ２．ESP-IDF をGET する
   • ３．MSYS2 の環境設定で ESP-IDF のパスを通すファイルを作成
   • ４．プロジェクトの作成
   • ５．ESP32-DevKitC を接続する
   • ６．コンパイルオプションメニュー設定
   • ７．コンパイル書き込み

ESP-IDF v4.0.1 stable版の使い方

2020年8月9日時点では、ESP-IDF の安定(stable)バージョンは 4.0.1 です。
これは、旧来のMSYS2を使う方法とは異なり、Windowsのコマンドプロンプト内で実行できて、とても便利になりました。
そのインストール方法、および使い方を説明します。

ESP-IDF をインストールする

ここでは、Windows 10環境で説明します。

まず、ESP32のメーカーESPRESSIF systems公式のESP-IDF Programming Guideサイトに行き、以下のページを開きます。

https://docs.espressif.com/projects/esp-idf/en/stable/get-started/windows-setup.html

そこの、ESP-IDF Tools Installer項目のところに、ESP-IDF Toolsインストーラーファイルのダウンロードリンクがあります。
下図の様なところをクリックすると、実行ファイルがダウンロードされます。

ダウンロードされるファイルは、2020/08/09現在では、
esp-idf-tools-setup-2.3.exe
という実行形式ファイルです。

ESP-IDF Tools をインストールする

次に、先ほどダウンロードした ESP-IDF Tools をインストールします。
ダウンロードフォルダを開き、下図の様に保存されたファイルを右クリックして、
「管理者として実行」
をクリックします。

すると、インストーラーが起動し、下図の様な画面になるので、規約内容をしっかり読み、同意すれば
I accept the agreement.
を選択して、「Next」をクリックして次に進みます。

すると、下図の様に Python をインストールするか訪ねてきます。
Pythonはプログラムの環境設定をしたり、ビルドしたり、ESP32にバイナリを転送するために必要なアプリです。
既にインストールされていなければチェックを入れて、次に進みます。

すると、下図の様な画面が出て来て、Git をインストールするか聞いてきます。
ESP-IDFのソースはGitHubにあり、そこから最新版に更新したりする為にGitが必要です。
Gitの最新版がインストールされていなければ、下図の様に選択します。
私の場合は、ver 2.13.2 がインストールされていましたが、最新版の2.21.0の方が欲しかったので、それを選択して、次に進みました。

すると、下図の様な画面が出てきます。
初めてESP-IDFをインストールする場合は、
Download ESP-IDF
を選択して、次に進みます。

すると、下図の様な画面が出てくるので、2020/08/09時点で最新の安定版である、
v4.0.1(release version)
を選択します。
そして、その下のダウンロードするフォルダは、私の場合はDドライブ直下にesp-idfというフォルダを作成し、そこを選択して次に進みました。
これは任意で良いと思います。

すると、下図の様な画面が出て来て、ESP-IDFツール群をインストールするフォルダを聞いてきます。
私の場合は、Dドライブ直下としました。
これも任意で良いと思います。
.espressif
というフォルダ名が自動的に作成されるはずです。

すると、下図の様な画面になるので、必要事項にチェックを入れます。
内容はこんな感じです。

①ESP-IDF Tools ショートカットをスタートメニューに作る場合
②ESP-IDF Tools ショートカットをディスクトップに作る場合
③ESP-IDF Tools 実行ファイルをウィルスチェックソフトWindows Defenderから除外する場合

特に3番については自己責任でチェックしてください。

すると、下図の様な画面になるので、問題無ければ、「Install」をクリックします。

すると、下図の様にインストールが始まります。

インストール完了すると、下図の様な画面になるので、他の開いているソフトを終了させてから、Yesを選択して、「Finish」をクリックすると、パソコンが再起動します。

パソコンの再起動が完了したら、ディスクトップに下図の様なアイコンが表示されていると思います。

そこで、ESP-IDF Command Prompt をダブルクリックして起動させます。
すると、下図の様な画面になれば、インストール成功です。

サンプルプログラムをコピーする

では、次にサンプルプログラムをコピーします。
先ほど作ったesp-idfフォルダを開きます。
私の場合はDドライブ直下に作ったので、パスは
D:￥esp-idf
となります。

そして、その中のexamplesフォルダの中にget-startedフォルダがあるのでそれを開きます。
パスは以下のようになります。

D:\esp-idf\examples\get-started

その中に、blinkというLEDをチカチカさせるプログラム（Ｌチカ）が入っているので、そのフォルダごと
D:\esp-idf フォルダにコピーします。
下図の様な感じです。

ESP32開発ボードとLEDを接続する

ESP32-DevKitC や、ESPr Developer 32 とLEDをブレッドボード上で接続します。
ブレッドボードは、サンハヤトのSAD-101がお勧めです。

サンハヤト SAD-101 ニューブレッドボード

サンハヤト

￥529（2024/11/21 08:14時点）

LED は通常の5V程度の砲弾型LEDで良いと思います。
ただ、ESP32のGPIOには最大12mA程度の電流しか流せないので、必ず電流制限抵抗を入れてください。
LEDの電流に合わせて、1kΩ～10kΩ程度になるかと思います。

ここでは、下図の様にGPIO #23 に接続します。

写真では以下のようになります。

接続し終わったら、今度はパソコンとESP32開発ボードをUSB接続しておきます。

サンプルプログラムを修正する

では、次に、blinkプログラムのソースコードを修正します。

先ほどコピーしたblinkフォルダを開き、その中のmainフォルダを開きます。
パスは私の場合は以下です。

D:\esp-idf\blink\main

すると、下図の様になるので、blink.cというファイルをテキストエディタで開きます。
テキストエディタはできるだけメモ帳でない方が良いです。
例えばサクラエディタとか。。。

そうしたら、１８行目を以下のように変更して上書き保存します。
要するに、LEDをGPIO #23に接続したので、その番号に変更するということです。

/* Blink Example

   This example code is in the Public Domain (or CC0 licensed, at your option.)

   Unless required by applicable law or agreed to in writing, this
   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
   CONDITIONS OF ANY KIND, either express or implied.
*/
#include <stdio.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/gpio.h"
#include "sdkconfig.h"

/* Can use project configuration menu (idf.py menuconfig) to choose the GPIO to blink,
   or you can edit the following line and set a number here.
*/
#define BLINK_GPIO 23

void app_main()
{
    /* Configure the IOMUX register for pad BLINK_GPIO (some pads are
       muxed to GPIO on reset already, but some default to other
       functions and need to be switched to GPIO. Consult the
       Technical Reference for a list of pads and their default
       functions.)
    */
    gpio_pad_select_gpio(BLINK_GPIO);
    /* Set the GPIO as a push/pull output */
    gpio_set_direction(BLINK_GPIO, GPIO_MODE_OUTPUT);
    while(1) {
        /* Blink off (output low) */
	printf("Turning off the LED\n");
        gpio_set_level(BLINK_GPIO, 0);
        vTaskDelay(100 / portTICK_PERIOD_MS);
        /* Blink on (output high) */
	printf("Turning on the LED\n");
        gpio_set_level(BLINK_GPIO, 1);
        vTaskDelay(100 / portTICK_PERIOD_MS);
    }
}

環境設定をする

次に、ESP-IDFのblinkプログラムの環境設定をします。
ここからは、Espressif Systemsの公式サイトドキュメントの以下のページを合わせて参照してください。

https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html#step-5-start-a-project

ESP-IDFを起動し、下図の様に

cd blink

とコマンドを入力して Enterキーを押します。
cd はchange directory コマンドです。

すると、サンプルプログラムのblinkフォルダに移動します。

そうしたら、今度は

idf.py menuconfig

と入力して、Enterキーを押します。

すると、下図の様な環境設定アプリ画面になります。

パソコンの矢印キーの「↓」を押して、下図の様に
Serial flasher config
を選択し、Enterキーを押します。

すると、下図の様な画面になるので、赤枠で囲った範囲のメニューを選択して選んで、値を変更します。

Flash SPI mode — QIO
Flash SPI speed — 80 MHz
Flash size — 4 MB

これは各々ESP32ボードに合わせれば良いです。

変更ができたら、パソコンのキーボードで「Esc」キーを２回連続して押しと、下図の様な画面になりますので、Yesを選択してEnterキーを押して設定を保存して環境設定を終了させます。
（「Esc」キーを押さなくても、下の欄の＜Save＞でも同じような画面になると思います。）

すると、下図の様な画面になり、設定を保存して、menuconfig画面を抜けたことになります。

ビルド（コンパイル）して、データをESP32のフラッシュへ書き込む

では、いよいよ、ESP32にビルド（コンパイル）して、データをESP32のフラッシュへ書き込みます。

その前に、パソコンとUSB接続したESP32開発ボードのCOMポート番号を調べます。
下図の様に、Windowsロゴマークを右クリックして、デバイスマネージャーを選択します。

すると、下図の様な画面になるので、
ポート(COM と LPT)
をクリックすると、そのボードのCOM番号が分かります。

次に、ESP-IDF画面に戻り、以下のflashコマンドを入力します。
flashコマンドはビルド（コンパイル）を実行して、フラッシュへ書き込みます。
私の場合はcom4だったので、以下のようにしました。

idf.py -p com4 flash

これでEnterキーを押します。

すると、ESP32のフラッシュへバイナリデータを転送します。
デフォルト設定では460800bpsで転送するようです。
完了すると、下図の様になります。

これでESP32のフラッシュへ書き込みました。
以前のMSYS2を使ったビルドよりも格段に高速になりましたね。

下図の様にLEDがチカチカすればＯＫです。

ビルド（コンパイル）だけする。（フラッシュに書き込まない）

参考として、フラッシュに書き込まずにビルド（コンパイル）だけしたい場合を紹介します。

下図の様に、

idf.py build

と入力して、Enterキーを押すと、コンパイルが始まります。

2～3分くらいでビルド（コンパイル）が終ると下図の様な画面になります。

これでビルドだけできました。

以上、Windows10 コマンドプロンプト環境でESP-IDFを使う方法でした。
次のページでは、従来のMSYS2環境で使うESP-IDFを紹介します。