Debug Console: различия между версиями

Материал из Wiren Board
 
(не показаны 192 промежуточные версии 9 участников)
Строка 1: Строка 1:
{{DISPLAYTITLE:Отладочный порт}}
{{DISPLAYTITLE:Отладочный порт в контроллерах Wiren Board}}
<languages/>
== Описание ==
У контроллеров Wiren Board есть отладочный порт. Он обозначен как «Debug console».
<gallery mode="packed" caption="" heights="150px" perrow=1>
Image: WirenBoard7DebugConsole.png | Wiren Board 7.x
Image: WirenBoard6DebugConsole.png | Wiren Board 6.x
Image: Debugusb58.png | Wiren Board 5.8 и 5.9
</gallery>


Подключившись к нему, как и в случае [[SSH | SSH]] подключения, вы превращаете свой компьютер в монитор и клавиатуру контроллера. И получаете доступ к его консоли (командной строке). А в отличие от SSH, вы сможете увидеть информацию, выводимую контроллером на экран при его начальной загрузке.


<!--T:100-->
Нужен этот порт для аварийных ситуаций, когда подключения по сети недоступны. Например, если вы неверно сконфигурировали сеть, и контроллер не может к ней подключиться. Или, если возникла какая-то проблема, мешающая контроллеру нормально загрузиться. Для обычной работы использовать это подключение мы не рекомендуем, используйте [[Веб-интерфейс Wiren Board | веб-интерфейс]] или SSH.
Контроллеры Wiren Board имеют отладочный порт, через который можно получить прямой доступ к консоли контроллера. Через него можно взаимодействовать с загрузчиком и следить за загрузкой операционной системы (последовательная консоль, serial console). Другие способы подключения к контроллеру: [[Веб-интерфейс Wiren Board | через веб-интерфейс]], [[SSH | по SSH]].


<!--T:105-->
== Подключение ==
== Физическая реализация порта отладочной консоли ==
{{YouTube
Физически в разных версиях контроллера отладочный порт реализован по разному:
|link=https://youtu.be/VA_XHrY1RVA?t=135
* для версий '''WB 6 и позднее''' он выглядит как Micro-USB разъём (подпись ''Debug Console'');
|text= Про командную строку, SSH и Debug Console}}
* для версий '''WB 5.8 и позднее''' он выглядит как Micro-USB разъём (подпись ''Debug Console'' или ''Debug USB'');
 
* для версий '''WB 5.6 и ранее''' он выглядит как трёхштыревой разъём (подпись ''Debug UART'').
Если у вас контроллер Wiren Board 5.6 и старее, обратитесь к [[WB5.6_Debug_Console| статье ]].
Программно во всех случаях это последовательный порт.
 
[[Файл:Debugusb58.png|250px|thumb|right|Разъем ''Debug USB'']]
Подключение выполняется стандартными кабелями, их легко купить. В комплекте с вашим смартфоном может быть такой.  
 
{{note|warn| Бывают кабели с такими же разъёмами, но предназначенные только для зарядки — они не подойдут. }}


Варианты реализации отладочной консоли в разных версиях контроллеров перечислены ниже.
Для подключения  '''Wiren Board 7''' к компьютеру нужен кабель '''USB Тип A – USB Тип C'''.


=== Реализация отладочной консоли в контроллерах Wiren Board ===
Для подключения более ранних контроллеров - '''USB тип A – Micro-USB Тип B'''.
{| class="wikitable"
! Версия коннтроллера !! Тип разъема !! Название разъема !! Интерфейс !! Чип USB/UART
|-
| 6.4 и старше || microUSB || Debug Console || USB/UART || HT42B534-1
|-
| 6.0 — 6.3  || microUSB || Debug Console || USB/UART  || CH340/CH341
|-
| 5.8 — 5.9 || microUSB || Debug Console || USB/UART || CH340/CH341
|-
| 5.6.1 || 3-pin UART (Gnd, Rx, Tx) || UART || UART (3,3 В) || —
|-
| 5.3  || 3-pin UART (Tx, Rx, GND) || Debug UART || UART (3,3 В) || —
|-
| 4 || 3-pin UART (Gnd, Rx, Tx) || Debug UART || UART (3,3 В) || —
|-
| 3.5 || 3-pin UART (Gnd, Tx, Rx) || UEXT1 (выводы 2,3,4) и 3-pin разъем без названия || UART (3,3 В) || —
|-
| 2.8 || 3-pin UART (Gnd, Tx, Rx) || UEXT1 (выводы 2,3,4) и 3-pin разъем без названия || UART (3,3 В) || —
|}


