Skip to content

Commit 8fd8e86

Browse files
committed
add Linux troubleshooting instructions
1 parent 9d69cd2 commit 8fd8e86

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/docs/01-build-guide/03-flash-and-configure.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Next, we will flash the Transit Tracker firmware to the Matrix Portal board, con
44

55
## Flash Firmware
66

7+
:::note
8+
If you're flashing on a Linux machine, see [this section](../02-user-manual/03-troubleshooting.md#cant-flash-firmware-on-linux) regarding permissions if you are having trouble.
9+
:::
10+
711
1. Plug the board into your computer.
812
2. Go to the <a href="/configurator" target="_blank">configurator</a> and press "Initial setup".
913
3. Hold the "Boot" button on the board. While continuing to hold "Boot", press "Reset" at the same time, then let go of both buttons. The board is successfully in flashing mode if you don't see anything on the displays.

docs/docs/02-user-manual/03-troubleshooting.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,20 @@ If you are having trouble pushing your Transit Tracker's configuration via USB,
2222
6. Try using a different USB port on your computer.
2323
7. If you're using a USB hub, try connecting directly to your computer instead.
2424

25+
### Can't flash firmware on Linux
26+
27+
If you are using a Linux machine and are having trouble flashing the firmware, you may need to give your user permission to access the USB device. For most distributions, you can follow these steps:
28+
29+
1. Run the following command to add your user to the `dialout` group:
30+
31+
```bash
32+
sudo usermod -aG dialout $USER
33+
```
34+
2. Log out and log back in for the group change to take effect.
35+
3. Try flashing the firmware again.
36+
37+
If it's still not working, consult your distribution's documentation for more information on managing USB device permissions. If you are using something like Flatpak or Snap to run your browser, you may need to give it additional permissions to access USB devices.
38+
2539
## Status Messages
2640

2741
If you see a status message on your Transit Tracker instead of the schedule, that can help diagnose an issue. Here are the possible status messages and their meanings.

0 commit comments

Comments
 (0)