Wb-mcu-fw-updater

Это черновик страницы. Последняя правка сделана 26.05.2021 пользователем A.Degtyarev.

Общая информация

Здесь описывается wb-mcu-fw-updater — утилита для автоматического обновления прошивок modbus-устройств Wiren Board.

Краткую инструкцию по обновлению прошивки читайте в статье Обновление прошивок на устройствах Wiren Board.

Установка утилиты

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

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

Контроллер Wiren Board

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

apt update
apt install wb-mcu-fw-updater

ОС Linux

Для 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

Индикация режима загрузчика

Утилита работает в разных режимах, описание которых можно посмотреть ниже или во встроенной справке по команде wb-mcu-fw-updater <режим> -h

Обновление прошивки (update-fw)

Обновление прошивки устройства с известным modbus-адресом.

Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию ПО и производит обновление, если требуется. Этот режим гибко настраивается с помощью ключей запуска, например, в этом режиме можно устанавливать тестовые прошивки.

Параметр	Описание	Значение по умолчанию
	Порт, к которому подключено устройство. Позиционный аргумент	обязательный
-a, --slaveid	Modbus адрес устройства	обязательный
--version	Скачивать прошивку определённой версии	latest
--branch	Скачивать прошивку из ветки разработки (на свой страх и риск!)	None
-h, --help	Описание ключей запуска для режима	Флаг
--force	Произвести перепрошивку устройства даже если установлена самая свежая прошивка	Флаг
--restore-defaults	Восстановить настройки устройства к заводским	Флаг

Обновление загрузчика (update-bl)

Обновление загрузчика устройства с известным modbus-адресом.

ВНИМАНИЕ: обновление загрузчика — потенциально опасная операция. Если во время обновления загрузчика пропало питание, устройство может превратиться в «кирпич». В этом случае гарантия на него аннулируется. Чтобы избежать такой ситуации — резервируйте питание контроллера и устройства, например, с помощью UPS2.

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

Параметр	Описание	Значение по умолчанию
	Порт, к которому подключено устройство. Позиционный аргумент	обязательный
-a, --slaveid	Modbus адрес устройства	обязательный
-h, --help	Описание ключей запуска для режима	Флаг
--force	Произвести перепрошивку устройства даже если установлен самый свежий бутлоадер	Флаг

Восстановление (recover)

Восстановление устройства с испорченной прошивкой. Может быть полезно, если при обновлении прошивки пропало питание и устройство не загружается.

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

Параметр	Описание	Значение по умолчанию
	Порт, к которому подключено устройство. Позиционный аргумент	обязательный
-a, --slaveid	Modbus адрес устройства	обязательный
--fw-sig	Сигнатура прошивки (если известна заранее)	None
--restore-defaults	Восстановление настроек устройства к заводским	Флаг
-h, --help	Описание ключей запуска для режима	Флаг

Обновление прошивки всех устройств (update-all)

Доступно только на контроллерах Wiren Board.

Обновление устройств, настроенных через web-интерфейс или прописанных вручную в файле /etc/wb-mqtt-serial.conf.

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

Параметр	Описание	Значение по умолчанию
--force	Произвести перепрошивку устройств даже если на них установлена самая свежая прошивка	Флаг
-h, --help	Описание ключей запуска для режима	Флаг

Восстановление прошивки всех устройств (recover-all)

Доступно только на контроллерах Wiren Board.

Восстановление устройств, настроенных через web-интерфейс или прописанных вручную в файле /etc/wb-mqtt-serial.conf.

Для каждого обнаруженного устройства утилита проверяет его статус и, если устройство находится в режиме загрузчика — прошивает свежей прошивкой.

Параметр	Описание	Значение по умолчанию
-h, --help	Описание ключей запуска для режима	Флаг

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

Утилита имеет формат запуска:

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

Ниже рассмотрим типичные сценарии использования.

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

1. Узнать modbus-адрес обновляемого устройства и порт, к которому оно подключено, например, /dev/ttyRS485-1.
2. Запустить утилиту wb-mcu-fw-updater со следующими ключами:

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

Установка тестовой прошивки

1. Узнать modbus-адрес обновляемого устройства и порт, к которому оно подключено, например, /dev/ttyRS485-1.
2. Узнать название тестовой ветки (branch).
3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:

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

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

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

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

   wb-mcu-fw-updater update-all
   

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

Восстановление прошивки на устройстве

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

1. Узнать modbus-адрес устройства и порт, к которому оно подключено.
2. Запустить утилиту wb-mcu-fw-updater со следующими ключами:

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