Skip to content
Snippets Groups Projects
Commit 8f758663 authored by Stephen D's avatar Stephen D
Browse files

Merge branch 'firmware-update-readme' into 'master'

Firmware update readme

See merge request cats/mobile-transceiver-software!4
parents 6c05c9d4 5695be96
No related branches found
No related tags found
No related merge requests found
......@@ -49,9 +49,19 @@ The black hole can be configured with `set black_hole lat lon radius_meters`. Fo
Note that you probably don't want to center your black hole exactly on your house. It may be possible to work out its position based on when exactly you stop transmitting. Instead, you should configure the black hole to overlap with your house, without being centered.
## Compiling and flashing firmware
## Updating firmware (Linux only)
At the moment, updating the board's firmware requires manually compiling the new firmware and flashing it to the board. The setup for this isn't too bad and requires no specialized hardware.
**NOTE:** Currently, updating the firmware can only be done on Linux. If you don't have a Linux computer, a Raspberry Pi, Virtual Machine, or Live-booted distro can be used.
1. Download the flasher utility from [here](https://gitlab.scd31.com/cats/mobile-transceiver-software/builds/artifacts/master/browse/flasher?job=build-flasher).
2. Run the utility:
```bash
chmod +x flasher-linux
sudo ./flasher-linux
```
3. Follow the instructions on the screen. Afterwards, the board will restart automatically.
## Compiling firmware from source (Linux only)
### Environment setup
......@@ -68,7 +78,7 @@ cargo install flip-link # needed for building
cargo install cargo-dfu # needed for flashing
```
Finally, if you're on Linux, you may need to give yourself permission to write to the board.
Finally, you may need to give yourself permission to write to the board.
```bash
sudo cp udev.rules /etc/udev/rules.d/99-dfu-stm32.rules
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment