Wb-mcu-fw-updater: различия между версиями
Vdromanov (обсуждение | вклад) |
|||
(не показано 60 промежуточных версий 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]. | |||
Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid (опционально). | |||
== | === Утилита wb-mcu-fw-updater === | ||
==== Установка: ==== <!--T:5--> | |||
На контроллерах Wiren Board (приобретённых после мая 2020) утилита доступна сразу. На контроллеры, приобретённые ранее, утилита устанавливается следующими командами: | |||
<pre> | |||
apt update | |||
apt install python-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-fw-flasher. | |||
# Установить собранный deb-пакет командами: | |||
<pre> | |||
apt update | |||
apt install ./<путь_до_собранного_пакета>.deb | |||
</pre> | |||
=== | ==== Интерфейс и режимы работы: ==== <!--T:7--> | ||
[[File:Wb-mcu-fw-updater interface.png||center||Help доступен при запуске утилиты с ключом -h]] | |||
===== Режим "update": ===== <!--T:8--> | |||
[[File:Bootloader.gif||right||Индикация режима загрузчика]] | |||
! | Обновление одного устройства с известный slaveid. Если адрес устройства неизвестен, утилита, с согласия пользователя, задаст устройству адрес 245. Далее, утилита считывает версию прошивки устройства и проверяет необходимость обновления. Если есть прошивка новее - скачивает и устанавливает её. | ||
| | |||
Для успешной работы в данном режиме, '''нужно освободить порт, к которому подключено устройство, от других драйверов''' (например, остановив на время wb-mqtt-serial). | |||
===== Режим "recover": ===== <!--T:9--> | |||
Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания модели устройства, утилита скачивает самую свежую прошивку для него и прошивает её через бутлоадер. Режим предназначен для использования '''только в бутлоадере''' (устройство мигает зелёным светодиодом примерно 1 раз в секунду). | |||
''' | Для успешной работы в данном режиме, '''нужно освободить порт, к которому подключено устройство, от других драйверов''' (например, остановив на время wb-mqtt-serial). | ||
Утилита | ===== Режим "update-all": ===== <!--T:10--> | ||
Обновление производится для всех устройств, работающих через wb-mqtt-serial. Поддерживается только на устройствах Wiren Board '''(для работы нужен драйвер wb-mqtt-serial)'''. Утилита останавливает драйвер, для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf проверяет наличие обновления и устанавливает его, если имеется. После этого, драйвер перезапускается, а пользователю возвращается список устройств, обновление которых не удалось (если таковые имеются). | |||
==== Ключи и порядок запуска wb-mcu-fw-updater: ==== <!--T:11--> | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ wb-mcu-fw-updater <port> <общие для всех режимов ключи/флаги> <режим работы> <ключи/флаги для этого режима> | |||
! Параметр !! Описание !! Значение по умолчанию | ! Параметр !! Описание !! Значение по умолчанию | ||
|- | |||
!colspan="3"|Общие для всех режимов. Ключи со значением (-<ключ> <значение>) | |||
|- | |- | ||
| || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | | || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | ||
|- | |- | ||
| -a, --slaveid || Modbus адрес устройства || | | -a, --slaveid || Modbus адрес устройства || 0 | ||
|- | |- | ||
|- | |- | ||
| - | | --save-to || Принудительно скачать прошивку в файл <значение_аргумента> || None | ||
|- | |- | ||
|- | |- | ||
| -- | | --version || Скачивать прошивку определённой версии || latest | ||
|- | |- | ||
|- | |- | ||
| - | | --branch || Скачивать прошивку из ветки разработки (не рекомендуется!) || None | ||
|- | |- | ||
| --mode || Обновлять прошивку или бутлоадер || fw | |||
|- | |- | ||
| - | !colspan="3"|Общие для всех режимов. Флаги (-<ключ>) | ||
|- | |- | ||
| --debug || Отображать подробные логи работы || None | |||
|- | |- | ||
|- | |- | ||
| --restore-defaults || Восстановить настройки устройства к заводским || False | |||
|- | |- | ||
| - | !colspan="3"|Режим "update". Флаги (-<ключ>) | ||
|- | |- | ||
| | | --force || Произвести перепрошивку устройства даже, если установлена самая свежая прошивка || False | ||
|- | |- | ||
| - | !colspan="3"|Режим "recover". Ключи со значением (-<ключ> <значение>) | ||
|- | |- | ||
| --model-name || Полная модель устройства (например, WB-MR6C) || '''обязательный''' | |||
|- | |- | ||
|- | |- | ||
| | | --signature || Сигнатура прошивки (если известна заранее) || None | ||
|- | |- | ||
| - | !colspan="3"|Режим "update-all". Ключи со значением (-<ключ> <значение>) | ||
|- | |- | ||
| || | | --config || Путь к конфигурационному файлу wb-mqtt-serial || /etc/wb-mqtt-serial.conf | ||
|- | |- | ||
| - | !colspan="3"|Режим "update-all". Флаги (-<ключ>) | ||
|- | |- | ||
| | | --force || Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка || False | ||
|- | |- | ||
|} | |} | ||
=== Типичные сценарии обновления === <!--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 со следующими ключами: | |||
wb-mcu-fw-updater | <pre> | ||
</ | wb-mcu-fw-updater <порт, на которм находится устройство> update | ||
</pre> | |||
# <li value="4">Подтвердить задание устройству адреса '''245''' (можно изменить в настройках утилиты).</li> | |||
# Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно | |||
=== Обновление всех устройств, подключённых к драйверу === | ==== Обновление всех устройств, подключённых к драйверу: ==== <!--T:15--> | ||
Устройства должны опрашиваться драйвером wb-mqtt-serial | Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле). | ||
# Запустить утилиту | # Запустить утилиту wb-mcu-fw-updater со следующими ключами: | ||
<pre> | |||
wb-mcu-fw-updater update-all | wb-mcu-fw-updater <порт, на которм находится устройство> update-all | ||
</ | </pre> | ||
# <li value="2">Дождаться завершения обновления всех устройств.</li> | |||
</translate> | |||
Версия 15:52, 7 мая 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 (приобретённых после мая 2020) утилита доступна сразу. На контроллеры, приобретённые ранее, утилита устанавливается следующими командами:
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 |
--restore-defaults | Восстановить настройки устройства к заводским | False |
Режим "update". Флаги (-<ключ>) | ||
--force | Произвести перепрошивку устройства даже, если установлена самая свежая прошивка | False |
Режим "recover". Ключи со значением (-<ключ> <значение>) | ||
--model-name | Полная модель устройства (например, WB-MR6C) | обязательный |
--signature | Сигнатура прошивки (если известна заранее) | None |
Режим "update-all". Ключи со значением (-<ключ> <значение>) | ||
--config | Путь к конфигурационному файлу wb-mqtt-serial | /etc/wb-mqtt-serial.conf |
Режим "update-all". Флаги (-<ключ>) | ||
--force | Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка | False |
Типичные сценарии обновления
Рассмотрим порядок действий и запуск 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
- Дождаться завершения обновления всех устройств.