Amazon FreeRTOS
ユーザーガイド

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

Espressif ESP32-DevKitC がない場合は、AWS Partner Device Catalog にアクセスして当社のパートナーから購入してください。Espressif ESP32-WROVER-KIT がない場合は、AWS Partner Device Catalog にアクセスして当社のパートナーから購入してください。Amazon FreeRTOS では両方のデバイスがサポートされています。お客様の持っている開発モジュールをチェックするには、ESP32 Modules and Boards を参照してください。

注記

現在、ESP32-WROVER-KIT および ESP DevKitC 用の Amazon FreeRTOS ポートは、以下をサポートしていません。

  • Lightweight IP。

  • 対称型マルチプロセッシング (SMP)。

Espressif ハードウェアのセットアップ

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

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

注記

Espressif ガイドの「開始方法」に進まないでください。代わりに、次のステップを実行します。

環境をセットアップする

シリアル接続の確立

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

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

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

ツールチェーンの設定

Espressif ツールチェーンをセットアップし、ボードと通信できるようにする必要があります。ツールチェーンをセットアップするには、ホストマシンのオペレーティングシステム用の手順に従います。

注記

ツールチェーンのセットアップ手順に従う場合は、[Next Steps (次のステップ)] の [Get ESP-IDF (ESP-IDF の取得)] 手順に進まないでください。代わりに、引き続きこのページの手順に従います。

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

環境をセットアップすると、GitHub から Amazon FreeRTOS をダウンロードできるようになります。Espressif ボード用の Amazon FreeRTOS の設定は、Amazon FreeRTOS コンソールからは利用できません。

Amazon FreeRTOS のダウンロード

GitHub から amazon-freertos リポジトリのクローンを作成します。

このチュートリアルでは、amazon-freertos ディレクトリへのパスを BASE_FOLDER と表記します。

注記

Microsoft Windows でファイルパスの最大長は 260 文字です。 Amazon FreeRTOS ダウンロードでの最長パスは 122 文字です。Amazon FreeRTOS プロジェクトのファイルに対応するため、amazon-freertos ディレクトリへのパスが 98 文字未満であることを確認してください。たとえば、C:\Users\Username\Dev\amazon-freertos の使用は可能ですが、C:\Users\Username\Documents\Development\Projects\amazon-freertos というパスではビルドに失敗します。

プロジェクトの設定

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

  2. Python 2.7.10 以降をインストールします。

  3. Windows を実行している場合は、easy_install awscli を使用して mingw32 環境に AWS CLI をインストールします。

    macOS または Linux を実行している場合は、システムに AWS CLI がインストールされていることを確認します。詳細については、「AWS コマンドラインインターフェイスのインストール」を参照してください。

  4. aws configure を実行し、AWS アクセスキー ID、シークレットアクセスキー、デフォルトリージョン名を使って AWS CLI を設定します。詳細については、「AWS CLI の設定」を参照してください。

  5. boto3 Python モジュールをインストールするには、次のコマンドを使用します。

    • Windows の mingw32 環境では、easy_install boto3 を使用します。

    • macOS や Linux では、pip install boto3 を使用します。

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

afr_source_dir

コンピュータ上の amazon-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. <BASE_FOLDER>/tools/aws_config_quick_start ディレクトリに移動して、次のコマンドを実行してください。

    python SetupAWS.py setup

このスクリプトは、IoT モノ、証明書、およびポリシーを作成します。これにより、IoT ポリシーが証明書に、証明書が IoT モノにアタッチされます。また、aws_clientcredential.h ファイルに AWS IoT エンドポイント、Wi-Fi SSID、認証情報を入力します。最後に、証明書とプライベートキーをフォーマットして aws_clientcredential.h ヘッダーファイルに書き込みます。スクリプトの詳細については、<BASE_FOLDER>/tools/aws_config_quick_start ディレクトリにある README.md を参照してください。

Amazon FreeRTOS デモプロジェクトを構築および実行する

デモのフラッシュのためにボードの接続を設定するには

  1. ホストコンピュータにボードを接続します。

  2. macOS または Linux を使用している場合、ターミナルを開きます。Windows を使用している場合、mingw32.exe (mysys ツールチェーンからダウンロードされたもの) を開きます。

  3. <BASE_FOLDER>/demos/espressif/esp32_devkitc_esp_wrover_kit/make に移動して次のコマンドを入力し、Espressif IoT 開発フレームワーク設定メニューを作成して開きます。

    make menuconfig

    メニューで選択を確定するには、[Select (選択)] を選択します。設定を保存するには、[Save (保存)] を選択します。メニューを終了するには、[Exit (終了)] を選択します。

  4. Espressif IoT 開発フレームワーク設定メニューで、[Serial flasher config (シリアルフラッシャー設定)] に移動します。

    シリアルポートを設定するには、[Default serial port (デフォルトのシリアルポート)] を選択します。ここで設定したシリアルポートは、ボードにデモアプリケーションを記述するために使用されます。Windows では、シリアルポートに COM1 のような名前があります。macOS では、/dev/cu で始まります。Linux では、/dev/tty で始まります。

    ボードとの通信中に使用するデフォルトボーレートを変更するには、[Default baud rate (デフォルトボーレート)] を選択します。ボーレートを増やすと、ボードをフラッシュさせるのに必要な時間を短縮できます。ハードウェアに応じて、最大 921600 までデフォルトのボーレートを増やすことができます。

  5. ボードの設定をセットアップしたら、保存してメニューを終了します。

ファームウェア (ブートローダーとパーティションテーブルを含む) をビルドしてフラッシュし、シリアルコンソール出力をモニタリングするには、ターミナル (macOS と Linux) または mingw32.exe (Windows) を開きます。<BASE_FOLDER>/demos/espressif/esp32_devkitc_esp_wrover_kit/make にディレクトリを変更し、次のコマンドを実行します。

make flash monitor

デモをモニタリングするには、MQTT トピックにサブスクライブします。このトピックでは、デモアプリケーションからメッセージ freertos/demos/echo が発行されます。

MQTT トピックをサブスクライブするには

  1. AWS IoT コンソールにサインインします。

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

  3. [Subscription topic (トピックのサブスクリプション)] で「freertos/demos/echo」と入力し、[Subscribe to topic (トピックへのサブスクライブ)] を選択します。

    make flash monitor コマンドを発行したターミナルまたはコマンドプロンプトから以下のような出力が返されると、Hello World number および Hello World number ACK メッセージが MQTT クライアントページの下部に表示されます。

    12 1350 [MQTTEcho] Echo successfully published 'Hello World 0' 13 1357 [Echoing] Message returned with ACK: 'Hello World 0 ACK' 14 1852 [MQTTEcho] Echo successfully published 'Hello World 1' 15 1861 [Echoing] Message returned with ACK: 'Hello World 1 ACK' 16 2355 [MQTTEcho] Echo successfully published 'Hello World 2' 17 2361 [Echoing] Message returned with ACK: 'Hello World 2 ACK' 18 2857 [MQTTEcho] Echo successfully published 'Hello World 3' 19 2863 [Echoing] Message returned with ACK: 'Hello World 3 ACK'

デモの実行が終了すると、ターミナルまたはコマンドプロンプトに次のような出力が表示されます。

32 6380 [MQTTEcho] Echo successfully published 'Hello World 10' 33 6386 [Echoing] Message returned with ACK: 'Hello World 10 ACK' 34 6882 [MQTTEcho] Echo successfully published 'Hello World 11' 35 6889 [Echoing] Message returned with ACK: 'Hello World 11 ACK' 36 7385 [MQTTEcho] MQTT echo demo finished. 37 7385 [MQTTEcho] ----Demo finished----

