以下操作說明使用 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
或者,您也可以使用以下指令啟動 root 工作階段:
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
在互動式選單中,設定下列選項:
Component config --->
CHIP Device Layer --->
Device Identification Options --->
將
Vendor ID
設為 Connectivity Standards Alliance (Alliance) 指派的 VID。將
Product ID
設為 Google Home Developer Console 中 Matter 整合作業所設定的 PID。
啟用 OTA Requestor 標記:
Component config -->
CHIP Core -->
System options --->
啟用 OTA 要求者標記
[*] Enable OTA Requestor
按兩下 ESC 鍵可返回頂層選單。
啟用 Matter OTA 映像檔建立旗標:
Component config -->
CHIP Device Layer --->
Matter OTA Image --->
[*] Generate OTA IMAGE
設定版本號碼:
Application manager --->
選取「
[*] Get the project version from Kconfig
」將
Project version (NEW)
設為1.0
按 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
在互動式選單中,更新下列項目:
Application manager --->
- 選取「
[*] Get the project version from Kconfig
」 - 將
Project version (NEW)
設為2.0
- 按下 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
檔案,或使用 cat
、tail
、more
或 grep
在其他殼層中顯示該檔案。
按下裝置側邊的紅色重設按鈕,查看啟動時的記錄。
在裝置輸出內容中,您應該會看到先前設定的 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
確認家中的中控台已連上網路。
使用記錄檔中顯示的連結 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
,然後在互動式選單選項中:
Component config -->
CHIP Device Layer --->
Device Identification Options
將
Version String
設為v1.0
。將
Device Software Version Number
設為1
。按下 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) 檢查裝置軟體版本。裝置調試完成後,請按照下列程序操作:
- 長按 GHA 主畫面上的裝置圖塊
- 輕觸右上方的 圖示
- 輕觸「技術資訊」
- 查看「軟體版本」欄位