Wb-mcu-fw-updater: различия между версиями

Материал из Wiren Board
 
(не показано 59 промежуточных версий 8 участников)
Строка 1: Строка 1:
<languages/>
{{DISPLAYTITLE:Утилита обновления прошивок wb-mcu-fw-updater}}
<translate>
== Общая информация ==
</translate>
Здесь описывается <code>wb-mcu-fw-updater</code> — утилита для автоматического обновления прошивок modbus-устройств Wiren Board.
{{DISPLAYTITLE:Обновление прошивок на устройствах Wiren Board}}
<translate>


Статья находится в процессе редактирования!
Краткую инструкцию по обновлению прошивки читайте в статье [[WB Modbus Devices Firmware Update | Обновление прошивок на устройствах Wiren Board]].


== Возможность обновления == <!--T:1-->
== Установка утилиты ==  
Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater].


<!--T:2-->
Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid.
Для всех устройств Wiren Board, работающих по протоколу Modbus RTU, доступно удалённое обновление ПО (микрокода) самого устройства. Обновление реализовано посредством прошивки файла .wbfw по шине modbus с помощью утилиты wb-mcu-fw-flasher. Подробная информация о процедуре прошивки доступна [[WB-MCU-Flasher | здесь.]]


<!--T:3-->
=== Контроллер Wiren Board ===
Сами файлы обновлений можно скачать в репозитории [http://fw-releases.wirenboard.com/?prefix=fw/ fw-releases.wirenboard.com]
Утилита предустановлена на все контроллеры Wiren Board, начиная с версии 5 и выше.


Если у вас её не оказалось, то можно установить из репозитория:
# Откройте консоль контроллера через [[SSH]].
# Обновите список пакетов:
#:<syntaxhighlight lang="bash">
apt update
</syntaxhighlight>
# Установите утилиту командой:
#:<syntaxhighlight lang="bash">
apt install wb-mcu-fw-updater
</syntaxhighlight>


== Автоматическое обновление прошивок устройств == <!--T:4-->
=== ОС Linux ===
Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater].
{{Anchor|linux}}
Wb-mcu-fw-updater не поддерживается на других платформах. Для Debian-подобных операционных систем есть утилита [[Wb-mcu-fw-flasher |wb-mcu-fw-flasher]].


Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid (опционально).
== Режимы ==
[[Image: Wb-mcu-fw-updater interface.png|450px|thumb|right| Help доступен при запуске утилиты с ключом -h. Для каждого режима работы тоже доступен help, например, wb-mcu-fw-updater update-fw -h]]
[[Image: Bootloader.gif|300px|thumb|right| Индикация режима загрузчика]]


=== Утилита wb-mcu-fw-updater ===
Утилита работает в разных режимах, описание которых можно посмотреть ниже или во встроенной справке по команде <code>wb-mcu-fw-updater <режим> -h</code>
==== Установка: ==== <!--T:5-->
На контроллерах Wiren Board (приобретённых после мая 2020) утилита доступна сразу. На контроллеры, приобретённые ранее, утилита устанавливается следующими командами:
<pre>
apt update
apt install python-wb-mcu-fw-updater
</pre>


