在 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 Workflow 中使用的版本,以決定哪一種 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

建構及製作 Flash

接下來的工作是建構映像檔並刷新開發套件,以接收 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 ConsoleMatter 整合中設定的 PID。

啟用 OTA 要求者標記:

  1. Component config -->

  2. CHIP Core -->

  3. System options --->

  4. 啟用 OTA 要求者旗標 [*] Enable OTA Requestor

  5. 按兩下 ESC 鍵,即可返回頂層選單。

啟用 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 鍵兩次,然後按下 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 鍵兩次,然後按下 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 檔案,或使用 cattailmoregrep 在其他殼層中顯示該檔案。

按下裝置側邊的紅色重設按鈕,即可查看啟動程序的記錄。

裝置輸出內容應會顯示先前設定的 VID 和 PID,以及您要用來調試裝置的 QR code 圖片網址。

[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

確認 Hub 已連上網路。

使用記錄檔中顯示的連結 QR code,透過 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 應用程式畫面,顯示「軟體版本」欄位