Wb-mcu-fw-updater: различия между версиями
Vdromanov (обсуждение | вклад) |
|||
(не показано 49 промежуточных версий 8 участников) | |||
Строка 1: | Строка 1: | ||
{{DISPLAYTITLE: | <languages/> | ||
<translate> | |||
</translate> | |||
{{DISPLAYTITLE:Обновление прошивок на устройствах Wiren Board}} | |||
<translate> | |||
Статья находится в процессе редактирования! | |||
== | == Возможность обновления == <!--T:1--> | ||
<!--T:2--> | |||
Для всех устройств Wiren Board, работающих по протоколу Modbus RTU, доступно удалённое обновление ПО (микрокода) самого устройства. Обновление реализовано посредством прошивки файла .wbfw по шине modbus с помощью утилиты wb-mcu-fw-flasher. Подробная информация о процедуре прошивки доступна [[WB-MCU-Flasher | здесь.]] | |||
<!--T:3--> | |||
Сами файлы обновлений можно скачать в репозитории [http://fw-releases.wirenboard.com/?prefix=fw/ fw-releases.wirenboard.com] | |||
== Автоматическое обновление прошивок устройств == <!--T:4--> | |||
Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита [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 === | ||
==== Установка: ==== <!--T:5--> | |||
На контроллеры Wiren Board утилита устанавливается следующими командами: | |||
<pre> | |||
apt update | |||
apt install wb-mcu-fw-updater | |||
</pre> | |||
===== На другие Debian-подобные системы: ===== <!--T:6--> | |||
# | Для 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-пакет командами: | |||
<pre> | |||
apt update | apt update | ||
</ | apt install ./<путь_до_собранного_пакета>.deb | ||
</pre> | |||
==== Интерфейс и режимы работы: ==== <!--T:7--> | |||
[[File:Wb-mcu-fw-updater interface.png||center||Help доступен при запуске утилиты с ключом -h. Для каждого режима работы тоже доступен help (пример: wb-mcu-fw-updater update-fw -h)]] | |||
Утилита работает в разных режимах (обновление прошивки, обновление бутлоадера, восстановление после неудачного обновления, обновление всех устройств из devices, восстановление всех устройств из devices). | |||
===== Режим "update-fw": ===== <!--T:8--> | |||
[[File:Bootloader.gif||right||Индикация режима загрузчика]] | |||
Обновление прошивки устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства его версию ПО, производит обновление, если требуется. Данный режим гибко настраивается с помощью ключей запуска (см. wb-mcu-fw-updater update-fw -h). Например, в данном режиме можно устанавливать тестовые прошивки с новой функциональностью. | |||
=== | ===== Режим "update-bl": ===== <!--T:9--> | ||
Обновление бутлоадера устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства его версию бутлоадера и производит обновление, если требуется. '''Обновление бутлоадера - потенциально опасная операция''', поэтому, данный режим имеет минимальное количество настроек (описание ключей запуска доступно в wb-mcu-fw-updater update-bl -h). Если во время обновления бутлоадера пропало питание, устройство может превратиться в "кирпич". В таком случае, гарантия на него аннулируется. При обновлении бутлоадера, устройство будет '''автоматически прошито самой свежей прошивкой'''. | |||
== | ===== Режим "recover": ===== <!--T:10--> | ||
Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания slaveid и порта, утилита попробует восстановить устройство. В случае неудачи, (с согласия пользователя), утилита пытается восстановить устройство с помощью всех доступных прошивок (процесс может быть длительным). | |||
===== Режим "update-all": ===== <!--T:11--> | |||
'''Только для контроллеров WirenBoard'''. Обновление всех устройств, подключенных к wb-mqtt-serial (настроенных через web-интерфейс). | |||
Для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf утилита проверяет наличие обновления и устанавливает его, если имеется. По завершению, пользователю вовзвращаются результаты (сколько устройство обновлено/сколько - нет) | |||
=== | ===== Режим "recover-all": ===== <!--T:11--> | ||
'''Только для контроллеров WirenBoard'''. Утилита проходит по всем устройствам, подключённым к wb-mqtt-serial (настроенным через web-интерфейс). Если какое-то из устройств находится в режиме бутлоадера, утилита прошивает его самой свежей прошивкой. | |||
==== Ключи и порядок запуска wb-mcu-fw-updater: ==== <!--T:11--> | |||
{| class="wikitable | {| class="wikitable" | ||
|+ wb-mcu-fw-updater <режим работы> <ключи/флаги для этого режима> | |||
! Параметр !! Описание !! Значение по умолчанию | ! Параметр !! Описание !! Значение по умолчанию | ||
|- | |||
!colspan="3"|Режим "update-fw". Обновление прошивки устройства. | |||
|- | |- | ||
| || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | | || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | ||
Строка 52: | Строка 80: | ||
|- | |- | ||
|- | |- | ||
| -h, --help || Описание ключей запуска для режима || Флаг | | -h, --help || Описание ключей запуска для режима '''update-fw''' || Флаг | ||
|- | |- | ||
|- | |- | ||
| | | --force || Произвести перепрошивку устройства даже, если установлена самая свежая прошивка || Флаг | ||
|- | |- | ||
|- | |- | ||
| --restore-defaults || | | --restore-defaults || Восстановить настройки устройства к заводским || Флаг | ||
|- | |||
|- | |- | ||
= | !colspan="3"|Режим "update-bl". Обновление бутлоадера устройства. | ||
Обновление | |||
|- | |- | ||
| || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | | || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | ||
Строка 80: | Строка 97: | ||
|- | |- | ||
|- | |- | ||
| -h, --help || Описание ключей запуска для режима || Флаг | | -h, --help || Описание ключей запуска для режима '''update-bl''' || Флаг | ||
|- | |- | ||
|- | |- | ||
| --force || Произвести перепрошивку устройства даже если | | --force || Произвести перепрошивку устройства даже, если установлена самый свежий бутлоадер || Флаг | ||
|- | |||
|- | |- | ||
!colspan="3"|Режим "recover". Восстановление прошивки устройства. | |||
|- | |- | ||
| || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | | || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | ||
Строка 108: | Строка 114: | ||
|- | |- | ||
|- | |- | ||
| --restore-defaults || | | --restore-defaults || Восстановление настроек устройства к заводским || Флаг | ||
|- | |- | ||
|- | |- | ||
| -h, --help || Описание ключей запуска для режима || Флаг | | -h, --help || Описание ключей запуска для режима '''recover''' || Флаг | ||
|- | |||
|- | |- | ||
!colspan="3"|Режим "update-all". Ключи со значением (-<ключ> <значение>) | |||
|- | |- | ||
| -- | | --config || Путь к конфигурационному файлу wb-mqtt-serial || /etc/wb-mqtt-serial.conf | ||
|- | |- | ||
!colspan="3"|Режим "update-all". Флаги (-<ключ>) | |||
|- | |- | ||
| - | | --force || Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка || False | ||
|- | |- | ||
|- | |- | ||
| -h, --help || Описание ключей запуска для режима | | -h, --help || Описание ключей запуска для режима '''update-all''' || None | ||
|- | |- | ||
|} | |} | ||
== Типичные сценарии обновления == <!--T:12--> | |||
Рассмотрим порядок действий и запуск wb-mcu-fw-updater для некоторых типичных случаев: | |||
== | |||
wb-mcu-fw-updater | |||
=== | ==== Обновление одного работающего устройства с известным адресом: ==== <!--T:13--> | ||
# | Устройство находится на шине с другими устройствами. | ||
# Узнать | # Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial). | ||
# Запустить утилиту | # Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства). | ||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | |||
wb-mcu-fw-updater | <pre> | ||
</ | wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> update | ||
</pre> | |||
# <li value="4">Дождаться завершения обновления и перезапустить драйвер, если он был остановлен.</li> | |||
=== Обновление | ==== Обновление одного устройства с неизвестным адресом: ==== <!--T:14--> | ||
Подключить устройство на отдельную modbus-шину. | |||
# Запустить утилиту | # Убедиться, что устройство - '''единственное на шине.''' | ||
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial). | |||
wb-mcu-fw-updater update | # Запустить утилиту wb-mcu-fw-updater со следующими ключами: | ||
</ | <pre> | ||
wb-mcu-fw-updater <порт, на которм находится устройство> update | |||
</pre> | |||
# <li value="4">Подтвердить задание устройству адреса '''245''' (можно изменить в настройках утилиты).</li> | |||
# Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно | |||
# <li value="2">Дождаться | ==== Обновление всех устройств, подключённых к драйверу: ==== <!--T:15--> | ||
Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле). | |||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | |||
<pre> | |||
wb-mcu-fw-updater <порт, на которм находится устройство> update-all | |||
</pre> | |||
# <li value="2">Дождаться завершения обновления всех устройств.</li> | |||
=== Восстановление прошивки на устройстве === | ==== Восстановление прошивки на устройстве с известным адресом: ==== <!--T:16--> | ||
Устройство находится в режиме | Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart '''остаются прежними.''' | ||
# | # Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial). | ||
# Запустить утилиту | # Убедиться, что устройство '''точно''' находится в бутлоадере (посмореть на зелёный светодиод). | ||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | |||
wb-mcu-fw-updater | <pre> | ||
</ | wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> recover --model-name <полное название модели> | ||
</pre> | |||
# <li value="4">Если modbus-адрес устройства был верным, начнётся процедура прошивки.</li> | |||
== | ==== Восстановление прошивки на устройстве с неизвестным адресом: ==== <!--T:17--> | ||
Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. При этом, адрес устройства неизвестен. По завершению восстановления, адрес устройства и настройки uart '''восстановятся к заводским (1, 9600-8-n-2).''' | |||
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial). | |||
# Убедиться, что устройство '''точно''' находится в бутлоадере (посмореть на зелёный светодиод). | |||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | |||
<pre> | |||
wb-mcu-fw-updater <порт, на котором находится устройство> recover --model-name <полное название модели> | |||
</pre> | |||
# <li value="4">Согласиться с восстановлением настроек к заводским.</li> | |||
# Дождаться окончания прошивки. | |||
</translate> |
Версия 18:45, 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 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
Интерфейс и режимы работы:
Утилита работает в разных режимах (обновление прошивки, обновление бутлоадера, восстановление после неудачного обновления, обновление всех устройств из devices, восстановление всех устройств из devices).
Режим "update-fw":
Обновление прошивки устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства его версию ПО, производит обновление, если требуется. Данный режим гибко настраивается с помощью ключей запуска (см. wb-mcu-fw-updater update-fw -h). Например, в данном режиме можно устанавливать тестовые прошивки с новой функциональностью.
Режим "update-bl":
Обновление бутлоадера устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства его версию бутлоадера и производит обновление, если требуется. Обновление бутлоадера - потенциально опасная операция, поэтому, данный режим имеет минимальное количество настроек (описание ключей запуска доступно в wb-mcu-fw-updater update-bl -h). Если во время обновления бутлоадера пропало питание, устройство может превратиться в "кирпич". В таком случае, гарантия на него аннулируется. При обновлении бутлоадера, устройство будет автоматически прошито самой свежей прошивкой.
Режим "recover":
Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания slaveid и порта, утилита попробует восстановить устройство. В случае неудачи, (с согласия пользователя), утилита пытается восстановить устройство с помощью всех доступных прошивок (процесс может быть длительным).
Режим "update-all":
Только для контроллеров WirenBoard. Обновление всех устройств, подключенных к wb-mqtt-serial (настроенных через web-интерфейс). Для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf утилита проверяет наличие обновления и устанавливает его, если имеется. По завершению, пользователю вовзвращаются результаты (сколько устройство обновлено/сколько - нет)
Режим "recover-all":
Только для контроллеров WirenBoard. Утилита проходит по всем устройствам, подключённым к wb-mqtt-serial (настроенным через web-интерфейс). Если какое-то из устройств находится в режиме бутлоадера, утилита прошивает его самой свежей прошивкой.
Ключи и порядок запуска wb-mcu-fw-updater:
Параметр | Описание | Значение по умолчанию |
---|---|---|
Режим "update-fw". Обновление прошивки устройства. | ||
Порт, к которому подключено устройство. Позиционный аргумент | обязательный | |
-a, --slaveid | Modbus адрес устройства | обязательный |
--version | Скачивать прошивку определённой версии | latest |
--branch | Скачивать прошивку из ветки разработки (на свой страх и риск!) | None |
-h, --help | Описание ключей запуска для режима update-fw | Флаг |
--force | Произвести перепрошивку устройства даже, если установлена самая свежая прошивка | Флаг |
--restore-defaults | Восстановить настройки устройства к заводским | Флаг |
Режим "update-bl". Обновление бутлоадера устройства. | ||
Порт, к которому подключено устройство. Позиционный аргумент | обязательный | |
-a, --slaveid | Modbus адрес устройства | обязательный |
-h, --help | Описание ключей запуска для режима update-bl | Флаг |
--force | Произвести перепрошивку устройства даже, если установлена самый свежий бутлоадер | Флаг |
Режим "recover". Восстановление прошивки устройства. | ||
Порт, к которому подключено устройство. Позиционный аргумент | обязательный | |
-a, --slaveid | Modbus адрес устройства | обязательный |
--fw-sig | Сигнатура прошивки (если известна заранее) | None |
--restore-defaults | Восстановление настроек устройства к заводским | Флаг |
-h, --help | Описание ключей запуска для режима recover | Флаг |
Режим "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 <полное название модели>
- Согласиться с восстановлением настроек к заводским.
- Дождаться окончания прошивки.