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

feat(docs): Document adding USB logging to a standalone board (#2039)

Browse source 
Currently this is only documented in the zephyr 3.0 upgrade blog. This explicitly documents it as well as when it doesn't need to be applied (i.e. when a mcu board is already in use).
This commit is contained in:
ReFil 2023-11-27 17:12:33 +00:00 • committed by GitHub
parent a3f30ee799
commit 84b93350b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -83,3 +83,32 @@ You should see tio printing `Disconnected` or `Connected` when you disconnect or
</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.
## Adding USB Logging to a Board
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`.
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";
};
};
```
Then you can add the `zephyr,console` binding in the `chosen` node:
```dts
/ {
chosen {
...
zephyr,console = &cdc_acm_uart;
};
...
};
```