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

Версия 14:54, 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

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

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:

Параметр	Описание	Значение по умолчанию
Общие для всех режимов. Ключи со значением (-<ключ> <значение>)
	Порт, к которому подключено устройство. Позиционный аргумент	(обязательный)
-a, --slaveid	Modbus адрес устройства	0
--save-to	Принудительно скачать прошивку в файл <значение_аргумента>	None
--version	Скачивать прошивку определённой версии	latest
-a, --slaveid	Modbus адрес устройства	0
-h, --help	Отображение всех ключей запуска
--debug	Отображение подробных логов работы утилиты	None
--restore-defaults	Восстановление всех настроек устройства к заводским	False
-p	Чётность (parity)	N
-s	Количество стопбитов	2
-r	Адрес holding-регистра для перехода в режим загрузчика	129
-D	Включить режим отладки
-u	Восстановление заводских настроек UART и Modbus адреса
-e	Сброс всех настроек до заводских

Пример (устройство в рабочем режиме):

wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw

Пример для Windows (устройство в рабочем режиме):

wb-mcu-fw-flasher.exe -j -d COM10 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw

Здесь COM10 — имя виртуального последовательного порта, которое присвоено адаптеру USB RS-485.

Пример для устройства с нестандартными настройками UART:

wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw -b 115200

В данном случае, устройство работало на скорости порта 115200.

Прошивка устройств

При прошивке с контроллера остановите wb-mqtt-serial:

service wb-mqtt-serial stop

Подключите устройство к RS-485.

Если вы не знаете точного аппаратного типа устройства, то его сигнатуру можно прочесть командой:

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 ''

Задайте адрес прошиваемого устройства в переменной mbusaddr.

В выводе команды вы получите сигнатуру устройства, например, wbmr6c.

Выберите подходящую прошивку, например, WB-MR-MR6C_MCU3_3_1.9.4.wbfw.

Прошейте устройство командой:

wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw

Успешный процесс прошивки выглядит следующим образом:

   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!

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

Пример ошибки при несовпадении сигнатуры:

Sending info block...
Error while sending info block: Slave device or server failure 
Data format is invalid or firmware signature doesn't match the device

Прошивка устройств по широковещательному Modbus-адресу 0

Bootloader позволяет загружать прошивку на устройства по Modbus-адресу 0. Для этого устройство должно быть единственным устройством на шине и находиться в режиме загрузчика.

Прошивка нескольких устройств на шине

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

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

@@ Строка 19: / Строка 19: @@
 Чтобы не производить действия по выбору подходящей прошивки, её скачиванию и установке на устройство, была написана утилита [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater].
-<!--T:5-->
 Она позволяет свести весь процесс обновления прошивки устройства до указания порта, к которому устройство подключено, и его slaveid (опционально).
 === Утилита wb-mcu-fw-updater ===
-==== Установка: ==== <!--T:6-->
+==== Установка: ==== <!--T:5-->
 На контроллерах Wiren Board (приобретённых после мая 2020) утилита доступна сразу. На контроллеры, приобретённые ранее, утилита устанавливается следующими командами:
 <pre>
@@ Строка 30: / Строка 29: @@
 </pre>
-===== На другие Debian-подобные системы: ===== <!--T:8-->
+===== На другие Debian-подобные системы: ===== <!--T:6-->
 Для Ubuntu, Linux Mint, Elementary OS и других дистрибутивов, использующих пакетный менеджер apt, порядок действий примерно следующий:
 # Перейти в репозиторий [https://github.com/wirenboard/wb-mcu-fw-updater.git wb-mcu-fw-updater].
@@ Строка 41: / Строка 40: @@
 </pre>
-<!--T:5-->
+==== Интерфейс и режимы работы: ==== <!--T:7-->
+[[File:Wb-mcu-fw-updater interface.png||center||Help доступен при запуске утилиты с ключом -h]]
+===== Режим "update": ===== <!--T:8-->
 [[File:Bootloader.gif||right||Индикация режима загрузчика]]
