Wb-mcu-fw-updater: различия между версиями
Vdromanov (обсуждение | вклад) |
Vdromanov (обсуждение | вклад) |
||
Строка 19: | Строка 19: | ||
Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater]. | Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater]. | ||
Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid | Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid. | ||
=== Утилита wb-mcu-fw-updater === | === Утилита wb-mcu-fw-updater === | ||
==== Установка: ==== <!--T:5--> | ==== Установка: ==== <!--T:5--> | ||
На | На контроллеры Wiren Board утилита устанавливается следующими командами: | ||
<pre> | <pre> | ||
apt update | apt update | ||
Строка 41: | Строка 41: | ||
==== Интерфейс и режимы работы: ==== <!--T:7--> | ==== Интерфейс и режимы работы: ==== <!--T:7--> | ||
[[File:Wb-mcu-fw-updater interface.png||center||Help доступен при запуске утилиты с ключом -h]] | [[File:Wb-mcu-fw-updater interface.png||center||Help доступен при запуске утилиты с ключом -h. Для каждого режима работы тоже доступен help (пример: wb-mcu-fw-updater update-fw -h)]] | ||
===== Режим "update": ===== <!--T:8--> | ===== Режим "update": ===== <!--T:8--> |
Версия 17:30, 11 июня 2020
Статья находится в процессе редактирования!
Возможность обновления
Для всех устройств 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 python-wb-mcu-fw-updater
На другие Debian-подобные системы:
Для Ubuntu, Linux Mint, Elementary OS и других дистрибутивов, использующих пакетный менеджер apt, порядок действий примерно следующий:
- Перейти в репозиторий wb-mcu-fw-updater.
- Собрать deb-пакет по инструкции в нём.
- Установить wb-mcu-fw-flasher.
- Установить собранный 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:
Параметр | Описание | Значение по умолчанию |
---|---|---|
Общие для всех режимов. Ключи со значением (-<ключ> <значение>) | ||
Порт, к которому подключено устройство. Позиционный аргумент | обязательный | |
-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 для некоторых типичных случаев:
Обновление одного работающего устройства с известным адресом:
Устройство находится на шине с другими устройствами.
- Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
- Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства).
- Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> update
- Дождаться завершения обновления и перезапустить драйвер, если он был остановлен.
Обновление одного устройства с неизвестным адресом:
Подключить устройство на отдельную modbus-шину.
- Убедиться, что устройство - единственное на шине.
- Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
- Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> update
- Подтвердить задание устройству адреса 245 (можно изменить в настройках утилиты).
- Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно
Обновление всех устройств, подключённых к драйверу:
Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле).
- Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> update-all
- Дождаться завершения обновления всех устройств.
Восстановление прошивки на устройстве с известным адресом:
Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart остаются прежними.
- Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
- Убедиться, что устройство точно находится в бутлоадере (посмореть на зелёный светодиод).
- Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> recover --model-name <полное название модели>
- Если modbus-адрес устройства был верным, начнётся процедура прошивки.
Восстановление прошивки на устройстве с неизвестным адресом:
Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. При этом, адрес устройства неизвестен. По завершению восстановления, адрес устройства и настройки uart восстановятся к заводским (1, 9600-8-n-2).
- Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
- Убедиться, что устройство точно находится в бутлоадере (посмореть на зелёный светодиод).
- Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на котором находится устройство> recover --model-name <полное название модели>
- Согласиться с восстановлением настроек к заводским.
- Дождаться окончания прошивки.