Утилита обновления прошивок wb-mcu-fw-updater

From Wiren Board
This is the approved revision of this page, as well as being the most recent.

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

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

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

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

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

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

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

Утилита предустановлена на все контроллеры Wiren Board, начиная с версии 5 и выше.

Если у вас её не оказалось, то можно установить из репозитория:

  1. Откройте консоль контроллера через SSH.
  2. Обновите список пакетов:
    apt update
    
  3. Установите утилиту командой:
    apt install wb-mcu-fw-updater
    

ОС Linux

Для Debian-подобных операционных систем есть скрипт, который выполняет функции утилиты wb-mcu-fw-updater и использует wb-mcu-fw-flasher.

Подготовка комплекта:

  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 Описание ключей запуска для режима Флаг
-f, --force Произвести перепрошивку устройства даже если установлена самая свежая прошивка Флаг
--restore-defaults Стирает все настройки и калибровочные значения: датчики начнут показывать ерунду.
Не используйте, если не знаете, что делаете.
Флаг

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

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

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

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

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

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

Восстановление устройства с испорченной прошивкой. Если при использовании wb-mcu-fw-updater процедура прервалась, например, пропало питание и устройство не загружается — можно воспользоваться этим режимом.

После запуска с указанием порта и 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 Описание ключей запуска для режима Флаг

Залить прошивку из файла (flash-file)

Заливает в устройство прошивку из указанного файла.

Параметр Описание Значение по умолчанию
Порт, к которому подключено устройство. Позиционный аргумент обязательный
-a, --slaveid Modbus адрес устройства обязательный
--file Путь к файлу прошивки обязательный
-h, --help Описание ключей запуска для режима Флаг
# wb-mcu-fw-updater flash-file /dev/ttyRS485-1 -a20 --file /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw 
2022-07-27 12:14:02,043 Flashing /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw
100%|#######################################################################################################|134/134

Получить debug-лог

Если в работе утилиты возникли ошибки, то при обращении в техподдержку лучше приложить debug-лог, чтобы его получить, добавьте в конце команды --debug, например:

wb-mcu-fw-updater update-fw /dev/ttyMOD1 -a32 -f --debug

Параметр работает во всех режимах.

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

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

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
    
  1. Дождаться результатов обновления.

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

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

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

Полезные ссылки