kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review

Browse source 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
ReFil 2023-11-27 08:53:58 +00:00 • committed by GitHub
parent 1ddb813bcf
commit 3612ecdf9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/docs/development/usb-logging.md
View file

@ -86,29 +86,29 @@ From there, you should see the various log messages from ZMK and Zephyr, dependi
## Adding USB logging to a board
Standard boards such as the nice!nano and Seeeduinoo XIAO family have logging already added, however if you are developing your own standalone board you may wish to add the ability to use USB logging in the future.
Standard boards such as the nice!nano and Seeeduino XIAO family have the necessary configuration for logging already added, however if you are developing your own standalone board you may wish to add the ability to use USB logging in the future.
To add USB logging to a board you need to define the USB CDC ACM device that the serial output gets piped to as well as adding the console in the `chosen` node inside `<board>.dts`
To add USB logging to a board you need to define the USB CDC ACM device that the serial output gets piped to, as well as adding the console in the `chosen` node inside `<board>.dts`.
Inside the USB device (`&usbd`), add the CDC ACM node:
```dts
&usbd {
status = "okay";
cdc_acm_uart: cdc_acm_uart {
compatible = "zephyr,cdc-acm-uart";
};
status = "okay";
cdc_acm_uart: cdc_acm_uart {
compatible = "zephyr,cdc-acm-uart";
};
};
```
Then you can add the `zephyr,console` binding in the `chosen` node
Then you can add the `zephyr,console` binding in the `chosen` node:
```dts
/ {
chosen {
chosen {
...
zephyr,console = &cdc_acm_uart;
};
...
zephyr,console = &cdc_acm_uart;
};
...
};
```