Wb-mcu-fw-updater: различия между версиями
Vdromanov (обсуждение | вклад) |
|||
(не показаны 64 промежуточные версии 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" | ||
! Параметр !! Описание !! Значение по умолчанию | ! Параметр !! Описание !! Значение по умолчанию | ||
|- | |||
!colspan="3"|Общие для всех режимов. Ключи со значением (-<ключ> <значение>) | |||
|- | |- | ||
| || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | | || Порт, к которому подключено устройство. Позиционный аргумент || '''обязательный''' | ||
|- | |- | ||
| -a, --slaveid || Modbus адрес устройства || | | -a, --slaveid || Modbus адрес устройства || 0 | ||
|- | |- | ||
|- | |- | ||
| - | | --save-to || Принудительно скачать прошивку в файл <значение_аргумента> || None | ||
|- | |- | ||
|- | |- | ||
| -- | | --version || Скачивать прошивку определённой версии || latest | ||
|- | |- | ||
|- | |- | ||
| | | --branch || Скачивать прошивку из ветки разработки (не рекомендуется!) || None | ||
|- | |- | ||
| - | | --mode || Обновлять прошивку или бутлоадер || fw | ||
|- | |- | ||
!colspan="3"|Общие для всех режимов. Флаги (-<ключ>) | |||
|- | |- | ||
| -- | | --debug || Отображать подробные логи работы || None | ||
|- | |- | ||
|- | |- | ||
| --restore-defaults || | | --restore-defaults || Восстановить настройки устройства к заводским || False | ||
|- | |- | ||
!colspan="3"|Режим "update". Флаги (-<ключ>) | |||
|- | |- | ||
| - | | --force || Произвести перепрошивку устройства даже, если установлена самая свежая прошивка || False | ||
|- | |- | ||
| | !colspan="3"|Режим "recover". Ключи со значением (-<ключ> <значение>) | ||
|- | |- | ||
| -- | | --model-name || Полная модель устройства (например, WB-MR6C) || '''обязательный''' | ||
|- | |- | ||
|- | |- | ||
| - | | --signature || Сигнатура прошивки (если известна заранее) || None | ||
|- | |- | ||
|} | |} | ||
<!--T:21--> | |||
Пример (устройство в рабочем режиме): | |||
<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--> | |||
Здесь COM10 — имя виртуального последовательного порта, которое присвоено адаптеру USB RS-485. | |||
<!--T:24--> | |||
Пример для устройства с нестандартными настройками UART: | |||
<pre> | |||
wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw -b 115200 | |||
</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--> | |||
Прошейте устройство командой: | |||
<pre> | |||
wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f WB-MR-MR6C_MCU3_3_1.9.4.wbfw | |||
</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> | |||
<!--T:32--> | |||
'''После успешной прошивки устройство само выйдет из режима загрузчика и перезапустится в основной программе.''' | |||
<!--T:33--> | |||
< | Пример ошибки при несовпадении сигнатуры: | ||
<pre> | |||
</ | 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 | |||
</pre> | |||
=== | === Прошивка устройств по широковещательному Modbus-адресу 0 === <!--T:34--> | ||
<!--T:35--> | |||
Bootloader позволяет загружать прошивку на устройства по Modbus-адресу 0. Для этого устройство должно быть единственным устройством на шине и находиться в режиме загрузчика. | |||
=== Прошивка нескольких устройств на шине === <!--T:36--> | |||
<!--T:37--> | |||
Возможна прошивка нескольких устройств, подключенных к шине. Устройства должны быть переведены в режим загрузчика и прошиваться по отдельности с указанием нешироковещательного Modbus-адреса. Прошивка устройств с одинаковым адресом возможна, если в режиме загрузчика находится только одно из них. Устройства прошиваются по очереди. | |||
<!--T:38--> | |||
'''Внимание!''' Прошивка устройств, находящимся в режиме загрузчика и имеющим одинаковый modbus-адрес, или же прошивка нескольких устройств, находящихся в режиме загрузчика по адресу 0 не будет выполнена; имеющаяся прошивка на устройствах будет испорчена. | |||
</translate> | |||
Версия 15:08, 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 |
Пример (устройство в рабочем режиме):
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 не будет выполнена; имеющаяся прошивка на устройствах будет испорчена.