Espressif ESP32-DevKitC と ESP-WROVER-KIT の開始方法 - FreeRTOS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Espressif ESP32-DevKitC と ESP-WROVER-KIT の開始方法

重要

これは、FreeRTOS リリース 202012.00 で使用する FreeRTOS ユーザーガイドのアーカイブ版です。このドキュメントの最新バージョンについては、FreeRTOS ユーザーガイドを参照してください。

このチュートリアルでは、ESP32-WROOM-32、ESP32-SOLO-1、または ESP-WROVER モジュールおよび ESP-WROVER-KIT-VB を搭載した Espressif ESP32-DevKitC の使用を開始するための手順について説明します。Partner AWS Device カタログでパートナーから購入するには、次のリンクを使用します。

開発ボードのこれらのバージョンが FreeRTOS でサポートされています。

これらのボードの最新バージョンの詳細については、Espressif ウェブサイトの「ESP32-DevKitC V4」または「ESP-WROVER-KIT v4.1」を参照してください。

注記

現在、ESP32-WROVER-KIT および ESP DevKitC の FreeRTOS ポートは、対称型マルチプロセッシング (SMP) 機能をサポートしていません。

概要

このチュートリアルでは次のステップを説明します。

  1. ボードをホストマシンに接続します。

  2. マイクロコントローラーボード用の組み込みアプリケーションを開発およびデバッグするためのソフトウェアをホストマシンにインストールします。

  3. FreeRTOS デモアプリケーションをバイナリイメージにクロスコンパイルします

  4. アプリケーションバイナリイメージをボードにロードし、アプリケーションを実行します

  5. モニタリングおよびデバッグの目的で、シリアル接続経由でボード上で実行されているアプリケーションに接続します

前提条件

Espressif ボードで FreeRTOS の使用を開始する前に、 AWS アカウントとアクセス許可を設定する必要があります。

にサインアップする AWS アカウント

がない場合は AWS アカウント、次の手順を実行して作成します。

にサインアップするには AWS アカウント
  1. https://portal.aws.amazon.com/billing/signup を開きます。

  2. オンラインの手順に従います。

    サインアップ手順の一部では、電話またはテキストメッセージを受信し、電話のキーパッドに検証コードを入力します。

    にサインアップすると AWS アカウント、 AWS アカウントのルートユーザー が作成されます。ルートユーザーには、アカウントのすべての AWS のサービス とリソースへのアクセス権があります。セキュリティベストプラクティスとして、ユーザーに管理アクセス権を割り当て、ルートユーザーアクセスが必要なタスクの実行にはルートユーザーのみを使用するようにしてください。

AWS サインアッププロセスが完了すると、 から確認メールが送信されます。https://aws.amazon.com/[マイアカウント] をクリックして、いつでもアカウントの現在のアクティビティを表示し、アカウントを管理することができます。

管理アクセスを持つユーザーを作成する

にサインアップしたら AWS アカウント、日常的なタスクにルートユーザーを使用しないように AWS アカウントのルートユーザー、 を保護し AWS IAM Identity Center、 を有効にして管理ユーザーを作成します。

を保護する AWS アカウントのルートユーザー
  1. ルートユーザーを選択し、 AWS アカウント E メールアドレスを入力して、アカウント所有者AWS Management Consoleとして にサインインします。次のページでパスワードを入力します。

    ルートユーザーを使用してサインインする方法については、AWS サインイン ユーザーガイドルートユーザーとしてサインインするを参照してください。

  2. ルートユーザーの多要素認証 (MFA) を有効にします。

    手順については、IAM ユーザーガイドの AWS アカウント 「ルートユーザー (コンソール) の仮想 MFA デバイスを有効にする」を参照してください。

管理アクセスを持つユーザーを作成する
  1. IAM アイデンティティセンターを有効にします。

    手順については、「AWS IAM Identity Center ユーザーガイド」の「AWS IAM Identity Centerの有効化」を参照してください。

  2. IAM アイデンティティセンターで、ユーザーに管理アクセスを付与します。

    を ID ソース IAM アイデンティティセンターディレクトリ として使用する方法のチュートリアルについては、AWS IAM Identity Center 「 ユーザーガイド」の「デフォルトを使用してユーザーアクセスを設定する IAM アイデンティティセンターディレクトリ」を参照してください。

管理アクセス権を持つユーザーとしてサインインする
  • IAM アイデンティティセンターのユーザーとしてサインインするには、IAM アイデンティティセンターのユーザーの作成時に E メールアドレスに送信されたサインイン URL を使用します。

    IAM Identity Center ユーザーを使用してサインインする方法については、AWS サインイン 「 ユーザーガイド」の AWS 「 アクセスポータルにサインインする」を参照してください。

追加のユーザーにアクセス権を割り当てる
  1. IAM アイデンティティセンターで、最小特権のアクセス許可を適用するというベストプラクティスに従ったアクセス許可セットを作成します。

    手順については、「AWS IAM Identity Center ユーザーガイド」の「権限設定を作成するを参照してください

  2. グループにユーザーを割り当て、そのグループにシングルサインオンアクセス権を割り当てます。

    手順については、「AWS IAM Identity Center ユーザーガイド」の「グループの結合」を参照してください。

アクセス権限を付与するにはユーザー、グループ、またはロールにアクセス許可を追加します。

注記

FreeRTOS 202012.00 リリースでは ESP-IDF v3.3 がサポートされています。FreeRTOS の新しいバージョンを使用している場合は、ESP-IDF v4.2 の開始方法 の IDFv4.2 固有の指示に従ってください。

ESP-IDF v3.3 の開始方法

このセクションでは、Espressif ハードウェアで ESP-IDF v3.3 を使用する方法について説明します。ESP-IDF v4.2 を使用するには、「ESP-IDF v4.2 の開始方法」を参照してください。

Espressif ハードウェアを設定する

ESP32-DevKitC 開発ボードハードウェアの設定の詳細については、ESP32-DevKitC V4 入門ガイドを参照してください。

ESP-WROVER-KIT 開発ボードハードウェアの設定の詳細については、ESP-WROVER-KIT V4.1 入門ガイドを参照してください。

重要

Espressif ガイドの開始方法セクションに到達したらそこで止まり、以下の手順に従います。

開発環境をセットアップする

ボードと通信するには、ツールチェーンをダウンロードしてインストールする必要があります。

ツールチェーンの設定

注記

ESP-IDF v3.3 では、ESP32 コンパイラの最新バージョンがサポートされていません。ESP32 コンパイラの最新バージョンを既にインストールしている場合は、それをアンインストールし、ツールチェーンのインストールに含まれる互換性のあるバージョンのコンパイラを使用する必要があります。このセクションにあるリンクを参照してください。コンパイラのバージョンを確認するには、次のコマンドを実行します。

xtensa-esp32-elf-gcc --version

ツールチェーンを設定するには、ホストマシンのオペレーティングシステムの指示に従ってください。

重要

次のステップの下にある「ESP-IDF の取得」の手順に到達したらそこで止まり、このページの手順に戻ります。

現在または前回の手順で次のステップの「ESP-IDF の取得」の手順に従った場合、システムの IDF_PATH 環境変数を続行する前にクリアする必要があります。この環境変数は、「ESP-IDF の取得」の手順に従った場合に自動的に設定されます。

CMake のインストール

CMake ビルドシステムは、このデバイスの FreeRTOS デモとテストアプリケーションを構築するために必要です。FreeRTOS は、バージョン 3.13 以降をサポートしています。

CMake.org から CMake の最新バージョンをダウンロードできます。ソースとバイナリ配布のいずれも利用可能です。

FreeRTOS で CMake を使用する方法について詳しくは、「FreeRTOS で CMake を使用する」を参照してください。

シリアル接続の確立

ホストマシンと ESP32-DevKitC の間にシリアル接続を確立するには、CP210x USB を UART Bridge VCP ドライバーにインストールする必要があります。これらのドライバーは Silicon Labs からダウンロードできます。

ホストマシンと ESP32-WROVER-KIT の間にシリアル接続を確立するには、一部の FTDI 仮想 COM ポートドライバーをインストールする必要があります。これらのドライバーは FTDI からダウンロードできます。

