aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--embassy-usb-logger/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/embassy-usb-logger/README.md b/embassy-usb-logger/README.md
new file mode 100644
index 000000000..81b0dcd0e
--- /dev/null
+++ b/embassy-usb-logger/README.md
@@ -0,0 +1,15 @@
1# embassy-usb-logger
2
3USB implementation of the `log` crate. This logger can be used by any device that implements `embassy-usb`. When running,
4it will output all logging done through the `log` facade to the USB serial peripheral.
5
6## Usage
7
8Add the following embassy task to your application. The `Driver` type is different depending on which HAL you use.
9
10 ```rust
11#[embassy_executor::task]
12async fn logger_task(driver: Driver<'static, USB>) {
13 embassy_usb_logger::run!(1024, log::LevelFilter::Info, driver);
14}
15```