Wb-mb-explorer: различия между версиями
(→Установка утилиты: полная версия утилиты доступна и в стабильном релизе) |
(→Описание основных функций: дописал про help) |
||
(не показано 29 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
{{ | {{Draft}} | ||
{{Note|info| <b>Данная утилита официально не поддерживается и не включена в дистрибутив ПО. Её использование осуществляется на свой страх и риск! Если вы не уверены в своих действиях, то не используйте ее!</b>}} | |||
{{Note|info| | |||
{{DISPLAYTITLE:Утилита для диагностики, конфигурирования и обновления прошивок wb-mb-explorer}} | |||
== Общая информация == | |||
Здесь описывается <code>wb-mb-explorer</code> — консольная графическая утилита для диагностики, конфигурирования и обновления прошивок modbus-устройств Wiren Board. Она представляет собой скрипт, основанный на штатных программах и утилитах контроллера Wirenboard: modbus_client, wb-mcu-fw-flasher, wb-mcu-fw-updater. За счет графического интерфейса работа с утилитой обычно проще, чем непосредственный набор команд с множеством опций в рабочей строке. | |||
Ниже | Ниже приведено несколько скриншотов работы утилиты. | ||
<gallery mode="packed" widths ="260px" heights="200px"> | <gallery mode="packed" widths ="260px" heights="200px"> | ||
Image: Wb-mb-explorer-main-menu.png | Главное меню утилиты wb-mb-explorer | Image: Wb-mb-explorer-main-menu.png | Главное меню утилиты wb-mb-explorer | ||
Image: Wb-mb-explorer-device-info.png | Чтение информации об устройстве | Image: Wb-mb-explorer-device-info.png | Чтение информации об устройстве | ||
Image: Wb-mb-explorer-read-register.png | Чтение регистра | Image: Wb-mb-explorer-read-register.png | Чтение регистра | ||
Image: Wb-mb-explorer- | Image: Wb-mb-explorer-quick-device-scan.png | Быстрое сканирование доступных адресов | ||
</gallery> | </gallery> | ||
== Установка утилиты == | == Установка утилиты == | ||
Исходный код доступен в репозитории [https://github.com/wirenboard/wb-mb-explorer wb-mb-explorer]. | Утилита доступна для установки в релизе <b>testing</b>. Исходный код доступен в репозитории [https://github.com/wirenboard/wb-mb-explorer wb-mb-explorer]. | ||
Установка утилиты осуществляется стандартным способом: | Установка утилиты осуществляется стандартным способом: | ||
# Откройте консоль контроллера через [[SSH]]. | # Откройте консоль контроллера через [[SSH]]. | ||
Строка 38: | Строка 31: | ||
После установки утилиту можно запустить командой <code>wb-mb-explorer</code> | После установки утилиту можно запустить командой <code>wb-mb-explorer</code> | ||
== Описание интерфейса == | |||
При запуске утилиты, а также при каждой попытке обращения к устройству по шине RS-485, драйвер wb-mqtt-serial будет остановлен. Это необходимо для получения доступа к портам контроллера. После запуска откроется главное окно, в котором можно выбирать нужные действия с устройствами. При выходе из утилиты драйвер wb-mqtt-serial будет снова запущен. | |||
Перед началом использования нужно выбрать пункт Settings и задать параметры обмена данными (скорость, четность, количество стоп-битов), а также адрес устройства, с которым требуется установить связь, номер и тип его регистра. Эти настройки утилита будет использовать для обмена данными с устройствами. | |||
=== | === Описание основных функций === | ||
[[Image: Wb-mb-explorer-main-menu.png |right| thumb| 400px | Главное меню утилиты wb-mb-explorer]] | [[Image: Wb-mb-explorer-main-menu.png |right| thumb| 400px | Главное меню утилиты wb-mb-explorer]] | ||
# <b>Settings</b> | # <b>Settings</b> - настройка параметров обмена, задание адреса устройства, номера и типа регистра для работы | ||
# <b>Show device info</b> | # <b>Show device info</b> - чтение информации об устройсве (модель устройства, серийный номер, версия прошивки, сигнатура прошивки и др.) | ||
# <b>Read/write register</b> | # <b>Read/write register</b> - чтение/запись выбранного регистра | ||
# <b> | # <b>Quick device scan</b> - проверка доступности устройств с адресами от 1 до 247 на шине с заданными параметрами обмена, занимает около 1 минуты. Утилита отправляет запрос на чтение holding-регистра с адресом 128, в котором хранится адрес Modbus-устройства Wirenboard. | ||
# <b> | # <b>Complete device scan</b> - проверка доступности устройств с адресами от 1 до 247 со всеми возможными комбинациями параметров обмена. Полностью процесс занимает около 1 часа. Для ускорения обнаружения устройств сначала производится опрос устройств на скорости 9600 бит/сек, затем на 115200 бит/сек, затем на остальных скоростях. При необходимости процесс можно прервать. | ||
# <b>FW update</b> | # <b>FW update</b> - переход в меню обновления прошивок | ||
# <b>Show log file</b> | # <b>Show log file</b> - показать файл сообщений о работе утилиты с момента последнего запуска. Записи хранятся в файле <code>/var/log/wb-mb-explorer.log</code>. При запуске утилиты содержимое файла стирается. | ||
Для отображения краткой справки по функциям утилиты нажмите на кнопку <code>Help</code>. | |||
=== | === Меню обновления прошивок === | ||
[[Image: Wb-mb-explorer-fw-update-menu.png |rigth| thumb| 400px | Меню | [[Image: Wb-mb-explorer-fw-update-menu.png |rigth| thumb| 400px | Меню обновления прошивок]] | ||
Для обновления прошивок Modbus-устройств есть | Для обновления прошивок Modbus-устройств есть четыре способа: | ||
# <b>Device FW update</b> | # <b>Device FW update</b> - обновление прошивки устройства, используя выбранный порт и адрес устройства. Перед обновлением и по завершению обновления утилита попытается считать информацию об устройстве, используя заданные настройки обмена. В процессе обновления из репозитория будет загружена самая последняя прошивка и произведена попытка обновления на нее. Если устройство уже имеет последнюю версию прошивки, то обновления не будет произведено. Для обновления вызывается команда <code>wb-mcu-fw-updater update-fw</code> с указанием выбранного порта и адреса устройства. | ||
# <b>Force device FW update</b> | # <b>Force device FW update</b> - функция, аналогичная <code>Device FW update</code>, но обновление будет даже в том случае, если устройство уже имеет последнюю версию прошивки. Для обновления вызывается команда <code>wb-mcu-fw-updater update-fw --force</code> с указанием выбранного порта и адреса устройства. | ||
# <b>Update FW of all devices</b> - обновление прошивок всех устройств, сконфигурированных на контроллере. Для обновления вызывается команда <code>wb-mcu-fw-updater update-all</code> | |||
# <b>Update FW of all devices</b> | # <b>Update FW using file</b> - обновление прошивки устройства с использованием заранее скачанного файла прошивки. Для обновления вызывается команда <code>wb-mcu-fw-flasher</code> с указанием выбранного порта, скорости обмена, адреса устройства и имени файла прошивки. | ||
# <b>Update FW using file</b> | |||
== Особенности работы == | === Особенности работы === | ||
[[Image: Wb-mb-explorer-setting-port.png |rigth| thumb| 400px | Диалог выбора порта]] | [[Image: Wb-mb-explorer-setting-port.png |rigth| thumb| 400px | Диалог выбора порта]] | ||
При выборе порта или обновлении прошивки откроется диалог выбора. Перемещаться между элементами окна следует с помощью клавиши < | При выборе порта или обновлении прошивки откроется диалог выбора. Перемещаться между элементами окна следует с помощью клавиши <code>Tab</code>, для автодополнения можно использовать клавишу <code>Space</code> (пробел). До нажатия кнопки <code>"ОК"</code> в поле ввода должен быть полностью указан путь к порту (файлу) иначе порт будет задан неверно. Путь можно задавать, набирая его с клавиатуры, или выбрать элемент в окне и нажать <code>Space</code>. | ||
Для изменения скорости обмена, настроек четности или стоп-битов нужно выбрать нужный вариант из списка с помощью клавиши < | Для изменения скорости обмена, настроек четности или стоп-битов нужно выбрать нужный вариант из списка с помощью клавиши <code>Space</code>, выбранный вариант отмечен символом <code>*</code>. |
Версия 16:24, 14 января 2022
Это черновик страницы. Последняя правка сделана 14.01.2022 пользователем Explorerol.
Данная утилита официально не поддерживается и не включена в дистрибутив ПО. Её использование осуществляется на свой страх и риск! Если вы не уверены в своих действиях, то не используйте ее!
Общая информация
Здесь описывается wb-mb-explorer
— консольная графическая утилита для диагностики, конфигурирования и обновления прошивок modbus-устройств Wiren Board. Она представляет собой скрипт, основанный на штатных программах и утилитах контроллера Wirenboard: modbus_client, wb-mcu-fw-flasher, wb-mcu-fw-updater. За счет графического интерфейса работа с утилитой обычно проще, чем непосредственный набор команд с множеством опций в рабочей строке.
Ниже приведено несколько скриншотов работы утилиты.
Установка утилиты
Утилита доступна для установки в релизе testing. Исходный код доступен в репозитории wb-mb-explorer. Установка утилиты осуществляется стандартным способом:
- Откройте консоль контроллера через SSH.
- Обновите список пакетов:
apt update
- Установите утилиту командой:
apt install wb-mb-explorer
После установки утилиту можно запустить командой wb-mb-explorer
Описание интерфейса
При запуске утилиты, а также при каждой попытке обращения к устройству по шине RS-485, драйвер wb-mqtt-serial будет остановлен. Это необходимо для получения доступа к портам контроллера. После запуска откроется главное окно, в котором можно выбирать нужные действия с устройствами. При выходе из утилиты драйвер wb-mqtt-serial будет снова запущен.
Перед началом использования нужно выбрать пункт Settings и задать параметры обмена данными (скорость, четность, количество стоп-битов), а также адрес устройства, с которым требуется установить связь, номер и тип его регистра. Эти настройки утилита будет использовать для обмена данными с устройствами.
Описание основных функций
- Settings - настройка параметров обмена, задание адреса устройства, номера и типа регистра для работы
- Show device info - чтение информации об устройсве (модель устройства, серийный номер, версия прошивки, сигнатура прошивки и др.)
- Read/write register - чтение/запись выбранного регистра
- Quick device scan - проверка доступности устройств с адресами от 1 до 247 на шине с заданными параметрами обмена, занимает около 1 минуты. Утилита отправляет запрос на чтение holding-регистра с адресом 128, в котором хранится адрес Modbus-устройства Wirenboard.
- Complete device scan - проверка доступности устройств с адресами от 1 до 247 со всеми возможными комбинациями параметров обмена. Полностью процесс занимает около 1 часа. Для ускорения обнаружения устройств сначала производится опрос устройств на скорости 9600 бит/сек, затем на 115200 бит/сек, затем на остальных скоростях. При необходимости процесс можно прервать.
- FW update - переход в меню обновления прошивок
- Show log file - показать файл сообщений о работе утилиты с момента последнего запуска. Записи хранятся в файле
/var/log/wb-mb-explorer.log
. При запуске утилиты содержимое файла стирается.
Для отображения краткой справки по функциям утилиты нажмите на кнопку Help
.
Меню обновления прошивок
Для обновления прошивок Modbus-устройств есть четыре способа:
- Device FW update - обновление прошивки устройства, используя выбранный порт и адрес устройства. Перед обновлением и по завершению обновления утилита попытается считать информацию об устройстве, используя заданные настройки обмена. В процессе обновления из репозитория будет загружена самая последняя прошивка и произведена попытка обновления на нее. Если устройство уже имеет последнюю версию прошивки, то обновления не будет произведено. Для обновления вызывается команда
wb-mcu-fw-updater update-fw
с указанием выбранного порта и адреса устройства. - Force device FW update - функция, аналогичная
Device FW update
, но обновление будет даже в том случае, если устройство уже имеет последнюю версию прошивки. Для обновления вызывается командаwb-mcu-fw-updater update-fw --force
с указанием выбранного порта и адреса устройства. - Update FW of all devices - обновление прошивок всех устройств, сконфигурированных на контроллере. Для обновления вызывается команда
wb-mcu-fw-updater update-all
- Update FW using file - обновление прошивки устройства с использованием заранее скачанного файла прошивки. Для обновления вызывается команда
wb-mcu-fw-flasher
с указанием выбранного порта, скорости обмена, адреса устройства и имени файла прошивки.
Особенности работы
При выборе порта или обновлении прошивки откроется диалог выбора. Перемещаться между элементами окна следует с помощью клавиши Tab
, для автодополнения можно использовать клавишу Space
(пробел). До нажатия кнопки "ОК"
в поле ввода должен быть полностью указан путь к порту (файлу) иначе порт будет задан неверно. Путь можно задавать, набирая его с клавиатуры, или выбрать элемент в окне и нажать Space
.
Для изменения скорости обмена, настроек четности или стоп-битов нужно выбрать нужный вариант из списка с помощью клавиши Space
, выбранный вариант отмечен символом *
.