W poniższych instrukcjach użyto przykładowej aplikacji do oświetlenia z pakietu SDK Matter i platformy programistycznej M5Stack ESP32.
Konfiguracja środowiska kompilacji
Najpierw skopiuj pakiet SDK Matter.
W tym przykładzie sprawdzamy minimalne obsługiwane zobowiązanie dotyczące Google Home Matter w wersji 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
Następnie sprawdzamy wersję używaną w przepływie pracy ESP32 GitHub, aby określić, który obraz Dockera najlepiej pasuje do naszej kompilacji:
$ cat .github/workflows/examples-esp32.yaml | grep chip-build | head -n 1
image: connectedhomeip/chip-build-esp32:0.5.99
Uruchamiamy kontener z obrazu Dockera, przekazując flagi umożliwiające podłączenie pakietu SDK Matter w kontenerze i zapewnienie dostępu do urządzenia 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
Zatrzymywanie i uruchamianie kontenera Dockera Matter
Za każdym razem, gdy uruchamiasz polecenie docker run
, tworzysz nowy kontener z określonym obrazem. Gdy to zrobisz, stare dane, które zostały zapisane w poprzedniej instancji kontenera, zostaną utracone. Czasem właśnie tego oczekujesz, ponieważ umożliwia to rozpoczęcie nowej instalacji. W tym przykładzie najprawdopodobniej chcesz zapisać konfigurację pracy i środowiska między sesjami.
user@host> docker stop container_name
Gdy wszystko będzie gotowe do ponownego uruchomienia, uruchom kontener i otwórz okno terminala:
user@host> docker start container_name
user@host> docker exec -it container_name /bin/bash
Dodatkowe sesje terminala możesz otwierać do swojego kontenera za pomocą:
user@host> docker exec -it container_name /bin/bash
Możesz też rozpocząć sesję główną za pomocą:
user@host> docker exec -u 0 -it container_name /bin/bash
Zainicjuj pakiet SDK
W kontenerze zainicjujemy pakiet Matter SDK i ESP IDF:
cd /workspace
git submodule update --init --recursive
source ./scripts/activate.sh
source /opt/espressif/esp-idf/export.sh
Kompiluj i flashuj
Następnym zadaniem jest utworzenie obrazu i wgranie pakietu programistycznego, aby otrzymać aktualizację oprogramowania OTA Matter.
Aby to zrobić, musisz utworzyć obraz.
Najpierw skonfiguruj kompilację za pomocą narzędzia menuconfig
z ESP IDF.
cd examples/lighting-app/esp32
idf.py menuconfig
W interaktywnym menu skonfiguruj następujące ustawienia:
Component config --->
CHIP Device Layer --->
Device Identification Options --->
Ustaw
Vendor ID
na identyfikator VID przypisany do: Connectivity Standards Alliance (Alliance).Ustaw
Product ID
na identyfikator PID ustawiony w integracji Matter w Google Home Developer Console.
Włącz flagę żądającego OTA:
Component config -->
CHIP Core -->
System options --->
Włącz flagę żądającego OTA
[*] Enable OTA Requestor
Naciśnij dwukrotnie ESC, aby powrócić do menu najwyższego poziomu.
Włącz flagę tworzenia obrazów OTA Matter:
Component config -->
CHIP Device Layer --->
Matter OTA Image --->
[*] Generate OTA IMAGE
Ustaw numer wersji:
Application manager --->
Wybierz
[*] Get the project version from Kconfig
Ustaw wartość
Project version (NEW)
na1.0
Naciśnij S, aby zapisać konfigurację. Naciśnij dwukrotnie Enter, a następnie Q, aby wyjść z trybu
menuconfig
.
Skonfiguruj certyfikaty testowe
Wykonaj czynności opisane w artykule Tworzenie certyfikatów testowych urządzeń Matter, aby utworzyć certyfikaty CD, DAC i PAI.
Zbuduj urządzenie
Teraz uruchom kompilację i załaduj urządzenie:
idf.py build
idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash
Tworzenie i przesyłanie obrazu OTA
Następnie ponownie zmień ustawienia kompilacji, aby utworzyć obraz OTA. Użyj tego samego obrazu, ale o zwiększonym numerze wersji.
Uruchom menuconfig
.
idf.py menuconfig
W interaktywnym menu zaktualizuj te dane:
Application manager --->
- Wybierz
[*] Get the project version from Kconfig
- Ustaw wartość
Project version (NEW)
na2.0
- Naciśnij s, aby zapisać konfigurację. Naciśnij dwukrotnie Enter, a następnie naciśnij Q, aby zamknąć tryb
menuconfig
.
Tworzenie i pobieranie obrazu. W poniższym przykładzie widać zarówno lokalizację obrazu na potrzeby OTA, jak i danych wyjściowych podczas analizy składni 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
Pakiet SDK Matter jest podłączany z hosta kontenera, dlatego obraz OTA jest dostępny na hoście kontenera.
Prześlij obraz OTA do usługi Developer Console, postępując zgodnie z instrukcjami przesyłania OTA.
Prowizja dla Google Home i obserwacja OTA
Upewnij się, że urządzenie jest podłączone przez USB do hosta z systemem Linux. Ten przykład pokazuje użycie programu GNU screen
do odczytu dzienników urządzenia:
screen -L /dev/ttyUSB0 115200
Spowoduje to wyświetlenie danych wyjściowych z urządzenia w terminalu i zapisanie tych samych danych w domyślnym pliku dziennika ekranu o nazwie screenlog.0
.
Plik screenlog.0
możesz otworzyć w innym edytorze tekstu lub wyświetlić go w innej powłoce za pomocą cat
, tail
, more
lub grep
.
Naciśnij czerwony przycisk resetowania z boku urządzenia, aby wyświetlić dzienniki uruchamiania.
W danych wyjściowych urządzenia powinny pojawić się ustawione przez Ciebie wcześniej ustawienia VID i PID oraz adres URL obrazu kodu QR, którego będziesz używać do uruchamiania urządzenia.
[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
Sprawdź, czy urządzenie Hub w domu jest online.
Przekaż urządzenie do: Google Home app (GHA), używając kodu QR z linku podanego w pliku dziennika.
Po uruchomieniu urządzenie powinno działać nieprzerwanie przez kilka minut.
Powinny się wyświetlać logi dotyczące żądania OTA, pobierania obrazu OTA i OTAImageProcessor
.
Po zainstalowaniu obrazu zobacz, że czas kompilacji obrazu jest zgodny z czasem przesłanym do konsoli i późniejszym niż ten zaraportowany przy pierwszym uruchomieniu. Wykonanie polecenia grep
z tym wzorcem w trybie wyrażenia regularnego w screenlog.0
może zilustrować proces 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
Po pierwszym wykonaniu możesz powtórzyć czynności opisane w sekcji Tworzenie i przesyłanie obrazu OTA bez przesyłania nowego obrazu. Tym razem ustaw wersje z powrotem na 1
.
Uruchom menuconfig
i w opcjach interaktywnego menu:
Component config -->
CHIP Device Layer --->
Device Identification Options
Ustaw wartość
Version String
nav1.0
.Ustaw wartość
Device Software Version Number
na1
.Naciśnij S, aby zapisać konfigurację, a następnie Q, aby zamknąć tryb
menuconfig
.
Usuń urządzenie z domu w: GHA.
Utwórz obraz, jeśli nie został jeszcze skompilowany:
idf.py build
Flash:
idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash
W razie potrzeby powtórz czynności opisane w sekcji Przekazywanie do Google Home i obserwuj OTA.
Zweryfikuj aktualizację oprogramowania OTA
Wersję oprogramowania urządzenia można sprawdzić w aplikacji Google Home (GHA). Po udostępnieniu urządzenia wykonaj te czynności:
- Przytrzymaj kafelek urządzenia na ekranie głównym aplikacji GHA
- Kliknij ikonę w prawym górnym rogu.
- Kliknij Informacje techniczne.
- Sprawdź pole Wersja oprogramowania