<!--T:3-->
Самый простой способ проверить, подходит ли кабель для подключения к контроллеру — подключить к компьютеру через этот кабель мобильный телефон. Если компьютер обнаружил новое устройство — кабель можно использовать и для контролера.


== Поддержка в операционных системах ==  
== Настройка порта, программное обеспечение ==
{| class="wikitable"
Необходимо определить, к какому порту компьютера подключен Wiren Board, и настроить этот порт в соответствии с настройками Debug console.
! Версия контроллера !! Linux  !! Windows XP, 7, 8 !! Windows 10 !! MacOS X (High Sierra)  !! Android 9 + USB Serial Console
{| border="1" class="wikitable"  
|+ Параметры порта Debug console
! Параметр|| Значение || Описание
|-
|-
| 6.4 и старше
| Модуль ядра cdc_acm (все новые дистрибутивы — из коробки) || Необходим драйвер [http://www.holtek.com/documents/10179/116677/USBBridgeSetup_CA.zip HT42B534-1] || Из коробки || Из коробки || Из коробки
|-
|-
| 6.0 — 6.3
| Baud rate || 115200 || Скорость, бит/с
| Модуль ядра ch341 (все новые дистрибутивы — из коробки)|| Необходим драйвер [http://www.wch.cn/downloads/CH341SER_ZIP.html CH341SER] || Из коробки || [[http://www.wch.cn/download/ch341ser_mac_zip.html CH341SER_MAC.ZIP]] || Из коробки
|-
|-
| 5.8 — 5.9
| Data bits || 8 || Количество битов данных
| Модуль ядра ch341 (все новые дистрибутивы — из коробки)|| Необходим драйвер [http://www.wch.cn/downloads/CH341SER_ZIP.html CH341SER]|| Из коробки || [[http://www.wch.cn/download/ch341ser_mac_zip.html CH341SER_MAC.ZIP]] || Из коробки
|-
|-
|}
| Parity || None ||  Бит чётности
 
Для контроллеров версии 5.6.1 и младше требуется переходник USB/UART.
 
 
=== Поддержка переходников USB/UART ===
{| class="wikitable"
! Переходник USB/UART (чип) !! Linux  !! Windows XP, 7, 8 !! Windows 10 !! MacOS X (High Sierra) !! Android 9 + USB Serial Console
|-
|-
| FTDI232
| Stop bits || 1 || Количество стоповых битов
| Модуль ядра ftdi_sio || требуют драйверов на ОС из коробки || требуют драйверов на ОС из коробки || Нет информации || Из коробки
|-
|-
| CP2102
| Hardware flow control || None || Аппаратный контроль потока
| Модуль ядра cp210x || [https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers Silicon Labs CP210x VCP Driver] || [https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers Silicon Labs CP210x VCP Driver] || [https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers Silicon Labs CP210x VCP Driver] || Из коробки
|-
|-
| CH340/CH341
| Software flow control || None || Программный контроль потока
| Модуль ядра ch341 || Необходим драйвер [http://www.wch.cn/downloads/CH341SER_ZIP.html CH341SER] || Из коробки || [http://www.wch.cn/download/ch341ser_mac_zip.html CH341SER_MAC.ZIP] || Из коробки
|-
|-
| PL2303xx
| Модуль ядра pl2303 || необходим драйвер || нет информации || нет информации  || нет информации
|}
|}


== Подключение к отладочному порту контроллеров Wiren Board 6, Wiren Board 5.8 и Wiren Board 5.9 == <!--T:104-->
=== Windows ===
[[Файл:USBA-MICROUSBB.png|250px|thumb|right|Кабель USB — Micro-USB]]
Если у вас на компьютере '''Windows 10''', а контроллер '''Wiren Board 6.4 или новее''', то система сама, после физического подключения, назначит виртуальный COM порт и установит необходимый драйвер. Увидеть номер этого порта можно в Диспетчере устройств Windows:
[[Файл:SerialUART_Win.png|250px|thumb|right|Номер порта в Windows]]
[[Файл:Dispatcher.png|left]]
'''Как найти порт: '''
<br clear="both" />


На корпусе напротив разъема отладочного порта находится надпись ''Debug Console''.
При использовании '''Windows XP, 7, 8''' скачайте и установите драйвер. Для установки драйвера вам потребуются навыки администрирования ОС Windows, ссылки на файлы:
* для [https://wirenboard.com/wiki/images/3/38/HT42B534_inf.zip Wiren Board 6.4 или новее];
* для [http://www.wch.cn/downloads/CH341SER_ZIP.html более ранних версий].


'''Как подключать:'''
Далее подключайте контроллер, и в Диспетчере устройств Windows вы должны увидеть виртуальный COM порт, как на иллюстрации выше.


Для подключения понадобится стандартный кабель USB — Micro-USB - такой же, как для подключения сотовых телефонов. Более точное название кабеля USB (A) — Micro-USB (B). Разъем USB (А) подключается к компьютеру, Micro-USB (B) — к контроллеру.
В качестве программы для общения с контроллером мы рекомендуем использовать [https://mobaxterm.mobatek.net/ MobaXterm] от компании Mobatek. ЕЕ возможности очень обширны. В платной версии их больше, но для наших целей достаточно и бесплатной версии.


Кабели от зарядных устройств подходят, но бывают исключения. Лучше выбирать такие, на которых указано, что они предназначены для передачи данных.  
Нам нужно создать новую сессию '''Sessions''' → '''New session''' → '''Serial''':
Если кабель выбран правильно, Windows сообщит звуком об обнаружении устройства.
[[Файл:Sessions.png|left]]
<br clear="both" />


'''Драйвер адаптера и номер виртуального COM-порта:'''
и настроить ее:
[[Файл:Basic.png|left]]
<br clear="both" />


Внутри контроллера установлен переходник USB-UART; подробнее — в таблице [[ #Реализация отладочной консоли в контроллерах Wiren Board]].
Во вкладке '''Terminal settings''' вы можете настроить шрифт, цвета и, при необходимости, указать файл для записи всего, что будет выводится на экран во время сеанса:
[[Файл:SessionLog.png|left]]
<br clear="both" />


*Linux: адаптер обычно определяется автоматически, при подключении в выводе команды <code>dmesg</code> должна появится строка <code>usb 1-1: ch341-uart converter now attached to ttyUSB0</code> или (для версий контроллера 6.4 и старше) <code>cdc_acm:3-6:1.0: ttyACM0: USB ACM device</code>. Номер порта ttyUSBx или ttyACMx может меняться, в зависимости от уже подключенных устройств. Смотрите список файлов в папке /dev/ . Консольный порт контроллеров новых версий 6.4 и старше определяется автоматически как устройство ''/dev/ttyACM0''.
А во вкладке '''Bookmark settings''' укажите внятное название сессии:
[[Файл:SessionName.png|left]]
<br clear="both" />


*Windows: в зависимости от версии и типа контроллера возможно, потребуется установка драйвера (см. таблицу [[#Поддержка в операционных системах]]). В Диспетчере устройств (Device Manager) в разделе Ports(COM&LPT) должен появиться виртуальный COM-порт контроллера. Если не очевидно, какой из портов используется контроллером, можно отсоединить кабель и включить снова.
=== Linux ===
Порт должен назначиться автоматически. В выводе команды dmesg контроллеров '''Wiren Board 6.4 или новее''' должна появиться строка:
<syntaxhighlight lang="console">
cdc_acm:3-6:1.0: ttyACM0: USB ACM device
</syntaxhighlight>


*macOS: Начиная с High Sierra отладочная консоль контроллеров определяется из коробки, предыдущие версии, возможно, потребуют установки драйверов.
В '''более ранних''' версиях:
<syntaxhighlight lang="console">
usb 1-1: ch341-uart converter now attached to ttyUSB0
</syntaxhighlight>


*Android: Поздние версии Android при подключении через OTG поддерживают отладочную консоль контроллеров без дополнительных драйверов. Тестировалось с приложением [https://play.google.com/store/apps/details?id=jp.sugnakys.usbserialconsole&hl=en_US USB Serial Console].
Номер порта ttyUSBx или ttyACMx может меняться, в зависимости от того, что у вас подключено к контроллеру.  


Переходите к [[#Настройка работы с последовательным портом | настройке работы с последовательным портом]].
Для работы с Debug console мы рекомендуем использовать Minicom. Команда для подключения будет выглядеть так:
<syntaxhighlight lang="console">
minicom -D /dev/ttyACM0 -b 115200 -8 -a off
</syntaxhighlight>
Скорее всего, для доступа к порту вам понадобятся права суперпользователя - используйте sudo.


<!--T:108-->
Более подробно про Minicom смотрите в нашем [[Minicom | руководстве]].


== Подключение к отладочному порту в Wiren Board 5.6 и младше== <!--T:4-->
==== Linux — возможные проблемы ====
'''Как найти порт:'''
Сервис '''ModemManager''' может мешать работе с портом. Если у вас WirenBoard 6.4 или новее — правильно сконфигурируйте udev.
* Создайте файл исключений udev:
<syntaxhighlight lang="bash">
sudo nano /etc/udev/rules.d/99-wb-debug-usb.rules
</syntaxhighlight>
* Добавьте в него строчку:
<syntaxhighlight lang="bash">
ATTRS{idVendor}=="04d9" ATTRS{idProduct}=="b534", ENV{ID_MM_DEVICE_IGNORE}="1"
</syntaxhighlight>
* После сохранения файла перезагрузите правило udev:
<syntaxhighlight lang="bash">
sudo udevadm control --reload-rules
</syntaxhighlight>


Читайте ниже в разделе [[#Wiren Board 5 | Как найти штырьки разъема отладочного порта]] .
В свежих операционных системах Linux может потребоваться отредактировать файл:
<syntaxhighlight lang="bash">
/lib/systemd/system/ModemManager.service
</syntaxhighlight>


'''Как подключать:'''
Подробности здесь:


Для подключения понадобится переходник USB-UART.
[https://bugs.launchpad.net/ubuntu/+source/modemmanager/+bug/1827328 ModemManager does not honor blacklisted ttys]
'''Внимание!'''
[[Файл:Duart.jpg|thumb|right|Адаптер USB-UART]]


* Подключайте Debug UART только через переходники USB-UART с напряжением 3.3 В.
[https://nick.zoic.org/art/failed-to-set-dtr-rts-systemd-modemmanager SystemD ModemManager: failed to set dtr/rts]
* UART не является синонимом RS-232 (где напряжение на линии может быть 5 В, 12 В и т.д.). Подключение Debug UART к порту RS-232 (или переходнику USB-RS-232) напрямую '''приведет к необратимому повреждению устройства'''.


=== MacOS ===
{{note|warn| Если у вас Wiren Board 7 и Mac с USB Тип C на процессоре Intel - нужно отключить питание контроллера, он будет питаться от USB. При наличии питания порт операционной системой не определяется. На более старые Mac и Mac на процессорах Apple эта особенность не распространяется. }}


Подключите адаптер USB-UART к компьютеру, соедините контакты адаптера с контактами (штырьками) отладочного порта на контроллере по схеме:
Начиная с версии MacOS '''10.14 Mojave'''  все должно определиться автоматически. Предыдущие версии, возможно, потребуют установки драйвера [http://www.wch.cn/download/ch341ser_mac_zip.html CH341SER_MAC].  
*GND к GND,
*TX к RX,
*RX к TX.
На некоторых переходниках маркировка перепутана — попробуйте соединить TX с TX и RX с RX.  


При подключении создается устройство:
{|  border="1" class="wikitable"
! Wiren Board 7 || Wiren Board 6.4 и новее || Более ранние
|-
| /dev/tty.usbmodemWB71 || /dev/tty.usbmodem00001 ||  /dev/tty.usbserial-1410
|-
|}


'''Драйвер адаптера и номер виртуального COM-порта:'''
Встроенная утилита cu позволит вам работать с Debug console:
<syntaxhighlight lang="bash">
sudo cu -s 115200 -l /dev/tty.usbserial-1410
</syntaxhighlight>


*Windows: установите драйвер конкретного адаптера.
Для выхода из cu введите символы
*Linux: адаптер скорее всего будет сразу поддерживаться ядром, но, возможно, придётся скомпилировать соответствующий модуль.
<syntaxhighlight lang="bash">
~!
</syntaxhighlight>


Переходите к [[#Настройка работы с последовательным портом | настройке работы с последовательным портом]].
==== MacOS — возможные проблемы ====
Порт может не определиться. Потребуется установка драйвера. Для этого (начиная с MacOS '''High Sierra 10.13''')  нужно дать на это разрешение в <code>Settings → Security&Privacy → Allow apps downloaded from:</code>
[[Файл:Allow.png|left]]
<br clear="both" />


== Настройка работы с последовательным портом == <!--T:7-->
И вот хорошая [https://kig.re/2014/12/31/how-to-use-arduino-nano-mini-pro-with-CH340G-on-mac-osx-yosemite.html статья] - человек подключает Arduino к MacOS. Хоть устройство и другое, но там используется точно такой же чип. Возможно, там есть ответы на ваши вопросы.
=== Установка программы для работы с последовательным портом ===


<!--T:8-->
=== Android ===
Для работы с последовательным портом установите на вашем компьютере подходящую утилиту - например, PuTTY:
[[Файл:OTG.png|150px|thumb|right| OTG-кабель]]
* версия для Windows - [http://the.earth.li/~sgtatham/putty/latest/x86/putty.exe скачать с официального сайта]
Начиная с Android версии 9 все работает без установки дополнительных драйверов. Подключение через OTG. Тестировалось с приложением [https://play.google.com/store/apps/details?id=jp.sugnakys.usbserialconsole&hl=en_US USB Serial Console], если ссылка не работает - ищите в Google Play.
* версия для Linux Debian или Ubuntu - выполните команду ''apt-get install putty''
<br clear="both" />
Подойдут также [http://elinux.org/RPi_Serial_Connection другие программы].


Настройки соединения: '''115200 8N1''' (115200 кбит/с, 8 бит, нет бита чётности, один стоп-бит), root/wirenboard.
== Работа с отладочным портом ==
[[Файл:DebugConsoleWindowLogin.png|500px|thumb|right| Отладочная консоль]]
Итак:
* Контроллер к компьютеру подключен;
* Программа запущена;
* Настройки порта программы соответствуют настройкам порта Debug console.
Теперь можно начинать работу.  


=== Подключение === <!--T:9-->
''' Если контроллер исправен '''


<!--T:10-->
Если контроллер работает нормально — вы будете видеть сообщения, выводимые операционной системой контроллера на консоль. Нажав клавишу ENTER, вы увидите приглашение операционной системы, типа такого:  
#Запустите приложение от имени администратора:
<syntaxhighlight lang="console">
#* в Windows - щёлкните по значку PuTTY правой кнопкой и выберите ''Run This Program As An Administrator''
Debian GNU/Linux 11 wirenboard-AQ4RCD2E ttyS0
#* в Linux - <code>gksu putty</code> <br /><br />
#В меню слева выберите последний пункт - ''Serial''. В появившиеся поля справа введите настройки порта:
#*название последовательного порта
#**для Windows - это ''COM4'' ('''цифра может меняться''', см.выше)
#**для Linux - это ''/dev/ttyUSB0'' либо ''/dev/ttyACM0'' (для WB6.4 и выше). '''Цифра может меняться''', см.выше.
#*скорость - ''115200''
#*количество битов в посылке - ''8''
#*количество стоп-битов - ''1''
#*чётность - ''нет''
#*контроль потока - ''нет'' <br /><br />
#:[[Файл:Putty serial settings.png|500px]] <br /><br />
#В меню слева выберите первый пункт - ''Session''. Справа переключите тип подключения на Serial - должны автоматически заполниться настройки порта. Затем нажмите ''Open''.<br /><br />
#:[[Файл:Putty serial open.png|500px]] <br /><br />
#Чтобы проверить, правильно ли вы всё сделали:
#*для Wiren Board 5.6 и младше: кнопкой выключите и включите контроллер - на экране должны появиться сообщения о загрузке.
#*для Wiren Board 5.8 и старше: нажмите Enter. Будет предложена авторизация.
#**запрос логина - введите ''root'' и нажмите ''Enter'',
#**запрос пароля - введите ''wirenboard'' (вводимые символы не будут отображаться) и нажмите ''Enter''.<br /><br />
#Появится приветственное сообщение - вы в консоли контроллера. Для перехода в визуальный файловый менеджер введите <code>mc</code>.<br /><br />
#:[[Файл:Putty serial logged in.png|500px]]


== Настройка работы отладочного порта в Linux для WB6.4 и выше ==
wirenboard-AQ4RCD2E login:
</syntaxhighlight>


'''Суть проблемы:''' на некоторых системах процесс ModemManager автоматически открывает устройство ''/dev/ttyACM0''.
Вводите логин, пароль ({{Wbincludes:Controller SSH Default Login Password|short=true}}) — командная строка в вашем распоряжении. Можете настроить сеть, исправить конфигурационные файлы, посмотреть логи и т. д.  
Для этого необходимо отключить ModemManager для данного устройства с помощью правил ''udev''.


* Создаем файл исключений ''udev''
ВАЖНО! При работе с Debug console на экран время от времени будут «выпадать» сообщения от работающих сервисов Linux. Особенно, если сервис работает с ошибкой. Вы можете продолжать ввод команды с клавиатуры — все будет отработано корректно. Для отключения вывода «лишних» сообщений на экран используйте команду <code>dmesg -n1</code>. Теперь будут выводится только те сообщения, которые требуют немедленного вмешательства.
<syntaxhighlight lang="bash"> sudo nano /etc/udev/rules.d/99-wb-debug-usb.rules </syntaxhighlight>


* в который записываем cтрочку
Логи можно смотреть через [[Journalctl]].
<syntaxhighlight lang="bash"> ATTRS{idVendor}=="04d9" ATTRS{idProduct}=="b534", ENV{ID_MM_DEVICE_IGNORE}="1" </syntaxhighlight>


* После сохранения файла необходимо перезагрузить правила ''udev'':
''' Если контроллер неисправен '''
<syntaxhighlight lang="bash"> sudo udevadm control --reload-rules </syntaxhighlight>


== Как найти штырьки разъёма отладочного порта на Wiren Board 5.6 и младше ==
Если контроллер нормально не функционирует - отключите питание контроллера выключателем.
=== Wiren Board 5 ===
{{note|info| Для Wiren Board 7 также отключите кабель USB (контроллер получает питание от USB, в обход выключателя). }}
Debug UART для версии 5.3 выведен на боковую панель, для 5.6 - выведен на гребенку между разъемами FW и IR.
Включите питание контроллера. Начнется загрузка контроллера.
{{note|info| Для Wiren Board 7 сначала присоедините кабель (сразу начнется загрузка контроллера), затем включите выключатель (для питания модулей расширения).}}
Наблюдайте сообщения, появляющиеся на экране при загрузке контроллера. Текст меняется быстро, отследить его невозможно. Но, если возникнет критическая ошибка — загрузка остановится, и сообщение об ошибке будет у вас перед глазами.


<gallery mode="packed" heights=200 widths=200 style="text-align:left">
Пролистывая экран назад вы можете просмотреть все сообщения, выведенные при загрузке. Обращайте внимание на  слова error, warning, filed. Не можете сами разобраться — записывайте сеанс в лог файл и обращайтесь в нашу техподдержку.
Image:Wb53 uart.jpg|Wiren Board 5.3
Image:Wb56 uart.jpg|Wiren Board 5.6
</gallery>
=== Wiren Board 4 ===
Выведен на боковую панель рядом с разъёмами для microSD и microSIM карт.
<gallery mode="packed" heights=200 widths=200 style="text-align:left">
Image:WirenBoard4DebugConsole.png|Wiren Board 4
</gallery>


===Wiren Board Smart Home 3.5===
== Физическая реализация в контроллерах ==
Debug UART выведен на разъём UEXT1, а также отдельно на гребёнку (рядом с аудиовыходом, см. схему)
{|  border="1" class="wikitable"
Для Debug UART используются ножки 2,3,4 (см. рисунок).
! Версия контроллера || Тип разъема || Название разъема || Интерфейс || Чип USB/UART
 
|-
<gallery mode="packed" heights=400 widths=400 style="text-align:left">
| 7.x || USB-C ||  Debug Console || USB/UART || HT42B534
Image:WB3.5.png|Wiren Board Smart Home rev 3.5
|-
</gallery>
| 6.4-6.9 || Micro-USB ||  Debug Console || USB/UART || HT42B534
 
|-
===Wiren Board 2.8===
| 5.8-6.3 || Micro-USB ||  Debug Console || USB/UART || CH340
Выведен на разъём UEXT1 (чёрный разъём с десятью штырьками на длинной стороне платы).
|-
 
| 5.6.1 || 3-pin UART (Gnd, Rx, TX) ||  UART || UART (3,3B) || -
<gallery mode="packed" heights=200 widths=200 style="text-align:left">
|-
Image:UEXTPINS.jpg|thumb|UEXT pinout for [[Insulation-displacement connector|IDC]] connector<br/>(looking into connector on host board)
| 4, 5.3 || 3-pin UART (Gnd, Rx, TX) ||  Debug UART || UART (3,3B) || -
</gallery>
|-
| 2.8, 3.5 || 3-pin UART (Gnd, Rx, TX) ||  UEXT1 (выводы 2,3,4) и 3-pin разъем без названия|| UART (3,3B) || -
|-
|}
Программно во всех случаях это последовательный порт.

Текущая версия на 10:58, 12 января 2024

Описание

У контроллеров Wiren Board есть отладочный порт. Он обозначен как «Debug console».

  • Wiren Board 7.x

  • Wiren Board 6.x

  • Wiren Board 5.8 и 5.9

Подключившись к нему, как и в случае SSH подключения, вы превращаете свой компьютер в монитор и клавиатуру контроллера. И получаете доступ к его консоли (командной строке). А в отличие от SSH, вы сможете увидеть информацию, выводимую контроллером на экран при его начальной загрузке.

Нужен этот порт для аварийных ситуаций, когда подключения по сети недоступны. Например, если вы неверно сконфигурировали сеть, и контроллер не может к ней подключиться. Или, если возникла какая-то проблема, мешающая контроллеру нормально загрузиться. Для обычной работы использовать это подключение мы не рекомендуем, используйте веб-интерфейс или SSH.

Подключение

Про командную строку, SSH и Debug Console

Если у вас контроллер Wiren Board 5.6 и старее, обратитесь к статье .

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

Бывают кабели с такими же разъёмами, но предназначенные только для зарядки — они не подойдут.

Для подключения Wiren Board 7 к компьютеру нужен кабель USB Тип A – USB Тип C.

Для подключения более ранних контроллеров - USB тип A – Micro-USB Тип B.

Самый простой способ проверить, подходит ли кабель для подключения к контроллеру — подключить к компьютеру через этот кабель мобильный телефон. Если компьютер обнаружил новое устройство — кабель можно использовать и для контролера.

Настройка порта, программное обеспечение

Необходимо определить, к какому порту компьютера подключен Wiren Board, и настроить этот порт в соответствии с настройками Debug console.

Параметры порта Debug console
Параметр Значение Описание
Baud rate 115200 Скорость, бит/с
Data bits 8 Количество битов данных
Parity None Бит чётности
Stop bits 1 Количество стоповых битов
Hardware flow control None Аппаратный контроль потока
Software flow control None Программный контроль потока

Windows

Если у вас на компьютере Windows 10, а контроллер Wiren Board 6.4 или новее, то система сама, после физического подключения, назначит виртуальный COM порт и установит необходимый драйвер. Увидеть номер этого порта можно в Диспетчере устройств Windows:

Dispatcher.png


При использовании Windows XP, 7, 8 скачайте и установите драйвер. Для установки драйвера вам потребуются навыки администрирования ОС Windows, ссылки на файлы:

Далее подключайте контроллер, и в Диспетчере устройств Windows вы должны увидеть виртуальный COM порт, как на иллюстрации выше.

В качестве программы для общения с контроллером мы рекомендуем использовать MobaXterm от компании Mobatek. ЕЕ возможности очень обширны. В платной версии их больше, но для наших целей достаточно и бесплатной версии.

Нам нужно создать новую сессию Sessions → New session → Serial:

Sessions.png


и настроить ее:

Basic.png


Во вкладке Terminal settings вы можете настроить шрифт, цвета и, при необходимости, указать файл для записи всего, что будет выводится на экран во время сеанса:

SessionLog.png


А во вкладке Bookmark settings укажите внятное название сессии:

SessionName.png


Linux

Порт должен назначиться автоматически. В выводе команды dmesg контроллеров Wiren Board 6.4 или новее должна появиться строка: 

cdc_acm:3-6:1.0: ttyACM0: USB ACM device

В более ранних версиях: 

usb 1-1: ch341-uart converter now attached to ttyUSB0

Номер порта ttyUSBx или ttyACMx может меняться, в зависимости от того, что у вас подключено к контроллеру.

Для работы с Debug console мы рекомендуем использовать Minicom. Команда для подключения будет выглядеть так: 

minicom -D /dev/ttyACM0 -b 115200 -8 -a off

Скорее всего, для доступа к порту вам понадобятся права суперпользователя - используйте sudo.

Более подробно про Minicom смотрите в нашем руководстве.

Linux — возможные проблемы

Сервис ModemManager может мешать работе с портом. Если у вас WirenBoard 6.4 или новее — правильно сконфигурируйте udev.

  • Создайте файл исключений udev:
sudo nano /etc/udev/rules.d/99-wb-debug-usb.rules
  • Добавьте в него строчку:
ATTRS{idVendor}=="04d9" ATTRS{idProduct}=="b534", ENV{ID_MM_DEVICE_IGNORE}="1"
  • После сохранения файла перезагрузите правило udev:
sudo udevadm control --reload-rules

В свежих операционных системах Linux может потребоваться отредактировать файл: 

/lib/systemd/system/ModemManager.service

Подробности здесь:

ModemManager does not honor blacklisted ttys

SystemD ModemManager: failed to set dtr/rts

MacOS

Если у вас Wiren Board 7 и Mac с USB Тип C на процессоре Intel - нужно отключить питание контроллера, он будет питаться от USB. При наличии питания порт операционной системой не определяется. На более старые Mac и Mac на процессорах Apple эта особенность не распространяется.

Начиная с версии MacOS 10.14 Mojave все должно определиться автоматически. Предыдущие версии, возможно, потребуют установки драйвера CH341SER_MAC.

При подключении создается устройство:

Wiren Board 7 Wiren Board 6.4 и новее Более ранние
/dev/tty.usbmodemWB71 /dev/tty.usbmodem00001 /dev/tty.usbserial-1410

Встроенная утилита cu позволит вам работать с Debug console: 

sudo cu -s 115200 -l /dev/tty.usbserial-1410

Для выхода из cu введите символы 

~!

MacOS — возможные проблемы

Порт может не определиться. Потребуется установка драйвера. Для этого (начиная с MacOS High Sierra 10.13) нужно дать на это разрешение в Settings → Security&Privacy → Allow apps downloaded from:

Allow.png


И вот хорошая статья - человек подключает Arduino к MacOS. Хоть устройство и другое, но там используется точно такой же чип. Возможно, там есть ответы на ваши вопросы.

Android

OTG-кабель

Начиная с Android версии 9 все работает без установки дополнительных драйверов. Подключение через OTG. Тестировалось с приложением USB Serial Console, если ссылка не работает - ищите в Google Play.

Работа с отладочным портом

Отладочная консоль

Итак:

  • Контроллер к компьютеру подключен;
  • Программа запущена;
  • Настройки порта программы соответствуют настройкам порта Debug console.

Теперь можно начинать работу.

Если контроллер исправен

Если контроллер работает нормально — вы будете видеть сообщения, выводимые операционной системой контроллера на консоль. Нажав клавишу ENTER, вы увидите приглашение операционной системы, типа такого: 

Debian GNU/Linux 11 wirenboard-AQ4RCD2E ttyS0

wirenboard-AQ4RCD2E login:

Вводите логин, пароль (по умолчанию root/wirenboard) — командная строка в вашем распоряжении. Можете настроить сеть, исправить конфигурационные файлы, посмотреть логи и т. д.

ВАЖНО! При работе с Debug console на экран время от времени будут «выпадать» сообщения от работающих сервисов Linux. Особенно, если сервис работает с ошибкой. Вы можете продолжать ввод команды с клавиатуры — все будет отработано корректно. Для отключения вывода «лишних» сообщений на экран используйте команду dmesg -n1. Теперь будут выводится только те сообщения, которые требуют немедленного вмешательства.

Логи можно смотреть через Journalctl.

Если контроллер неисправен

Если контроллер нормально не функционирует - отключите питание контроллера выключателем. Для Wiren Board 7 также отключите кабель USB (контроллер получает питание от USB, в обход выключателя). Включите питание контроллера. Начнется загрузка контроллера. Для Wiren Board 7 сначала присоедините кабель (сразу начнется загрузка контроллера), затем включите выключатель (для питания модулей расширения). Наблюдайте сообщения, появляющиеся на экране при загрузке контроллера. Текст меняется быстро, отследить его невозможно. Но, если возникнет критическая ошибка — загрузка остановится, и сообщение об ошибке будет у вас перед глазами.

Пролистывая экран назад вы можете просмотреть все сообщения, выведенные при загрузке. Обращайте внимание на слова error, warning, filed. Не можете сами разобраться — записывайте сеанс в лог файл и обращайтесь в нашу техподдержку.

Физическая реализация в контроллерах

Версия контроллера Тип разъема Название разъема Интерфейс Чип USB/UART
7.x USB-C Debug Console USB/UART HT42B534
6.4-6.9 Micro-USB Debug Console USB/UART HT42B534
5.8-6.3 Micro-USB Debug Console USB/UART CH340
5.6.1 3-pin UART (Gnd, Rx, TX) UART UART (3,3B) -
4, 5.3 3-pin UART (Gnd, Rx, TX) Debug UART UART (3,3B) -
2.8, 3.5 3-pin UART (Gnd, Rx, TX) UEXT1 (выводы 2,3,4) и 3-pin разъем без названия UART (3,3B) -

Программно во всех случаях это последовательный порт.

Источник — https://wirenboard.com/wiki/index.php?title=Debug_Console&oldid=78412