Skip to content

Commit 96027ca

Browse files
committed
add top level documentation and filtering information.
1 parent 875b496 commit 96027ca

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

.main-meta/main.json

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
"metaDataVersion":"1.0.0",
66
"name":"com.microchip.mplabx.project.pic24-dspic-can-canfd-bootloader",
77
"version":"x.x.x",
8-
"displayName":"xxxxxxxxxxxxxxx",
8+
"displayName":"CAN/CAN-FD Bootloader for PIC24/dsPIC products",
99
"projectName":"pic24-dspic-can-canfd-bootloader",
10-
"shortDescription":"xxxxxxxxxxxxxxx",
10+
"shortDescription":"CAN and CAN-FD bootloader example using the ISO-15765 CAN transport layer for the PIC24 and dsPIC product lines.",
1111
"ide":{
1212
"name":"MPLABX",
1313
"semverRange":">=5.40.0"
1414
},
1515
"compiler":{
1616
"name":"XC16",
17-
"semverRange":"^1.50.0"
17+
"semverRange":"^1.61.0"
1818
},
1919
"dfp":{
20-
"name":"xxxxxxxxxxxxxxx",
21-
"semverRange":">=x.x.x"
20+
"name":"dsPIC33CK-MP_DFP",
21+
"semverRange":">=1.5.135"
2222
},
2323
"configurator": {
2424
"name": "MCC",
@@ -30,17 +30,23 @@
3030
"content":{
3131
"metaDataVersion":"1.0.0",
3232
"category":"com.microchip.device",
33-
"name":"xxxxxxxxxxxxxxx",
33+
"name":"dsPIC33CK256MP508",
3434
"versionRange":"*"
3535
}
3636
},
3737
"peripherals":[
38-
"DMA",
39-
"CAN"
38+
"CAN",
39+
"CAN-FD",
40+
"CANFD"
4041
],
4142
"keywords":[
42-
"DMA",
43-
"Sensor"
43+
"CAN",
44+
"Bootloader",
45+
"CAN-FD",
46+
"CANFD",
47+
"ISO-15765",
48+
"ISO-TP",
49+
"CAN-TP"
4450
]
4551
}
4652
}

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,22 @@
11
![image](images/microchip.jpg)
22

3-
## PIC24 DSPIC CAN CANFD BOOTLOADER
4-
5-
Board Image if any.
3+
## PIC24/dsPIC CAN/CAN-FD Bootloader Demo
64

75
## Summary
86

7+
An example bootloader using the 16-bit MCC bootloader and the CAN or CAN-FD peripheral.
98

109
## Related Documentation
1110

11+
https://www.microchip.com/16-bit-bootloader
1212

13-
## Software Used
14-
15-
16-
## Hardware Used
17-
18-
19-
## Setup
20-
13+
## Setup And Operation
2114

22-
## Operation
15+
There are 3 configurations provided in this demo:
16+
1) Using CAN classic on a device with the CAN-FD module
17+
2) Using CAN-FD on a device with the CAN-FD module
18+
3) Using CAN classic on a device with the enhanced CAN controller
2319

20+
The hardware and software setup is different for each of these use cases. There are readme*.html files associated with each folder that describe the required hardware and software as well as how to setup and run each of the corresponding demos.
2421

2522

0 commit comments

Comments
 (0)