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

Материал из Wiren Board
Строка 107: Строка 107:
|}
|}


<!--T:21-->
=== Типичные сценарии обновления === <!--T:12-->
Пример (устройство в рабочем режиме):
Рассмотрим порядок действий и запуск wb-mcu-fw-updater для некоторых типичных случаев:
<pre>
wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw
</pre>
 
<!--T:22-->
Пример для Windows (устройство в рабочем режиме):
<pre>
wb-mcu-fw-flasher.exe -j -d COM10 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw
</pre>


<!--T:23-->
==== Обновление одного работающего устройства с известным адресом: ==== <!--T:13-->
Здесь COM10 — имя виртуального последовательного порта, которое присвоено адаптеру USB RS-485.
Устройство находится на шине с другими устройствами.
 
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
<!--T:24-->
# Узнать modbus адрес обновляемого устройства (адрес по умолчанию напечатан на наклейке сбоку устройства).
Пример для устройства с нестандартными настройками UART:
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
<pre>
<pre>
wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw -b 115200
wb-mcu-fw-updater <порт, на которм находится устройство> -a <modbus адрес устройства> update
</pre>
</pre>
В данном случае, устройство работало на скорости порта 115200.
# Дождаться завершения обновления и перезапустить драйвер, если он был остановлен.
 
== Прошивка устройств == <!--T:25-->
 
<!--T:26-->
'''При прошивке с контроллера остановите wb-mqtt-serial:'''
<pre>
service wb-mqtt-serial stop
</pre>
 
<!--T:27-->
Подключите устройство к RS-485.
 
<!--T:28-->
Если вы не знаете точного аппаратного типа устройства, то его сигнатуру можно прочесть командой:
<pre>
export mbusaddr=1;  echo  -e `modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a$mbusaddr -t0x03 -r290 -c 12 | grep Data | sed -e 's/0x00/\x/g' -e 's/Data://' -e 's/s//g'`|  xxd -r -p && echo ''
</pre>   
Задайте адрес прошиваемого устройства в переменной mbusaddr.
 
<!--T:29-->
В выводе команды вы получите сигнатуру устройства, например, '''wbmr6c'''.
 
<!--T:30-->
Выберите подходящую прошивку, например, WB-MR-MR6C_MCU3_3_1.9.4.wbfw.


<!--T:31-->
==== Обновление одного устройства с неизвестным адресом: ==== <!--T:14-->
Прошейте устройство командой:
Подключить устройство на отдельную modbus-шину.
# Убедиться, что устройство - '''единственное на шине.'''
# Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
<pre>
<pre>
wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw
wb-mcu-fw-updater <порт, на которм находится устройство> update
</pre>
Успешный процесс прошивки выглядит следующим образом:
<pre>
  wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 1 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw         
  /dev/ttyRS485-1 opened successfully.
  Send jump to bootloader command and wait 2 seconds...
  Error: Connection timed out.
  May be device already in bootloader, try to send firmware...
  WB-MR-MR6C_MCU3_3_1.9.4.wbfw opened successfully, size 12136 bytes
  Sending info block... OK
  Sending data block 89 of 89... OK.
  All done!
</pre>
</pre>
# Подтвердить задание устройству адреса '''245''' (можно изменить в настройках утилиты).
# Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно


<!--T:32-->
==== Обновление всех устройств, подключённых к драйверу: ==== <!--T:15-->
'''После успешной прошивки устройство само выйдет из режима загрузчика и перезапустится в основной программе.'''
Устройства должны опрашиваться драйвером wb-mqtt-serial (находиться в его конфигурационном файле).
 
# Запустить утилиту wb-mcu-fw-updater со следующими ключами:
<!--T:33-->
Пример ошибки при несовпадении сигнатуры:
<pre>
<pre>
Sending info block...
wb-mcu-fw-updater <порт, на которм находится устройство> update-all
Error while sending info block: Slave device or server failure
Data format is invalid or firmware signature doesn't match the device
</pre>
</pre>
# Дождаться завершения обновления всех устройств.




=== Прошивка устройств по широковещательному Modbus-адресу 0 === <!--T:34-->
<!--T:35-->
Bootloader позволяет загружать прошивку на устройства по Modbus-адресу 0. Для этого устройство должно быть единственным устройством на шине и находиться в режиме загрузчика.
=== Прошивка нескольких устройств на шине === <!--T:36-->
<!--T:37-->
Возможна прошивка нескольких устройств, подключенных к шине. Устройства должны быть переведены в режим загрузчика и прошиваться по отдельности с указанием нешироковещательного Modbus-адреса. Прошивка устройств с одинаковым адресом возможна, если в режиме загрузчика находится только одно из них. Устройства прошиваются по очереди.


<!--T:38-->
'''Внимание!''' Прошивка устройств, находящимся в режиме загрузчика и имеющим одинаковый modbus-адрес, или же прошивка нескольких устройств, находящихся в режиме загрузчика по адресу 0 не будет выполнена; имеющаяся прошивка на устройствах будет испорчена.
</translate>
</translate>

Версия 15:37, 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, порядок действий примерно следующий:

  1. Перейти в репозиторий wb-mcu-fw-updater.
  2. Собрать deb-пакет по инструкции в нём.
  3. Установить wb-mcu-fw-flasher.
  4. Установить собранный deb-пакет командами:
apt update
apt install ./<путь_до_собранного_пакета>.deb

Интерфейс и режимы работы:

Help доступен при запуске утилиты с ключом -h
Режим "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:

wb-mcu-fw-updater <port> <общие для всех режимов ключи/флаги> <режим работы> <ключи/флаги для этого режима>
Параметр Описание Значение по умолчанию
Общие для всех режимов. Ключи со значением (-<ключ> <значение>)
Порт, к которому подключено устройство. Позиционный аргумент обязательный
-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 для некоторых типичных случаев:

Обновление одного работающего устройства с известным адресом:

Устройство находится на шине с другими устройствами.

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

Обновление одного устройства с неизвестным адресом:

Подключить устройство на отдельную modbus-шину.

  1. Убедиться, что устройство - единственное на шине.
  2. Остановить драйвер, опрашивающий порт с устройством (например, wb-mqtt-serial).
  3. Запустить утилиту wb-mcu-fw-updater со следующими ключами:
wb-mcu-fw-updater <порт, на которм находится устройство> update
  1. Подтвердить задание устройству адреса 245 (можно изменить в настройках утилиты).
  2. Дождаться завершения обновления и задать устройству желаемый modbus адрес. Перезапустить драйвер, если нужно

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

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

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