Skip to content

Commit

Permalink
Reworked documenation based on review; Removing harmony license file …
Browse files Browse the repository at this point in the history
…as it is included in harmony download
  • Loading branch information
David Cowden authored and David Cowden committed Jun 29, 2016
1 parent 19f83df commit 45c5420
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 15 deletions.
Binary file removed documents/harmony_license_v1.07.01.pdf
Binary file not shown.
16 changes: 9 additions & 7 deletions documents/iot-ethernet-firmware-compile-and-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ This document will show you where to find the latest _released_ version of the f
You will need the following Microchip development tools to program and develop with the Microchip IoT Ethernet.

- Download the latest project for IoT Ethernet from here: [IoT Ethernet Project](https://github.com/MicrochipTech/aws-iot-firmware-pic32mz/releases/latest)
- 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)
- 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)
- Download and install Microchip MPLAB<sup>&reg;</sup> X IDE for your OS from here:
[Microchip MPLAB<sup>&reg;</sup> X IDE](http://www.microchip.com/mplabx) (3.26, 3.30 tested)
- 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)
[Microchip MPLAB<sup>&reg;</sup> X IDE](http://www.microchip.com/mplabx) (3.30 tested)
- 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)

More information about Microchip tools can be found on [Microchip's developer help site](http://microchip.wikidot.com/swtools:start)

---

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

#### Compiling the Firmware
1. Extract the zip file downloaded from the git repository to a location of your choice
Expand All @@ -30,9 +32,9 @@ Test platform is MAC OS X, these instructions may vary slightly on different OS.
- Navigate to: ` <path-to-your-project>/aws-iot-firmware-pic32mz/software/aws-iot-ethernet/firmware`
- Select the project __aws-iot-ethernet.X__
- With your project opened, right click on the project __aws-iot-ethernet__ in the Projects tab and select __Set as Main Project__
- 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)
- 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)
- Open the MHC by clicking __Tools -> Embedded -> MPLAB Harmony Configurator__
- 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"
- 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"
- 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.
- With the new Harmony framework selected for your project, you will need to regenerate code by clicking the generate code button. ![](images/generateCode.png)
- A settings window will pop up, check only the box "Create a backup...": ![](images/mhc-generate-code-settings.png)
Expand All @@ -56,4 +58,4 @@ If you are having trouble, check to make sure that each of the issues bellow are
- 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).

#### Project won't compile due to errors such as missing ADCxxx registers
- 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).
- 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).
24 changes: 16 additions & 8 deletions documents/iot-ethernet-mplab-ipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
---

### Introduction
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
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.

More information about the MPLAB<sup>&reg;</sup> IPE can be found on [Microchip's developer help site](http://microchip.wikidot.com/ipe:start).

---

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

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

---
Expand All @@ -31,18 +33,24 @@ You will need the following Microchip development tools to program the Microchip
- Under "Tool:" select the PICKit<sup>&trade;</sup> 3 or other programmer.
- The tool should be enumerated with its serial number.
- Click the "Connect" button
![Settings](./images/ipe-device-tool.png)

![Settings](./images/ipe-device-tool.png)
- 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.
![Programmer connecting](./images/ipe-connecting-to-programmer.png)

![Programmer connecting](./images/ipe-connecting-to-programmer.png)
- 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.
![Hex browseing](./images/ipe-hex-browse.png)

![Hex browseing](./images/ipe-hex-browse.png)
- Once the HEX file is loaded you will get a dialog in the output window saying "Hex file loaded successfully".
- Now we can program the board: Click the "Program" button.
![Hex browseing](./images/ipe-program.png)

![Hex browseing](./images/ipe-program.png)
- 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.
![Hex browseing](./images/ipe-programming.png)

![Hex browseing](./images/ipe-programming.png)
- Upon completion you will see a "Programming complete" in the output window.
![Hex browseing](./images/ipe-programming-complete.png)

![Hex browseing](./images/ipe-programming-complete.png)
- You can now begin using the board.

---
Expand Down

0 comments on commit 45c5420

Please sign in to comment.