Wb-mcu-fw-updater: различия между версиями
Vdromanov (обсуждение | вклад) |
Vdromanov (обсуждение | вклад) |
||
| Строка 4: | Строка 4: | ||
{{DISPLAYTITLE:Обновление прошивок на устройствах Wiren Board}} | {{DISPLAYTITLE:Обновление прошивок на устройствах Wiren Board}} | ||
<translate> | <translate> | ||
== Возможность обновления == <!--T:1--> | == Возможность обновления == <!--T:1--> | ||
<!--T:2--> | <!--T:2--> | ||
Для | Для устройств Wiren Board, работающих по протоколу Modbus RTU, доступно удалённое обновление ПО (микрокода) самого устройства. Обновление реализовано посредством прошивки файла .wbfw по шине modbus с помощью утилиты wb-mcu-fw-flasher. Подробная информация о процедуре прошивки доступна [[WB-MCU-Flasher | здесь.]] | ||
<!--T:3--> | <!--T:3--> | ||
| Строка 46: | Строка 44: | ||
===== Режим "update-fw": ===== <!--T:8--> | ===== Режим "update-fw": ===== <!--T:8--> | ||
[[File:Bootloader.gif||right||Индикация режима загрузчика]] | [[File:Bootloader.gif||right||Индикация режима загрузчика]] | ||
Обновление прошивки устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства | Обновление прошивки устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию ПО, производит обновление, если требуется. Данный режим гибко настраивается с помощью ключей запуска (см. wb-mcu-fw-updater update-fw -h). Например, в данном режиме можно устанавливать тестовые прошивки. | ||
===== Режим "update-bl": ===== <!--T:9--> | ===== Режим "update-bl": ===== <!--T:9--> | ||
Обновление бутлоадера устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства | Обновление бутлоадера устройства с известным slaveid. Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию бутлоадера и производит обновление, если требуется. '''Обновление бутлоадера - потенциально опасная операция''', поэтому, данный режим имеет минимальное количество настроек (описание ключей запуска доступно в wb-mcu-fw-updater update-bl -h). Если во время обновления бутлоадера пропало питание, устройство может превратиться в "кирпич". В таком случае, гарантия на него аннулируется. При обновлении бутлоадера, устройство будет '''автоматически прошито самой свежей прошивкой'''. | ||
===== Режим "recover": ===== <!--T:10--> | ===== Режим "recover": ===== <!--T:10--> | ||
Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания slaveid и порта, утилита попробует восстановить устройство. В случае неудачи, (с согласия пользователя), утилита пытается восстановить устройство с помощью всех доступных прошивок (процесс может быть длительным). | Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания slaveid и порта, утилита попробует восстановить устройство. В случае неудачи, (с согласия пользователя), утилита пытается восстановить устройство с помощью всех доступных прошивок (процесс может быть длительным). | ||
===== Режим "update-all": ===== <!--T: | ===== Режим "update-all": ===== <!--T:12--> | ||
'''Только для контроллеров WirenBoard'''. Обновление всех устройств, подключенных к wb-mqtt-serial (настроенных через web-интерфейс). | '''Только для контроллеров WirenBoard'''. Обновление всех устройств, подключенных к wb-mqtt-serial (настроенных через web-интерфейс). | ||
Для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf утилита проверяет наличие обновления и устанавливает его, если имеется. По завершению, пользователю вовзвращаются результаты (сколько устройство обновлено/сколько - нет) | Для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf утилита проверяет наличие обновления и устанавливает его, если имеется. По завершению, пользователю вовзвращаются результаты (сколько устройство обновлено/сколько - нет) | ||
===== Режим "recover-all": ===== <!--T: | ===== Режим "recover-all": ===== <!--T:13--> | ||
'''Только для контроллеров WirenBoard'''. Утилита проходит по всем устройствам, подключённым к wb-mqtt-serial (настроенным через web-интерфейс). Если какое-то из устройств находится в режиме бутлоадера, утилита прошивает его самой свежей прошивкой. | '''Только для контроллеров WirenBoard'''. Утилита проходит по всем устройствам, подключённым к wb-mqtt-serial (настроенным через web-интерфейс). Если какое-то из устройств находится в режиме бутлоадера, утилита прошивает его самой свежей прошивкой. | ||
==== Ключи и порядок запуска wb-mcu-fw-updater: ==== <!--T: | ==== Ключи и порядок запуска wb-mcu-fw-updater: ==== <!--T:14--> | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ wb-mcu-fw-updater <режим работы> <ключи/флаги для этого режима> | |+ wb-mcu-fw-updater <режим работы> <ключи/флаги для этого режима> | ||
| Строка 100: | Строка 98: | ||
|- | |- | ||
|- | |- | ||
| --force || Произвести перепрошивку устройства даже, если | | --force || Произвести перепрошивку устройства даже, если установлен самый свежий бутлоадер || Флаг | ||
|- | |- | ||
|- | |- | ||
| Строка 121: | Строка 119: | ||
|- | |- | ||
!colspan="3"|Режим "update-all". | !colspan="3"|Режим "update-all". Обновление прошивок всех устройств, подключённых к драйверу. | ||
|- | |- | ||
| -- | | --force || Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка || Флаг | ||
|- | |- | ||
|- | |- | ||
| -- | | -h, --help || Описание ключей запуска для режима '''update-all''' || Флаг | ||
|- | |- | ||
!colspan="3"|Режим "recover-all". Восстановление прошивок всех устройств, подключённых к драйверу. | |||
|- | |- | ||
| -h, --help || Описание ключей запуска для режима ''' | | -h, --help || Описание ключей запуска для режима '''recover-all''' || Флаг | ||
|- | |- | ||
|} | |} | ||
== Типичные сценарии | == Типичные сценарии использования == <!--T:15--> | ||
Рассмотрим порядок действий и запуск wb-mcu-fw-updater для некоторых типичных случаев: | Рассмотрим порядок действий и запуск wb-mcu-fw-updater для некоторых типичных случаев: | ||
==== Обновление | ==== Обновление прошивки устройства: ==== <!--T:16--> | ||
# Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства) и порт, к которому оно подключено (например, /dev/ttyRS485-1). | |||
# Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства). | |||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | # Запустить утилиту wb-mcu-fw-updater со следующими ключами: | ||
<pre> | <pre> | ||
wb-mcu-fw-updater <порт, на | wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства> | ||
</pre> | </pre> | ||
==== | ==== Установка тестовой прошивки: ==== <!--T:17--> | ||
# Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства) и порт, к которому оно подключено (например, /dev/ttyRS485-1). | |||
# Узнать название тестовой ветки (branch). | |||
# | |||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | # Запустить утилиту wb-mcu-fw-updater со следующими ключами: | ||
<pre> | <pre> | ||
wb-mcu-fw-updater <порт, на | wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства> --branch <ветка с тестовой прошивкой> | ||
</pre> | </pre> | ||
==== Обновление всех устройств, подключённых к драйверу: ==== <!--T: | ==== Обновление всех устройств, подключённых к драйверу: ==== <!--T:18--> | ||
Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле). | Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле). | ||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | # Запустить утилиту wb-mcu-fw-updater со следующими ключами: | ||
<pre> | <pre> | ||
wb-mcu-fw-updater | wb-mcu-fw-updater update-all | ||
</pre> | </pre> | ||
# <li value="2">Дождаться | # <li value="2">Дождаться результатов обновления.</li> | ||
==== Восстановление прошивки на устройстве | ==== Восстановление прошивки на устройстве: ==== <!--T:19--> | ||
Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart '''остаются прежними.''' | Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart '''остаются прежними.''' | ||
# | # Узнать modbus-адрес устройства и порт, к которому оно подключено. | ||
# Запустить утилиту wb-mcu-fw-updater со следующими ключами: | # Запустить утилиту wb-mcu-fw-updater со следующими ключами: | ||
<pre> | <pre> | ||
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства | wb-mcu-fw-updater recover <порт, на которм находится устройство> -a <modbus адрес устройства> | ||
</pre> | </pre> | ||
</translate> | </translate> | ||
Версия 19:09, 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". Обновление прошивок всех устройств, подключённых к драйверу. | ||
| --force | Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка | Флаг |
| -h, --help | Описание ключей запуска для режима update-all | Флаг |
| Режим "recover-all". Восстановление прошивок всех устройств, подключённых к драйверу. | ||
| -h, --help | Описание ключей запуска для режима recover-all | Флаг |
Типичные сценарии использования
Рассмотрим порядок действий и запуск 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 адрес устройства>