Wb-mcu-fw-updater

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

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

Для всех устройств 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 (приобретённых после мая 2020) утилита доступна сразу. На контроллеры, приобретённые ранее, утилита устанавливается следующими командами:

apt update
apt install python-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

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

Режим "update":

Обновление одного устройства с известный slaveid. Если адрес устройства неизвестен, утилита, с согласия пользователя, задаст устройству адрес 245. Далее, утилита считывает версию прошивки устройства и проверяет необходимость обновления. Если есть прошивка новее - скачивает и устанавливает её.

Для успешной работы в данном режиме, нужно освободить порт, к которому подключено устройство, от других драйверов (например, остановив на время wb-mqtt-serial).

Режим "recover":

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

Для успешной работы в данном режиме, нужно освободить порт, к которому подключено устройство, от других драйверов (например, остановив на время wb-mqtt-serial).

Режим "update-all":

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

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

wb-mcu-fw-updater <port> <общие для всех режимов ключи/флаги> <режим работы> <ключи/флаги для этого режима>

Параметр	Описание	Значение по умолчанию
Общие для всех режимов. Ключи со значением (-<ключ> <значение>)
	Порт, к которому подключено устройство. Позиционный аргумент	обязательный
-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

4. Дождаться завершения обновления и перезапустить драйвер, если он был остановлен.

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

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

1. Убедиться, что устройство - единственное на шине.
2. Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:

wb-mcu-fw-updater <порт, на которм находится устройство> update

4. Подтвердить задание устройству адреса 245 (можно изменить в настройках утилиты).
5. Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно

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

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

1. Запустить утилиту wb-mcu-fw-updater со следующими ключами:

wb-mcu-fw-updater <порт, на которм находится устройство> update-all

2. Дождаться завершения обновления всех устройств.

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

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

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

wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> recover --model-name <полное название модели>

4. Если 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 <полное название модели>

4. Согласиться с восстановлением настроек к заводским.
5. Дождаться окончания прошивки.