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

Wb-mcu-fw-updater (просмотреть исходный код)

Версия 14:54, 7 мая 2020

1326 байт добавлено , 4 года назад

Нет описания правки

Vdromanov

wb_editors

556

правок

@@ Строка 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