Skip to content

Commit dc11842

Browse files
committed
minor fix: README style fixes
- Related to #10
1 parent 92d1860 commit dc11842

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<p align="center">
1616
Program your STM32Fxx Over-the-Air using ESP32
1717
<br />
18-
<a href="https://github.com/laukik-hase/OTA_update_STM32_using_ESP32/"></a>
18+
**** <a href="https://github.com/laukik-hase/OTA_update_STM32_using_ESP32/"></a>
1919
<br />
2020
<a href="https://github.com/laukik-hase/OTA_update_STM32_using_ESP32/">View Code</a>
2121
·
@@ -39,6 +39,7 @@
3939
- [Setting Up](#setting-up)
4040
- [Disclaimer](#disclaimer)
4141
- [Usage (For STM32 Blue Pill)](#usage-for-stm32-blue-pill)
42+
- [Compatibility](#compatibility)
4243
- [Troubleshooting](#troubleshooting)
4344
- [Contributors](#contributors)
4445
- [Acknowledgements and Resources](#acknowledgements-and-resources)
@@ -48,7 +49,7 @@
4849

4950
The project aims at enabling firmware update of STM32Fxx and STM32Gxx series MCUs Over-the-Air using ESP32.
5051

51-
Testing was done with ESP32-DevKitC v4 board and STM32F103C8T6 ([Blue Pill](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)), [STM32F072C8T6](https://www.st.com/en/microcontrollers-microprocessors/stm32f072c8.html) and STM32G431KB ([NUCLEO-G431KB](https://www.st.com/en/evaluation-tools/nucleo-g431kb.html)). You can try with any other STM32Fxx/STM32Gxx MCUs and let us know how it worked out.
52+
Testing was done with ESP32-DevKitC v4 board and STM32F103C8T6 ([Blue Pill](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)), [STM32F072C8T6](https://www.st.com/en/microcontrollers-microprocessors/stm32f072c8.html) and STM32G431KB ([NUCLEO-G431KB](https://www.st.com/en/evaluation-tools/nucleo-g431kb.html)). You can try with any other STM32Fxx/STM32Gxx MCUs and let us know how it worked out.
5253

5354
### Code
5455

@@ -76,7 +77,7 @@ To run the OTA demo, you need an ESP32 dev board (e.g. ESP32-WROVER Kit) or ESP3
7677

7778
You can also use [**CubeIDE**]((https://stackoverflow.com/questions/57017703/how-do-i-generate-a-binary-file-of-the-stm32-code)) or [**Keil**](https://www2.keil.com/stmicroelectronics-stm32) for generation of **.bin** files.
7879

79-
80+
8081
### Setting Up
8182

8283
1. Wire your STM32 (e.g. Blue Pill) to the ESP32 as follows:
@@ -96,16 +97,18 @@ We have assumed that the STM32 is already in boot mode before flashing the code
9697

9798
The program code uses only the path of the binary file to be flashed as a parameter. Thus, it can be easily integrated into any other projects as the file can be sent to ESP32 over any protocol (MQTT, HTTP Client, WebSockets).
9899

100+
Read carefully the Boot Mode Procedure ([AN2606](https://www.st.com/content/ccc/resource/technical/document/application_note/b9/9b/16/3a/12/1e/40/0c/CD00167594.pdf/files/CD00167594.pdf/jcr:content/translations/en.CD00167594.pdf)) and the USART protocol used in Bootloader Mode ([AN3105](https://www.st.com/content/ccc/resource/technical/document/application_note/51/5f/03/1e/bd/9b/45/be/CD00264342.pdf/files/CD00264342.pdf/jcr:content/translations/en.CD00264342.pdf)) in order to deeply understand how to use this project with other STM32 microcontrollers.
101+
99102
## Usage (For STM32 Blue Pill)
100103

101-
1. Make sure the BOOT0 jumper pin on the board is set to 1 (programming mode) while uploading the code. Once the code is flashed this pin can be changed back to initial position (operating mode). This procedure with your STM32Fxx MCU varies according with your MCU version.
102-
104+
1. Make sure the BOOT0 jumper pin on the board is set to 1 (programming mode) while uploading the code. Once the code is flashed this pin can be changed back to initial position (operating mode). This procedure with your STM32Fxx MCU varies according with your MCU version.
105+
103106
Refer this [documentation](https://www.st.com/content/ccc/resource/technical/document/application_note/b9/9b/16/3a/12/1e/40/0c/CD00167594.pdf/files/CD00167594.pdf/jcr:content/translations/en.CD00167594.pdf) for help.
104-
107+
105108
<p align="center">
106109
<kbd><img width="500" height="355" src="images/blue_pill_bm.jpg" border="5"></kbd>
107110
</p>
108-
111+
109112
2. Open the project configuration menu (`idf.py menuconfig`) go to `Example Connection Configuration` ->
110113
1. WiFi SSID: WiFi network to which your PC is also connected to.
111114
2. WiFi Password: WiFi password
@@ -138,7 +141,7 @@ The program code uses only the path of the binary file to be flashed as a parame
138141
6. Voila! your STM32 is now running the code you uploaded Over-the-Air!
139142

140143
## Compatibility
141-
According to ST documentation this project could be compatible with a wide range of microcontrollers, **prior to some customization**:
144+
According to STM documentation, this project could be compatible with a wide range of microcontrollers, **prior to some customization**:
142145
- **STM32F0 Series (verified)**
143146
- **STM32F1 Series (verified)**
144147
- STM32F2 Series
@@ -174,8 +177,6 @@ According to ST documentation this project could be compatible with a wide range
174177

175178
## Acknowledgements and Resources
176179

177-
Read carefully the Boot Mode Procedure (AN2606) and the USART protocol used in Bootloader Mode (AN3105) in order to deeply understand how use this script with other SMT32 micros.
178-
179180
* STM32 USART Protocol: [Documentation](https://www.st.com/content/ccc/resource/technical/document/application_note/51/5f/03/1e/bd/9b/45/be/CD00264342.pdf/files/CD00264342.pdf/jcr:content/translations/en.CD00264342.pdf)
180181

181182
* Python Script: [stm32loader.py](https://github.com/espruino/Espruino/blob/master/scripts/stm32loader.py)
@@ -189,7 +190,7 @@ Read carefully the Boot Mode Procedure (AN2606) and the USART protocol used in B
189190
* [HackerNews Article: Updating STM32 Over-The-Air using ESP32](https://news.ycombinator.com/item?id=23302664)
190191

191192
* [Reddit Post: Update STM32 Over-the-Air using ESP32](https://www.reddit.com/r/esp32/comments/jx399y/update_stm32_overtheair_using_esp32/)
192-
193+
193194
## License
194195

195196
Distributed under the MIT License. See `LICENSE` for more information.

0 commit comments

Comments
 (0)