Samples: add information on installing dfu-util

This was on the `Update` page, but not here.

Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
Sean Cross 2018-09-01 16:45:55 +08:00
parent a87bf87b59
commit 9d509a8130

View file

@ -18,6 +18,50 @@ Project | DFU | Description
**[usb-cdcacm](https://github.com/im-tomu/tomu-quickstart/tree/master/usb-cdcacm)** | [usb-cdcacm.dfu](https://github.com/im-tomu/tomu-quickstart/raw/master/prebuilt/usb-cdcacm.dfu) | Communicate with Tomu over a virtual serial port.
**[opticspy](https://github.com/im-tomu/tomu-quickstart/tree/master/opticspy)** | [opticspy.dfu](https://github.com/im-tomu/tomu-quickstart/raw/master/prebuilt/opticspy.dfu) | Interactive shell to communicate with an [OpticSpy](http://www.grandideastudio.com/opticspy/)
## Installing dfu-util
The `dfu-util` suite of programs is used to talk to `Toboot`,
the Tomu bootloader. Most package managers have some form of
`dfu-util` available.
### Ubuntu and Debian
````sh
sudo apt-get install dfu-util
````
Create `/etc/udev/rules.d/10-tomu.rules` and populate it with the following:
````udev
ATTRS{idProduct}=="70b1", ATTRS{idVendor}=="1209", MODE="777"
````
(Note: you can give it a more restrictive mode if you also give it a group that you're in)
### Fedora
````sh
sudo yum install dfu-util
````
### Arch
````sh
sudo pacman -Sy dfu-util
````
### Windows
Download [dfu-util-static.exe](http://dfu-util.sourceforge.net/releases/dfu-util-0.8-binaries/win32-mingw32/dfu-util-static.exe) from the `dfu-util` repository and rename it to `dfu-util.exe`. Place it somewhere in your $PATH for convenience. To build examples, you'll also want to get [dfu-suffix.exe](http://dfu-util.sourceforge.net/releases/dfu-util-0.8-binaries/win32-mingw32/dfu-suffix.exe) and put it in your $PATH.
### Mac
Install [Homebrew](https://brew.sh/) and run:
````sh
brew install dfu-util
````
## Compiling Samples
To compile the samples, you will need an ARM compiler, `make`, and `dfu-util`. The steps to install these files vary depending on your operating system: