Обновление прошивок на устройствах Wiren Board

Материал из Wiren Board



Статья находится в процессе редактирования!

Возможность обновления

Для всех устройств Wiren Board, работающих по протоколу Modbus RTU, доступно удалённое обновление ПО (микрокода) самого устройства. Обновление реализовано посредством прошивки файла .wbfw по шине modbus с помощью утилиты wb-mcu-fw-flasher. Подробная информация о процедуре прошивки доступна здесь.

Сами файлы обновлений можно скачать в репозитории fw-releases.wirenboard.com


Автоматическое обновление прошивок устройств

Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита wb-mcu-fw-updater.

Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid.

Утилита wb-mcu-fw-updater

Установка:

На контроллеры Wiren Board утилита устанавливается следующими командами:

apt update
apt install wb-mcu-fw-updater
На другие Debian-подобные системы:

Для Ubuntu, Linux Mint, Elementary OS и других дистрибутивов, использующих пакетный менеджер apt, порядок действий примерно следующий:

  1. Перейти в репозиторий wb-mcu-fw-updater.
  2. Собрать deb-пакет по инструкции в нём.
  3. Установить wb-mcu-fw-flasher.
  4. Установить собранный deb-пакет командами:
apt update
apt install ./<путь_до_собранного_пакета>.deb

Интерфейс и режимы работы:

Help доступен при запуске утилиты с ключом -h. Для каждого режима работы тоже доступен help (пример: wb-mcu-fw-updater update-fw -h)

Утилита работает в разных режимах (обновление прошивки, обновление бутлоадера, восстановление после неудачного обновления, обновление всех устройств из devices, восстановление всех устройств из devices).

Режим "update-fw":
Индикация режима загрузчика

Обновление прошивки устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства его версию ПО, производит обновление, если требуется. Данный режим гибко настраивается с помощью ключей запуска (см. wb-mcu-fw-updater update-fw -h). Например, в данном режиме можно устанавливать тестовые прошивки с новой функциональностью.

Режим "update-bl":

Обновление бутлоадера устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства его версию бутлоадера и производит обновление, если требуется. Обновление бутлоадера - потенциально опасная операция, поэтому, данный режим имеет минимальное количество настроек (описание ключей запуска доступно в wb-mcu-fw-updater update-bl -h). Если во время обновления бутлоадера пропало питание, устройство может превратиться в "кирпич". В таком случае, гарантия на него аннулируется. При обновлении бутлоадера, устройство будет автоматически прошито самой свежей прошивкой.

Режим "recover":

Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания slaveid и порта, утилита попробует восстановить устройство. В случае неудачи, (с согласия пользователя), утилита пытается восстановить устройство с помощью всех доступных прошивок (процесс может быть длительным).

Режим "update-all":

Только для контроллеров WirenBoard. Обновление всех устройств, подключенных к wb-mqtt-serial (настроенных через web-интерфейс). Для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf утилита проверяет наличие обновления и устанавливает его, если имеется. По завершению, пользователю вовзвращаются результаты (сколько устройство обновлено/сколько - нет)

Режим "recover-all":

Только для контроллеров WirenBoard. Утилита проходит по всем устройствам, подключённым к wb-mqtt-serial (настроенным через web-интерфейс). Если какое-то из устройств находится в режиме бутлоадера, утилита прошивает его самой свежей прошивкой.

Ключи и порядок запуска wb-mcu-fw-updater:

wb-mcu-fw-updater <режим работы> <ключи/флаги для этого режима>
Параметр Описание Значение по умолчанию
Общие для всех режимов. Ключи со значением (-<ключ> <значение>)
Порт, к которому подключено устройство. Позиционный аргумент обязательный
-a, --slaveid Modbus адрес устройства 0
--save-to Принудительно скачать прошивку в файл <значение_аргумента> None
--version Скачивать прошивку определённой версии latest
--branch Скачивать прошивку из ветки разработки (не рекомендуется!) None
--mode Обновлять прошивку или бутлоадер fw
Общие для всех режимов. Флаги (-<ключ>)
--debug Отображать подробные логи работы None
-h, --help Описание всех общих ключей запуска None
Режим "update". Флаги (-<ключ>)
--force Произвести перепрошивку устройства даже, если установлена самая свежая прошивка False
--restore-defaults Восстановить настройки устройства к заводским False
-h, --help Описание ключей запуска для режима update None
Режим "recover". Ключи со значением (-<ключ> <значение>)
--model-name Полная модель устройства (например, WB-MR6C) обязательный
--signature Сигнатура прошивки (если известна заранее) None
Режим "update-all". Ключи со значением (-<ключ> <значение>)
--config Путь к конфигурационному файлу wb-mqtt-serial /etc/wb-mqtt-serial.conf
Режим "update-all". Флаги (-<ключ>)
--force Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка False
-h, --help Описание ключей запуска для режима update-all None

Типичные сценарии обновления

Рассмотрим порядок действий и запуск wb-mcu-fw-updater для некоторых типичных случаев:

Обновление одного работающего устройства с известным адресом:

Устройство находится на шине с другими устройствами.

  1. Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
  2. Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства).
  3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> update
  1. Дождаться завершения обновления и перезапустить драйвер, если он был остановлен.

Обновление одного устройства с неизвестным адресом:

Подключить устройство на отдельную modbus-шину.

  1. Убедиться, что устройство - единственное на шине.
  2. Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
  3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> update
  1. Подтвердить задание устройству адреса 245 (можно изменить в настройках утилиты).
  2. Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно

Обновление всех устройств, подключённых к драйверу:

Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле).

  1. Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> update-all
  1. Дождаться завершения обновления всех устройств.

Восстановление прошивки на устройстве с известным адресом:

Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart остаются прежними.

  1. Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
  2. Убедиться, что устройство точно находится в бутлоадере (посмореть на зелёный светодиод).
  3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> recover --model-name <полное название модели>
  1. Если modbus-адрес устройства был верным, начнётся процедура прошивки.

Восстановление прошивки на устройстве с неизвестным адресом:

Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. При этом, адрес устройства неизвестен. По завершению восстановления, адрес устройства и настройки uart восстановятся к заводским (1, 9600-8-n-2).

  1. Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
  2. Убедиться, что устройство точно находится в бутлоадере (посмореть на зелёный светодиод).
  3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на котором находится устройство> recover --model-name <полное название модели>
  1. Согласиться с восстановлением настроек к заводским.
  2. Дождаться окончания прошивки.