Skip to content

Commit 8512377

Browse files
author
Priyanka Tamhankar
committed
M8BTL-2809 Updated readMe to change "images\" to "images/"
1 parent 51616b0 commit 8512377

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -37,35 +37,35 @@ This example will demonstrate:
3737

3838
- PIC18F56Q24 Curiosity Nano [(EV01E86A)](https://www.microchip.com/en-us/development-tool/ev01e86a)
3939

40-
[![PIC18F56Q24_CNano](images\230928-mcu8-photo-ev01e86a-front-transparent.PNG)](images\230928-mcu8-photo-ev01e86a-front-transparent.PNG)
40+
[![PIC18F56Q24_CNano](images/230928-mcu8-photo-ev01e86a-front-transparent.PNG)](images/230928-mcu8-photo-ev01e86a-front-transparent.PNG)
4141

4242
---
4343
## Setup
4444

4545
The following project setup is the same for all the example project pairs. If something goes wrong while running these examples, confirm that the settings in the projects are consistent with the options seen in this section.
4646

4747
### Client Setup
48-
[![mdfu-builder](images\ProjectConfigurationOverview.PNG)](images\ProjectConfigurationOverview.PNG)
48+
[![mdfu-builder](images/ProjectConfigurationOverview.PNG)](images/ProjectConfigurationOverview.PNG)
4949

5050
**Configuration Bits**
5151
- External Oscillator Selection bits: Oscillator not enabled
5252
- Reset Oscillator Selection bits: HFINTOSC with HFFRQ = 64 MHz and CDIV = 1:1
5353

54-
[![CFG](images\ConfigBitsSetup.PNG)](images\ConfigBitsSetup.PNG)
54+
[![CFG](images/ConfigBitsSetup.PNG)](images/ConfigBitsSetup.PNG)
5555

5656
**Clock Control**
5757
- Clock Source: HFINTOSC
5858
- HF Internal Clock: 8_MHz
5959
- Clock Divider: 1
6060

61-
[![CLK](images\ClockSetup.PNG)](images\ClockSetup.PNG)
61+
[![CLK](images/ClockSetup.PNG)](images/ClockSetup.PNG)
6262

6363
**NVM**
6464
- Generate Flash APIs: Enabled
6565
- Generate EEPROM APIs: Enabled
6666
- Generate Device ID APIs: Enabled
6767

68-
[![NVM](images\NVMSetup.PNG)](images\NVMSetup.PNG)
68+
[![NVM](images/NVMSetup.PNG)](images/NVMSetup.PNG)
6969

7070
**UART**
7171
- Custom Name: UART2
@@ -79,7 +79,7 @@ The following project setup is the same for all the example project pairs. If so
7979
- Redirect Printf to UART: Disabled
8080
- Interrupt Driven: Disabled
8181

82-
[![UART](images\UARTDriverSetup.PNG)](images\UARTDriverSetup.PNG)
82+
[![UART](images/UARTDriverSetup.PNG)](images/UARTDriverSetup.PNG)
8383

8484
**UART PLIB**
8585
- Actual Baud Rate: 9615.385
@@ -88,13 +88,13 @@ The following project setup is the same for all the example project pairs. If so
8888
- Enable UART: Enable
8989
- Enable Transmit: Enabled
9090

91-
[![UART_PLIB](images\UARTPLIBSetup.PNG)](images\UARTPLIBSetup.PNG)
91+
[![UART_PLIB](images/UARTPLIBSetup.PNG)](images/UARTPLIBSetup.PNG)
9292

9393
**UART Pins**
9494
- UART TX: RB5
9595
- UART RX: RB4
9696

97-
[![UART_Pins](images\UARTPortsSetup.PNG)](images\UARTPortsSetup.PNG)
97+
[![UART_Pins](images/UARTPortsSetup.PNG)](images/UARTPortsSetup.PNG)
9898

9999
**8-Bit MDFU Client**
100100
- Communication Protocol: UART
@@ -106,43 +106,43 @@ The following project setup is the same for all the example project pairs. If so
106106

107107
*Example for CRC32 Verification*
108108

109-
[![MDFU](images\MDFUClientSetup.PNG)](images\MDFUClientSetup.PNG)
109+
[![MDFU](images/MDFUClientSetup.PNG)](images/MDFUClientSetup.PNG)
110110

111111
**8-Bit MDFU Client I/O**
112112
- BOOT INDICATE: RF2
113113
- BOOT ENTRY: RF3
114114

115-
[![IO-Pins](images\IOPortSetup.PNG)](images\IOPortSetup.PNG)
115+
[![IO-Pins](images/IOPortSetup.PNG)](images/IOPortSetup.PNG)
116116
- BOOT INDICATE: Start High
117117
- BOOT ENTRY: Weak Pullup
118118

119-
[![IO-Settings](images\IOPinsSetup.PNG)](images\IOPinsSetup.PNG)
119+
[![IO-Settings](images/IOPinsSetup.PNG)](images/IOPinsSetup.PNG)
120120

121121
**8-Bit MDFU Client Project Properties**
122122
- ROM Ranges: This option is configured based on the start address of the application
123123
- For example, if the application starts at 0x2000 then this value will reflect as `0-1FFF`
124124

125-
[![IO-Settings](images\MemoryModelSettings.PNG)](images\MemoryModelSettings.PNG)
125+
[![IO-Settings](images/MemoryModelSettings.PNG)](images/MemoryModelSettings.PNG)
126126

127127
---
128128
### Application Setup
129-
[![app-builder](images\AppConfigurationOverview.PNG)](images\AppConfigurationOverview.PNG)
129+
[![app-builder](images/AppConfigurationOverview.PNG)](images/AppConfigurationOverview.PNG)
130130

131131
**I/O Pins**
132132
- GPIO Output: RF2
133133

134-
[![app_io](images\AppPortSetup.PNG)](images\AppPortSetup.PNG)
134+
[![app_io](images/AppPortSetup.PNG)](images/AppPortSetup.PNG)
135135
- Custom Name: LED
136136

137-
[![app_io_settings](images\LEDSetup.PNG)](images\LEDSetup.PNG)
137+
[![app_io_settings](images/LEDSetup.PNG)](images/LEDSetup.PNG)
138138

139139
**Project Properties**
140140

141141
Linker Additional Options
142142
- Codeoffset: 0x<APP_START> = 0x2000
143143
- Checksum: Dependant on the verification scheme
144144

145-
[![app_offset](images\AppOffset.PNG)](images\AppOffset.PNG)
145+
[![app_offset](images/AppOffset.PNG)](images/AppOffset.PNG)
146146

147147
Note:*Check the table below to understand how the CRC32 option must be configured in the application projects*
148148

@@ -161,7 +161,7 @@ Fill Flash Memory
161161
- Increment/Decrement: No Incrementing
162162
- Memory address range: 0x<APP_START>:0x<FLASH_END> = 0x2000:0xFFFF
163163

164-
[![app_fill](images\AppFill.PNG)](images\AppFill.PNG)
164+
[![app_fill](images/AppFill.PNG)](images/AppFill.PNG)
165165

166166
## Operation
167167
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).
@@ -170,40 +170,40 @@ In this section, we will walkthrough how to run the examples in this repository.
170170

