Skip to content

Commit b3fe5f7

Browse files
MPAE-18393: Fixed tool name
1 parent 5737b79 commit b3fe5f7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This example demonstrates how to utilize MPLAB Code Configurator (MCC) generated code to set up various Microchip Device Firmware Update (MDFU) bootloader solutions for the PIC18F56Q24 Curiosity Nano Evaluation board.
88

9-
The MDFU is a firmware update system that employs a device-independent host application to update application firmware. The application image loaded into the host adheres to a custom file format, incorporating device and application-specific parameters necessary for the update. This repository offers a foundational setup to configure and customize the MCC Melody 8-Bit MDFU Client library on the PIC18F56Q24 Curiosity Nano Base for Click boards™, along with instructions for executing the examples.
9+
The MDFU is a firmware update system that employs a device-independent host application to update application firmware. The application image loaded into the host adheres to a custom file format, incorporating device and application-specific parameters necessary for the update. This repository offers a foundational setup to configure and customize the MCC Melody 8-Bit MDFU Client library on the PIC18F56Q24 Curiosity Nano Evaluation board, along with instructions for executing the examples.
1010

1111
This example demonstrates:
1212
- How to configure the 8-Bit MDFU Client library in MCC Melody for different verification schemes
@@ -39,7 +39,7 @@ This example demonstrates:
3939

4040
## Setup
4141

42-
The following project setup steps demonstrate the basic configuration for setting up the 8-Bit MDFU Client with Universal Asynchronous Receiver-Transmitter (UART) communication. The configuration bits, clock, Non-Volatile Memory (NVM), and General Purpose Input/Output (GPIO) settings will be consistent across all examples in this repository and any deviations from this setup due to the chosen communication protocol will be described individually later in this section.
42+
The following project setup steps demonstrate the basic configuration for setting up the 8-Bit MDFU Client with Universal Asynchronous Receiver-Transmitter (UART) communication. The configuration bits, clock, Non-Volatile Memory (NVM), and General Purpose Input/Output (GPIO) settings will be consistent across all examples in this repository, and any deviations from this setup due to the chosen communication protocol will be described individually later in this section.
4343

4444
### [Client Setup](#client-setup)
4545
[![mdfu-builder](images/ProjectConfigurationOverview.PNG)](images/ProjectConfigurationOverview.PNG)
@@ -66,7 +66,7 @@ The following project setup steps demonstrate the basic configuration for settin
6666

6767
**8-Bit MDFU Client**
6868

69-
This section will guide you through the setup process for UART communication. For more details on configuring and operating other communication protocols, please refer to the pages listed below:
69+
This section will guide you through the setup process for UART communication. For more details on configuring and operating other communication protocols, refer to the pages listed below:
7070
- [SPI Communication](spi/Readme.md)
7171

7272
**8-Bit MDFU Client with UART Communication**
@@ -115,7 +115,7 @@ This section will guide you through the setup process for UART communication. Fo
115115

116116
[![IO-Pins](images/IOPortSetup.PNG)](images/IOPortSetup.PNG)
117117
- BOOT INDICATE: Start High
118-
- BOOT ENTRY: Weak Pull up
118+
- BOOT ENTRY: Weak Pull-up
119119

120120
[![IO-Settings](images/IOPinsSetup.PNG)](images/IOPinsSetup.PNG)
121121

@@ -145,7 +145,7 @@ This section is consistent for any example created in this repository.
145145
**I/O Pins**
146146
- GPIO Input: RF3
147147
- Custom Name: BTN
148-
- Weak Pull up: Enabled
148+
- Weak Pull-up: Enabled
149149
- GPIO Output: RF2
150150
- Custom Name: LED
151151

@@ -181,7 +181,7 @@ Fill Flash Memory
181181
[![app_fill](images/AppFill.PNG)](images/AppFill.PNG)
182182

183183
## Operation
184-
In this section, we will walkthrough how to run the examples in this repository. This example shows how to execute the CRC32 verification example and update the device Flash memory with the CRC32 application image to demonstrate a successful device firmware update (DFU).
184+
This section explains how to run the examples in this repository. This example shows how to execute the CRC32 verification example and update the device Flash memory with the CRC32 application image to demonstrate a successful device firmware update (DFU).
185185

186186
**8-Bit MDFU Client Operation**
187187

@@ -197,7 +197,7 @@ In this section, we will walkthrough how to run the examples in this repository.
197197

198198
[![CleanBuild](images/CleanAndBuildMDFU.png)](images/CleanAndBuildMDFU.png)
199199

200-
4. Program the MDFU Client Project
200+
4. Program the MDFU Client Project.
201201

202202
[![ProgramMDFU](images/ProgramMDFU.PNG)](images/ProgramMDFU.PNG)
203203

@@ -239,7 +239,7 @@ Right click, then select Clean and Build
239239

240240
5. Use the [pymdfu](https://pypi.org/project/pymdfu/) host tool to transfer the application image file to the bootloader.
241241

242-
> **Tip**: You can find the COM port of the MCU using the MPLAB Data Visualizer.*
242+
> **Tip**: You can find the COM port of the MCU using the MPLAB® Data Visualizer.
243243
244244
- To run the update with the examples, navigate to the project tab and right click, *Important Files>`pymdfu_update.bat`* for Windows or *Important Files>`pymdfu_update.sh`* for Mac and Linux. Double click to open the file.
245245
- Edit the port number to the CDC port name that is assigned to the Curiosity Nano device

0 commit comments

Comments
 (0)