TCP/IP Base Board Setup Instructions (JGS_ETH24_BASE)

Transcription

1 TCP/IP Base Board Setup Instructions (JGS_ETH24_BASE) Actual Size Image 2.1mm Power Jack RJ45 MagJack ICSP Programming Connector 3.5mm Stereo Jack for Serial I/O 4 8 pin headers for external connections Board Description and Features The JGS_ETH24_BASE board is an embedded TCP/IP 10 BaseT network module designed to work with the Microchip TCP/IP stack. The board consists of the following components: Microchip PIC24HJ128GP MIPS microcontroller. Microchip ENC28J60 10 BaseT Ethernet interface. SST (now Microchip) 2 or 4 MByte Serial Flash memory. Microchip 25AA02E48 MAC address chip provides universally unique MAC address. MAX3232 serial interface provides 2 serial ports. 3.5mm TRS (stereo) jack provides access to one serial port. 2.1mm Power Jack for connecting a 5 volt power supply. Onboard voltage regulator provides 3.3V to the components. RJ45 MagJack connector for Ethernet connection via CAT 5/6 cable. 4 8 pin 0.1 pitch headers provide access to 5V, 3.3V, Gnd, MCLR, second serial port and 26 I/O lines. Of the microprocessor s on board peripherals, only SPI1 and Timer1 are reserved, all others are available. ICSP programming support. Pads for adding a 32khz watch crystal for RTCC support. While the MagJack has LED link and activity indicators, additional LEDs on the board makes them more visible. Pads for 0 ohm resistors for connecting the second serial port. On board power indicator. Test point for measuring current at the 3.3V rail. All on a 3.5 by 2 board. Includes instructions for use with Microchip TCP/IP stack. TCP-IP Base Board Setup.docx September 2011

2 Package Contents 1 JGS_ETH24_BASE board, assembled, tested and loaded with software. 1 Printed copy of the instructions The following files: o TCP-IP Base Board Setup.pdf this document o HWP JGS_ETH24_BASE.h o TCPIP JGS_ETH24_BASE.h o MainDemo.h o MainDemo.c o pps.h o SMTPDemo.c o JGS-ETH24-BASE.hex o TCPIPConfig.h o HardwareProfile.h The board comes with a version of the Microchip TCPIP Demo App loaded. Connect the serial, power and Ethernet cables and it s ready to go. (The default baud rate is 38,400.) If you don t have a serial cable to monitor the board startup and see the assigned IP address, use the MicrochipEthernetDiscover utility to find the IP address. This utility can be found in the C:\Microchip Solutions v \Microchip\TCPIP Stack\Utilities directory. Then, direct a browser to the IP address of the board to see the embedded web server application running. The default setup of the board can have LEDs connected to pins RB4, RA4 and RA9, and pushbuttons connected to pins RC3 and RC4. The LEDs should be connected to ground via appropriate resistors. The normally open pushbuttons should also be connected to ground. These pins are all located on the J3 header, next to the 5V, Gnd and 3.3V pins. For my testing I fashioned a testing fixture out of some spare parts. A sample, along with the circuit diagram, are shown below: TCP-IP Base Board Setup.docx September 2011

