メインコンテンツへスキップ
見出し画像

Windows + VS CodeでESP-IDF開発環境を作る|ESP32でHello WorldをBuild / Flashするまで


    ESP32の開発では、Arduino IDEを使うと比較的手軽にプログラムを書き始めることができます。Arduinoを使った経験があれば馴染みやすく、ESP32を試したり、小規模な電子工作を作ったりするには便利な環境です。

    一方で、ESP32にはEspressifが公式に提供している開発フレームワーク「ESP-IDF」があります。Arduino-ESP32も内部ではESP-IDFを利用しているため、ESP-IDF由来のAPIを使える場面もありますが、Arduinoから扱いやすい形に抽象化された開発環境と、ESP-IDFを直接使う環境では、触れるレイヤーが少し違います。

    たとえば、FreeRTOSのTaskやCPU Coreの扱い、ESP-IDFのComponentやBuild Configuration、カメラのクロックやドライバの動作など、ハードウェアやOSに近い部分まで細かく制御したくなると、ESP-IDFを直接使った方が扱いやすい場面が出てきます。

    今回ESP32を使った開発を進める中でも、こうした低いレイヤーまで制御する必要が出てきたため、Arduino中心の開発環境からESP-IDFへ移ることにしました。

    そこでこの記事では、Windows + Visual Studio CodeにESP-IDFの開発環境を構築し、ESP-IDF標準のhello_worldをBuildしてESP32へFlashし、シリアルMonitorからHello world!を確認できるところまで、実際に行った手順をまとめます。

    今回の動作確認用の実機には、Freenove ESP32-S3-WROOM CAM N16R8(16MB Flash / 8MB Octal PSRAM)を使用します。

    ただし、この記事で扱うのはESP-IDFの開発環境構築と基本的なBuild / Flash / Monitorの流れです。カメラ機能そのものは使用せず、ESP-IDF標準のhello_worldを使って確認します。


    1. 今回構築するESP-IDF開発環境

    今回構築するのは、Windows上のVisual Studio CodeからESP-IDFを使ってESP32を開発する環境です。

    使用する構成は以下の通りです。

    • Windows

    • Visual Studio Code

    • Espressif ESP-IDF Extension

    • ESP-IDF v6.1

    • 動作確認用Target:ESP32-S3

    実際に使用するボードは、Freenove ESP32-S3-WROOM CAM N16R8 PCB V1.2です。

    このボードには16MB Flashと8MB Octal PSRAMが搭載されていますが、今回はカメラ機能の開発ではなく、ESP-IDFの基本的な開発環境を構築するための動作確認用ボードとして使用します。

    この記事では、コマンドラインからidf.pyを直接操作する方法を中心には扱いません。

    実際の開発で使用しているVisual Studio CodeとESP-IDF Extensionをベースに、Ctrl + Shift + PでCommand Paletteを開き、Build、Flash、Monitorなどを操作する流れで進めます。

    最終的には、

    Windows
    ↓
    Visual Studio Code
    ↓
    ESP-IDF Extension
    ↓
    ESP-IDF v6.1
    ↓
    ESP32-S3
    ↓
    Build / Flash / Monitor
    

    という環境を作り、ESP32上でhello_worldが動作するところまで確認します。

    この章では、今回使用するESP-IDF開発環境の全体像を確認しました。

    次の章では、Visual Studio CodeへESP-IDF ExtensionとESP-IDF本体をインストールします。


    2. Windows + VS CodeにESP-IDF開発環境を作る

    ここでは、Windows上のVisual Studio CodeにESP-IDFの開発環境を構築します。

    この記事では、Visual Studio Code自体はすでにWindowsへインストールされていることを前提とします。

    Visual Studio CodeにESP-IDF Extensionを追加する

    Visual Studio Codeを起動し、Ctrl + Shift + XでExtensionsを開きます。

    検索欄にESP-IDFと入力し、Espressifが提供しているESP-IDF Extensionをインストールします。

    インストールすると、VS CodeのCommand PaletteからESP-IDF関連の操作を実行できるようになります。

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

    Ctrl + Shift + PでCommand Paletteを開き、

    ESP-IDF: Open ESP-IDF Installation Manager

    を実行します。

    ESP-IDF Installation Managerが起動するので、ここからESP-IDF本体と開発に必要なToolsをインストールします。
    *今回はCustom Installationを選択しました。

    画像
    ESP-IDF インストーラー

    今回使用したバージョンは、ESP-IDF v6.1です。

    ESP-IDFでは本体だけでなく、コンパイラやPython環境、CMake、Ninjaなど複数のツールを組み合わせてBuildを行いますが、Installation Managerを使うことで必要な環境をまとめて構築できます。

    画像
    今回はAllでは無くesp32s3のみを選択しました
    画像
    今回はv6.1を選択しました

    ESP-IDFが正常に使えることを確認する

    インストールが完了したら、Ctrl + Shift + PでCommand Paletteを開き、

    ESP-IDF: Select Current ESP-IDF Version

    を実行します。

    インストールしたESP-IDFが選択肢として表示されれば、Visual Studio CodeのESP-IDF Extensionから開発環境が認識されています。

    必要であれば、

    ESP-IDF: Doctor Command

    を実行すると、ESP-IDF本体やToolsなど、Extensionが認識している開発環境を確認できます。

    ここまでで、Windows + Visual Studio Code上へESP-IDFをインストールし、ExtensionからESP-IDF環境が認識されているところまで確認できました。

    次の章では、ESP-IDF標準のhello_worldプロジェクトを作成し、使用するESP-IDFのバージョン、Target、シリアルポートを設定します。


    3. hello_worldプロジェクトでESP32-S3の開発設定を行う

    ESP-IDFのインストールが完了したら、まずESP-IDFに用意されているhello_worldを使ってプロジェクトを作成します。

    ここではアプリケーションのコードそのものはまだ扱いません。

    ESP-IDFでBuildできる最小構成としてhello_worldを利用し、そのプロジェクトに対してESP-IDFのバージョン、Target、シリアルポートなどの基本設定を行います。

    hello_worldからプロジェクトを作成する

    Ctrl + Shift + PでVisual Studio CodeのCommand Paletteを開き、

    ESP-IDF: New Project

    を選択します。

    Example Projectから、

    get-started
    └─ hello_world
    

    を選択し、

    Create Project Using Template hello_world

    を実行します。

    画像
    ESP-IDF Examples から hello_world を選択

    プロジェクト作成画面では、プロジェクト名と保存先のディレクトリを指定します。

    画面上にはESP-IDF Targetなどの設定項目もありますが、この記事では、今後自分でESP-IDFプロジェクトを作成するときにも使えるように、後ほど別途、ESP-IDFのバージョン、Target、シリアルポートはプロジェクト作成後にVisual Studio CodeのCommand Paletteから明示的に設定していきます。

    プロジェクトを作成したら、作成したhello_worldプロジェクトをVisual Studio Codeで開きます。

    今回Buildするコードには、このExample Projectに含まれているmain/hello_world_main.cをそのまま使用します。

    ここではコードの内容自体には立ち入りません。

    使用するESP-IDFを選択する

    Ctrl + Shift + PでCommand Paletteを開き、

    ESP-IDF: Select Current ESP-IDF Version

    を実行します。

    インストール済みのESP-IDF環境が表示されるので、今回はESP-IDF v6.1を選択します。

    複数のESP-IDFをインストールしている場合でも、ここで現在のプロジェクトで使用するESP-IDFを指定できます。

    TargetをESP32-S3に設定する

    次にCommand Paletteから、

    ESP-IDF: Set Espressif Device Target

    を実行します。

    Targetには、esp32s3を選択します。

    ESP-IDFはESP32、ESP32-S3、ESP32-C3など複数のSoCをサポートしているため、使用するチップに合わせてTargetを設定します。

    今回使用するFreenove ESP32-S3-WROOM CAMにはESP32-S3が搭載されているため、Targetはesp32s3とします。

    使用するシリアルポートを選択する

    Freenove ESP32-S3-WROOM CAMをUSBでWindows PCへ接続します。

    Ctrl + Shift + PでCommand Paletteを開き、

    ESP-IDF: Select Port to Use

    を実行します。

    接続されているシリアルポートの一覧から、ESP32-S3が接続されているCOMポートを選択します。

    Windowsでは、

    COM3
    COM4
    COM5
    ...

    のような形で表示されます。

    どのポートがESP32なのか分からない場合は、USBケーブルを抜き差しして増減するCOMポートを確認すると判別できます。

    ここまでで、

    • ESP-IDF : v6.1

    • Target : esp32s3

    • Port : ESP32-S3を接続したCOMポート

    という基本設定ができました。

    画像
    VS Code の左下に設定値が表示されます

    これで、今回使用するコードをBuildするESP-IDFのバージョン、Buildしたファームウェアを書き込むTargetとなるESP32の種類、そしてファームウェアの書き込みやMonitorで使用するシリアルポートの設定ができました。

    次の章では、実際にhello_worldをBuildし、Targetに設定したESP32-S3へファームウェアを書き込み、Monitorで動作を確認します。


    4. hello_worldをBuild / Flash / Monitorして動作確認する

    前の章で、hello_worldプロジェクトに対して使用するESP-IDFのバージョン、Target、シリアルポートを設定しました。

    ここでは実際にhello_worldをBuildし、ESP32-S3へファームウェアを書き込み、Monitorから動作を確認します。

    hello_worldをBuildする

    Ctrl + Shift + PでVisual Studio CodeのCommand Paletteを開き、

    ESP-IDF: Build your Project

    を実行します。

    Buildが始まるとVisual Studio Code内にTerminalが開き、CMakeやNinjaによるBuildの進行状況が表示されます。

    正常に完了するとBuild成功のメッセージが表示され、プロジェクト内のbuildディレクトリにESP32-S3へ書き込むためのバイナリなどが生成されます。

    画像
    Build 時の Terminal 出力

    この段階では、まだESP32-S3本体への書き込みは行われていません。

    ESP32-S3へFlashする

    ESP32-S3をUSBでWindows PCへ接続していることを確認します。

    前の章でシリアルポートを設定済みなので、Ctrl + Shift + Pから、

    ESP-IDF: Flash your Project

    を実行します。

    Build済みのファームウェアが、設定したシリアルポートを使ってESP32-S3へ書き込まれます。

    Flash中の処理もVisual Studio Code内のTerminalに表示され、正常に完了すれば書き込み完了のメッセージが表示されます。

    画像
    Flash 時の Terminal 出力

    もし書き込み先のポートを変更したい場合は、

    ESP-IDF: Select Port to Use

    から再設定できます。

    Monitorで動作を確認する

    Flashが完了したら、次にESP32-S3から出力されるログを確認します。

    Ctrl + Shift + Pから、

    ESP-IDF: Monitor Device

    を実行します。

    ESP-IDF Monitorが起動し、設定したシリアルポートを通してESP32-S3の起動ログやアプリケーションからの出力が表示されます。

    今回使用しているhello_worldでは、起動ログのあとに、Hello world!の出力が確認できます。

    さらに、ESP32-S3のCPU Core数やFlash、Heapなどの情報も表示されます。

    画像
    Monitor 時の Terminal 出力

    Hello world!が表示され、カウントダウン後にESP32-S3が再起動して同じ処理を繰り返せば、作成したファームウェアが実機上で正常に動作しています。

    Monitorを終了するときは、

    Ctrl + ]
    

    を使用します。

    Build / Flash / Monitorをまとめて実行することもできる

    ESP-IDF Extensionには、

    ESP-IDF: Build, Flash and Start a Monitor on Your Device

    というコマンドも用意されています。

    これは、

    Build → Flash → Monitor

    をまとめて実行するものです。

    一度環境が正常に動作することを確認した後は、このコマンドを使うと一連の作業をまとめて実行できます。

    ただし、最初の動作確認ではBuild、Flash、Monitorを個別に実行しておいた方が、問題が発生した場合にどの段階で失敗しているのか確認しやすくなります。

    その後、一度正常に動作したコードの定数やパラメータを少し調整して書き直すような場合には、BuildからMonitorまでをまとめて実行できるこのコマンドが便利です。

    一方で、Componentの追加やBuild設定の変更など、プロジェクトに大きな変更を加えた場合は、まずBuildだけを個別に実行して正常に完了することを確認してからFlashへ進めた方が、問題の切り分けはしやすくなります。

    ここまでで、

    ESP-IDF v6.1でコードをBuild
    ↓
    ESP32-S3用のファームウェアを生成
    ↓
    設定したシリアルポートから実機へFlash
    ↓
    Monitorで実行結果を確認

    というESP-IDFの基本的な開発フローが一通り動作することを確認できました。

    これで、ESP-IDFそのもののインストールだけではなく、実際にESP32用のコードをBuildし、実機へFlashして動かせる開発環境まで構築できたことになります。

    次の章では、Arduino IDEのツールメニューから設定していたようなFlashやPSRAMなど、使用するESP32ボード固有のハードウェア構成をESP-IDF側で設定します。


    5. 使用するESP32ボードに合わせてFlashを設定する

    前の章までで、ESP-IDF v6.1を使ってhello_worldをBuildし、ESP32-S3へFlashして実行できるところまで確認しました。

    Arduino IDEを使っていたときは、ESP32のFlashサイズやPSRAMなど、使用するボード固有の設定を主にツールメニューから選択していました。

    ESP-IDFでは、こうした同じESP32シリーズの中でもボードごとに異なるハードウェア構成を、Project Configurationとして設定します。

    ここからは、今回動作確認に使用しているFreenove ESP32-S3-WROOM CAM N16R8のハードウェア構成を例に、ESP-IDF側の設定を変更していきます。

    今回使用するボードの主なメモリ構成は、

    Flash : 16MB
    PSRAM : 8MB Octal PSRAM

    です。

    ESP32-S3をTargetに指定しただけでは、搭載されているFlashやPSRAMの構成までは決まりません。

    使用するボードに合わせて、これらをプロジェクト側で設定します。

    SDK Configuration Editorを開く

    Ctrl + Shift + PでVisual Studio CodeのCommand Paletteを開き、

    ESP-IDF: SDK Configuration Editor

    を実行します。

    ESP-IDFのProject Configurationを変更する画面が開きます。

    SDK Configuration Editorは、ESP-IDFのmenuconfigをVisual Studio Code上からGUIで操作するためのものです。

    Flashを16MBに設定する

    SDK Configuration Editorで、

    Serial flasher config

    を開きます。

    今回使用するボードに合わせて、Flash関連を次のように設定します。

    Flash SPI mode  : QIO
    Flash SPI speed : 80 MHz
    Flash size      : 16 MB
    画像
    Serial flasher config 設定


    今回のプロジェクトで使用する設定値では、内部的には次のKconfigに対応します。

    CONFIG_ESPTOOLPY_FLASHSIZE_16MB=y
    CONFIG_ESPTOOLPY_FLASHMODE_QIO=y
    CONFIG_ESPTOOLPY_FLASHFREQ_80M=y

    ESP-IDFではFlash容量だけでなく、Flashの接続モードや動作周波数もProject Configurationとして設定されます。

    そのため、ここは「ESP32-S3だからこの値」というものではなく、実際に使用するボードのハードウェア構成に合わせて設定する必要があります。

    *ESP-IDF v6.1.0の公式hello_worldはMINIMAL_BUILD構成のため、hello_worldで使用していないPSRAM関連の設定はSDK Configuration Editorに表示されません。PSRAMを使用するプロジェクトでは、そのプロジェクトに合わせてPSRAMの設定も行います。

    設定を保存する

    Flashの設定が終わったら、SDK Configuration EditorのSaveを実行して設定を保存します。

    保存された設定はプロジェクトのsdkconfigに反映され、以降のBuildではこのハードウェア構成が使用されます。

    必要な初期値をsdkconfig.defaultsへ残しておけば、Build環境を作り直した場合にも同じ基本設定を再現しやすくなります。

    例えば今回のFlash設定であれば、

    CONFIG_ESPTOOLPY_FLASHSIZE_16MB=y
    CONFIG_ESPTOOLPY_FLASHFREQ_80M=y
    CONFIG_ESPTOOLPY_FLASHMODE_QIO=y

    といった設定になります。

    ここまでで、Arduino IDEではツールメニューから設定していたような、使用するボード固有のFlashの構成をESP-IDF側でも設定できました。

    今回の実機では、

    ESP32-S3
    + 16MB Flash

    というFreenove ESP32-S3-WROOM CAM N16R8のハードウェア構成をProject Configurationへ反映しています。


    まとめ

    今回は、Windows + Visual Studio CodeへESP-IDFの開発環境を構築し、ESP-IDF標準のhello_worldを使ってESP32で最初のBuild / Flash / Monitorを行いました。

    今回行った作業をまとめると、

    Visual Studio CodeへESP-IDF Extensionを追加
    ↓
    ESP-IDF v6.1をインストール
    ↓
    hello_worldプロジェクトを作成
    ↓
    ESP-IDF Versionを選択
    ↓
    ESP32のTargetを設定
    ↓
    シリアルポートを設定
    ↓
    Build
    ↓
    Flash
    ↓
    MonitorでHello world!を確認
    ↓
    使用するボードに合わせてFlashを設定
    

    という流れになります。

    Arduino IDEでは、BoardやFlash、PSRAMなどをツールメニューからまとめて設定していました。

    ESP-IDFではそれらを、

    • ESP-IDF Version

    • Target SoC

    • Serial Port

    • SDK Configuration

    といった項目として個別に設定していくため、最初は設定項目が増えたように感じます。

    一方で、使用するESP32やComponent、Build Configurationをプロジェクト単位で明示的に管理できるため、ハードウェアやOSに近い部分まで扱いたい場合には、こちらの方が構成を把握しやすくなります。

    これで、Windows + Visual Studio Code上でESP-IDFを使い、ESP32用のコードをBuildして実機へFlashし、Monitorから動作を確認するための基本環境ができました。

    ESP-IDFを使うことで、Arduino IDEでも利用できるESP32の機能を、よりESP-IDF本来の構成に近い形で扱えるようになります。FreeRTOSのTaskやCPU Core、Component、Build Configuration、各Peripheralの設定など、Arduino IDEでは抽象化されていた部分もプロジェクト側から明示的に管理しやすくなります。

    設定項目が増えるぶん最初は少し複雑になりますが、使用するハードウェアやライブラリ、動作条件を細かく把握しながら開発できるのは大きなメリットです。ESP32を「Arduino互換のマイコン」として使うところから一歩進んで、ESP32そのものの機能をより細かく制御した開発を行うための環境が、これで整いました。

     
     

    Criet

     
     
    このnoteは、作ったものの記録や備忘録のようなメモ置き場です。 主に3DCGや3Dプリント、電子工作、AI関連に興味があり、記事もそういったテーマが中心になると思います。 みなさま、よろしくお願いします。

    あなたへのおすすめ