===== На другие Debian-подобные системы: ===== <!--T:6-->
=== Обновление прошивки (update-fw) ===  
Для Ubuntu, Linux Mint, Elementary OS и других дистрибутивов, использующих пакетный менеджер apt, порядок действий примерно следующий:
Обновление прошивки устройства с известным modbus-адресом.  
# Перейти в репозиторий [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]]
{| class="wikitable noclear"
 
! Параметр !! Описание !! Значение по умолчанию
===== Режим "update": ===== <!--T:8-->
|-
[[File:Bootloader.gif||right||Индикация режима загрузчика]]
|  || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный'''
Обновление одного устройства с известный slaveid. Если адрес устройства неизвестен, утилита, с согласия пользователя, задаст устройству адрес 245. Далее, утилита считывает версию прошивки устройства и проверяет необходимость обновления. Если есть прошивка новее - скачивает и устанавливает её.
|-
| -a, --slaveid || Modbus адрес устройства || '''обязательный'''
|-
|-
| --version || Скачивать прошивку определённой версии || latest
|-
|-
| --branch || Скачивать прошивку из ветки разработки (на свой страх и риск!) || None
|-
|-
| -h, --help || Описание ключей запуска для режима || Флаг
|-
|-
| -f, --force || Произвести перепрошивку устройства даже если установлена самая свежая прошивка || Флаг
|-
|-
| --restore-defaults || Стирает все настройки и калибровочные значения: датчики начнут показывать ерунду. <br>Не используйте, если не знаете, что делаете. || Флаг
|-
|}


Для успешной работы в данном режиме, '''нужно освободить порт, к которому подключено устройство, от других драйверов''' (например, остановив на время wb-mqtt-serial).
=== Обновление загрузчика (update-bl) ===
{{Anchor|update-bl}}
Обновление загрузчика устройства с известным  modbus-адресом.  


===== Режим "recover": ===== <!--T:9-->
Изменения в новой версии загрузчика описаны в [[Bootloader_Changelog |журнале изменений]].
Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания модели устройства, утилита скачивает самую свежую прошивку для него и прошивает её через бутлоадер. Режим предназначен для использования '''только в бутлоадере''' (устройство мигает зелёным светодиодом примерно 1 раз в секунду).


Для успешной работы в данном режиме, '''нужно освободить порт, к которому подключено устройство, от других драйверов''' (например, остановив на время wb-mqtt-serial).
'''ВНИМАНИЕ:''' обновление загрузчика — потенциально опасная операция. Если во время обновления загрузчика пропало питание, устройство может превратиться в «кирпич». В этом случае гарантия на него аннулируется. Чтобы избежать такой ситуации — подключайте устройство напрямую к контроллеру, а также резервируйте питание контроллера и устройства, например, с помощью [[UPS2 | WB-UPS v.2]].


===== Режим "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
|-
|-
| -h, --help || Описание ключей запуска для режима || Флаг
|-
|-
| --save-to || Принудительно скачать прошивку в файл <значение_аргумента> || None
|-
|-
| --force || Произвести перепрошивку устройства даже если установлен самый свежий бутлоадер || Флаг
|-
|-
| --version || Скачивать прошивку определённой версии || latest
|}
 
Пример команды, которая обновляет загрузчик в устройстве с адресом 153, подключенного к порту /dev/ttyRS485-1:
<syntaxhighlight lang="bash">
wb-mcu-fw-updater update-bl -a 153 /dev/ttyRS485-1
</syntaxhighlight>
 
=== Восстановление (recover) ===
Восстановление устройства с испорченной прошивкой. Если при использовании <code>wb-mcu-fw-updater</code> процедура прервалась, например, пропало питание и устройство не загружается — можно воспользоваться этим режимом.
 
После запуска с указанием порта и modbus-адреса устройства утилита попробует его восстановить с помощью последней зашитой в него прошивкой. Если восстановление не получится, то с согласия пользователя, утилита попробует восстановить устройство с помощью всех доступных прошивок, процесс перебора может быть длительным.
 
{| class="wikitable"
! Параметр !! Описание !! Значение по умолчанию
|-
|-
|  || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный'''
|-
|-
| --branch || Скачивать прошивку из ветки разработки (не рекомендуется!) || None
| -a, --slaveid || Modbus адрес устройства || '''обязательный'''
|-
|-
| --mode || Обновлять прошивку или бутлоадер || fw
|-
|-
!colspan="3"|Общие для всех режимов. Флаги (-<ключ>)
| --fw-sig || Сигнатура прошивки (если известна заранее) || None
|-
|-
| --debug || Отображать подробные логи работы || None
|-
|-
| --restore-defaults || Стирает все настройки и калибровочные значения: датчики начнут показывать ерунду. <br>Не используйте, если не знаете, что делаете. || Флаг
|-
|-
| --restore-defaults || Восстановить настройки устройства к заводским || False
|-
|-
!colspan="3"|Режим "update". Флаги (-<ключ>)
| -h, --help || Описание ключей запуска для режима || Флаг
|-
|-
| --force || Произвести перепрошивку устройства даже, если установлена самая свежая прошивка || False
|}
 
=== Обновление прошивки всех устройств (update-all) ===
Доступно только на контроллерах Wiren Board.
 
Обновление устройств, настроенных через web-интерфейс или прописанных вручную в файле <code>/etc/wb-mqtt-serial.conf</code>.
 
Для каждого обнаруженного устройства утилита проверяет наличие обновления и устанавливает его, если необходимо. По завершению утилита возвращает пользователю статистику по обновленным и пропущенным устройствам.
 
