Skip to content

Commit 6c88ef0

Browse files
committed
Update BOSSA GUI docs
1 parent fb35d79 commit 6c88ef0

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

docs/firmware_update.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,29 @@ From time to time SparkFun will release new firmware for the LoRaSerial product
44

55
## BOSSA GUI
66

7-
![SparkFun BOSSA GUI](https://github.com/sparkfun/SparkFun_BOSSA_GUI/raw/main/img/BOSSA_GUI.png)
7+
![SparkFun BOSSA GUI](img/BOSSA_GUI_Windows.png)
88

9-
The LoRaSerial utilizes a SAMD21 microcontroller. To update the firmware, obtain the SparkFun BOSSA GUI from [this repo](https://github.com/sparkfun/SparkFun_BOSSA_GUI). The GUI is a Qt5 based python script that can be run from the command line. Alternatively, Windows-compatible executables are available in the [release section](https://github.com/sparkfun/SparkFun_BOSSA_GUI/releases).
9+
The LoRaSerial utilizes a SAMD21 microcontroller. To update the firmware, obtain the SparkFun BOSSA GUI from [this repo](https://github.com/sparkfun/SparkFun_BOSSA_GUI). The GUI is PyQt5 based on the Python SAM-BA Loader script that can be run from the command line. Alternatively, Windows, macOS and Linux-compatible executables are available in the [release section](https://github.com/sparkfun/SparkFun_BOSSA_GUI/releases). There is a Python package too, which works nicely on Raspberry Pi.
1010

1111
Next, get the latest LoRaSerial Firmware binary located in [LoRaSerial Binaries folder](https://github.com/sparkfun/SparkFun_LoRaSerial/tree/main/Binaries). Note: There are two types of firmware files, one 'with_bootloader' and one without. You can ignore the 'with_bootloader' type file.
1212

13-
![Enlcosure screw](img/SparkFun_LoRaSerial_Enclosure_Screw.jpg)
13+
Run the GUI.
14+
15+
Click `Browse` and select the firmware file.
16+
17+
Click the `COM Port` dialog box and select the correct port. On macOS, you will see two ports - select the one called `tty.usbmodem`.
18+
19+
Click `Upload Binary` to start the upload.
20+
21+
### Bootloader Mode
22+
23+
The BOSSA GUI will attempt to put the SAMD21 into bootloader mode automatically to perform the update. But we have noticed that this fails occasionally on some machines - it is machine-dependent.
24+
25+
![SparkFun BOSSA GUI](img/BOSSA_GUI_Windows_2.png)
26+
27+
On those machines, you will need to put the SAMD21 into bootloader mode manually by opening the case and giving the reset button a double-tap.
28+
29+
![Enclosure screw](img/SparkFun_LoRaSerial_Enclosure_Screw.jpg)
1430

1531
*Small Philips head screw*
1632

@@ -20,4 +36,4 @@ Remove the two side screws and open the LoRaSerial enclosure to expose the reset
2036

2137
*SAMD21 reset button*
2238

23-
Connect the LoRaSerial to the computer over USB. Double-tap the reset button to enter bootloader mode. You should see the blue LED slowly pulse on/off. Now open the BOSSA GUI, select the Binary file you downloaded, select the COM port of the LoRaSerial device, and finally click 'Upload Binary'.
39+
Connect the LoRaSerial to the computer over USB. Double-tap the reset button to enter bootloader mode. You should see the blue LED slowly pulse on/off. Now open the BOSSA GUI, select the Binary file you downloaded, select the COM port of the LoRaSerial device. ***Uncheck the SAMD21 check-box*** and finally click `Upload Binary`.

docs/img/BOSSA_GUI_Windows.png

16.4 KB
Loading

docs/img/BOSSA_GUI_Windows_2.png

19.3 KB
Loading

0 commit comments

Comments
 (0)