usernames in URLs updated

import-tiago · Jul 21, 2023 · e2dbd9b · e2dbd9b
1 parent b5d455f
commit e2dbd9b
Showing 1 changed file with 120 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -1,120 +1,120 @@
-DrizzlingBytes is a way to provide over-the-air (OTA) device firmware update (DFU) for MSP430-based systems.
-
-In this implementation, an ESP32 (SoC) acts as a Hosting Device, managing and downloading new firmware available from Firebase Storage and then programming the target MSP430 (MCU).
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/Overview.png" ></p>
-
-Access to the target's embedded memory is via the Bootstrap Loader (BSL), sometimes just called a "bootloader", available natively on MSP430 microcontrollers.
-
-The MSP430 bootstrap loader does not start automatically; a special sequence is required on the RST/NMI and TEST pins, and then, a serial communication to the target becomes available through BSL. The entire process for using this feature can be found in Texas Instruments [SLAA096B](https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Hardware/1.%20Datasheets/MSP430%20BSL/Application%20of%20Bootstrap%20Loader%20in%20MSP430%20With%20Flash%20Hardware%20and%20Software%20Proposal%20(SLAA096B).pdf) documentation, used as a reference in this implementation.
-
-Briefly, the process is as follows:
-
-Put the MSP430 in Bootstrap Loader mode by the following invocation process:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/BSLModeInvocation.png" ></p>
-
-From this point, the target is ready to communicate with the host. There are two ways to do this: from I2C or UART protocols. In this case, UART is the choice. The necessary settings for the peripheral are:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/BSLUARTSettings.png" ></p>
-
-And then writing the BSL commands as needed. The possibilities are:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/BSLCommandsList.png" ></p>
-
-All commands must be transmitted according to the BSL protocol shown below:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/BSLProtocol.png" ></p>
-
-Then, after performing the desired memory accesses, set the target to normal mode operation again, exiting BSL mode:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/NormalModeInvocation.png" ></p>
-
-All tests and validations were performed with the following circuit:
-
-<p align="center"><a href="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Hardware/0.%20Project/DrizzlingBytes.pdf"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/SchematicPreview.png"  title="Schematic Preview" alt="PDF Download"></a></p>
-
-As shown in the schematic above, the target MSP430 used for testing is an [MSP430FR4133](https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Hardware/1.%20Datasheets/MSP430%20BSL/Datasheet%20-%20MSP430FR413x%20Mixed-Signal%20Microcontrollers%20(Rev.%20F).pdf). In order to have a clear visual representation of whether or not the target firmware has been updated, two firmware versions have been pre-compiled: [Slow_Blinky](https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/Precompiled%20Firmware/Slow_Blinky/firmware.txt) and [Fast_Blinky](https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/Precompiled%20Firmware/Fast_Blinky/firmware.txt).
-
-The source code used to produce these files can be viewed below and [Code Composer Studio](https://www.ti.com/tool/CCSTUDIO) was used has Integrated Development Environment (IDE).
-
-```c
-#include <msp430.h>
-
-#define FAST 100000
-#define SLOW 1000000
-#define LED BIT7
-
-void main(void) {
-    WDTCTL = WDTPW | WDTHOLD;
-
-    P2OUT &= ~LED;
-    P2DIR |= LED;
-
-    PM5CTL0 &= ~LOCKLPM5;
-
-    while (1) {
-        P2OUT ^= LED;
-        __delay_cycles(SLOW);
-    }
-}
-```
-
-The version that makes the LED blink slowly was flashed to the MCU and the version that makes it blink faster was uploaded in Firebase Storage. That way, if the ESP32 is able to successfully download and update the target, it will be easily noticeable by the blinky frequency of the LED.
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/FirebaseStorage.png" ></p>
-
-Once the circuit is powered up, the ESP32 downloads the firmware from Firebase and starts the MSP430 programming process. The result of the BSL invocation as well as the periods of each pulse can be seen below:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/BSLInvocationSignals.png" ></p>
-
-If all goes well, the communication between HOST and TARGET can be seen through the UART ([Docklight](https://docklight.de/) used as serial terminal):
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/ESP32_Tx.png" ></p>
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/ESP32_Rx.png" ></p>
-
-Organizing and synchronizing the submissions and responses between the parties for better visualization, we have:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/UARTCommunicationSync.png" ></p>
-
-The assembled circuit used for the tests:
-
-<p align="center"><img src="https://github.com/TiagoPaulaSilva/DrizzlingBytes/blob/main/Assets/Breadboard.png" ></p>
-
-### Simplified Code Example
-This is a simplified code snippet to show the main functions of the MSP430 library from the Drizzling Bytes project. Check the [/Examples](https://github.com/TiagoPaulaSilva/DrizzlingBytes/tree/main/Examples/) directory for a complete implementation.
-```cpp
-#define CLOUD_FIRMWARE_ADDRESS "new/firmware.txt"
-#define SPIFFS_FIRMWARE_ADDRESS "download/firmware.txt"
-
-MSP430 BSL(ESP32_GPIO_RESET_PIN, ESP32_GPIO_TEST_PIN, Serial2, SPIFFS_FIRMWARE_ADDRESS);
-
-FirebaseStorage OTA(STORAGE_BUCKET_ADDRESS, FIREBASE_FIRMWARE_ADDRESS, SPIFFS_FIRMWARE_ADDRESS);
-
-void loop() {
-
-	OTA.Download_Firmware_and_Store_in_SPIFFS();
-
-	BSL.Load_from_SPIFFS_and_Store_in_RAM();
-
-	BSL.Invoke_MSP_BSL_Mode_Operation();
-
-	BSL.Write_Default_Password();
-
-	BSL.Write_Firmware();
-
-	BSL.Invoke_MSP_Normal_Mode_Operation();
-
-	while (1);
-}
-```
-
-### Contributing
-0. Give this project a :star:
-1. Create an issue and describe your idea.
-2. [Fork it](https://github.com/TiagoPaulaSilva/DrizzlingBytes/fork).
-3. Create your feature branch (`git checkout -b my-new-feature`).
-4. Commit your changes (`git commit -a -m "Added feature title"`).
-5. Publish the branch (`git push origin my-new-feature`).
-6. Create a new pull request.
-7. Done! :heavy_check_mark:
+DrizzlingBytes is a way to provide over-the-air (OTA) device firmware update (DFU) for MSP430-based systems.
+
+In this implementation, an ESP32 (SoC) acts as a Hosting Device, managing and downloading new firmware available from Firebase Storage and then programming the target MSP430 (MCU).
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/Overview.png" ></p>
+
+Access to the target's embedded memory is via the Bootstrap Loader (BSL), sometimes just called a "bootloader", available natively on MSP430 microcontrollers.
+
+The MSP430 bootstrap loader does not start automatically; a special sequence is required on the RST/NMI and TEST pins, and then, a serial communication to the target becomes available through BSL. The entire process for using this feature can be found in Texas Instruments [SLAA096B](https://github.com/import-tiago/DrizzlingBytes/blob/main/Hardware/1.%20Datasheets/MSP430%20BSL/Application%20of%20Bootstrap%20Loader%20in%20MSP430%20With%20Flash%20Hardware%20and%20Software%20Proposal%20(SLAA096B).pdf) documentation, used as a reference in this implementation.
+
+Briefly, the process is as follows:
+
+Put the MSP430 in Bootstrap Loader mode by the following invocation process:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/BSLModeInvocation.png" ></p>
+
+From this point, the target is ready to communicate with the host. There are two ways to do this: from I2C or UART protocols. In this case, UART is the choice. The necessary settings for the peripheral are:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/BSLUARTSettings.png" ></p>
+
+And then writing the BSL commands as needed. The possibilities are:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/BSLCommandsList.png" ></p>
+
+All commands must be transmitted according to the BSL protocol shown below:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/BSLProtocol.png" ></p>
+
+Then, after performing the desired memory accesses, set the target to normal mode operation again, exiting BSL mode:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/NormalModeInvocation.png" ></p>
+
+All tests and validations were performed with the following circuit:
+
+<p align="center"><a href="https://github.com/import-tiago/DrizzlingBytes/blob/main/Hardware/0.%20Project/DrizzlingBytes.pdf"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/SchematicPreview.png"  title="Schematic Preview" alt="PDF Download"></a></p>
+
+As shown in the schematic above, the target MSP430 used for testing is an [MSP430FR4133](https://github.com/import-tiago/DrizzlingBytes/blob/main/Hardware/1.%20Datasheets/MSP430%20BSL/Datasheet%20-%20MSP430FR413x%20Mixed-Signal%20Microcontrollers%20(Rev.%20F).pdf). In order to have a clear visual representation of whether or not the target firmware has been updated, two firmware versions have been pre-compiled: [Slow_Blinky](https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/Precompiled%20Firmware/Slow_Blinky/firmware.txt) and [Fast_Blinky](https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/Precompiled%20Firmware/Fast_Blinky/firmware.txt).
+
+The source code used to produce these files can be viewed below and [Code Composer Studio](https://www.ti.com/tool/CCSTUDIO) was used has Integrated Development Environment (IDE).
+
+```c
+#include <msp430.h>
+
+#define FAST 100000
+#define SLOW 1000000
+#define LED BIT7
+
+void main(void) {
+    WDTCTL = WDTPW | WDTHOLD;
+
+    P2OUT &= ~LED;
+    P2DIR |= LED;
+
+    PM5CTL0 &= ~LOCKLPM5;
+
+    while (1) {
+        P2OUT ^= LED;
+        __delay_cycles(SLOW);
+    }
+}
+```
+
+The version that makes the LED blink slowly was flashed to the MCU and the version that makes it blink faster was uploaded in Firebase Storage. That way, if the ESP32 is able to successfully download and update the target, it will be easily noticeable by the blinky frequency of the LED.
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/FirebaseStorage.png" ></p>
+
+Once the circuit is powered up, the ESP32 downloads the firmware from Firebase and starts the MSP430 programming process. The result of the BSL invocation as well as the periods of each pulse can be seen below:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/BSLInvocationSignals.png" ></p>
+
+If all goes well, the communication between HOST and TARGET can be seen through the UART ([Docklight](https://docklight.de/) used as serial terminal):
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/ESP32_Tx.png" ></p>
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/ESP32_Rx.png" ></p>
+
+Organizing and synchronizing the submissions and responses between the parties for better visualization, we have:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/UARTCommunicationSync.png" ></p>
+
+The assembled circuit used for the tests:
+
+<p align="center"><img src="https://github.com/import-tiago/DrizzlingBytes/blob/main/Assets/Breadboard.png" ></p>
+
+### Simplified Code Example
+This is a simplified code snippet to show the main functions of the MSP430 library from the Drizzling Bytes project. Check the [/Examples](https://github.com/import-tiago/DrizzlingBytes/tree/main/Examples/) directory for a complete implementation.
+```cpp
+#define CLOUD_FIRMWARE_ADDRESS "new/firmware.txt"
+#define SPIFFS_FIRMWARE_ADDRESS "download/firmware.txt"
+
+MSP430 BSL(ESP32_GPIO_RESET_PIN, ESP32_GPIO_TEST_PIN, Serial2, SPIFFS_FIRMWARE_ADDRESS);
+
+FirebaseStorage OTA(STORAGE_BUCKET_ADDRESS, FIREBASE_FIRMWARE_ADDRESS, SPIFFS_FIRMWARE_ADDRESS);
+
+void loop() {
+
+	OTA.Download_Firmware_and_Store_in_SPIFFS();
+
+	BSL.Load_from_SPIFFS_and_Store_in_RAM();
+
+	BSL.Invoke_MSP_BSL_Mode_Operation();
+
+	BSL.Write_Default_Password();
+
+	BSL.Write_Firmware();
+
+	BSL.Invoke_MSP_Normal_Mode_Operation();
+
+	while (1);
+}
+```
+
+### Contributing
+0. Give this project a :star:
+1. Create an issue and describe your idea.
+2. [Fork it](https://github.com/import-tiago/DrizzlingBytes/fork).
+3. Create your feature branch (`git checkout -b my-new-feature`).
+4. Commit your changes (`git commit -a -m "Added feature title"`).
+5. Publish the branch (`git push origin my-new-feature`).
+6. Create a new pull request.
+7. Done! :heavy_check_mark: