Espressif ESP32 で OTA をテストする

次の手順では、Matter SDK のライトアプリの例と M5Stack ESP32 開発ボードを使用します。

ビルド環境の設定

まず、Matter SDK のクローンを作成します。

この例では、Google Home の Matter リリース 5 でサポートされる最小契約額を確認します。

$ mkdir otaprep
$ cd otaprep
git clone https://github.com/project-chip/connectedhomeip.git
cd connectedhomeip
git fetch origin v1.0-branch
git checkout FETCH_HEAD
git submodule update --init --recursive
source ./scripts/activate.sh

次に、ESP32 GitHub ワークフローで使用されているバージョンを確認して、ビルドに最適な Docker イメージを決定します。

$ cat .github/workflows/examples-esp32.yaml | grep chip-build | head -n 1
            image: connectedhomeip/chip-build-esp32:0.5.99

Docker イメージからコンテナを実行し、Matter SDK をコンテナにマウントし、ESP32 デバイスにアクセスできるようにするフラグを渡します。

$ docker run --name container_name -it --user $(id -u):$(id -g) --mount source=$(pwd),target=/workspace,type=bind --device=/dev/ttyUSB0 connectedhomeip/chip-build-esp32:0.5.99 /bin/bash

Matter Docker コンテナを停止して起動する

docker run コマンドを実行すると、指定したイメージを含む新しいコンテナが作成されます。この操作を行うと、以前のコンテナ インスタンスに保存されている古いデータは失われます。新たにインストールを開始できるため、このような事態が望まれる場合もあります。ただしこの例では、作業と環境構成をセッション間で保存することをおすすめします。

user@host> docker stop container_name

再実行する準備ができたら、コンテナを起動してターミナル ウィンドウを開きます。

user@host> docker start container_name
user@host> docker exec -it container_name /bin/bash

次のコマンドで、コンテナに対する追加のターミナル セッションを開くことができます。

user@host> docker exec -it container_name /bin/bash

または、次のコマンドを使用してルート セッションを開始します。

user@host> docker exec -u 0 -it container_name /bin/bash

SDK を初期化する

コンテナで、Matter SDK と ESP IDF を初期化します。

cd /workspace
git submodule update --init --recursive
source ./scripts/activate.sh
source /opt/espressif/esp-idf/export.sh

ビルドとフラッシュ

次のタスクでは、イメージのビルドと開発キットのフラッシュを行って、Matter OTA ファームウェア アップデートを受信します。

そのためには、イメージを作成する必要があります。

まず、ESP IDF の menuconfig ユーティリティを使用してビルドを構成します。

cd examples/lighting-app/esp32
idf.py menuconfig

インタラクティブ メニューで、次の設定を構成します。

  1. Component config --->

  2. CHIP Device Layer --->

  3. Device Identification Options --->

  4. Vendor ID を Connectivity Standards Alliance (Alliance) に割り当てられた VID に設定します。

  5. Product ID を、Google Home Developer Console の Matter 統合で設定した PID に設定します。

OTA リクエスタ フラグを有効にします。

  1. Component config -->

  2. CHIP Core -->

  3. System options --->

  4. OTA リクエスタ フラグ [*] Enable OTA Requestor を有効にする

  5. ESC キーを 2 回押して、最上位のメニューに戻ります。

Matter OTA イメージ作成フラグを有効にします。

  1. Component config -->

  2. CHIP Device Layer --->

  3. Matter OTA Image --->

  4. [*] Generate OTA IMAGE

バージョン番号を設定します。

  1. Application manager --->

  2. [*] Get the project version from Kconfig を選択

  3. Project version (NEW) を 1.0 に設定する

  4. s キーを押して構成を保存し、Enter キーを 2 回押してから、q キーを押して menuconfig を終了します。

テスト証明書を設定する

Matter デバイスのテスト証明書を作成するの手順に沿って、CD、DAC、PAI の証明書を作成します。

デバイスを作る

ビルドを実行してデバイスをフラッシュします。

idf.py build
idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash

OTA イメージを作成してアップロードする

ビルド設定をもう一度変更して OTA イメージを作成します。バージョン番号を更新した同じイメージを使用します。

menuconfig を実行します。

idf.py menuconfig

インタラクティブ メニューで、次のように更新します。

  1. Application manager --->
  2. [*] Get the project version from Kconfig を選択
  3. Project version (NEW) を 2.0 に設定する
  4. s キーを押して構成を保存し、Enter キーを 2 回押してから、q キーを押して menuconfig を終了します。

イメージをビルドして取得します。以下の例は、OTA 用の画像の場所と、ota_image_tool.py で解析するときの出力の両方を示しています。

cd build
/workspace/src/app/ota_image_tool.py show ./chip-lighting-app-ota.bin
Magic: 1beef11e
Total Size: 1243360
Header Size: 64
Header TLV:
  [0] Vendor Id: XXXXX (0x000)
  [1] Product Id: XXXXX (0x000)
  [2] Version: 2 (0x2)
  [3] Version String: v2.0
  [4] Payload Size: 1243280 (0x12f890)
  [8] Digest Type: 1 (0x1)
  [9] Digest: e367f4d71e2ccd554b9a399c864abbf2c039382ef1def1b986fb2f59a99923a8

Matter SDK がコンテナホストからマウントされているため、OTA イメージはコンテナホストで使用できます。

OTA アップロード手順に沿って、OTA イメージを Developer Console にアップロードします。

Google Home にコミッショニングして OTA を監視する

デバイスが USB でホストの Linux マシンに接続されていることを確認します。次の例は、GNU screen を使用してデバイスログを読み取る方法を示しています。

screen -L /dev/ttyUSB0 115200

これにより、デバイスからの出力がターミナルに表示され、同じ出力が screenlog.0 というデフォルトの画面ログファイルに書き込まれます。

screenlog.0 ファイルは、別のテキスト エディタで開くことができます。または、cat、tail、more、grep を使用して別のシェルで表示することもできます。

デバイスの側面にある赤いリセットボタンを押すと、起動時のログが表示されます。

デバイスの出力には、先ほど設定した VID と PID、デバイスのコミッショニングに使用する QR コード画像の URL が表示されます。

[0;32mI (2388) chip[DIS]: Advertise commission parameter vendorID=XXXXX productID=XXXX discriminator=3840/15 cm=1[0m

[0;32mI (1928) chip[SVR]: SetupQRCode: [MT:E59-000000000000000][0m

https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3AE59-000000000000000

家の中で Google Nest Hub がオンラインになっていることを確認します。

ログファイルに表示されるリンクから QR コードを使用して、Google Home app (GHA) をデバイスにコミッショニングします。

コミッショニング後、数分間、デバイスを中断せずに動作させます。 OTA リクエスタ、OTA イメージのダウンロード、OTAImageProcessor に関連するログ出力が表示されます。

イメージのインストール後、イメージのコンパイル時間がコンソールにアップロードされたイメージのコンパイル時間と一致し、初回起動時に報告されたコンパイル時間より後であることを確認します。screenlog.0 の正規表現モードで、次のパターンを使用して grep を実行すると、OTA プロセスを確認できます。

$ grep -E "(Compile time|OTA)" screenlog.0
I (76) boot:  1 otadata          OTA data         01 00 0000f000 00002000
I (91) boot:  3 ota_0            OTA app          00 10 00020000 00177000
I (99) boot:  4 ota_1            OTA app          00 11 001a0000 00177000
I (645) cpu_start: Compile time:     Oct 15 2022 06:21:59
I (135558) chip[SWU]: OTA Requestor received AnnounceOTAProvider
I (540658) chip[SWU]: OTA image downloaded to offset 0x1a0000
I (541348) OTAImageProcessor: Applying, Boot partition set offset:0x1a0000
I (76) boot:  1 otadata          OTA data         01 00 0000f000 00002000
I (91) boot:  3 ota_0            OTA app          00 10 00020000 00177000
I (99) boot:  4 ota_1            OTA app          00 11 001a0000 00177000
I (645) cpu_start: Compile time:     Oct 15 2022 07:35:31
I (76) boot:  1 otadata          OTA data         01 00 0000f000 00002000
I (91) boot:  3 ota_0            OTA app          00 10 00020000 00177000
I (99) boot:  4 ota_1            OTA app          00 11 001a0000 00177000
I (645) cpu_start: Compile time:     Oct 15 2022 07:35:31

初回の実行後、新しい画像をアップロードせずに、OTA イメージを作成してアップロードするセクションの手順を繰り返すことができます。今回は、バージョンを 1 に戻します。

menuconfig を実行し、インタラクティブ メニュー オプションで次の操作を行います。

  1. Component config -->

  2. CHIP Device Layer --->

  3. Device Identification Options

  4. Version String を v1.0 に設定します。

  5. Device Software Version Number を 1 に設定します。

  6. S キーを押して設定を保存し、Q キーを押して menuconfig を終了します。

GHAで家からデバイスを削除します。

イメージがまだビルドされていない場合は、ビルドします。

idf.py build

フラッシュする:

idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash

必要に応じて、Google Home へのコミッショニングと OTA のモニタリングの手順を繰り返します。

OTA ソフトウェア アップデートを検証する

デバイスのソフトウェア バージョンは、Google Home アプリ（GHA）で確認できます。デバイスのコミッショニングが完了したら、次の手順を行います。

  1. GHA のメイン画面でデバイスのタイルを長押しします
  2. 右上の アイコンをタップします
  3. [技術情報] をタップします。
  4. [ソフトウェア バージョン] を確認します

ソフトウェア バージョン フィールドが表示されている Google Home アプリの画面