詳細については、「ESP32 とのシリアル接続を確立する」を参照してください。シリアル接続を確立したら、ボードとの接続用のシリアルポートをメモしておきます。デモを構築する際に必要になります。

FreeRTOS をダウンロードして設定する

環境をセットアップした後、GitHub から FreeRTOS をダウンロードできます。手順については、GitHub ウェブサイトの README.md ファイルを参照してください。

FreeRTOS デモアプリケーションを設定する

  1. macOS または Linux を実行している場合、ターミナルプロンプトを開きます。Windows を実行している場合は、mingw32.exe を開きます。MinGW は、ネイティブ Microsoft Windows アプリケーション用の最小限の開発環境です。

  2. Python 2.7.10 以降がインストールされていることを確認するには、以下を実行します。

    python --version

    インストールされているバージョンが表示されます。Python 2.7.10 以降がインストールされていない場合は、Python ウェブサイトからインストールできます。

  3. AWS IoT コマンドを実行するには AWS Command Line Interface 、(AWS CLI) が必要です。Windows を実行している場合は、 easy_install awscli を使用して mingw32 環境に をインストール AWS CLI します。

    macOS または Linux を実行している場合は、AWS CLIのインストールを参照してください。

  4. アクセスキー IDaws configure、シークレット AWS アクセスキー、 AWS リージョン AWS CLI を使用して を実行して設定します。詳細については、「Configuring the AWS CLI」を参照してください。

  5. 次のコマンドを使用して AWS SDK for Python (boto3) をインストールします。

    • Windows の場合、mingw32 環境で以下を実行します。

      easy_install boto3
    • macOS または Linux の場合、以下を実行します。

      pip install tornado nose --user

      続いて以下を実行します。

      pip install boto3 --user

FreeRTOS には、 AWS IoTに接続するための Espressif ボードのセットアップを容易にする SetupAWS.py スクリプトが含まれています。このスクリプトを設定するには、freertos/tools/aws_config_quick_start/configure.json を開いて以下の属性を設定します。

afr_source_dir

コンピュータの freertos ディレクトリへの完全なパス。このパスの指定にスラッシュを使用していることを確認します。

thing_name

ボードを表す AWS IoT モノに割り当てる名前。

wifi_ssid

Wi-Fi ネットワークの SSID。

wifi_password

Wi-Fi ネットワークのパスワード。

wifi_security

Wi-Fi ネットワークのセキュリティタイプ。

次のセキュリティタイプが有効です。

  • eWiFiSecurityOpen (オープン、セキュリティなし)

  • eWiFiSecurityWEP (WEP セキュリティ)

  • eWiFiSecurityWPA (WPA セキュリティ)

  • eWiFiSecurityWPA2 (WPA2 セキュリティ)

設定スクリプトを実行するには
  1. macOS または Linux を実行している場合、ターミナルプロンプトを開きます。Windows を実行している場合は、mingw32.exe を開きます。

  2. freertos/tools/aws_config_quick_start ディレクトリに移動して、以下を実行します。

    python SetupAWS.py setup

スクリプトは、次を実行します。

  • IoT のモノ、証明書およびポリシーを作成します。

  • 証明書に IoT ポリシーを、 AWS IoT のモノに証明書をアタッチします。

  • AWS IoT ファイルにエンドポイント、Wi-Fi SSID、認証情報を入力しますaws_clientcredential.h

  • 証明書とプライベートキーをフォーマットして aws_clientcredential_keys.h ヘッダーファイルに書き込みます。

    注記

    証明書はデモ目的でのみハードコードされています。本番稼動レベルのアプリケーションでは、これらのファイルを安全な場所に保存する必要があります。

SetupAWS.py の詳細については、freertos/tools/aws_config_quick_start ディレクトリにある「README.md」を参照してください。

FreeRTOS デモプロジェクトを構築、フラッシュ、実行する

CMake を使用してビルドファイルを生成し、Make を使用してアプリケーションバイナリをビルドし、Espressif の IDF ユーティリティを使用してボードをフラッシュできます。

Linux と macOS で FreeRTOS を構築する (ESP-IDF v3.3)

Windows を使用している場合は、「Windows で FreeRTOS を構築する (ESP-IDF v3.3)」を参照してください。

CMake を使用してビルドファイルを生成してから、Make を使用してアプリケーションをビルドします。

CMake を使用してデモアプリケーションのビルドファイルを生成するには
  1. ディレクトリを FreeRTOS ダウンロードディレクトリのルートに変更します。

  2. ビルドファイルを生成するには、次のコマンドを使用します。

    cmake -DVENDOR=espressif -DBOARD=esp32_wrover_kit -DCOMPILER=xtensa-esp32 -S . -B your-build-directory
    注記

    デバッグ用にアプリケーションをビルドする場合は、このコマンドに -DCMAKE_BUILD_TYPE=Debug フラグを追加します。

    テストアプリケーションのビルドファイルを生成する場合は、-DAFR_ENABLE_TESTS=1 フラグを追加します。

    Espressif が提供するコードは、ライトウェイト IP (lwIP) スタックをデフォルトのネットワークスタックとして使用します。代わりに FreeRTOS+TCP ネットワークスタックを使用するには、CMake コマンドに –DAFR_ESP_FREERTOS_TCP フラグを追加します。

    ベンダー以外が提供するコードの lwIP 依存関係を追加するには、カスタム Wi-Fi コンポーネントの CMake 依存関係ファイル CMakeLists.txt に次の行を追加します。

    # Add a dependency on the bluetooth espressif component to the common component set(COMPONENT_REQUIRES lwip)
Make を使用してアプリケーションをビルドするには
  1. ディレクトリを build ディレクトリに変更します。

  2. Make を使用してアプリケーションを構築するには、次のコマンドを使用します。

    make all -j4
    注記

    aws_demos プロジェクトと aws_tests プロジェクトを切り替えるたびに、cmake コマンドでビルドファイルを生成する必要があります。

Windows で FreeRTOS を構築する (ESP-IDF v3.3)

Windowsでは、CMake 用のビルドジェネレーターを指定する必要があります。それ以外の場合、CMake はデフォルトで Visual Studio に設定されます。Ninja ビルドシステムは Windows、Linux、および MacOS で機能するため、Expressif では Ninja ビルドシステムが公式に推奨されます。CMake コマンドは、cmd あるいは PowerShell などのネイティブの Windows 環境で実行する必要があります。MSYS2 や WSL などの仮想 Linux 環境で CMake コマンドを実行することはサポートされていません。

CMake を使用してビルドファイルを生成してから、Make を使用してアプリケーションをビルドします。

CMake を使用してデモアプリケーションのビルドファイルを生成するには
  1. ディレクトリを FreeRTOS ダウンロードディレクトリのルートに変更します。

  2. ビルドファイルを生成するには、次のコマンドを使用します。

    cmake -DVENDOR=espressif -DBOARD=esp32_wrover_kit -DCOMPILER=xtensa-esp32 -GNinja -S . -B build-directory
    注記

    デバッグ用にアプリケーションをビルドする場合は、このコマンドに -DCMAKE_BUILD_TYPE=Debug フラグを追加します。

    テストアプリケーションのビルドファイルを生成する場合は、-DAFR_ENABLE_TESTS=1 フラグを追加します。

    Espressif が提供するコードは、ライトウェイト IP (lwIP) スタックをデフォルトのネットワークスタックとして使用します。代わりに FreeRTOS+TCP ネットワークスタックを使用するには、CMake コマンドに –DAFR_ESP_FREERTOS_TCP フラグを追加します。

    ベンダー以外が提供するコードの lwIP 依存関係を追加するには、カスタム Wi-Fi コンポーネントの CMake 依存関係ファイル CMakeLists.txt に次の行を追加します。

    # Add a dependency on the bluetooth espressif component to the common component set(COMPONENT_REQUIRES lwip)
アプリケーションを構築するには
  1. ディレクトリを build ディレクトリに変更します。

  2. Ninja を呼び出してアプリケーションを構築します。

    ninja

    または、一般的な CMake インターフェイスを使用してアプリケーションをビルドします。

    cmake --build build-directory
    注記

    aws_demos プロジェクトと aws_tests プロジェクトを切り替えるたびに、cmake コマンドでビルドファイルを生成する必要があります。