171171
1. Open the MDFU Client Project.
172172

173-
[![OpenMDFUProject](images\openProjectMDFU.png)](images\openProjectMDFU.png)
173+
[![OpenMDFUProject](images/openProjectMDFU.png)](images/openProjectMDFU.png)
174174

175175
2. Set MDFU Client Project as Main Project.
176176

177-
[![OpenMDFUProject](images\setAsMainProject.png)](images\setAsMainProject.png)
177+
[![OpenMDFUProject](images/setAsMainProject.png)](images/setAsMainProject.png)
178178

179179
3. Right click, then select Clean and Build.
180180

181-
[![CleanBuild](images\CleanAndBuildMDFU.png)](images\CleanAndBuildMDFU.png)
181+
[![CleanBuild](images/CleanAndBuildMDFU.png)](images/CleanAndBuildMDFU.png)
182182

183183
4. Program the MDFU Client Project
184184

185-
[![ProgramMDFU](images\ProgramMDFU.PNG)](images\ProgramMDFU.PNG)
185+
[![ProgramMDFU](images/ProgramMDFU.PNG)](images/ProgramMDFU.PNG)
186186

187187
**Bootloader Operation After Initial Programming**
188188

189189
After the initial programming, the LED must be on.
190190

191-
[![MDFU_BootMode](images\PIC18F56Q24_BootMode.png)](images\PIC18F56Q24_BootMode.png)
191+
[![MDFU_BootMode](images/PIC18F56Q24_BootMode.png)](images/PIC18F56Q24_BootMode.png)
192192

193193
**Application Operation**
194194
1. Open the Application Project that is configured for your selected verification scheme.
195195

196-
[![OpenAppProject](images\openProjectApp.png)](images\openProjectApp.png)
196+
[![OpenAppProject](images/openProjectApp.png)](images/openProjectApp.png)
197197

198198
2. Set the application project as the Main Project.
199199

200-
[![MainAppProject](images\setAppAsMainProject.png)](images\setAppAsMainProject.png)
200+
[![MainAppProject](images/setAppAsMainProject.png)](images/setAppAsMainProject.png)
201201

202202
3. Build the required Application project.
203203

204204
Right click, then select Clean and Build
205205

206-
[![CleanBuild_App](images\CleanAndBuildApp.png)](images\CleanAndBuildApp.png)
206+
[![CleanBuild_App](images/CleanAndBuildApp.png)](images/CleanAndBuildApp.png)
207207

208208
4. Build the Application Image File using **pyfwimagebuilder**.
209209

@@ -213,7 +213,7 @@ Right click, then select Clean and Build
213213

214214
`pyfwimagebuilder build -i "application_hex_file.hex" -c "mdfu_config_file.toml" -o output.img`
215215

216-
[![build_img](images\BuildTheImage.PNG)](images\BuildTheImage.PNG)
216+
[![build_img](images/BuildTheImage.PNG)](images/BuildTheImage.PNG)
217217

218218
5. Use the **pymdfu** host tool to transfer the application image file to the bootloader.
219219

@@ -223,11 +223,11 @@ Right click, then select Clean and Build
223223

224224
`pymdfu update serial ./crc32.img --baudrate 9600 --port COM##`
225225

226-
[![transfer_img](images\SendTheImage.PNG)](images\SendTheImage.PNG)
226+
[![transfer_img](images/SendTheImage.PNG)](images/SendTheImage.PNG)
227227

228228
**Application Has Been Updated Successfully**
229229

230-
[![MDFU_AppMode](images\PIC18F56Q24_AppMode.gif)](images\PIC18F56Q24_AppMode.gif)
230+
[![MDFU_AppMode](images/PIC18F56Q24_AppMode.gif)](images/PIC18F56Q24_AppMode.gif)
231231

232232
## Summary
233233

0 commit comments

Comments
 (0)