Wb-mb-explorer: различия между версиями

Версия 14:26, 28 декабря 2021

Это черновик страницы. Последняя правка сделана 28.12.2021 пользователем 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 будет остановлен. При выходе из утилиты драйвер будет снова запущен. Это необходимо для получения доступа к портам контроллера. После запуска откроется главное окно, в котором можно выбирать нужные действия с устройствами.

Перед началом использования нужно выбрать пункт Settings и задать параметры обмена данными (скорость, четность, количество стоп-битов), а также адрес устройства, с которым требуется установить связь, номер и тип его регистра. Эти настройки утилита будет использовать для обмена данными с устройствами.

Описание основных функций

Главное меню утилиты wb-mb-explorer

Settings - настройка параметров обмена, задание адреса устройства, номера и типа регистра для работы
Show device info - чтение информации об устройсве (модель устройства, серийный номер, версия прошивки, сигнатура прошивки и др.)
Read/write register - чтение/запись выбранного регистра
Quick device scan - проверка доступности устройств с адресами от 1 до 247 на шине с заданными параметрами обмена
Complete device scan - проверка доступности устройств со всеми возможными комбинациями параметров обмена. Полностью процесс занимает около 1 часа. Для ускорения обнаружения устройств сначала производится опрос устройств на скорости 9600 бит/сек, затем на 115200 бит/сек, затем на остальных скоростях. При необходимости процесс можно прервать.
FW update - переход в раздел обновления прошивок
Show log file - показать файл сообщений о работе утилиты с момента последнего запуска. Записи хранятся в файле /var/log/wb-mb-explorer.log. При запуске утилиты содержимое файла стирается.

@@ Строка 1: / Строка 1: @@
 {{Draft}}
+{{Note|info| <b>Данная утилита официально не поддерживается. Её использование осуществляется на свой страх и риск! Если вы не уверены в своих действиях, то не используйте ее!</b>}}
 {{DISPLAYTITLE:Утилита для диагностики, конфигурирования и обновления прошивок wb-mb-explorer}}
 == Общая информация ==
-Здесь описывается <code>wb-mb-explorer</code> — консольная графическая утилита для диагностики, конфигурирования и обновления прошивок modbus-устройств Wiren Board. Она представляет собой скрипт, основанный на штатных программах и утилитах контроллера Wirenboard: modbus_client, wb-mcu-fw-flasher, wb-mcu-fw-updater. За счет графического интерфейса работа с утилитой обычно проще, чем непосредственный набор команд в рабочей строке.
+Здесь описывается <code>wb-mb-explorer</code> — консольная графическая утилита для диагностики, конфигурирования и обновления прошивок modbus-устройств Wiren Board. Она представляет собой скрипт, основанный на штатных программах и утилитах контроллера Wirenboard: modbus_client, wb-mcu-fw-flasher, wb-mcu-fw-updater. За счет графического интерфейса работа с утилитой обычно проще, чем непосредственный набор команд с множеством опций в рабочей строке.
 == Установка утилиты ==
-Утилита доступна для установки в релизе testing. Исходный код доступен в репозитории [https://github.com/wirenboard/wb-mb-explorer wb-mb-explorer].
+Утилита доступна для установки в релизе <b>testing</b>. Исходный код доступен в репозитории [https://github.com/wirenboard/wb-mb-explorer wb-mb-explorer].
+Установка утилиты осуществляется стандартным способом:
+# Откройте консоль контроллера через [[SSH]].
+# Обновите список пакетов:
+#:<syntaxhighlight lang="bash">
+apt update
+</syntaxhighlight>
+# Установите утилиту командой:
+#:<syntaxhighlight lang="bash">
+apt install wb-mb-explorer
+</syntaxhighlight>
+После установки утилиту можно запустить командой <code>wb-mb-explorer</code>
+== Описание интерфейса ==
+При запуске утилиты, а также при каждой попытке обращения к устройству по шине RS-485, драйвер wb-mqtt-serial будет остановлен. При выходе из утилиты драйвер будет снова запущен. Это необходимо для получения доступа к портам контроллера.
+После запуска откроется главное окно, в котором можно выбирать нужные действия с устройствами.
+Перед началом использования нужно выбрать пункт Settings и задать параметры обмена данными (скорость, четность, количество стоп-битов), а также адрес устройства, с которым требуется установить связь, номер и тип его регистра. Эти настройки утилита будет использовать для обмена данными с устройствами.
+=== Описание основных функций ===
+[[Image: Wb-mb-explorer-main-menu.png |rigth| thumb| 400px | Главное меню утилиты wb-mb-explorer]]
+# <b>Settings</b> - настройка параметров обмена, задание адреса устройства, номера и типа регистра для работы
+# <b>Show device info</b> - чтение информации об устройсве (модель устройства, серийный номер, версия прошивки, сигнатура прошивки и др.)
+# <b>Read/write register</b> - чтение/запись выбранного регистра
+# <b>Quick device scan</b> - проверка доступности устройств с адресами от 1 до 247 на шине с заданными параметрами обмена
+# <b>Complete device scan</b> - проверка доступности устройств со всеми возможными комбинациями параметров обмена. Полностью процесс занимает около 1 часа. Для ускорения обнаружения устройств сначала производится опрос устройств на скорости 9600 бит/сек, затем на 115200 бит/сек, затем на остальных скоростях. При необходимости процесс можно прервать.
+# <b>FW update</b> - переход в раздел обновления прошивок
+# <b>Show log file</b> - показать файл сообщений о работе утилиты с момента последнего запуска. Записи хранятся в файле <code>/var/log/wb-mb-explorer.log</code>. При запуске утилиты содержимое файла стирается.
+== Функции утилиты ==

Навигация