FreeRTOS をフラッシュして実行する (ESP-IDF v3.3)

このセクションでは、Espressif ハードウェアで ESP-IDF v3.3 を使用する方法について説明します。ESP-IDF v4.2 を使用するには、「ESP-IDF v4.2 の開始方法」を参照してください。

Espressif の IDF ユーティリティ (freertos/vendors/espressif/esp-idf/tools/idf.py) を使用してボードをフラッシュし、アプリケーションを実行してログを表示します。

ボードのフラッシュを消去するには、freertos ディレクトリに移動し、次のコマンドを使用します。

./vendors/espressif/esp-idf/tools/idf.py erase_flash -B build-directory

アプリケーションバイナリをボードにフラッシュするには、make を使用します。

make flash

また、次のように IDF スクリプトを使用してボードをフラッシュすることもできます。

./vendors/espressif/esp-idf/tools/idf.py flash -B build-directory

モニタリングするには、次のコマンドを使用します。

./vendors/espressif/esp-idf/tools/idf.py monitor -p /dev/ttyUSB1 -B build-directory
注記

これらのコマンドを組み合わせることができます。例:

./vendors/espressif/esp-idf/tools/idf.py erase_flash flash monitor -p /dev/ttyUSB1 -B build-directory

ESP-IDF v4.2 の開始方法

このセクションでは、Espressif ハードウェアで ESP-IDF v4.2 を使用する方法について説明します。ESP-IDF v3.3 を使用するには、「ESP-IDF v3.3 の開始方法」を参照してください。

注記

このチュートリアルの Linux コマンドでは、Bash シェルを使用する必要があります。

Espressif ハードウェアを設定する

ESP32-DevKitC 開発ボードハードウェアの設定の詳細については、ESP32-DevKitC V4 入門ガイドを参照してください。

ESP-WROVER-KIT 開発ボードハードウェアの設定の詳細については、ESP-WROVER-KIT V4.1 入門ガイドを参照してください。

重要

Espressif ガイドの開始方法セクションに到達したらそこで止まり、このページの手順に戻ります。

開発環境をセットアップする

ボードと通信するには、ツールチェーンをダウンロードしてインストールする必要があります。

ツールチェーンの設定

ツールチェーンを設定するには、ホストマシンのオペレーティングシステムの指示に従ってください。

重要

次のステップの下にある「ESP-IDF の取得」の手順に到達したらそこで止まり、このページの手順に戻ります。

インストールを完了する (Linux/macOS)

ESP-IDF Windows インストーラは、必要なすべてのツールをインストールします。Linux および macOS プラットフォームでは、インストールを完了するために追加のステップが必要です。

  1. コマンドラインウィンドウを開く

  2. FreeRTOS ダウンロードディレクトリに移動し、次のスクリプトを実行して、お使いのプラットフォーム用の espressif ツールチェーンをダウンロードしてインストールします。

    vendors/espressif/esp-idf/install.sh
  3. 次のコマンドを使用して、ESP-IDF ツールチェーンツールをターミナルのパスに追加します。

    source vendors/espressif/esp-idf/export.sh

シリアル接続の確立

ホストマシンと ESP32-DevKitC の間にシリアル接続を確立するには、CP210x USB を UART Bridge VCP ドライバーにインストールする必要があります。これらのドライバーは Silicon Labs からダウンロードできます。

ホストマシンと ESP32-WROVER-KIT の間にシリアル接続を確立するには、FTDI 仮想 COM ポートドライバーをインストールする必要があります。このドライバーは FTDI からダウンロードできます。

詳細については、「ESP32 とのシリアル接続を確立する」を参照してください。シリアル接続を確立したら、ボードとの接続用のシリアルポートをメモしておきます。デモを構築する際に必要になります。

FreeRTOS をダウンロードして設定する

環境をセットアップすると、GitHub から FreeRTOS をダウンロードできます。手順については、GitHub ウェブサイトの README.md ファイルを参照してください。

FreeRTOS デモアプリケーションを設定する

  1. macOS または Linux を実行している場合、ターミナルプロンプトを開きます。Windows を実行している場合は、mingw32.exe を開きます。(MinGW は、ネイティブ Microsoft Windows アプリケーション用の最小限の開発環境です。)

  2. Python3 がインストールされていることを確認するには、以下を実行します。

    python --version

    インストールされているバージョンが表示されます。Python 3.0.1 以降がインストールされていない場合は、Python ウェブサイトからインストールできます。

  3. AWS IoT コマンドを実行するには AWS Command Line Interface 、(AWS CLI) が必要です。Windows を実行している場合は、 easy_install awscli を使用して mingw32 環境に をインストール AWS CLI します。

    macOS または Linux を実行している場合は、AWS CLIのインストールを参照してください。

  4. 実行

    aws configure

    AWS アクセスキー ID、シークレットアクセスキー、デフォルト AWS リージョン AWS CLI を使用して を設定します。詳細については、「Configuring the AWS CLI」を参照してください。

  5. 次のコマンドを使用して AWS SDK for Python (boto3) をインストールします。

    • Windows の場合、mingw32 環境で以下を実行します。

      easy_install boto3
    • macOS または Linux の場合、以下を実行します。

      pip install tornado nose --user

      続いて以下を実行します。

      pip install boto3 --user

FreeRTOS には、 AWS IoTに接続するための Espressif ボードのセットアップを容易にする SetupAWS.py スクリプトが含まれています。このスクリプトを設定するには、freertos/tools/aws_config_quick_start/configure.json を開いて以下の属性を設定します。

afr_source_dir

コンピュータの freertos ディレクトリへの完全なパス。このパスの指定にスラッシュを使用していることを確認します。

thing_name

ボードを表す AWS IoT モノに割り当てる名前。

wifi_ssid

Wi-Fi ネットワークの SSID。

wifi_password

Wi-Fi ネットワークのパスワード。

wifi_security

Wi-Fi ネットワークのセキュリティタイプ。

次のセキュリティタイプが有効です。

  • eWiFiSecurityOpen (オープン、セキュリティなし)

  • eWiFiSecurityWEP (WEP セキュリティ)

  • eWiFiSecurityWPA (WPA セキュリティ)

  • eWiFiSecurityWPA2 (WPA2 セキュリティ)

設定スクリプトを実行するには
  1. macOS または Linux を実行している場合、ターミナルプロンプトを開きます。Windows を実行している場合は、mingw32.exe ファイルを開きます。

  2. freertos/tools/aws_config_quick_start ディレクトリに移動して、以下を実行します。

    python SetupAWS.py setup

スクリプトは、次を実行します。

  • IoT のモノ、証明書およびポリシーを作成します。

  • 証明書に IoT ポリシーを、 AWS IoT のモノに証明書をアタッチします。

  • AWS IoT ファイルにエンドポイント、Wi-Fi SSID、認証情報を入力しますaws_clientcredential.h

  • 証明書とプライベートキーをフォーマットして aws_clientcredential_keys.h ヘッダーファイルに書き込みます。

    注記

    証明書はデモ目的でのみハードコードされています。本番稼動レベルのアプリケーションでは、これらのファイルを安全な場所に保存する必要があります。

SetupAWS.py の詳細については、freertos/tools/aws_config_quick_start ディレクトリにある「README.md」を参照してください。

idf.py スクリプトを使用して FreeRTOS デモプロジェクトを構築、フラッシュ、実行する

Espressif の IDF ユーティリティを使用してビルドファイルを生成し、アプリケーションバイナリを構築し、ボードをフラッシュできます。

Windows、Linux、MacOS で FreeRTOS を構築してフラッシュする (ESP-IDF v4.2)

idf.py スクリプトを使用して、プロジェクトを構築し、デバイスにバイナリをフラッシュします。

注記

一部のセットアップでは、次の例のように、idf.py でポートオプション "-p port-name" を使用して正しいポートを指定する必要があります。

