Skip to content

Commit 146680d

Browse files
graham.sanderson@raspberrypi.comkilograham
authored andcommitted
update usb example info in README.md
1 parent e43d7a6 commit 146680d

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

+35-6
Original file line numberDiff line numberDiff line change
@@ -176,18 +176,47 @@ App|Description
176176

177177
### USB Device
178178

179+
#### TinyUSB Examples
180+
181+
All but one of the USB device examples come directly from the TinyUSB device examples directory [here](https://github.com/hathach/tinyusb/tree/master/examples/device).
182+
Those that are supported on RP2040 devices are automatically included as part of the pico-examples
183+
build as targets named `tinyusb_dev_<example_name>`, e.g. https://github.com/hathach/tinyusb/tree/master/examples/device/hid_composite
184+
is built as `tinyusb_dev_hid_composite`.
185+
186+
At the time of writing, these examples are available:
187+
188+
- tinyusb_dev_audio_4_channel_mic
189+
- tinyusb_dev_audio_test
190+
- tinyusb_dev_board_test
191+
- tinyusb_dev_cdc_dual_ports
192+
- tinyusb_dev_cdc_msc
193+
- tinyusb_dev_dfu
194+
- tinyusb_dev_dfu_runtime
195+
- tinyusb_dev_dynamic_configuration
196+
- tinyusb_dev_hid_composite
197+
- tinyusb_dev_hid_generic_inout
198+
- tinyusb_dev_hid_multiple_interface
199+
- tinyusb_dev_midi_test
200+
- tinyusb_dev_msc_dual_lun
201+
- tinyusb_dev_uac2_headset
202+
- tinyusb_dev_usbtmc
203+
- tinyusb_dev_webusb_serial
204+
205+
#### Low Level examples
179206
App|Description
180207
---|---
181-
[dev_audio_headset](usb/device/dev_audio_headset) | Audio headset example from TinyUSB
182-
[dev_hid_composite](usb/device/dev_hid_composite) | Composite HID (mouse + keyboard) example from TinyUSB
183-
[dev_hid_generic_inout](usb/device/dev_hid_generic_inout) | Generic HID device example from TinyUSB
184208
[dev_lowlevel](usb/device/dev_lowlevel) | A USB Bulk loopback implemented with direct access to the USB hardware (no TinyUSB)
185209

186210
### USB Host
187211

188-
App|Description
189-
---|---
190-
[host_hid](usb/host/host_hid) | Use USB in host mode to poll an attached HID keyboard (TinyUSB example)
212+
All the USB host examples come directly from the TinyUSB host examples directory [here](https://github.com/hathach/tinyusb/tree/master/examples/host).
213+
Those that are supported on RP2040 devices are automatically included as part of the pico-examples
214+
build as targets named `tinyusb_host_<example_name>`, e.g. https://github.com/hathach/tinyusb/tree/master/examples/host/cdc_msc_hid
215+
is built as `tinyusb_host_cdc_msc_hid`.
216+
217+
At the time of writing, there is only one host example available:
218+
219+
- tinyusb_host_cdc_msc_hid
191220

192221
### Watchdog
193222

0 commit comments

Comments
 (0)