以下操作說明使用 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
在互動式選單中進行以下設定:
Component config --->
CHIP Device Layer --->
Device Identification Options --->
將
Vendor ID
設為Connectivity Standards Alliance (Alliance)指派的 VID。將
Product ID
設為您在 Google Home Developer Console 的 Matter 整合上設定的 PID。
啟用 OTA 要求者標記:
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 佣金並觀察網路旅行社
確保使用 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
確認家中 Nest 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
,然後在互動式選單選項中:
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
重複按照「Commission to Google Home」(向 Google Home 裝置佣金) 一節的步驟執行操作,並視情況觀察 OTA。
驗證 OTA 軟體更新
你可以透過 Google Home 應用程式 (GHA) 查看裝置軟體版本。裝置停用後,請採取下列程序:
- 長按GHA主畫面上的裝置圖塊
- 輕觸右上方的 圖示
- 輕觸「技術資訊」。
- 檢查「軟體版本」欄位