-Устройство переходит в режим загрузчика, если:
+Обновление одного устройства с известный slaveid. Если адрес устройства неизвестен, утилита, с согласия пользователя, задаст устройству адрес 245. Далее, утилита считывает версию прошивки устройства и проверяет необходимость обновления. Если есть прошивка новее - скачивает и устанавливает её.
-* на устройстве имеется корректная прошивка — первые 2 секунды после включения питания устройство работает в режиме загрузчика;
-* на устройстве нет корректной прошивки (например, был сбой при обновлении прошивки) — в этом случае режим загрузчика активен постоянно;
-* при работе основной программы в holding-регистр 129 (0x81) была записана 1 — в этом случае устройство перезагружается и остается в режиме загрузчика 120 секунд.
-<!--T:6-->
+Для успешной работы в данном режиме, '''нужно освободить порт, к которому подключено устройство, от других драйверов''' (например, остановив на время wb-mqtt-serial).
-Индикация режима загрузчика: индикатор Status устройства редко мигает. При заливке новой прошивки индикатор перестает менять состояние.
+===== Режим "recover": ===== <!--T:9-->
+Восстановление устройства с испорченной прошивкой (например, при прошивке пропало питание, и устройство перестало загружаться). После указания модели устройства, утилита скачивает самую свежую прошивку для него и прошивает её через бутлоадер. Режим предназначен для использования '''только в бутлоадере''' (устройство мигает зелёным светодиодом примерно 1 раз в секунду).
+Для успешной работы в данном режиме, '''нужно освободить порт, к которому подключено устройство, от других драйверов''' (например, остановив на время wb-mqtt-serial).
-== Утилита для прошивки wb-mcu-fw-flasher == <!--T:15-->
+===== Режим "update-all": ===== <!--T:10-->
+Обновление производится для всех устройств, работающих через wb-mqtt-serial. Поддерживается только на устройствах Wiren Board '''(для работы нужен драйвер wb-mqtt-serial)'''. Утилита останавливает драйвер, для каждого обнаруженного устройства в конфигурационном файле /etc/wb-mqtt-serial.conf проверяет наличие обновления и устанавливает его, если имеется. После этого, драйвер перезапускается, а пользователю возвращается список устройств, обновление которых не удалось (если таковые имеются).
-<!--T:16-->
-Для передачи прошивки на устройства используется утилита wb-mcu-fw-flasher, запускаемая с контроллера Wiren Board (или компьютера с Linux или Windows).
-<!--T:17-->
-Для установки утилиты '''на контроллер Wiren Board''' выполните команды:
-<pre>
-apt-get update
-apt-get install wb-mcu-fw-flasher
-</pre>
-<!--T:18-->
-Версию утилиты для '''MS Windows''' можно скачать по этой ссылке: [[Media: Wb-mcu-fw-flasher_1.0.3.zip | Wb-mcu-fw-flasher_1.0.3.zip]]
-<!--T:19-->
-Для установки на '''компьютер с Debian''' скачайте пакет отсюда: [[Media: Wb-mcu-fw-flasher_1.0.3_amd64-all.deb | Wb-mcu-fw-flasher_1.0.3_amd64-all.deb]]
-и выполните команды в директории, куда загрузился пакет.
-<pre>
-apt-get update
-apt-get install libmodbus5
-dpkg -i Wb-mcu-fw-flasher_1.0.3_amd64-all.deb
-</pre>
-<!--T:20-->
+==== Ключи запуска wb-mcu-fw-updater: ==== <!--T:11-->
-Опции запуска утилиты wb-mcu-fw-flasher:
 {| class="wikitable"
 ! Параметр !! Описание !! Значение по умолчанию
 |-
-| -d || Устройство последовательного порта ('''обязательно''') ||
+!colspan="3"|Общие для всех режимов. Ключи со значением (-<ключ> <значение>)
+|-
+|  || Порт, к которому подключено устройство. Позиционный аргумент || ('''обязательный''')
 |-
-| -f || Файл прошивки ||
+| -a, --slaveid || Modbus адрес устройства || 0
 |-
-| -a || Адрес Modbus || 1
 |-
-| -j || Отправить на устройство команду перехода в режим загрузчика ||
+| --save-to || Принудительно скачать прошивку в файл <значение_аргумента> || None
+|-
+|-
+| --version || Скачивать прошивку определённой версии || latest
+|-
+|-
+| -a, --slaveid || Modbus адрес устройства || 0
+|-
+| -h, --help || Отображение всех ключей запуска ||
+|-
+| --debug || Отображение подробных логов работы утилиты || None
 |-
-| -b || Скорость порта (baudrate) || 9600
+| --restore-defaults || Восстановление всех настроек устройства к заводским || False
 |-
 | -p || Чётность (parity) || N

Навигация