{| class="wikitable"
! Параметр !! Описание !! Значение по умолчанию
|-
|-
!colspan="3"|Режим "recover". Ключи со значением (-<ключ> <значение>)
| --force || Произвести перепрошивку устройств даже если на них установлена самая свежая прошивка || Флаг
|-
|-
| --model-name || Полная модель устройства (например, WB-MR6C) || '''обязательный'''
|-
|-
| -h, --help || Описание ключей запуска для режима || Флаг
|-
|-
| --signature || Сигнатура прошивки (если известна заранее) || None
|}
 
=== Восстановление прошивки всех устройств (recover-all) ===
 
Доступно только на контроллерах Wiren Board.
 
Восстановление устройств, настроенных через web-интерфейс или прописанных вручную в файле <code>/etc/wb-mqtt-serial.conf</code>.
 
Для каждого обнаруженного устройства утилита проверяет его статус и, если устройство находится в режиме загрузчика — прошивает свежей прошивкой.
 
{| class="wikitable"
! Параметр !! Описание !! Значение по умолчанию
|-
|-
!colspan="3"|Режим "update-all". Ключи со значением (-<ключ> <значение>)
| -h, --help || Описание ключей запуска для режима || Флаг
|}
 
=== Залить прошивку из файла (flash-file) ===
 
Заливает в устройство прошивку из указанного файла.
 
{| class="wikitable"
! Параметр !! Описание !! Значение по умолчанию
|-
|-
| --config || Путь к конфигурационному файлу wb-mqtt-serial || /etc/wb-mqtt-serial.conf
| ||Порт, к которому подключено устройство. Позиционный аргумент  || '''обязательный'''
|-
|-
!colspan="3"|Режим "update-all". Флаги (-<ключ>)
| -a, --slaveid || Modbus адрес устройства || '''обязательный'''
|-
|-
| --force || Произвести перепрошивку устройств даже, если на них установлена самая свежая прошивка || False
| --file || Путь к файлу прошивки || '''обязательный'''
|-
|-
| -h, --help || Описание ключей запуска для режима || Флаг
|}
|}


=== Типичные сценарии обновления === <!--T:12-->
<syntaxhighlight lang="console">
Рассмотрим порядок действий и запуск wb-mcu-fw-updater для некоторых типичных случаев:
# wb-mcu-fw-updater flash-file /dev/ttyRS485-1 --conn-settings 115200N2 -a20 --file /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw
2022-07-27 12:14:02,043 Flashing /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw
100%|#######################################################################################################|134/134
</syntaxhighlight>
 
=== Получить debug-лог ===
Если в работе утилиты возникли ошибки, то при обращении в техподдержку лучше приложить debug-лог, чтобы его получить, добавьте в конце команды <code>--debug</code>, например:
<syntaxhighlight lang="bash">
wb-mcu-fw-updater update-fw /dev/ttyMOD1 -a32 -f --debug
</syntaxhighlight>
 
Параметр работает во всех режимах.
 
== Типичные сценарии использования ==
 
Утилита имеет формат запуска:
<syntaxhighlight lang="bash">
wb-mcu-fw-updater <режим работы> <ключи/флаги для этого режима>
</syntaxhighlight>
 
Ниже рассмотрим типичные сценарии использования.
 
=== Обновление прошивки устройства ===
# Узнать [[Определение и изменение Modbus-адреса устройств Wirenboard | modbus-адрес]] обновляемого устройства и порт, к которому оно подключено, например, <code>/dev/ttyRS485-1</code>.
# Запустить утилиту <code>wb-mcu-fw-updater</code> со следующими ключами:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства>
</syntaxhighlight>


==== Обновление одного работающего устройства с известным адресом: ==== <!--T:13-->
=== Установка тестовой прошивки ===  
Устройство находится на шине с другими устройствами.
# Узнать [[Определение и изменение Modbus-адреса устройств Wirenboard | modbus-адрес]] обновляемого устройства и порт, к которому оно подключено, например, <code>/dev/ttyRS485-1</code>.
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
# Узнать название тестовой ветки (branch).
# Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства).
# Запустить утилиту <code>wb-mcu-fw-updater</code> со следующими ключами:
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
#:<syntaxhighlight lang="bash">
<pre>
wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства> --branch <ветка с тестовой прошивкой>
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> update
</syntaxhighlight>
</pre>
# <li value="4">Дождаться завершения обновления и перезапустить драйвер, если он был остановлен.</li>