idf.py -p /dev/cu.usbserial-00101301B flash
プロジェクトを構築してフラッシュするには
  1. FreeRTOS ダウンロードディレクトリのルートに移動します。

  2. コマンドラインウィンドウで、次のコマンドを入力し、ESP-IDF ツールをターミナルのパスに追加します。

    Windows

    vendors\espressif\esp-idf\export.bat

    Linux/macOS

    source vendors/espressif/esp-idf/export.sh
  3. 次のコマンドを使用して build ディレクトリで cmake を設定し、ファームウェアイメージを構築します。

    idf.py -DVENDOR=espressif -DBOARD=esp32_wrover_kit -DCOMPILER=xtensa-esp32 build

    次のような出力が表示されます。

    Running cmake in directory /path/to/hello_world/build Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"... Warn about uninitialized values. -- Found Git: /usr/bin/git (found version "2.17.0") -- Building empty aws_iot component due to configuration -- Component names: ... -- Component paths: ... ... (more lines of build system output) [527/527] Generating hello-world.bin esptool.py v2.3.1 Project build complete. To flash, run this command: ../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin or run 'idf.py -p PORT flash'

    エラーが起きなければ、構築によってファームウェアバイナリの .bin ファイルが生成されます。

  4. 次のコマンドを使用して、開発ボードのフラッシュメモリを消去します。

    idf.py erase_flash
  5. idf.py スクリプトを使用して、アプリケーションバイナリをボードにフラッシュします。

    idf.py flash
  6. 次のコマンドを使用して、ボードのシリアルポートからの出力をモニタリングします。

    idf.py monitor
注記

以下の例のように、これらのコマンドを組み合わせることができます。

idf.py erase_flash flash monitor
注記

特定のホストマシンのセットアップでは、次の例のように、ボードをフラッシュするときにポートを指定する必要があります。

idf.py erase_flash flash monitor -p /dev/ttyUSB1

CMake で FreeRTOS を構築してフラッシュする

コードを構築して実行するために IDF SDK によって提供される idf.py スクリプトに加えて、CMake を使用してプロジェクトを構築することもできます。現在、Unix Makefiles または Ninja ビルドシステムのいずれかがサポートされています。

プロジェクトを構築してフラッシュするには
  1. コマンドラインウィンドウで、FreeRTOS ダウンロードディレクトリのルートに移動します。

  2. 次のスクリプトを実行して、ESP-IDF ツールをシェルのパスに追加します。

    Windows

    vendors\espressif\esp-idf\export.bat

    Linux/macOS

    source vendors/espressif/esp-idf/export.sh
  3. 次のコマンドを入力して、ビルドファイルを生成します。

    Unix Makefiles を使用

    cmake -DVENDOR=espressif -DBOARD=esp32_wrover_kit -DCOMPILER=xtensa-esp32 -S . -B ./YOUR_BUILD_DIRECTORY -DAFR_ENABLE_ALL_MODULES=1 -DAFR_ENABLE_TESTS=0

    Ninja を使用

    cmake -DVENDOR=espressif -DBOARD=esp32_wrover_kit -DCOMPILER=xtensa-esp32 -S . -B ./YOUR_BUILD_DIRECTORY -DAFR_ENABLE_ALL_MODULES=1 -DAFR_ENABLE_TESTS=0 -GNinja
  4. フラッシュを消去してから、ボードをフラッシュします。

    Unix Makefiles を使用

    make -C ./YOUR_BUILD_DIRECTORY erase_flash
    make -C ./YOUR_BUILD_DIRECTORY flash

    Ninja を使用

    ninja -C ./YOUR_BUILD_DIRECTORY erase_flash
    ninja -C ./YOUR_BUILD_DIRECTORY flash

クラウドの MQTT メッセージのモニタリング

AWS IoT コンソールで MQTT クライアントを使用して、デバイスが AWS クラウドに送信するメッセージをモニタリングできます。

MQTT クライアントで AWS IoT MQTT トピックをサブスクライブするには
  1. AWS IoT コンソールに移動します。

  2. ナビゲーションペインで、[Test] (テスト) を選択して MQTT クライアントを開きます。

  3. [Subscription topic] (トピックのサブスクリプション) で your-thing-name/example/topic と入力し、[Subscribe to topic] (トピックへのサブスクライブ) を選択します。

Bluetooth Low Energy デモを実行する

FreeRTOS は、Bluetooth Low Energy 接続をサポートしています。

Bluetooth Low Energy で FreeRTOS デモプロジェクトを実行するには、iOS または Android のモバイルデバイスで FreeRTOS Bluetooth Low Energy Mobile SDK デモアプリケーションを実行する必要があります。

FreeRTOS Bluetooth Low Energy Mobile SDK デモアプリケーションをセットアップするには
  1. モバイルプラットフォーム用の SDK をホストコンピュータにダウンロードしてインストールするには、FreeRTOS Bluetooth デバイス用の Mobile SDK の手順に従います。

  2. モバイルデバイスでデモモバイルアプリケーションを設定するには、FreeRTOS Bluetooth Low Energy Mobile SDK デモアプリケーションの手順に従います。

ボードで MQTT over Bluetooth Low Energy デモを実行する方法については、「MQTT over Bluetooth Low Energy デモアプリケーション」を参照してください。

ボードで Wi-Fi プロビジョニングデモを実行する方法については、「Wi-Fi プロビジョニングデモアプリケーション」を参照してください。

ESP32 用の独自の CMake プロジェクトで FreeRTOS を使用する

独自の CMake プロジェクトで FreeRTOS を使用したい場合は、それをサブディレクトリとして設定し、アプリケーションと一緒に構築することができます。まず、GitHub から FreeRTOS のコピーを取得します。それを、次のコマンドを使用して Git サブモジュールとして設定することもできます。これにより、将来の更新が容易になります。

git submodule add -b release https://github.com/aws/amazon-freertos.git freertos

新しいバージョンがリリースされた場合、これらのコマンドを使用してローカルコピーを更新できます。

# Pull the latest changes from the remote tracking branch. git submodule update --remote -- freertos
# Commit the submodule change because it is pointing to a different revision now. git add freertos
git commit -m "Update FreeRTOS to a new release"

プロジェクトのディレクトリ構造が次のものであると仮定します。

- freertos (the copy that you obtained from GitHub or the AWS IoT console) - src - main.c (your application code) - CMakeLists.txt

以下に、FreeRTOS を使用してアプリケーションを構築するために使用できる最上位 CMakeLists.txt ファイルの例を示します。

ESP-IDF v3.3
cmake_minimum_required(VERSION 3.13) project(freertos_examples) add_executable(my_app src/main.c) # Tell IDF build to link against this target. set(IDF_PROJECT_EXECUTABLE my_app) # Add FreeRTOS as a subdirectory. AFR_BOARD tells which board to target. set(AFR_BOARD espressif.esp32_devkitc CACHE INTERNAL "") add_subdirectory(freertos) # Link against the mqtt library so that we can use it. Dependencies are transitively # linked. target_link_libraries(my_app PRIVATE AFR::mqtt)
ESP-IDF v4.2
cmake_minimum_required(VERSION 3.13) project(freertos_examples) # Pull in ESP-IDF defined CMake build infrastructure logic to configure the project, discover all the components, etc set(esp_idf_dir "${CMAKE_CURRENT_LIST_DIR}/freertos/vendors/espressif/esp-idf") include(${esp_idf_dir}/tools/cmake/idf.cmake) # Tell IDF build to link against this target. set(IDF_PROJECT_EXECUTABLE my_app) get_filename_component( IDF_EXECUTABLE_SRCS "src/main.c" ABSOLUTE )

プロジェクトをビルドするには、次の CMake コマンドを実行します。ESP32 コンパイラが PATH 環境変数にあることを確認してください。

cmake -S . -B build-directory -DCMAKE_TOOLCHAIN_FILE=freertos/tools/cmake/toolchains/xtensa-esp32.cmake -GNinja
cmake --build build

アプリケーションをボードにフラッシュするには、次のコマンドを実行します。

cmake --build build-directory --target flash

FreeRTOS のコンポーネントを使用する

CMake を実行した後、サマリー出力で使用可能なすべてのコンポーネントを見つけることができます。次の例のようになります。

