Skip to content

Commit 45c5420

Browse files
David CowdenDavid Cowden
David Cowden
authored and
David Cowden
committed
Reworked documenation based on review; Removing harmony license file as it is included in harmony download
1 parent 19f83df commit 45c5420

File tree

3 files changed

+25
-15
lines changed

3 files changed

+25
-15
lines changed

‎documents/harmony_license_v1.07.01.pdf

-41.1 KB
Binary file not shown.

‎documents/iot-ethernet-firmware-compile-and-program.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ This document will show you where to find the latest _released_ version of the f
1313
You will need the following Microchip development tools to program and develop with the Microchip IoT Ethernet.
1414

1515
- Download the latest project for IoT Ethernet from here: [IoT Ethernet Project](https://github.com/MicrochipTech/aws-iot-firmware-pic32mz/releases/latest)
16-
- Download and install Microchip MPLAB<sup>&reg;</sup> Harmony Integrated Software Framework v1.07.01 for your OS from here: [Harmony](http://www.microchip.com/mplab/mplab-harmony)
16+
- Download and install Microchip MPLAB<sup>&reg;</sup> Harmony Integrated Software Framework v1.08 for your OS from here: [Harmony](http://www.microchip.com/mplab/mplab-harmony)
1717
- Download and install Microchip MPLAB<sup>&reg;</sup> X IDE for your OS from here:
18-
[Microchip MPLAB<sup>&reg;</sup> X IDE](http://www.microchip.com/mplabx) (3.26, 3.30 tested)
19-
- Download and install the latest XC32 compiler for your OS from here (Install both v1.40 and v1.40B - Part Patch): [Microchip MPLAB<sup>&reg;</sup> XC32 Compiler](http://www.microchip.com/xc32) (v1.40 with v1.40B part patch tested)
18+
[Microchip MPLAB<sup>&reg;</sup> X IDE](http://www.microchip.com/mplabx) (3.30 tested)
19+
- Download and install the v1.40 XC32 compiler for your OS from here (Install both v1.40 and v1.40B - Part Patch): [Microchip MPLAB<sup>&reg;</sup> XC32 Compiler](http://www.microchip.com/xc32) (v1.40 with v1.40B part patch tested)
20+
21+
More information about Microchip tools can be found on [Microchip's developer help site](http://microchip.wikidot.com/swtools:start)
2022

2123
---
2224

2325
### Compiling and programming the IoT Ethernet Board
24-
Test platform is MAC OS X, these instructions may vary slightly on different OS.
26+
Example below is shown on MAC OS X, these instructions may vary slightly on different OS.
2527

2628
#### Compiling the Firmware
2729
1. Extract the zip file downloaded from the git repository to a location of your choice
@@ -30,9 +32,9 @@ Test platform is MAC OS X, these instructions may vary slightly on different OS.
3032
- Navigate to: ` <path-to-your-project>/aws-iot-firmware-pic32mz/software/aws-iot-ethernet/firmware`
3133
- Select the project __aws-iot-ethernet.X__
3234
- With your project opened, right click on the project __aws-iot-ethernet__ in the Projects tab and select __Set as Main Project__
33-
- Follow these directions to install the Microchip Harmony Configurator (MHC): [Steps to Install MHC](http://ww1.microchip.com/downloads/en/DeviceDoc/MPLAB%20Harmony%20Configurator%20%28MHC%29%20and%20MPLAB%20Harmony%20Graphics%20Composer%20%28v1.07.01%29.pdf)
35+
- Follow these directions to install the Microchip Harmony Configurator (MHC): [Steps to Install MHC](http://ww1.microchip.com/downloads/en/DeviceDoc/MPLAB%20Harmony%20Configurator%20(MHC)%20and%20MPLAB%20Harmony%20Graphics%20Composer.pdf)
3436
- Open the MHC by clicking __Tools -> Embedded -> MPLAB Harmony Configurator__
35-
- The MHC will prompt asking to choose a Harmony framework to use, select "Yes" and select the location of your v1.07.01 Harmony install and click "OK"
37+
- The MHC will prompt asking to choose a Harmony framework to use, select "Yes" and select the location of your v1.08 Harmony install and click "OK"
3638
- The MHC will then ask if you want to open the configuration file __IoT-Ethernet.mhc__ for the __aws-iot-ethernet__ project, select "Open" to proceed.
3739
- With the new Harmony framework selected for your project, you will need to regenerate code by clicking the generate code button. ![](images/generateCode.png)
3840
- A settings window will pop up, check only the box "Create a backup...": ![](images/mhc-generate-code-settings.png)
@@ -56,4 +58,4 @@ If you are having trouble, check to make sure that each of the issues bellow are
5658
- Often times a project won't compile if you are on a Windows machine due to a limitation in the path length. Windows OS has a max path length of 260 characters, so file paths are sometimes truncated when attempting to compile which leads to files not being found by the compiler. Try putting the project in the topmost directory, usually "C:/". For more information please see [MSDN article from Microsoft](https://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath).
5759

5860
#### Project won't compile due to errors such as missing ADCxxx registers
59-
- As of the v1.1.0 release the latest compiler for XC32 is v1.40. This compiler must be updated with the v1.40B which is the "Part Patch". This installer will update your XC32 v1.40 comipler with the required files to compile for the part on the IoT Ethernet Kit. Again, this can be downloaded at [Microchip MPLAB<sup>&reg;</sup> XC32 Compiler](http://www.microchip.com/xc32).
61+
- v1.40 compiler must be updated with the v1.40B which is the "Part Patch". This installer will update your v1.40 compiler with the required files to compile for the part on the IoT Ethernet Kit. Again, this can be downloaded at [Microchip MPLAB<sup>&reg;</sup> XC32 Compiler](http://www.microchip.com/xc32).

‎documents/iot-ethernet-mplab-ipe.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
---
44

55
### Introduction
6-
This document will show you where to find the latest _released_ version of the firmware HEX and how to program it into the IoT Ethernet Kit. The MPLAB<sup>&reg;</sup> IPE allows you to directly program the HEX file of a program into the hardware. This eliminates having to recompile a program and is much quciker
6+
This document will show you where to find the latest _released_ version of the firmware HEX and how to program it into the IoT Ethernet Kit. The MPLAB<sup>&reg;</sup> IPE allows you to directly program the HEX file of a program into the hardware. This eliminates having to recompile a program.
7+
8+
More information about the MPLAB<sup>&reg;</sup> IPE can be found on [Microchip's developer help site](http://microchip.wikidot.com/ipe:start).
79

810
---
911

@@ -13,7 +15,7 @@ You will need the following Microchip development tools to program the Microchip
1315

1416
- Download the latest HEX file for IoT Ethernet from here: [IoT Ethernet Project](https://github.com/MicrochipTech/aws-iot-firmware-pic32mz/releases/latest)
1517
- Download and install Microchip MPLAB<sup>&reg;</sup> X IDE for your OS from here:
16-
[Microchip MPLAB<sup>&reg;</sup> X IDE](http://www.microchip.com/mplabx) (3.26, 3.30 tested)
18+
[Microchip MPLAB<sup>&reg;</sup> X IDE](http://www.microchip.com/mplabx) (3.30 tested)
1719
- PICKit<sup>&trade;</sup> 3 In-Circuit Debugger/Programmer (or other programmer)
1820

1921
---
@@ -31,18 +33,24 @@ You will need the following Microchip development tools to program the Microchip
3133
- Under "Tool:" select the PICKit<sup>&trade;</sup> 3 or other programmer.
3234
- The tool should be enumerated with its serial number.
3335
- Click the "Connect" button
34-
![Settings](./images/ipe-device-tool.png)
36+
37+
![Settings](./images/ipe-device-tool.png)
3538
- The programmer will begin to connect to the IPE, it may update itself with new firmware. This is normal. When the programmer is fully connected you should see your target PIC32 device found as shown below.
36-
![Programmer connecting](./images/ipe-connecting-to-programmer.png)
39+
40+
![Programmer connecting](./images/ipe-connecting-to-programmer.png)
3741
- Now we need to load the HEX file into the IPE. Click the "Browse" button next to the "Source" box. Browse to the HEX file you downloaded and select it.
38-
![Hex browseing](./images/ipe-hex-browse.png)
42+
43+
![Hex browseing](./images/ipe-hex-browse.png)
3944
- Once the HEX file is loaded you will get a dialog in the output window saying "Hex file loaded successfully".
4045
- Now we can program the board: Click the "Program" button.
41-
![Hex browseing](./images/ipe-program.png)
46+
47+
![Hex browseing](./images/ipe-program.png)
4248
- The PICKit<sup>&trade;</sup> 3 will begin programming the HEX file into the board. Please wait until it is finished. This can take a couple minutes.
43-
![Hex browseing](./images/ipe-programming.png)
49+
50+
![Hex browseing](./images/ipe-programming.png)
4451
- Upon completion you will see a "Programming complete" in the output window.
45-
![Hex browseing](./images/ipe-programming-complete.png)
52+
53+
![Hex browseing](./images/ipe-programming-complete.png)
4654
- You can now begin using the board.
4755

4856
---

0 commit comments

Comments
 (0)