==== Обновление одного устройства с неизвестным адресом: ==== <!--T:14-->
=== Обновление всех устройств, подключённых к драйверу ===  
Подключить устройство на отдельную modbus-шину.
Устройства должны опрашиваться драйвером wb-mqtt-serial, то есть находиться в его конфигурационном файле.
# Убедиться, что устройство - '''единственное на шине.'''
# Запустить утилиту <code>wb-mcu-fw-updater</code> со следующими ключами:
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
#:<syntaxhighlight lang="bash">
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater update-all
<pre>
</syntaxhighlight>
wb-mcu-fw-updater <порт, на которм находится устройство> update
</pre>
# <li value="4">Подтвердить задание устройству адреса '''245''' (можно изменить в настройках утилиты).</li>
# Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно


==== Обновление всех устройств, подключённых к драйверу: ==== <!--T:15-->
# <li value="2">Дождаться результатов обновления.</li>
Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле).
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
<pre>
wb-mcu-fw-updater <порт, на которм находится устройство> update-all
</pre>
# <li value="2">Дождаться завершения обновления всех устройств.</li>


==== Восстановление прошивки на устройстве: ==== <!--T:16-->
=== Восстановление прошивки на устройстве ===  
Устройство находится в режиме бутлоадера (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы.
Устройство находится в режиме загрузчика (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart остаются прежними.
# Подключить устройство к отдельной шине modbus; убедиться, что устройство - '''единственное на шине.'''
# Узнать modbus-адрес устройства и порт, к которому оно подключено.
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
# Запустить утилиту <code>wb-mcu-fw-updater</code> со следующими ключами:
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
#:<syntaxhighlight lang="bash">
<pre>
wb-mcu-fw-updater recover <порт, на котором находится устройство> -a <modbus адрес устройства>
wb-mcu-fw-updater <порт, на которм находится устройство> -a<modbus адрес устройства> recover --model-name <полное название модели>
</syntaxhighlight>
</pre>
# <li value="4">Если modbus-aадрес устройства неизвестен, аргумент "-a<modbus адрес устройства>" можно опустить.</li>
# Если устройство удалось прошить по указанному адресу, он остаётся неизменным; в противном случае, '''все настройки устройства возвращаются к заводским (1, 9600-8-N2).'''


</translate>
== Полезные ссылки ==
* [[Restore factory settings Wiren Board Modbus device | Сброс Modbus-устройства Wiren Board к заводским настройкам]]
* [[WB Modbus Devices Firmware Update | Обновление прошивки Modbus-устройств Wiren Board]]
* [[wb-mcu-fw-flasher | Сервисная утилита wb-mcu-fw-flasher]]

Текущая версия на 13:33, 18 декабря 2023

Общая информация

Здесь описывается wb-mcu-fw-updater — утилита для автоматического обновления прошивок modbus-устройств Wiren Board.

Краткую инструкцию по обновлению прошивки читайте в статье Обновление прошивок на устройствах Wiren Board.

Установка утилиты

Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита wb-mcu-fw-updater.

Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid.

Контроллер Wiren Board

Утилита предустановлена на все контроллеры Wiren Board, начиная с версии 5 и выше.

Если у вас её не оказалось, то можно установить из репозитория:

  1. Откройте консоль контроллера через SSH.
  2. Обновите список пакетов: 
    apt update
  3. Установите утилиту командой: 
    apt install wb-mcu-fw-updater

ОС Linux

Wb-mcu-fw-updater не поддерживается на других платформах. Для Debian-подобных операционных систем есть утилита wb-mcu-fw-flasher.

Режимы

Help доступен при запуске утилиты с ключом -h. Для каждого режима работы тоже доступен help, например, wb-mcu-fw-updater update-fw -h
Индикация режима загрузчика

Утилита работает в разных режимах, описание которых можно посмотреть ниже или во встроенной справке по команде wb-mcu-fw-updater <режим> -h

Обновление прошивки (update-fw)

Обновление прошивки устройства с известным modbus-адресом.

Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию ПО и производит обновление, если требуется. Этот режим гибко настраивается с помощью ключей запуска, например, в этом режиме можно устанавливать тестовые прошивки.

Параметр Описание Значение по умолчанию
Порт, к которому подключено устройство. Позиционный аргумент обязательный
-a, --slaveid Modbus адрес устройства обязательный
--version Скачивать прошивку определённой версии latest
--branch Скачивать прошивку из ветки разработки (на свой страх и риск!) None
-h, --help Описание ключей запуска для режима Флаг
-f, --force Произвести перепрошивку устройства даже если установлена самая свежая прошивка Флаг
--restore-defaults Стирает все настройки и калибровочные значения: датчики начнут показывать ерунду.
Не используйте, если не знаете, что делаете.		 Флаг

Обновление загрузчика (update-bl)

Обновление загрузчика устройства с известным modbus-адресом.

Изменения в новой версии загрузчика описаны в журнале изменений.

ВНИМАНИЕ: обновление загрузчика — потенциально опасная операция. Если во время обновления загрузчика пропало питание, устройство может превратиться в «кирпич». В этом случае гарантия на него аннулируется. Чтобы избежать такой ситуации — подключайте устройство напрямую к контроллеру, а также резервируйте питание контроллера и устройства, например, с помощью WB-UPS v.2.

Утилита сама находит настройки соединения с устройством, запрашивает у устройства версию загрузчика и производит обновление, если требуется. При обновлении загрузчика, устройство будет автоматически прошито самой свежей прошивкой.

Параметр Описание Значение по умолчанию
Порт, к которому подключено устройство. Позиционный аргумент обязательный
-a, --slaveid Modbus адрес устройства обязательный
-h, --help Описание ключей запуска для режима Флаг
--force Произвести перепрошивку устройства даже если установлен самый свежий бутлоадер Флаг

Пример команды, которая обновляет загрузчик в устройстве с адресом 153, подключенного к порту /dev/ttyRS485-1: 

wb-mcu-fw-updater update-bl -a 153 /dev/ttyRS485-1

Восстановление (recover)

Восстановление устройства с испорченной прошивкой. Если при использовании wb-mcu-fw-updater процедура прервалась, например, пропало питание и устройство не загружается — можно воспользоваться этим режимом.

После запуска с указанием порта и 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 Описание ключей запуска для режима Флаг

Залить прошивку из файла (flash-file)

Заливает в устройство прошивку из указанного файла.

Параметр Описание Значение по умолчанию
Порт, к которому подключено устройство. Позиционный аргумент обязательный
-a, --slaveid Modbus адрес устройства обязательный
--file Путь к файлу прошивки обязательный
-h, --help Описание ключей запуска для режима Флаг 
# wb-mcu-fw-updater flash-file /dev/ttyRS485-1 --conn-settings 115200N2 -a20 --file /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw 
2022-07-27 12:14:02,043 Flashing /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw
100%|#######################################################################################################|134/134

Получить debug-лог

Если в работе утилиты возникли ошибки, то при обращении в техподдержку лучше приложить debug-лог, чтобы его получить, добавьте в конце команды --debug, например: 

wb-mcu-fw-updater update-fw /dev/ttyMOD1 -a32 -f --debug

Параметр работает во всех режимах.

Типичные сценарии использования

Утилита имеет формат запуска: 

wb-mcu-fw-updater <режим работы> <ключи/флаги для этого режима>

Ниже рассмотрим типичные сценарии использования.

Обновление прошивки устройства

  1. Узнать modbus-адрес обновляемого устройства и порт, к которому оно подключено, например, /dev/ttyRS485-1.
  2. Запустить утилиту wb-mcu-fw-updater со следующими ключами: 
    wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства>

Установка тестовой прошивки

  1. Узнать modbus-адрес обновляемого устройства и порт, к которому оно подключено, например, /dev/ttyRS485-1.
  2. Узнать название тестовой ветки (branch).
  3. Запустить утилиту wb-mcu-fw-updater со следующими ключами: 
    wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства> --branch <ветка с тестовой прошивкой>

Обновление всех устройств, подключённых к драйверу

Устройства должны опрашиваться драйвером wb-mqtt-serial, то есть находиться в его конфигурационном файле.

  1. Запустить утилиту wb-mcu-fw-updater со следующими ключами: 
    wb-mcu-fw-updater update-all
  2. Дождаться результатов обновления.

Восстановление прошивки на устройстве

Устройство находится в режиме загрузчика (зелёный светодиод мигает 1 раз в секунду) и не может запустить нормальный режим работы. По завершению восстановления, адрес устройства и настройки uart остаются прежними.

  1. Узнать modbus-адрес устройства и порт, к которому оно подключено.
  2. Запустить утилиту wb-mcu-fw-updater со следующими ключами: 
    wb-mcu-fw-updater recover <порт, на котором находится устройство> -a <modbus адрес устройства>

Полезные ссылки

Источник — https://wirenboard.com/wiki/index.php?title=Wb-mcu-fw-updater&oldid=77889