Browse Source

Added Arduino IDE to USB Logging

xmkb
Kevin 4 years ago
parent
commit
ec6215f38e
  1. 23
      docs/docs/dev-guide-usb-logging.md

23
docs/docs/dev-guide-usb-logging.md

@ -3,6 +3,9 @@ id: dev-guide-usb-logging @@ -3,6 +3,9 @@ id: dev-guide-usb-logging
title: USB Logging
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview
If you are developing ZMK on a device that does not have a built in UART for debugging and log/console output,
@ -11,7 +14,7 @@ messages to that device instead. @@ -11,7 +14,7 @@ messages to that device instead.
## Kconfig
The following KConfig values need to be set, either by copy and paste into the `app/prj.conf` file, or by running
The following KConfig values need to be set, either by copy and pasting into the `app/prj.conf` file, or by running
`west build -t menuconfig` and manually enabling the various settings in that UI.
```
@ -42,12 +45,26 @@ CONFIG_USB_UART_DTR_WAIT=n @@ -42,12 +45,26 @@ CONFIG_USB_UART_DTR_WAIT=n
## Viewing Logs
After flashing the updated ZMK image, the board should expose a USB CDC ACM device, that you can connect to and view the logs.
After flashing the updated ZMK image, the board should expose a USB CDC ACM device that you can connect to and view the logs.
On Linux, this should be a device like `/dev/ttyACM0` and you can connect with `minicom` or `tio` as usual, e.g.:
<Tabs
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'Windows', value: 'windows'},
]}>
<TabItem value="linux">
On Linux, this should be a device like `/dev/ttyACM0` and you can connect with `minicom` or `tio` as usual, e.g.:
```
sudo tio /dev/ttyACM0
```
</TabItem>
<TabItem value="windows">
On Windows, you can use the Arduino IDE which contains a built-in Serial Monitor. Download and install it from [their website](https://www.arduino.cc/en/main/software), then connect your board and under Tools select "Serial Monitor".
</TabItem>
</Tabs>
From there, you should see the various log messages from ZMK and Zephyr, depending on which systems you have set to what log levels.

Loading…
Cancel
Save