====================Configuration for FreeRTOS==================== Version: 201910.00 Git version: 201910.00-388-gcb3612cb7 Target microcontroller: vendor: Espressif board: ESP32-DevKitC description: Development board produced by Espressif that comes in two variants either with ESP-WROOM-32 or ESP32-WROVER module family: ESP32 data ram size: 520KB program memory size: 4MB Host platform: OS: Linux-4.15.0-66-generic Toolchain: xtensa-esp32 Toolchain path: /opt/xtensa-esp32-elf CMake generator: Ninja FreeRTOS modules: Modules to build: ble, ble_hal, ble_wifi_provisioning, common, crypto, defender, dev_mode_key_provisioning, freertos_plus_tcp, greengrass, https, kernel, mqtt, ota, pkcs11, pkcs11_implementation, platform, secure_sockets, serializer, shadow, tls, wifi Enabled by user: ble, ble_hal, ble_wifi_provisioning, defender, greengrass, https, mqtt, ota, pkcs11, pkcs11_implementation, platform, secure_sockets, shadow, wifi Enabled by dependency: common, crypto, demo_base, dev_mode_key_provisioning, freertos, freertos_plus_tcp, kernel, pkcs11_mbedtls, secure_sockets_freertos_plus_tcp, serializer, tls, utils 3rdparty dependencies: http_parser, jsmn, mbedtls, pkcs11, tinycbor Available demos: demo_ble, demo_ble_numeric_comparison, demo_defender, demo_greengrass_connectivity, demo_https, demo_mqtt, demo_ota, demo_shadow, demo_tcp, demo_wifi_provisioning Available tests: =========================================================================

Modules to build リストから任意のコンポーネントを参照できます。それらをアプリケーションにリンクするには、名前の前に AFR:: 名前空間を置きます。例えば AFR::mqttAFR::ota などです。

ESP-IDF へのカスタムコンポーネントの追加

ESP-IDF ビルド環境にさらにコンポーネントを追加できます。例えば、example_component というコンポーネントを追加し、プロジェクトは次のようになります。

- freertos - components - example_component - include - example_component.h - src - example_component.c - CMakeLists.txt - src - main.c - CMakeLists.txt

以下は、コンポーネントの CMakeLists.txt ファイルの例です。

ESP-IDF v3.3
# include paths of this components. set(COMPONENT_ADD_INCLUDEDIRS include) # source files of this components. set(COMPONENT_SRCDIRS src) # Alternatively, use COMPONENT_SRCS to specify source files explicitly # set(COMPONENT_SRCS src/example_component.c) # add this components, this will define a CMake library target. register_component()
ESP-IDF v4.2
# Use idf_component_register to add this component, this will define a CMake library target. # Specify component sources in SRCS. # Specify component include directories in INCLUDE_DIRS. idf_component_register(SRCS "src/foo.c" INCLUDE_DIRS "include") # Standard CMake function can be used to specify dependencies. ${COMPONENT_TARGET} is defined # from esp-idf when you call register_component, by default it's idf_component_<folder_name>. target_link_libraries(${COMPONENT_TARGET} PRIVATE AFR::mqtt)

標準の CMake 関数 target_link_libraries を使用して依存関係を指定することもできます。コンポーネントのターゲット名は、ESP-IDF で定義された変数 COMPONENT_TARGET に格納されていることに注意してください。

ESP-IDF v3.3
# add this component, this will define a CMake library target. register_component() # standard CMake function can be used to specify dependencies. ${COMPONENT_TARGET} is defined # from esp-idf when you call register_component, by default it's idf_component_<folder_name>. target_link_libraries(${COMPONENT_TARGET} PRIVATE AFR::mqtt)
ESP-IDF v4.2
# add this component, this will define a CMake library target. idf_component_register(SRCS "src/foo.c" INCLUDE_DIRS "include") # standard CMake function can be used to specify dependencies. ${COMPONENT_TARGET} is defined # from esp-idf when you call register_component, by default it's idf_component_<folder_name>. target_link_libraries(${COMPONENT_TARGET} PRIVATE AFR::mqtt)

ESP コンポーネントの場合、これは 2 つの変数 COMPONENT_REQUIRESCOMPONENT_PRIV_REQUIRES を設定することによって行われます。ESP-IDF プログラミングガイド v4.2ビルドシステム (CMake)を参照してください。

ESP-IDF v3.3
# If the dependencies are from ESP-IDF, use these 2 variables. Note these need to be # set before calling register_component(). set(COMPONENT_REQUIRES log) set(COMPONENT_PRIV_REQUIRES lwip)
ESP-IDF v4.2
# If the dependencies are from ESP-IDF, use these 2 variables (REQUIRES, PRIV_REQUIRES) # in the idf_component_register call: (Refer here for information on the # idf_component_register function: https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/build-system.html#cmake-component-register) idf_component_register(SRCS "src/foo.c" INCLUDE_DIRS "include" REQUIRES log PRIV_REQUIRES lwip)

次に、最上位レベルの CMakeLists.txt ファイルで、これらのコンポーネントを検索する場所を ESP-IDF に指示します。add_subdirectory(freertos) の前の任意の場所に次の行を追加します。

ESP-IDF v3.3
# Add some extra components. IDF_EXTRA_COMPONENT_DIRS is a variable used by ESP-IDF # to collect extra components. get_filename_component( EXTRA_COMPONENT_DIRS "components/example_component" ABSOLUTE ) list(APPEND IDF_EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS})
ESP-IDF v4.2
# Add some extra components. IDF_EXTRA_COMPONENT_DIRS is a variable used by ESP-IDF # to collect extra components. get_filename_component( EXTRA_COMPONENT_DIRS "components/example_component" ABSOLUTE ) idf_build_component(${EXTRA_COMPONENT_DIRS})

このコンポーネントは、デフォルトでアプリケーションコードに自動的にリンクされるようになりました。ヘッダーファイルを含めて、定義する関数を呼び出すことができるはずです。

FreeRTOS の設定を上書きする

現在、FreeRTOS ソースツリーの外で構成を再定義するための明確なアプローチはありません。デフォルトでは、CMake による検索対象は freertos/vendors/espressif/boards/esp32/aws_demos/config_files/ ディレクトリと freertos/demos/include/ ディレクトリです。ただし、回避策を使用して、最初に他のディレクトリを検索するようにコンパイラに指示できます。例えば、FreeRTOS 設定用に別のフォルダを追加できます。

- freertos - freertos-configs - aws_clientcredential.h - aws_clientcredential_keys.h - iot_mqtt_agent_config.h - iot_config.h - components - src - CMakeLists.txt

freertos-configs の下にあるファイルは、freertos/vendors/espressif/boards/esp32/aws_demos/config_files/ ディレクトリと freertos/demos/include/ ディレクトリからコピーされます。次に、最上位レベルの CMakeLists.txt ファイルで、次の行を add_subdirectory(freertos) の前に追加し、このディレクトリをコンパイラーが最初に検索するようにします。

include_directories(BEFORE freertos-configs)

ESP-IDF 用の独自の sdkconfig を提供する

独自の sdkconfig.default を提供したい場合は、コマンドラインから CMake 変数 IDF_SDKCONFIG_DEFAULTS を設定することができます。

cmake -S . -B build-directory -DIDF_SDKCONFIG_DEFAULTS=path_to_your_sdkconfig_defaults -DCMAKE_TOOLCHAIN_FILE=freertos/tools/cmake/toolchains/xtensa-esp32.cmake -GNinja

独自の sdkconfig.default ファイルの場所を指定しない場合、FreeRTOS では freertos/vendors/espressif/boards/esp32/aws_demos/sdkconfig.defaults にあるデフォルトのファイルが使用されます。

概要

example_component という名前のコンポーネントを持つプロジェクトがあり、いくつかの設定を上書きする場合、最上位レベルの CMakeLists.txt ファイルの完全な例を次に示します。