3 Microchip TCP/IP Stack Configuration In order to follow the instructions below, you will need to download and install the following software from Microchip on your computer. These instructions assume all the applications and libraries have been installed in their default locations. The version numbers refer to the ones I used. Microchip MPLAB IDE version ( ) Microchip C30 Compiler version ( ) You must register with the site to download this. The free and evaluation versions work fine. Microchip Application Libraries v ( ) which includes the TCP/IP Stack version Please note that directories have been reorganized in the TCP/IP stack in each of the most recent versions and may therefore be reorganized again. The instructions below apply to the versions listed above but should work with other versions as well, with some adjustment. Microchip Application Libraries Help Files This is important because the documentation for the TCP/IP stack is part of this. The TCP/IP stack and supporting utilities are complex and anyone using the stack should go through this documentation. You will also need: Microchip PICKit2 or similar device for loading hex code via the ICSP connection. Be sure to load any associated software. Serial cable consisting of a 3.5mm TRS (stereo) plug at one end and a DB 9 Female connector at the other. Tip connects to pin 2 (TX from board), Ring connects to pin 3 (RX from board), and Sleeve connects to pin 5 (Ground). Plug the DB 9 connector into your computer s serial port or USB to Serial converter cable. Further information on TRS connectors is available here: Terminal program such as TeraTerm. ( CAT 5 cable to connect the board to your Ethernet switch. Regulated 5 volt, 500mA power supply. You can also power the board from the PICKit 2 programmer. Modified Microchip source files that accompany the JGS_ETH24_BASE board. These instructions preserve the original project structure so that there is the least amount of difference between the Demo App for this board and the original. This will help you in learning how the projects and their files are organized. These instructions also assume you know how to use the MPLAB IDE. Working within the C:\Microchip Solutions v \tcpip directory do the following: 1. Make a copy of the Demo App directory and rename Demo App. at the beginning sorts the directory to the top of the list so it s easier to find. 2. In the new directory start MPLAB with the C30-EX16_ENC28.mcp project. 3. On the Configure tab change the device to PIC24HJ128GP In the Project Build Options, MPLAB C30, General, change the Preprocessor Macros for MPLAB C30 to JGS_ETH24_BASE. 5. In the Project Build Options, MPLAB C30, Optimization, select 0 for no optimization. 6. In the Project Build Options, Directories, change the Intermediate Directory to Obj-JGS_ETH24_BASE. 7. On the Project tab save the project as JGS_ETH24_BASE. TCP-IP Base Board Setup.docx September 2011

4 o Be sure you save the project into your new directory. MPLAB remembers a project s directory, so when you switch project locations it may try to save to an old location. 8. Copy the following files to the project root directory: o MainDemo.c o MainDemo.h o pps.h o SMTPDemo.c o HardwareProfile.h o TCPIPConfig.h 9. You can clean up the project root directory by erasing all the other.mcp and.mcw files. 10. Delete all the existing files in the Configs subdirectory and copy into it the following files: o HWP JGS_ETH24_BASE.h o TCPIP JGS_ETH24_BASE.h NOTE: After doing the file cleanup you may get a warning message that some source files are not where they used to be. You can ignore this (assuming you didn t delete too much) and clean up the file list in the workspace window. 11. In the C:\Microchip Solutions v \microchip\tcpip Stack directory edit the file ENC28J60.c and comment out line 320. This will allow the CLKOUT signal to be generated to provide the clock signal for the PIC Check and/or set the baud rate you want to use for serial communications in MainDemo.h. 13. Compile the project (F10) and load the hex file onto the processor using the ICSP connection. 14. Connect a terminal program to the serial port. 15. Apply power to the board. You should see output displaying the name of the board and the IP address. If LED0 is connected, it should be flashing once per second. 16. If you built your own board or have been using some other web pages, use MPFS2.exe, also in the utilities directory, to load the Demo App web pages into the board s serial flash memory. Instructions for using the MPFS2 program are in the help file for the TCP/IP stack. The web site image file is MPFSImg2.bin which is in the project root directory. You can also reload it from the original Demo App directory. 17. Direct your browser at the IP address to display the stored web pages. Configuration The board and software are configured as follows: TIMER1 is used by the TCP/IP stack UART2 is used by the TCP/IP stack for configuration and debugging SPI1 is used to communicate with the ENC28J60, serial flash and MAC address chips SPI2 is used by the optional thermostat daughterboard for the LCD display UART1 can be assigned to pins RB14 and RB15 which in turn can be connected to the MAX3232 via optional 0 ohm jumpers at R1 and R2. The serial port RX and TX will come out at J6.7 and J6.8. The trace at R14 can be cut and a 2 pin header installed so that current at the 3.3V rail can be measured. The board has traces and pads for a 32khz watch crystal and supporting capacitors to support RTCC functions. TCP-IP Base Board Setup.docx September 2011

5 By default, the LEDs on the MAGJACK are not used. I put Link and Activity LEDs on the board because they are usually easier to see. To turn on the MAGJACK LEDs, add resistors at R5 and R6 (see the schematic for actual values.) Demonstration Modules The project directory contains a number of modules that demonstrate various capabilities, such as ping, client/server, and others, of the Microchip TCP/IP stack. If you wish to try these you may need to make some adjustments to adapt them to this hardware. Be sure to read the Microchip TCP/IP Stack documentation first. As I was researching the Microchip forums I found that there are frequent questions relating to sending with the stack. The solution to this had little to do with the stack software, rather, it had to do with the selection of a mail server. Using some of the common mail services such as Hotmail will not work due to security restrictions. When I followed the instructions and used sendmail, which is running on a web server I control, everything works as described. The included file SMTPDemo.c has been modified from the original so that an is sent when Button0 and Button1 are pressed simultaneously. You still need to modify the file with your own server and account information. UPDATE: I found that I can use my earthlink.net POP3 access information to send s from the board. Optional Ethernet Bootloader If you purchased the bootloader option then the following files were sent to you by p24hj128gp204_eble_app.gld this is a linker script that tells the compiler how much room to reserve in the processor memory for the bootloader. You must add this file to your project in the Linker Script section and then recompile the application. XTEA.exe compresses and encrypts the application hex file for loading. This is a console application and must be run in a DOS window or Command Prompt. Encrypted_ENC_loader.exe PC application that loads new applications to the hardware. Encrypted_ENC_loader.inc control file for Encrypted_ENC_loader.exe. ENC_C30.hex this is the bootloader that must be loaded onto the microprocessor via the ICSP connector. This hex file will only work with the TCP/IP Developer and Experimenter board. If you want the source code for the bootloader so you can use it with other hardware, you can buy that from Brush Electronics ( ). BE Encrypted Ethernet Bootloader System Ver 1.3.pdf manual for using the bootloader. Put all of the files in the project directory. The steps for using the Ethernet Bootloader are as follows: 1. Using the ICSP plug load ENC_C30.hex onto the target hardware, which is referred to as the LIA (LAN Interface Adapter). This only needs to be done once. 2. Compile the application, producing a new JGS_ETH24_BASE.hex. 3. Encrypt and compress the application using XTEA.exe by typing xtea JGS_ETH24_BASE.hex in a DOS window or Command Prompt. This will produce a file JGS_ETH24_BASE.cry. TCP-IP Base Board Setup.docx September 2011

6 4. Start the Encrypted_ENC_loader.exe application 5. Click the Capture Target button and reset the thermostat by going the config screen and hit save which causes a reset. Upon reset, the bootloader will run first and for 5 seconds will scan for the loader utility when it finds it and makes a connection you should see something like this in the loader: 6. Select the JGS_ETH24_BASE.cry file and click the Program button. After a while you will see a Programming Complete message. 7. Reset the hardware by clicking on the Reset LIA button. 8. All these steps should be performed promptly to avoid timeouts. 9. Restart at step 2 after revising the application. You have just reloaded the application via the Ethernet. If you have made changes to the web pages, be sure to run the MPFS2.jar utility. This is found in C:\Microchip Solutions v \microchip\tcpip Stack\Utilities as a java application so you will need to have a java runtime environment on your system. The companion utility TCPIP Discoverer.jar is useful for finding lost Microchip based TCP/IP hardware. If the Announce feature is turned on in the application, then they announce themselves to the Discoverer application. Both the Demo App and the Thermostat projects have the announce feature turned on by default. TCP-IP Base Board Setup.docx September 2011

7 Resources All the information I needed for this project I found on the Microchip web site and on the Microchip forums. The hardware information I found in the documentation for various Microchip demonstration boards and the data sheet for the ENC28J60 chip. The main information source for the TCP/IP stack is the associated help file. The first time through stack documentation is like trying to drink from a fire hose. After a while, looking at this alongside the source code for the demonstration applications, it starts to make sense. The Microchip forums helped to fill in the gaps, there are a lot of helpful and knowledgeable people there. This board is also described in the September and October 2011 issues of Nuts and Volts. The supporting website is: Pin Reference The following chart provides a reference for the various pins on the PIC24HJ128GP204 processor and how they are used. The Header Pin column identifies all the pins that are brought out to the four headers. The last column identifies pin functions unique to the TCP/IP experimenter board, the pins and headers used by the Thermostat daughterboard, and the pins used by the testing fixture, respectively. TCP-IP Base Board Setup.docx September 2011

8 PIC24HJ128GP204 Pin Reference with TCP/IP Base Assignments Name U1 Pin Number Pin Type CNxx Pullup RPxx ANxx Functions (selected) Header Pin Vdd 17,28, v J3.3 TCP/IP Base / Thermostat Pins Testing Fixture Pins (J3) Vss 6,16,29,39 GND J3.2 GND MCLR 18 J6.3 Reset button Vcap 7 RA0 19 I/O ST CN2 AN0 Vref+ J6.4 RA1 20 I/O ST CN3 AN1 Vref- J6.5 RA2 30 I/O ST CN30 OSC1, CLKI Clock input from ENC28J60 RA3 31 I/O ST CN31 OSC2, CLKO CS for MAC address chip RA4 34 I/O ST CN0 SOSCO J3.5 optional RTCC Xtal LED1 RA7 13 I/O ST PMA7 J5.8 RA8 32 I/O ST PMA8 CS for ENC28J60 RA9 35 I/O ST PMA9 J3.6 LED2 RA10 12 I/O ST PMA10 J5.7 RB0 21 I/O ST CN4 RP0 AN2 RX2, ICSP PGD RB1 22 I/O ST CN5 RP1 AN3 TX2, ICSP PGC RB2 23 I/O ST CN6 RP2 AN4 J6.6 RB3 24 I/O ST CN7 RP3 AN5 SPI1 SCK RB4 33 I/O ST CN1 RP4 SOSCI J3.4 optional RTCC Xtal LED0 RB5 41 I/O ST CN27 RP5 J4.2 Relay Heat RB6 42 I/O ST CN24 RP6 J4.3 Relay Cool RB7 43 I/O ST CN23 RP7 J4.4 LCD Backlight RB8 44 I/O ST CN22 RP8 SCL1 J4.5 LCD RS RB9 1 I/O ST CN21 RP9 SDA1 J4.6 LCD SPI2 SCK RB10 8 I/O ST CN16 RP10 J5.3 PB Off RB11 9 I/O ST CN15 RP11 J5.4 PB Heat RB12 10 I/O ST CN14 RP12 AN12 J5.5 Temp Sensor RB13 11 I/O ST CN13 RP13 AN11 J5.6 Temp Sensor RB14 14 I/O ST CN12 RP14 AN10 J6.1 optional TX1 RB15 15 I/O ST CN11 RP15 AN9 J6.2 optional RX1 RC0 25 I/O ST CN8 RP16 AN6 SPI1 SDI RC1 26 I/O ST CN9 RP17 AN7 SPI1 SDO RC2 27 I/O ST CN10 RP18 AN8 CS for Serial Flash RC3 36 I/O ST CN28 RP19 J3.7 PB Colder PB0 RC4 37 I/O ST CN25 RP20 J3.8 PB Hotter PB1 RC5 38 I/O ST CN26 RP21 J4.1 Relay Fan RC6 2 I/O ST CN18 RP22 J4.7 LCD SPI2 SDO RC7 3 I/O ST CN17 RP23 J4.8 Heartbeat LED RC8 4 I/O ST CN20 RP24 J5.1 PB Fan RC9 5 I/O ST CN19 RP25 J5.2 PB Cool TCP-IP Base Board Setup.docx September 2011

9 JGS_ETH24_BASE Circuit Diagrams TCP-IP Base Board Setup.docx September 2011