Skip to content

Commit dc34174

Browse files
committed
Docs: STM32 firmware update
1 parent 62ba48a commit dc34174

7 files changed

+34
-8
lines changed

docs/firmware_update_stm32.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,61 @@
22

33
Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Not Supported](img/Icons/RedDot.png)
44

5-
The STM32WLE firmware runs the 915MHz LoRa radio inside the RTK Torch. The firmware version number is displayed in the radio menu:
5+
The STM32WLE firmware runs the 915MHz LoRa radio inside the RTK Torch.
66

7-
![RTK Express with firmware v3.0](<img/Displays/SparkFun%20RTK%20Boot%20Screen%20Version%20Number.png>)
7+
![Menu showing firmware version 2.0.1](<img/Firmware/SparkFun RTK Everywhere - STM32 Firmware.png>)
88

99
*RTK Torch LoRa radio firmware version 2.0.1*
1010

11+
The firmware version number is displayed in the radio menu. If the device does not show this menu option the [ESP32 firmware](firmware_update_esp32.md) will need to be updated first.
12+
1113
Firmware updates to the STM32WLE can only be done over the serial interface. Follow these steps to update the LoRa radio firmware on the RTK Torch.
1214

1315
![UI of STM32CubeProgrammer](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer.png>)
1416

1517
1. Download and install [STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html). While it *is* available for Windows/Linux/iOS, ST makes it rather difficult to get this software. We're sorry!
1618

19+
20+
2. Download the latest STM32 LoRa binary from the [RTK Everywhere Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/STM32_LoRa) repo. As of writing, this is **RTK_Torch_STM32_LoRa_v2_0_1.bin**.
21+
1722
![Debug menu showing the STM32 direct connect option](<img/Firmware/SparkFun RTK Everywhere - STM32 Passthrough Menu.png>)
1823

19-
2. Open the main menu and select System (**s**), Hardware Debug (**h**), STM32 direct connect (**17**).
24+
3. Open the main menu and select System (**s**), Hardware Debug (**h**), STM32 direct connect (**17**).
2025

2126
![Passthrough mode output on reset](<img/Firmware/SparkFun RTK Everywhere - STM32 Passthrough 1.png>)
2227

23-
3. The device will automatically reset and show very little including various symbols. The device is now operating in pass-through mode at 57600bps, and ready to be programmed. If needed, to exit this pass-through mode, press and release the main power button.
28+
4. The device will automatically reset and show instructions. The device is now operating in pass-through mode at 57600bps, and ready to be programmed. If needed, to exit this pass-through mode, press and release the main power button.
2429

25-
4. Close the terminal connection. This will likely cause the device to reset - that is ok.
30+
5. Close the terminal connection. This will likely cause the device to reset - that is ok.
2631

2732
![Settings in STM32CubeProgrammer](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer Callouts.png>)
2833

29-
5. Open STM32CubeProgrammer. Select UART (blue box) and the programming interface. Set the Baudrate to 57600, No parity, RTS and DTR set to high.
34+
6. Open STM32CubeProgrammer. Select UART (blue box) and the programming interface. Set the Baudrate to 57600, No parity, RTS and DTR set to high.
3035

3136
![Don't select Read Unprotected](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer Read Unprotected.png>)
3237

33-
6. Avoid **Read Unprotected**. Do not enable. This setting writes to fuse bits and if there is a problem with serial communication, it can lead to an inoperable bootloader. The device can be repaired but only at SparkFun (we have to use a ST-Link to reprogram the fust bits over the SWD interface).
38+
7. Avoid **Read Unprotected**. Do not enable. This setting writes to fuse bits and if there is a problem with serial communication, it can lead to an inoperable bootloader. The device can be repaired but only at SparkFun (we have to use an ST-Link to reprogram the fuse bits over the SWD interface).
39+
40+
8. Select the COM port associated with COM-B of the RTK device. Not sure? Read [here](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/configure_with_serial/#rtk-torch). Once selected, click **Connect**.
41+
42+
![Connected to STM32](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer Connected.png>)
43+
44+
9. Once connected, select *Erasing & programming* on the left side menu.
45+
46+
![Programming button in STM32CubeProgrammer](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer Program.png>)
47+
48+
10. Select the binary file and click *Start Programming*.
49+
50+
![Programming complete confirmation](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer Program Complete.png>)
51+
52+
11. After a few seconds, programming will complete.
53+
54+
![Disconnect button](<img/Firmware/SparkFun RTK Everywhere - STM32CubeProgrammer Disconnect.png>)
55+
56+
12. Click disconnect to close the port.
57+
58+
13. Now press and release the power button on the Torch. The device will beep indicating it has exited pass-through mode. You can now use your device normally.
3459

35-
7. Select the COM port associated with COM-B of the RTK device. Not sure? Read [here](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/configure_with_serial/#rtk-torch). Once selected, click **Connect**.
60+
![Menu showing firmware version 2.0.1](<img/Firmware/SparkFun RTK Everywhere - STM32 Firmware.png>)
3661

62+
14. To confirm the version, open the Radio menu and enable the radio. Above, version 2.0.1 is seen.
9.96 KB
Loading
-72 KB
Loading
103 KB
Loading
6.11 KB
Loading
6.86 KB
Loading
91.1 KB
Loading

0 commit comments

Comments
 (0)