ESP-IDF v3.3
cmake_minimum_required(VERSION 3.13) project(freertos_examples) add_executable(my_app src/main.c) # Tell IDF build to link against this target. set(IDF_PROJECT_EXECUTABLE my_app) # Add some extra components. IDF_EXTRA_COMPONENT_DIRS is a variable used by ESP-IDF # to collect extra components. get_filename_component( EXTRA_COMPONENT_DIRS "components/example_component" ABSOLUTE ) list(APPEND IDF_EXTRA_COMPONENT_DIRS ${EXTRA_COMPONENT_DIRS}) # Override the configurations for FreeRTOS. include_directories(BEFORE freertos-configs) # Add FreeRTOS as a subdirectory. AFR_BOARD tells which board to target. set(AFR_BOARD espressif.esp32_devkitc CACHE INTERNAL "") add_subdirectory(freertos) # Link against the mqtt library so that we can use it. Dependencies are transitively # linked. target_link_libraries(my_app PRIVATE AFR::mqtt)
ESP-IDF v4.2
cmake_minimum_required(VERSION 3.13) project(freertos_examples) # Pull in ESP-IDF defined CMake build infrastructure logic to configure the project, discover all the components, etc set(esp_idf_dir "${CMAKE_CURRENT_LIST_DIR}/freertos/vendors/espressif/esp-idf") include(${esp_idf_dir}/tools/cmake/idf.cmake) # Tell IDF build to link against this target. set(IDF_PROJECT_EXECUTABLE my_app) get_filename_component( IDF_EXECUTABLE_SRCS "src/main.c" ABSOLUTE ) # Add some extra components. IDF_EXTRA_COMPONENT_DIRS is an variable used by ESP-IDF # to collect extra components. get_filename_component( EXTRA_COMPONENT_DIRS "components/foo" ABSOLUTE ) idf_build_component(${EXTRA_COMPONENT_DIRS}) # Override the configurations for FreeRTOS. include_directories(BEFORE freertos-configs) # Add FreeRTOS as a subdirectory. AFR_BOARD tells which board to target. set(AFR_BOARD espressif.esp32_devkitc CACHE INTERNAL "") add_subdirectory(freertos) # Link against the mqtt library so that we can use it. Dependencies are transitively # linked. target_link_libraries(my_app PRIVATE AFR::mqtt)

CMake を使用する Espressif ビルドシステムの詳細については、Espressif API ガイドのビルドシステムを参照してください。

トラブルシューティング

  • macOS を使用していてオペレーティングシステムが ESP-WROVER-KIT を認識しない場合は、D2XX ドライバーがインストールされていないことを確認してください。ドライバーをアンインストールするには、FTDI Drivers Installation Guide for macOS X の手順に従います。

  • ESP-IDF によって提供された (および make monitor を使用して呼び出された) モニタユーティリティを使用して、アドレスをデコードできます。そのため、アプリケーションが停止した場合に意味のあるバックトレースを取得するのに役立ちます。詳細については、Espressif ウェブサイトの自動アドレスデコーディングを参照してください。

  • GDBstub を gdb との通信用に有効にすることができます。特別な JTAG ハードウェアは必要ありません。詳細については、Espressif ウェブサイトの GDBStub を使用して GDB を起動するを参照してください。

  • JTAG ハードウェアベースのデバッグが必要な場合に OpenOCD ベースの環境をセットアップする方法の詳細については、Espressif ウェブサイトの JTAG のデバッグを参照してください。

  • macOS で pip を使用して pyserial をインストールできない場合、pyserial ウェブサイト からダウンロードします。

  • ボードが継続的にリセットされる場合は、ターミナルで次のコマンドを入力して、フラッシュの消去を試してください。

    make erase_flash
  • idf_monitor.py を実行するときにエラーが表示された場合は、Python 2.7 を使用します。

  • ESP-IDF からの必須ライブラリは FreeRTOS に含まれています。外部でダウンロードする必要はありません。IDF_PATH 環境変数が設定されている場合、FreeRTOS を構築する前にクリアすることをお勧めします。

  • Windows では、プロジェクトのビルドに 3 ~ 4 分かかる場合があります。ビルド時間を減らすために、make コマンドで -j4 スイッチを使用できます。

    make flash monitor -j4
  • デバイスが に接続できない場合は AWS IoT、 aws_clientcredential.h ファイルを開き、設定変数が ファイルで正しく定義されていることを確認します。 clientcredentialMQTT_BROKER_ENDPOINT[] は のようになります1234567890123-ats.iot.us-east-1.amazonaws.com

  • ESP32 用の独自の CMake プロジェクトで FreeRTOS を使用する」の手順を実行していて、リンカーから未定義の参照エラーが返された場合は、通常、依存ライブラリまたはデモがないことを示します。これらを追加するには、標準の CMake 関数 target_link_libraries を使用して CMakeLists.txt ファイル (ルートディレクトリの下) を更新します。

  • ESP-IDF v4.2 では、xtensa-esp32-elf-gcc 8.2.0. ツールチェーンの使用がサポートされています。以前のバージョンの Xtensa ツールチェーンを使用している場合、必要なバージョンをダウンロードしてください。

  • ESP-IDF v4.2 で満たされていない Python の依存関係に関して、次のようなエラーログが表示された場合。

    The following Python requirements are not satisfied: click>=5.0 pyserial>=3.0 future>=0.15.2 pyparsing>=2.0.3,<2.4.0 pyelftools>=0.22 gdbgui==0.13.2.0 pygdbmi<=0.9.0.2 reedsolo>=1.5.3,<=1.5.4 bitstring>=3.1.6 ecdsa>=0.16.0 Please follow the instructions found in the "Set up the tools" section of ESP-IDF Getting Started Guide

    次の Python コマンドを使用して、プラットフォームに Python の依存関係をインストールします。

    root/vendors/espressif/esp-idf/requirements.txt

トラブルシューティングの詳細については、「トラブルシューティングの開始方法」を参照してください。

デバッグ

Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード (ESP-IDF v3.3)

このセクションでは、ESP-IDF v3.3 を使用して Espressif ハードウェアをデバッグする方法について説明します。ESP-IDF v4.2 を使用してデバッグする方法については、「Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード (ESP-IDF v4.2)」を参照してください。

JTAG to USB ケーブルが必要です。USB to MPSSE ケーブルを使用します (例: FTDI C232HM-DDHSL-0)。

ESP-DevKitC JTAG セットアップ

FTDI C232HM-DDHSL-0 ケーブルの場合、これらは ESP32 DevkitC への接続です。

C232HM-DDHSL-0 配線色 ESP32 GPIO ピン JTAG 通知名

茶色 (ピン 5)

IO14

TMS

黄色 (ピン 3)

IO12

TDI

黒 (ピン 10)

GND

GND

オレンジ (ピン 2)

IO13

TCK

緑 (ピン 4)

IO15

TDO

ESP-WROVER-KIT JTAG セットアップ

FTDI C232HM-DDHSL-0 ケーブルの場合、これらは ESP32-WROVER-KIT への接続です。

C232HM-DDHSL-0 配線色 ESP32 GPIO ピン JTAG 通知名

茶色 (ピン 5)

IO14

TMS

黄色 (ピン 3)

IO12

TDI

オレンジ (ピン 2)

IO13

TCK

緑 (ピン 4)

IO15

TDO

これらのテーブルは、FTDI C232HM-DDHSL-0 データシートから開発されました。詳細については、データシートの「C232HM MPSSE Cable Connection and Mechanical Details」セクションを参照してください。

ESP-WROVER-KIT で JTAG を有効にするには、次に示すように TMS、TDO、TDI、TCK、S_TDI のピンにジャンパーを配置します。

ジャンパーの配置

Windows でのデバッグ (ESP-IDF v3.3)

