In der folgenden Anleitung wird das Beispiel Lampensteuerung 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 den Mindestwert für den unterstützten 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 zu ermitteln, welches Docker-Image am besten für unseren Build geeignet ist:
$ 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 Ihre alten Daten verloren, die in einer vorherigen Containerinstanz gespeichert waren. Manchmal ist das so, was Sie möchten, weil Sie so mit einer neuen Installation beginnen können. In diesem Beispiel sollten Sie Ihre Arbeit und die Umgebungskonfiguration jedoch zwischen den Sitzungen speichern.
user@host> docker stop container_name
Wenn Sie zur erneuten Ausführung bereit sind, starten Sie den Container und öffnen Sie ein Terminalfenster:
user@host> docker start container_name
user@host> docker exec -it container_name /bin/bash
Sie können zusätzliche Terminalsitzungen für Ihren Container mit folgenden Befehlen öffnen:
user@host> docker exec -it container_name /bin/bash
Oder Sie starten 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 die ESP-IDF:
cd /workspace
git submodule update --init --recursive
source ./scripts/activate.sh
source /opt/espressif/esp-idf/export.sh
Erstellen und flashen
Als Nächstes müssen Sie das Image erstellen und das Entwicklungskit flashen, um das Matter-OTA-Firmwareupdate zu erhalten.
Dazu müssen Sie ein Image erstellen.
Konfigurieren Sie zuerst den Build mit dem menuconfig
-Dienstprogramm 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 --->
Setze
Vendor ID
auf die von Connectivity Standards Alliance (Alliance) zugewiesene VID.Legen Sie
Product ID
auf die PID fest, die Sie in der Google Home Developer Console für die Matter-Integration festgelegt haben.
Aktiviere das Flag „OTA-Anfrage“:
Component config -->
CHIP Core -->
System options --->
Flag „OTA-Anfrage“ aktivieren
[*] Enable OTA Requestor
Drücken Sie zweimal die ESC, um zur obersten Menüebene zurückzukehren.
Aktivieren Sie das Flag Matter für die Erstellung von OTA-Images:
Component config -->
CHIP Device Layer --->
Matter OTA Image --->
[*] Generate OTA IMAGE
Legen Sie die Versionsnummer fest:
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. Drücken Sie 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 erstellen
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
Ändern Sie nun die Build-Einstellungen noch einmal, um ein OTA-Image zu erstellen. Verwenden Sie dasselbe Bild, aber mit einer inkrementellen 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, und zweimal die Eingabetaste. Drücken Sie dann q, um
menuconfig
zu beenden.
Erstellen Sie das Image und rufen Sie es ab. Das folgende Beispiel zeigt sowohl den Speicherort des Bildes für OTA als auch die Ausgabe beim Parsen mit der 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 über Ihren Containerhost bereitgestellt wird, ist das OTA-Image auf Ihrem Containerhost verfügbar.
Laden Sie das OTA-Image auf die Developer Console hoch. Folgen Sie dazu der Anleitung zum OTA-Upload.
Inbetriebnahme für Google Home und Beobachtung von Onlinereisebüros
Achten Sie darauf, dass Ihr Gerät über USB mit dem Linux-Hostcomputer verbunden ist. Das folgende Beispiel zeigt die Verwendung von GNU screen
zum Lesen der Geräteprotokolle:
screen -L /dev/ttyUSB0 115200
Dadurch wird die Ausgabe des Geräts im Terminal angezeigt und in die Standard-Bildschirmprotokolldatei screenlog.0
geschrieben.
Sie können die screenlog.0
-Datei 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 Protokolle vom Start zu sehen.
In der Geräteausgabe sollten die zuvor festgelegte VID und PID sowie eine URL zum QR-Code-Bild angezeigt werden, 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
Achten Sie darauf, dass Ihr Hub zu Hause online ist.
Stellen Sie das Gerät mit der Google Home app (GHA) über den QR-Code aus dem Link in der Protokolldatei in Betrieb.
Lassen Sie das Gerät nach der Inbetriebnahme einige Minuten lang laufen.
Sie sollten die Protokollausgabe im Zusammenhang mit OTA-Anfrage, OTA-Image-Download und OTAImageProcessor
beobachten.
Beachten Sie nach der Installation des Images, dass die Kompilierungszeit des Images mit der des Images übereinstimmt, das in die Konsole hochgeladen wurde, und nach der Kompilierungszeit liegt, die beim ersten Start gemeldet wurde. Die Ausführung von grep
mit dem folgenden Muster im Regex-Modus auf screenlog.0
kann den Over-the-air-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 wählen Sie in den interaktiven Menüoptionen Folgendes aus:
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.
Entfernen Sie das Gerät in der GHA aus Ihrem Zuhause.
Erstellen Sie das Image, falls noch nicht geschehen:
idf.py build
So flashen Sie das Gerät:
idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash
Wiederholen Sie bei Bedarf die Schritte unter Inbetriebnahme für Google Home und beobachten Sie das Over-the-Air-Update (OTA).
OTA-Softwareupdate validieren
Die Gerätesoftwareversion kann über die Google Home App (GHA) geprüft werden. Sobald ein Gerät in Betrieb genommen wurde, gehen Sie so vor:
- Halte die Gerätekachel auf dem Hauptbildschirm von GHA lange gedrückt
- Tippe oben rechts auf das Symbol .
- Tippen Sie auf Technische Daten.
- Prüfen Sie das Feld Softwareversion.