espressif_tinyusb/examples/readme.md

46 lines
1.3 KiB
Markdown
Raw Normal View History

2018-12-13 09:20:28 +01:00
# Examples
2019-09-06 11:50:00 +02:00
## Clone this repo
```
$ git clone https://github.com/hathach/tinyusb tinyusb
$ cd tinyusb
```
## Fetch submodule MCUs drivers
TinyUSB examples includes external repos aka submodules to provide low-level MCU peripheral's driver to compile with. Therefore we will firstly fetch those mcu driver repo by running this command in the top folder repo
```
$ git submodule update --init --rescursive
```
It will takes a bit of time due to the number of supported MCUs, luckily we only need to do this once.
## Build
[Here is the list of supported Boards](docs/boards.md) that should work out of the box with provided examples.
To build example, go to its folder project then type `make BOARD=[our_board] all` e.g
```
$ cd examples/device/cdc_msc_hid
$ make BOARD=feather_nrf52840_express all
```
## Flash
2019-09-09 06:24:43 +02:00
`flash` target will use the on-board debugger (jlink/cmsisdap/stlink/dfu) to flash the binary. We should install those debugger/programmer software in advance. Futhermore, since external jlink can be used with most of the board, there is also `flash-jlink` target for out convenience.
2019-09-06 11:50:00 +02:00
```
$ make BOARD=feather_nrf52840_express flash
2019-09-09 06:24:43 +02:00
$ make BOARD=feather_nrf52840_express flash-jlink
```
Some board use uf2 bootloader for drag & drop in to mass storage device, uf2 can be generated with `uf2` target
```
$ make BOARD=feather_nrf52840_express all uf2
2019-09-06 11:50:00 +02:00
```