Windows でのデバッグをセットアップするには
  1. FTDI C232HM-DDHSL-0 の USB 側をコンピュータに接続し、他方の側を Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード (ESP-IDF v3.3) の説明に従って接続します。FTDI C232HM-DDHSL-0 デバイスは、[Universal Serial Bus Controllers] (ユニバーサルシリアルバスコントローラー) の [Device Manager] (デバイスマネージャー) に表示されます。

  2. ユニバーサルシリアルバスデバイスのリストで、[C232HM-DDHSL-0] デバイスを右クリックし、[Properties] (プロパティ) を選択します。

    注記

    このデバイスは、[USB Serial Port] (USB シリアルポート) として表示される場合があります。

    プロパティウィンドウで [Details] (詳細) タブを選択して、デバイスのプロパティを表示します。デバイスが表示されない場合は、Windows driver for FTDI C232HM-DDHSL-0 をインストールします。

  3. [Details] (詳細) タブで、[Property] (プロパティ) を選択し、[Hardware IDs] (ハードウェア ID) を選択します。[Value] (値) フィールドに、次のような内容が表示されます。

    FTDIBUS\COMPORT&VID_0403&PID_6014

    この例では、ベンダー ID は 0403 で、製品 ID は 6014 です。

    これらの ID が projects/espressif/esp32/make/aws_demos/esp32_devkitj_v1.cfg の ID に一致していることを確認します。ID は ftdi_vid_pid で始まる行で指定されており、その後にベンダー ID と製品 ID が続きます。

    ftdi_vid_pid 0x0403 0x6014
  4. OpenOCD for Windows をダウンロードします。

  5. ファイルを C:\ に解凍して、システムパスに C:\openocd-esp32\bin を追加します。

  6. OpenOCD には libusb が必要です。これは、Windows にデフォルトではインストールされません。

    libusb のインストール方法

    1. zadig.exe をダウンロードします。

    2. zadig.exe を実行します。[Options] (オプション) メニューから、[List All Devices] (すべてのデバイスをリストする) を選択します。

    3. ドロップダウンメニューから [C232HM-DDHSL-0] を選択します。

    4. ターゲットドライバーフィールドの緑の矢印の右側で [WinUSB] を選択します。

    5. ターゲットドライバーフィールドの下のドロップダウンリストから、矢印を選択して [Install Driver] (ドライバーのインストール) を選択します。[Replace Driver] (ドライバーの置換) を選択します。

  7. コマンドプロンプトを開いて projects/espressif/esp32/make/aws_demos に移動し、以下のコマンドを実行します。

    ESP32-WROOM-32 および ESP32-WROVER の場合

    openocd.exe -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg

    ESP32-SOLO-1 の場合

    openocd.exe -f esp32_devkitj_v1.cfg -f esp-solo-1.cfg

    このコマンドプロンプトを開いたままにしておきます。

  8. 新しいコマンドプロンプトを開き、msys32 ディレクトリに移動して mingw32.exe を実行します。

  9. mingw32 ターミナルで projects/espressif/esp32/make/aws_demos に移動し、以下を実行します。

    make flash monitor
  10. 別の mingw32 ターミナルを開き、projects/espressif/esp32/make/aws_demos に移動し、ボードでデモの実行が開始されるまで待機します。このときに、xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf を実行します。このプログラムは main 関数で停止する必要があります。

注記

ESP32 では、最大 2 個のブレークポイントがサポートされています。

macOS (ESP-IDF v3.3) でのデバッグ

  1. FTDI driver for macOS をダウンロードします。

  2. OpenOCD をダウンロードします。

  3. ダウンロードした .tar ファイルを抽出して、.bash_profile のパスを OCD_INSTALL_DIR/openocd-esp32/bin に設定します。

  4. 次のコマンドを使用して macOS に libusb をインストールします。

    brew install libusb
  5. 次のコマンドを使用してシリアルポートドライバーをアンロードします。

    sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver
  6. macOS 10.9 以降のバージョンを実行している場合は、次のコマンドを使用して Apple の FTDI ドライバーをアンロードします。

    sudo kextunload -b com.apple.driver.AppleUSBFTDI
  7. 次のコマンドを使用して FTDI ケーブルの製品 ID とベンダー ID を取得します。アタッチされた USB デバイスが表示されます。

    system_profiler SPUSBDataType

    system_profiler からの出力は次のようになります。

    DEVICE: Product ID: product-ID Vendor ID: vendor-ID (Future Technology Devices International Limited)
  8. projects/espressif/esp32/make/aws_demos/esp32_devkitj_v1.cfg ファイルを開きます。デバイスのベンダー ID および製品 ID は ftdi_vid_pid で始まる行で指定されています。前のステップの system_profiler 出力の ID に一致するように ID を変更します。

  9. ターミナルウィンドウを開き、projects/espressif/esp32/make/aws_demos に移動して、以下のコマンドを使用して OpenOCD を実行します。

    ESP32-WROOM-32 および ESP32-WROVER の場合

    openocd -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg

    ESP32-SOLO-1 の場合

    openocd -f esp32_devkitj_v1.cfg -f esp-solo-1.cfg
  10. 新しいターミナルを開き、次のコマンドを使用して FTDI シリアルポートドライバーをロードします。

    sudo kextload -b com.FTDI.driver.FTDIUSBSerialDriver
  11. projects/espressif/esp32/make/aws_demos に移動して、以下のコマンドを実行します。

    make flash monitor
  12. 別の新しいターミナルを開き、projects/espressif/esp32/make/aws_demos に移動して、次のコマンドを実行します。

    xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf

    main() でこのプログラムを停止する必要があります。

Linux でのデバッグ (ESP-IDF v3.3)

  1. OpenOCD をダウンロードします。tarball を抽出し、readme ファイルのインストール手順に従ってください。

  2. 次のコマンドを使用して Linux に libusb をインストールします。

    sudo apt-get install libusb-1.0
  3. ターミナルを開いて ls -l /dev/ttyUSB* と入力し、コンピュータに接続されているすべての USB デバイスを一覧表示します。これにより、ボードの USB ポートがオペレーティングシステムによって認識されているかどうかを確認できます。次のような出力が表示されます。

    $ls -l /dev/ttyUSB* crw-rw---- 1 root dialout 188, 0 Jul 10 19:04 /dev/ttyUSB0 crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1
  4. サインオフしてからサインインし、ボードの電源を入れ直して変更を有効にします。ターミナルプロンプトで、USB デバイスを一覧表示します。グループ所有者が dialout から plugdev に変化していることを確認します。

    $ls -l /dev/ttyUSB* crw-rw---- 1 root plugdev 188, 0 Jul 10 19:04 /dev/ttyUSB0 crw-rw---- 1 root plugdev 188, 1 Jul 10 19:04 /dev/ttyUSB1

    数の少ない番号を持つ /dev/ttyUSBn インターフェイスは、JTAG 通信に使用されます。もう 1 つのインターフェイスは ESP32 のシリアルポート (UART) にルーティングされ、コードを ESP32 のフラッシュメモリにアップロードするために使用されます。

  5. ターミナルウィンドウで projects/espressif/esp32/make/aws_demos に移動して、以下のコマンドを使用して OpenOCD を実行します。

    ESP32-WROOM-32 および ESP32-WROVER の場合

    openocd -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg

    ESP32-SOLO-1 の場合

    openocd -f esp32_devkitj_v1.cfg -f esp-solo-1.cfg
  6. 別のターミナルを開き、projects/espressif/esp32/make/aws_demos に移動して次のコマンドを実行します。

    make flash monitor
  7. 別のターミナルを開き、projects/espressif/esp32/make/aws_demos に移動して次のコマンドを実行します。

    xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf

    main() でこのプログラムを停止する必要があります。

Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード (ESP-IDF v4.2)

このセクションでは、ESP-IDF v4.2 を使用して Espressif ハードウェアをデバッグする方法について説明します。ESP-IDF v3.3 を使用してデバッグする方法については、「Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード (ESP-IDF v3.3)」を参照してください。

JTAG to USB ケーブルが必要です。USB to MPSSE ケーブルを使用します (例: FTDI C232HM-DDHSL-0)。

ESP-DevKitC JTAG セットアップ

FTDI C232HM-DDHSL-0 ケーブルの場合、これらは ESP32 DevkitC への接続です。

C232HM-DDHSL-0 配線色 ESP32 GPIO ピン JTAG 通知名

茶色 (ピン 5)

IO14

TMS

黄色 (ピン 3)

IO12

TDI

黒 (ピン 10)

GND

GND

オレンジ (ピン 2)

IO13

TCK

緑 (ピン 4)

IO15

TDO

