Как протестировать OTA на Espressif ESP32

В инструкциях ниже используется пример приложения для управления освещением из SDK Matter и плата разработки M5Stack ESP32.

Настройка среды сборки

Сначала клонируйте SDK Matter.

В этом примере мы проверяем минимальный поддерживаемый коммит для выпуска 5 Google Home: Matter

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, передавая флаги для монтирования SDK Matter в контейнере и предоставления доступа к устройству 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

В контейнере мы инициализируем SDK Matter и ESP IDF:

cd /workspace
git submodule update --init --recursive
source ./scripts/activate.sh
source /opt/espressif/esp-idf/export.sh

Сборка и прошивка

Теперь нужно создать образ и прошить комплект разработчика, чтобы получить обновление встроенного ПО Matter по беспроводной сети.

Для этого нужно создать образ.

Сначала настройте сборку с помощью утилиты menuconfig из ESP IDF.

cd examples/lighting-app/esp32
idf.py menuconfig

В интерактивном меню задайте следующие настройки:

  1. Component config --->

  2. CHIP Device Layer --->

  3. Device Identification Options --->

  4. Задайте для параметра Vendor ID значение VID, назначенное Connectivity Standards Alliance (Alliance).

  5. Задайте для параметра Product ID значение PID, которое вы указали при интеграции Matter в Google Home Developer Console.

Включите параметр OTA Requestor:

  1. Component config -->

  2. CHIP Core -->

  3. System options --->

  4. Включите параметр OTA Requestor [*] Enable OTA Requestor

  5. Чтобы вернуться в меню верхнего уровня, дважды нажмите ESC.

Включите параметр Matter для создания OTA-образа:

  1. Component config -->

  2. CHIP Device Layer --->

  3. Matter OTA Image --->

  4. [*] Generate OTA IMAGE

Укажите номер версии:

  1. Application manager --->

  2. Выбрать: [*] Get the project version from Kconfig

  3. Установить для параметра "Project version (NEW)" значение "1.0"

  4. Нажмите S, чтобы сохранить конфигурацию, дважды нажмите Ввод, а затем нажмите 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

В интерактивном меню измените следующее:

  1. Application manager --->
  2. Выбрать: [*] Get the project version from Kconfig
  3. Установить для параметра "Project version (NEW)" значение "2.0"
  4. Нажмите S, чтобы сохранить конфигурацию, дважды нажмите Ввод, а затем нажмите 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

Поскольку SDK Matter монтируется с хоста контейнера, образ OTA доступен на хосте контейнера.

Загрузите образ OTA на устройство Developer Console, следуя инструкциям по загрузке OTA.

Добавьте устройство в Google Home и проверьте, обновляется ли оно по беспроводной сети

Убедитесь, что устройство подключено к хост-компьютеру Linux через USB. В примере ниже показано, как использовать GNU screen для чтения журналов устройства.

screen -L /dev/ttyUSB0 115200

Выходные данные с устройства будут показаны в терминале и записаны в файл журнала экрана по умолчанию с названием screenlog.0.

Вы можете открыть файл screenlog.0 в другом текстовом редакторе или отобразить его в другой оболочке с помощью cat, tail, more или grep.

Нажмите красную кнопку сброса на боковой панели устройства, чтобы посмотреть журналы загрузки.

В выходных данных устройства вы должны увидеть VID и PID, которые вы установили ранее, а также URL-адрес изображения QR-кода, который вы будете использовать для ввода устройства в эксплуатацию.

[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

Убедитесь, что контроллер подключен к интернету.

Введите устройство в эксплуатацию с помощью Google Home app (GHA), используя QR-код по ссылке, которая появится в файле журнала.

После ввода в эксплуатацию дайте устройству поработать без перерывов в течение нескольких минут. Вы должны увидеть выходные данные журнала, связанные с OTA Requestor, скачиванием образа OTA и OTAImageProcessor.

После установки образа убедитесь, что время его компиляции совпадает с временем компиляции образа, загруженного в консоль, и позже времени компиляции, указанного при первой загрузке. Выполнение grep со следующим шаблоном в режиме регулярного выражения на screenlog.0 может проиллюстрировать процесс 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 и в интерактивном меню выберите:

  1. Component config -->

  2. CHIP Device Layer --->

  3. Device Identification Options

  4. Задайте для параметра Version String значение v1.0.

  5. Задайте для параметра Device Software Version Number значение 1.

  6. Нажмите S, чтобы сохранить конфигурацию, а затем Q, чтобы выйти из menuconfig.

Удалите устройство из дома в GHA.

Создайте образ, если он ещё не создан:

idf.py build

Прошивка

idf.py -p /dev/ttyUSB0 erase_flash
idf.py -p /dev/ttyUSB0 flash

При необходимости повторите шаги из раздела Комиссия Google Home и наблюдение за OTA.

Проверьте беспроводное обновление ПО

Версию ПО устройства можно проверить в приложении Google Home. После ввода устройства в эксплуатацию выполните следующие действия:

  1. Нажмите и удерживайте карточку устройства на главном экране приложения GHA.
  2. Нажмите на значок в правом верхнем углу.
  3. Нажмите Техническая информация.
  4. Проверьте поле Версия ПО.

Экран приложения Google Home с полем версии ПО