In der folgenden Anleitung wird das Beispiel der Beleuchtungsanwendung aus dem Matter SDK zusammen mit einem M5Stack ESP32-Entwicklungsboard verwendet.
Build-Umgebung einrichten
Klonen Sie zuerst das Matter SDK.
In diesem Beispiel sehen wir uns das unterstützte Mindest-Commit für Matter Release 5 von Google Home an:
$ 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
Als Nächstes prüfen wir die im ESP32-GitHub-Workflow verwendete Version, um festzustellen, welches Docker-Image am besten zu unserem Build passt:
$ cat .github/workflows/examples-esp32.yaml | grep chip-build | head -n 1
image: connectedhomeip/chip-build-esp32:0.5.99
Wir führen einen Container aus dem Docker-Image aus und übergeben Flags, um das Matter SDK im Container bereitzustellen und Zugriff auf das ESP32-Gerät zu gewähren.
$ 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-Container beenden und starten
Wenn Sie einen docker run
-Befehl ausführen, erstellen Sie einen neuen Container mit dem angegebenen Image. Dabei gehen die alten Daten verloren, die auf einer vorherigen Containerinstanz gespeichert wurden. Manchmal ist dies der Fall, da Sie so mit einer Neuinstallation beginnen können. In diesem Beispiel möchten Sie jedoch wahrscheinlich Ihre Arbeits- und Umgebungskonfiguration zwischen Sitzungen speichern.
user@host> docker stop container_name
Wenn Sie den Container wieder ausführen möchten, starten Sie den Container und öffnen Sie ein Terminalfenster:
user@host> docker start container_name
user@host> docker exec -it container_name /bin/bash
Mit den folgenden Methoden können Sie zusätzliche Terminalsitzungen für Ihren Container öffnen:
user@host> docker exec -it container_name /bin/bash
Oder starten Sie eine Root-Sitzung mit:
user@host> docker exec -u 0 -it container_name /bin/bash
SDK initialisieren
Im Container initialisieren wir das Matter SDK und ESP IDF:
cd /workspace
git submodule update --init --recursive
source ./scripts/activate.sh
source /opt/espressif/esp-idf/export.sh
Build und Flash
Die nächste Aufgabe besteht darin, das Image zu erstellen und das Entwicklungskit zu flashen, um das OTA-Firmwareupdate Matter zu erhalten.
Dazu müssen Sie ein Image erstellen.
Konfigurieren Sie zuerst den Build mit dem Dienstprogramm menuconfig
aus der ESP IDF.
cd examples/lighting-app/esp32
idf.py menuconfig
Konfigurieren Sie im interaktiven Menü die folgenden Einstellungen:
Component config --->
CHIP Device Layer --->
Device Identification Options --->
Lege für
Vendor ID
die von Connectivity Standards Alliance (Alliance) zugewiesene VID fest.Legen Sie für
Product ID
die PID fest, die Sie für die Matter-Integration in der Google Home Developer Console festgelegt haben.
Aktivieren Sie das Flag „OTA-Anforderer“:
Component config -->
CHIP Core -->
System options --->
OTA-Anforderer-Flag
[*] Enable OTA Requestor
aktivierenDrücken Sie zweimal die ESC, um zum Menü der obersten Ebene zurückzukehren.
Aktivieren Sie das Flag Matter für die OTA-Image-Erstellung:
Component config -->
CHIP Device Layer --->
Matter OTA Image --->
[*] Generate OTA IMAGE
Versionsnummer festlegen:
Application manager --->
[*] Get the project version from Kconfig
auswählenSetzen Sie
Project version (NEW)
auf1.0
.Drücken Sie s, um die Konfiguration zu speichern, und dann zweimal die Eingabetaste und dann q, um
menuconfig
zu beenden.
Testzertifikate einrichten
Folgen Sie der Anleitung unter Matter-Gerätetestzertifikate erstellen, um CD-, DAC- und PAI-Zertifikate zu erstellen.
Gerät zusammenstellen
Führen Sie nun den Build aus und flashen Sie das Gerät:
idf.py build
idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash
OTA-Image erstellen und hochladen
Ändere nun die Build-Einstellungen noch einmal, um ein OTA-Image zu erstellen. Verwenden Sie dasselbe Image, aber mit einer erhöhten Versionsnummer.
Führen Sie menuconfig
aus.
idf.py menuconfig
Aktualisieren Sie im interaktiven Menü Folgendes:
Application manager --->
[*] Get the project version from Kconfig
auswählen- Setzen Sie
Project version (NEW)
auf2.0
. - Drücken Sie s, um die Konfiguration zu speichern. Drücken Sie zweimal die Eingabetaste und dann q, um
menuconfig
zu beenden.
Erstellen Sie das Image und rufen Sie es ab. Das folgende Beispiel zeigt sowohl den Speicherort des Images für OTA als auch die Ausgabe beim Parsen mit 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
Da das Matter SDK von Ihrem Containerhost bereitgestellt wird, ist das OTA-Image auf Ihrem Containerhost verfügbar.
Laden Sie das OTA-Image auf Developer Console hoch. Folgen Sie dazu der Anleitung für den OTA-Upload.
Inbetriebnahme für Google Home und Beobachtung des OTA-Protokolls
Prüfen Sie, ob Ihr Gerät über USB mit dem Linux-Hostcomputer verbunden ist. Das folgende Beispiel zeigt die Verwendung von GNU screen
zum Lesen der Gerätelogs:
screen -L /dev/ttyUSB0 115200
Dadurch wird die Ausgabe des Geräts in Ihrem Terminal angezeigt und in die standardmäßige Bildschirm-Logdatei mit dem Namen screenlog.0
geschrieben.
Sie können die Datei screenlog.0
in einem anderen Texteditor öffnen oder mit cat
, tail
, more
oder grep
in einer anderen Shell anzeigen.
Drücken Sie die rote Taste zum Zurücksetzen an der Seite des Geräts, um die Bootprotokolle anzuzeigen.
In der Geräteausgabe sollten die zuvor festgelegte VID und PID sowie eine URL zu dem QR-Code-Bild zu sehen sein, mit dem Sie das Gerät in Betrieb nehmen.
[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
Achte darauf, dass dein Hub bei dir zu Hause online ist.
Setzen Sie das Gerät mit der Google Home app (GHA) in Betrieb. Verwenden Sie dazu den QR-Code aus dem Link, der in der Logdatei angezeigt wird.
Lassen Sie das Gerät nach der Inbetriebnahme einige Minuten lang ohne Unterbrechung laufen.
Sie sollten die Logausgabe zum OTA-Requestor, OTA-Image-Download und OTAImageProcessor
beobachten.
Prüfen Sie nach der Installation des Images, ob die Kompilierungszeit des Images mit der Zeit des in die Console hochgeladenen Images übereinstimmt und nach dem beim ersten Start gemeldeten Kompilierungszeitpunkt liegt. Die Ausführung von grep
mit dem folgenden Muster im Regex-Modus in screenlog.0
kann den OTA-Prozess veranschaulichen:
$ 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
Nach der ersten Ausführung können Sie die Schritte im Abschnitt OTA-Image erstellen und hochladen wiederholen, ohne ein neues Image hochzuladen. Setzen Sie die Versionen dieses Mal auf 1
zurück.
Führen Sie menuconfig
aus und gehen Sie in den interaktiven Menüoptionen so vor:
Component config -->
CHIP Device Layer --->
Device Identification Options
Setzen Sie
Version String
aufv1.0
.Setzen Sie
Device Software Version Number
auf1
.Drücken Sie s, um die Konfiguration zu speichern, und dann q, um
menuconfig
zu beenden.
Entferne das Gerät aus deinem Zuhause im GHA.
Erstellen Sie das Image, falls es noch nicht erstellt wurde:
idf.py build
Flash erstellen:
idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash
Wiederholen Sie die Schritte unter Google Home in Betrieb nehmen und beobachten Sie bei Bedarf das OTA-Update.
OTA-Softwareupdate validieren
Die Softwareversion des Geräts kann in der Google Home App (GHA) geprüft werden. Sobald ein Gerät in Betrieb genommen wurde, gehen Sie so vor:
- Gerätekachel auf dem Hauptbildschirm von GHA lange drücken
- Tippe oben rechts auf das Symbol .
- Tippen Sie auf Technische Daten.
- Überprüfen Sie das Feld Softwareversion.