Bluetooth Low-Energy デモを実行する

Amazon FreeRTOS の Bluetooth Low Energy サポートは、パブリックベータリリースに含まれています。BLE デモは変更されることがあります。

Amazon FreeRTOS は、Bluetooth Low Energy (BLE) 接続をサポートしています。BLE を備えた Amazon FreeRTOS は、GitHub からダウンロードできます。Amazon FreeRTOS BLE ライブラリは、まだパブリックベータにあるため、ボード用のコードにアクセスするにはブランチを切り替える必要があります。feature/ble-beta という名前のブランチを確認します。

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

Amazon FreeRTOS BLE Mobile SDK デモアプリケーションをセットアップするには

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

  2. モバイルデバイスでデモモバイルアプリケーションをセットアップするには、Amazon FreeRTOS BLE Mobile SDK デモアプリケーションの手順に従います。

ボードで MQTT over BLE デモを実行する方法については、MQTT over BLE demo application (MQTT over BLE デモアプリケーション) を参照してください。

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

トラブルシューティング

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

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

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

  • JTAG ハードウェアベースのデバッグが必要な場合に OpenOCD ベースの環境をセットアップする方法の詳細については、JTAG Debugging を選択します。

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

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

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

その他の注意事項

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

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

    make flash monitor -j4

Espressif ESP32-DevKitC および ESP-WROVER-KIT のデバッグコード

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 datasheet から開発されました。詳細については、データシートの C232HM MPSSE Cable Connection and Mechanical Details を参照してください。

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

Windows でのデバッグ

Windows でのデバッグをセットアップするには

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

  2. USB コントローラーのリストから C232HM-DDHSL-0 デバイス (製造元は FTDI) を右クリックし、[Properties (プロパティ)] を選択します。プロパティウィンドウで [Details (詳細)] タブを選択して、デバイスのプロパティを表示します。デバイスが表示されない場合は、Windows driver for FTDI C232HM-DDHSL-0 をインストールします。

  3. [Device Manager (デバイスマネージャ)] に表示されるベンダー ID と製品 ID が demos\espressif\esp32_devkitc_esp_wrover_kit\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 にデフォルトではインストールされません。以下の方法でインストールします。

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

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

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

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

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

  7. コマンドプロンプトを開き、<BASE_FOLDER>\demos\espressif\esp32_devkitc_esp_wrover_kit\make に移動して以下を実行します。

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

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

  8. 新しいコマンドプロンプトを開き、msys32 ディレクトリに移動して mingw32.exe を実行します。mingw32 ターミナルで、<BASE_FOLDER>\demos\espressif\esp32_devkitc_esp_wrover_kit\make に移動して make flash monitor を実行します。

  9. 別の mingw32 ターミナルを開き、<BASE_FOLDER>\demos\espressif\esp32_devkitc_esp_wrover_kit\make に移動して xtensa-esp32-elf-gdb -x gdbinit build/aws_demos.elf を実行します。このプログラムは main 関数で停止する必要があります。

注記

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

macOS でのデバッグ

  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. オープン demos/espressif/esp32_devkitc_esp_wrover_kit/esp32_devkitj_v1.cfg.デバイスのベンダー ID および製品 ID は ftdi_vid_pid で始まる行で指定されています。前のステップの system_profiler 出力の ID に一致するように ID を変更します。

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

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

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

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

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

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

Linux でのデバッグ

  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. ターミナルウィンドウで <BASE_FOLDER>/demos/espressif/esp32_devkitc_esp_wrover_kit/make に移動して、以下のコマンドを使用して OpenOCD を実行します。

    openocd -f esp32_devkitj_v1.cfg -f esp-wroom-32.cfg
  6. 別のターミナルを開き、<BASE_FOLDER>/demos/espressif/esp32_devkitc_esp_wrover_kit/make に移動して次のコマンドを実行します。

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

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

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