ESP-WROVER-KIT JTAG セットアップ

FTDI C232HM-DDHSL-0 ケーブルの場合、これらは ESP32-WROVER-KIT への接続です。

C232HM-DDHSL-0 配線色 ESP32 GPIO ピン JTAG 通知名

茶色 (ピン 5)

IO14

TMS

黄色 (ピン 3)

IO12

TDI

オレンジ (ピン 2)

IO13

TCK

緑 (ピン 4)

IO15

TDO

これらのテーブルは、FTDI C232HM-DDHSL-0 データシートから開発されました。詳細については、データシートの「C232HM MPSSE Cable Connection and Mechanical Details」セクションを参照してください。

ESP-WROVER-KIT で JTAG を有効にするには、次に示すように TMS、TDO、TDI、TCK、S_TDI のピンにジャンパーを配置します。

ジャンパーの配置

Windows でのデバッグ (ESP-IDF v4.2)

Windows でのデバッグをセットアップするには
  1. FTDI C232HM-DDHSL-0 の USB 側をコンピュータに接続し、他方の側を Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード (ESP-IDF v4.2) の説明に従って接続します。FTDI C232HM-DDHSL-0 デバイスは、[Universal Serial Bus Controllers] (ユニバーサルシリアルバスコントローラー) の [Device Manager] (デバイスマネージャー) に表示されます。

  2. ユニバーサルシリアルバスデバイスのリストで、[C232HM-DDHSL-0] デバイスを右クリックし、[Properties] (プロパティ) を選択します。

    注記

    このデバイスは、[USB Serial Port] (USB シリアルポート) として表示される場合があります。

    プロパティウィンドウで [Details] (詳細) タブを選択して、デバイスのプロパティを表示します。デバイスが表示されない場合は、Windows driver for FTDI C232HM-DDHSL-0 をインストールします。

  3. [Details] (詳細) タブで、[Property] (プロパティ) を選択し、[Hardware IDs] (ハードウェア ID) を選択します。[Value] (値) フィールドに、次のような内容が表示されます。

    FTDIBUS\COMPORT&VID_0403&PID_6014

    この例では、ベンダー ID は 0403 で、製品 ID は 6014 です。

    これらの ID が projects/espressif/esp32/make/aws_demos/esp32_devkitj_v1.cfg の ID に一致していることを確認します。ID は ftdi_vid_pid で始まる行で指定されており、その後にベンダー ID と製品 ID が続きます。

    ftdi_vid_pid 0x0403 0x6014
  4. OpenOCD for Windows をダウンロードします。

  5. ファイルを C:\ に解凍して、システムパスに C:\openocd-esp32\bin を追加します。

  6. OpenOCD には libusb が必要です。これは、Windows にデフォルトではインストールされません。

    libusb のインストール方法

    1. zadig.exe をダウンロードします。

    2. zadig.exe を実行します。[Options] (オプション) メニューから、[List All Devices] (すべてのデバイスをリストする) を選択します。

    3. ドロップダウンメニューから [C232HM-DDHSL-0] を選択します。

    4. ターゲットドライバーフィールドの緑の矢印の右側で [WinUSB] を選択します。

    5. ターゲットドライバーフィールドの下のドロップダウンリストから、矢印を選択して [Install Driver] (ドライバーのインストール) を選択します。[Replace Driver] (ドライバーの置換) を選択します。

  7. コマンドプロンプトを開き、FreeRTOS ダウンロードディレクトリのルートに移動し、次のコマンドを実行します。

    idf.py openocd

    このコマンドプロンプトを開いたままにしておきます。

  8. 新しいコマンドプロンプトを開き、FreeRTOS ダウンロードディレクトリのルートに移動して以下を実行します。

    idf.py flash monitor
  9. 別のコマンドプロンプトを開き、FreeRTOS ダウンロードディレクトリのルートに移動し、ボードでデモの実行が開始されるまで待ちます。このときに、以下を実行します。

    idf.py gdb

    このプログラムは main 関数で停止する必要があります。

注記

ESP32 では、最大 2 個のブレークポイントがサポートされています。

macOS (ESP-IDF v4.2) でのデバッグ

  1. FTDI driver for macOS をダウンロードします。

  2. OpenOCD をダウンロードします。

  3. ダウンロードした .tar ファイルを抽出して、.bash_profile のパスを OCD_INSTALL_DIR/openocd-esp32/bin に設定します。

  4. 次のコマンドを使用して macOS に libusb をインストールします。

    brew install libusb
  5. 次のコマンドを使用してシリアルポートドライバーをアンロードします。

    sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver
  6. macOS 10.9 以降のバージョンを実行している場合は、次のコマンドを使用して Apple の FTDI ドライバーをアンロードします。

    sudo kextunload -b com.apple.driver.AppleUSBFTDI
  7. 次のコマンドを使用して FTDI ケーブルの製品 ID とベンダー ID を取得します。アタッチされた USB デバイスが表示されます。

    system_profiler SPUSBDataType

    system_profiler からの出力は次のようになります。

    DEVICE: Product ID: product-ID Vendor ID: vendor-ID (Future Technology Devices International Limited)
  8. projects/espressif/esp32/make/aws_demos/esp32_devkitj_v1.cfg ファイルを開きます。デバイスのベンダー ID および製品 ID は ftdi_vid_pid で始まる行で指定されています。前のステップの system_profiler 出力の ID に一致するように ID を変更します。

  9. ターミナルウィンドウを開き、FreeRTOS ダウンロードディレクトリのルートに移動して、以下のコマンドを使用して OpenOCD を実行します。

    idf.py openocd

    ターミナルウィンドウは開いたままにします。

  10. 新しいターミナルを開き、次のコマンドを使用して FTDI シリアルポートドライバーをロードします。

    sudo kextload -b com.FTDI.driver.FTDIUSBSerialDriver
  11. FreeRTOS ダウンロードディレクトリのルートに移動し、以下を実行します。

    idf.py flash monitor
  12. 別の新しいターミナルを開き、FreeRTOS のダウンロードディレクトリのルートに移動し、以下を実行します。

    idf.py gdb

    main でこのプログラムを停止する必要があります。

Linux でのデバッグ (ESP-IDF v4.2)

  1. OpenOCD をダウンロードします。tarball を抽出し、readme ファイルのインストール手順に従ってください。

  2. 次のコマンドを使用して Linux に libusb をインストールします。

    sudo apt-get install libusb-1.0
  3. ターミナルを開いて ls -l /dev/ttyUSB* と入力し、コンピュータに接続されているすべての USB デバイスを一覧表示します。これにより、ボードの USB ポートがオペレーティングシステムによって認識されているかどうかを確認できます。次のような出力が表示されます。

    $ls -l /dev/ttyUSB* crw-rw---- 1 root dialout 188, 0 Jul 10 19:04 /dev/ttyUSB0 crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1
  4. サインオフしてからサインインし、ボードの電源を入れ直して変更を有効にします。ターミナルプロンプトで、USB デバイスを一覧表示します。グループ所有者が dialout から plugdev に変化していることを確認します。

    $ls -l /dev/ttyUSB* crw-rw---- 1 root plugdev 188, 0 Jul 10 19:04 /dev/ttyUSB0 crw-rw---- 1 root plugdev 188, 1 Jul 10 19:04 /dev/ttyUSB1

    数の少ない番号を持つ /dev/ttyUSBn インターフェイスは、JTAG 通信に使用されます。もう 1 つのインターフェイスは ESP32 のシリアルポート (UART) にルーティングされ、コードを ESP32 のフラッシュメモリにアップロードするために使用されます。

  5. ターミナルウィンドウで FreeRTOS ダウンロードディレクトリのルートに移動して、以下のコマンドを使用して OpenOCD を実行します。

    idf.py openocd
  6. 別のターミナルを開き、FreeRTOS ダウンロードディレクトリのルートに移動し、以下のコマンドを実行します。

    idf.py flash monitor
  7. 別のターミナルを開き、FreeRTOS ダウンロードディレクトリのルートに移動し、以下のコマンドを実行します。

    idf.py gdb

    main() でこのプログラムを停止する必要があります。