Wb-mcu-fw-updater: различия между версиями
м |
|||
(не показаны 23 промежуточные версии 7 участников) | |||
Строка 11: | Строка 11: | ||
=== Контроллер Wiren Board === | === Контроллер Wiren Board === | ||
На контроллеры Wiren Board утилита устанавливается следующими командами: | |||
<syntaxhighlight lang="bash"> | |||
apt update | apt update | ||
apt install wb-mcu-fw-updater | apt install wb-mcu-fw-updater | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== ОС Linux === | === ОС Linux === | ||
Для Ubuntu, Linux Mint, Elementary OS и других дистрибутивов, использующих пакетный менеджер apt, порядок действий примерно следующий: | |||
# Перейти в репозиторий [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater]. | |||
# Собрать deb-пакет по инструкции в нём. | |||
# Установить [[WB-MCU-Flasher | wb-mcu-fw-flasher]]. | |||
# Установить собранный deb-пакет командами: | |||
#:<syntaxhighlight lang="bash"> | |||
apt update | |||
apt install ./<путь_до_собранного_пакета>.deb | |||
</syntaxhighlight> | |||
== Режимы == | == Режимы == | ||
Строка 38: | Строка 38: | ||
Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию ПО и производит обновление, если требуется. Этот режим гибко настраивается с помощью ключей запуска, например, в этом режиме можно устанавливать тестовые прошивки. | Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию ПО и производит обновление, если требуется. Этот режим гибко настраивается с помощью ключей запуска, например, в этом режиме можно устанавливать тестовые прошивки. | ||
{| class="wikitable | {| class="wikitable" | ||
! Параметр !! Описание !! Значение по умолчанию | ! Параметр !! Описание !! Значение по умолчанию | ||
|- | |- | ||
Строка 55: | Строка 55: | ||
|- | |- | ||
|- | |- | ||
| | | --force || Произвести перепрошивку устройства даже если установлена самая свежая прошивка || Флаг | ||
|- | |- | ||
|- | |- | ||
| --restore-defaults || | | --restore-defaults || Восстановить настройки устройства к заводским || Флаг | ||
|- | |- | ||
|} | |} | ||
=== Обновление загрузчика (update-bl) === | === Обновление загрузчика (update-bl) === | ||
Обновление загрузчика устройства с известным modbus-адресом. | Обновление загрузчика устройства с известным modbus-адресом. | ||
'''ВНИМАНИЕ:''' обновление загрузчика — потенциально опасная операция. Если во время обновления загрузчика пропало питание, устройство может превратиться в «кирпич». В этом случае гарантия на него аннулируется. Чтобы избежать такой ситуации — резервируйте питание контроллера и устройства, например, с помощью [[UPS2 | UPS2]]. | |||
'''ВНИМАНИЕ:''' обновление загрузчика — потенциально опасная операция. Если во время обновления загрузчика пропало питание, устройство может превратиться в «кирпич». В этом случае гарантия на него аннулируется. Чтобы избежать такой ситуации — | |||
Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию загрузчика и производит обновление, если требуется. При обновлении загрузчика, устройство будет автоматически прошито самой свежей прошивкой. | Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию загрузчика и производит обновление, если требуется. При обновлении загрузчика, устройство будет автоматически прошито самой свежей прошивкой. | ||
{| class="wikitable" | {| class="wikitable" | ||
! Параметр !! Описание !! Значение по умолчанию | ! Параметр !! Описание !! Значение по умолчанию | ||
Строка 86: | Строка 82: | ||
|- | |- | ||
|} | |} | ||
=== Восстановление (recover) === | === Восстановление (recover) === | ||
Восстановление устройства с испорченной прошивкой. | Восстановление устройства с испорченной прошивкой. Может быть полезно, если при обновлении прошивки пропало питание и устройство не загружается. | ||
После запуска с указанием порта и modbus-адреса устройства утилита попробует его восстановить с помощью последней зашитой в него прошивкой. Если восстановление не получится, то с согласия пользователя, утилита попробует восстановить устройство с помощью всех доступных прошивок, процесс перебора может быть длительным. | После запуска с указанием порта и modbus-адреса устройства утилита попробует его восстановить с помощью последней зашитой в него прошивкой. Если восстановление не получится, то с согласия пользователя, утилита попробует восстановить устройство с помощью всех доступных прошивок, процесс перебора может быть длительным. | ||
Строка 108: | Строка 99: | ||
|- | |- | ||
|- | |- | ||
| --restore-defaults || | | --restore-defaults || Восстановление настроек устройства к заводским || Флаг | ||
|- | |- | ||
|- | |- | ||
Строка 146: | Строка 137: | ||
| -h, --help || Описание ключей запуска для режима || Флаг | | -h, --help || Описание ключей запуска для режима || Флаг | ||
|} | |} | ||
== Типичные сценарии использования == | == Типичные сценарии использования == |
Версия 20:59, 27 мая 2021
Общая информация
Здесь описывается 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, порядок действий примерно следующий:
- Перейти в репозиторий wb-mcu-fw-updater.
- Собрать deb-пакет по инструкции в нём.
- Установить wb-mcu-fw-flasher.
- Установить собранный deb-пакет командами:
apt update apt install ./<путь_до_собранного_пакета>.deb
Режимы
Утилита работает в разных режимах, описание которых можно посмотреть ниже или во встроенной справке по команде 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 <режим работы> <ключи/флаги для этого режима>
Ниже рассмотрим типичные сценарии использования.
Обновление прошивки устройства
- Узнать modbus-адрес обновляемого устройства и порт, к которому оно подключено, например,
/dev/ttyRS485-1
. - Запустить утилиту
wb-mcu-fw-updater
со следующими ключами:wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства>
Установка тестовой прошивки
- Узнать modbus-адрес обновляемого устройства и порт, к которому оно подключено, например,
/dev/ttyRS485-1
. - Узнать название тестовой ветки (branch).
- Запустить утилиту
wb-mcu-fw-updater
со следующими ключами:wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства> --branch <ветка с тестовой прошивкой>
Обновление всех устройств, подключённых к драйверу
Устройства должны опрашиваться драйвером wb-mqtt-serial, то есть находиться в его конфигурационном файле.
- Запустить утилиту
wb-mcu-fw-updater
со следующими ключами:wb-mcu-fw-updater update-all
- Дождаться результатов обновления.
Восстановление прошивки на устройстве
Устройство находится в режиме загрузчика (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart остаются прежними.
- Узнать modbus-адрес устройства и порт, к которому оно подключено.
- Запустить утилиту
wb-mcu-fw-updater
со следующими ключами:wb-mcu-fw-updater recover <порт, на котором находится устройство> -a <modbus адрес устройства>