Remote flower watering and monitoring with the tuxgraphics avr ethernet board

!! READ THIS FIRST !!
---------------------
The mac address has to be unique within your own network.
If you connect more than one board to the same LAN
you will need to change the mac address to something else.
Edit the file main.c and change the last digit in this line:

static uint8_t mymac[6] = {0x54,0x55,0x58,0x10,0x00,0x29};

It does not matter to what value you change it as long as
there is no other ethernet board with the same value on your
lan. Your neighbor could re-use the same address.

Check the file "Makefile" and configure the programmer options
correctly:

For windows and tuxgraphics avrusb500 you will need to configure
the virtual com-port to which the avrusb500 is attached:
# windows 
#LOADCMD=avrdude -P COM4


More information about Makefiles can be found at:
http://tuxgraphics.org/electronics/200912/makefiles.shtml

This software has a fixed IP address which is set at compile time in 
file main.c:
static uint8_t myip[4] = {10,0,0,29};

myip must be a free address from the address range in your network.

There is a range of private addresses (not routed on the public internet)
which you can use:
Netmask          Network Addresses
255.0.0.0         10.0.0.0 - 10.255.255.255
255.255.0.0       172.16.0.0 - 172.31.255.255
255.255.255.0     192.168.0.0 - 192.168.255.255

Example: you wlan router might have 192.168.1.1, your PC might have
192.168.1.2. This means you could e.g use 192.168.1.10 and leave some
room for more PCs. If you use DHCP then make sure that the address it not
double allocated (exclude it from the DHCP range).

You need an avr-gcc development environment in order to compile this.

Setting a password
The password is defined in main.c on this line:
static char password[]="secret";

To compile the software use the command:
make

Note: windows users may use and modify the supplied winmake.bat to setup the
environment correctly.

The command
make load

will execute the avrdude command to load the software.
E.g something like: 
   avrdude -p m328p -c stk500v2 -e -U flash:w:main.hex

! Note: your programmer might interfere with the enc28j60! For the avrusb500
! with 30cm cable you can normally leave the cable on. For all other programmers
! it is however saver to remove the programmer cable and power down/up the device.
! This is because the SPI interface is used for loading of the software and 
! communication to the enc28j60.

To see a list of all possible build targets run the command:
make help

Selecting the right clock source
--------------------------------
Tuxgraphics hardware sold as of march 2007 is prepared to use the clock
signal from the enc28j60. To use this you need to change the 
low fuse byte once from 0x62 to 0x60:
avrdude -p m328p -c stk500v2 -u -v -U lfuse:w:0x60:m

or just type in your Linux shell:
make fuse

The fuse settings of the atmega328 are after programming:
 lfuse reads as 0x60
 hfuse reads as 0xD9
 efuse reads as 0x07
    Note: the efuse might be different on the atmega328p, the upper
    bits are not used and their settings depend on the chip revision.


details of the lfuse bits:
  CKDIV8 = 0
  CKOUT  = 1
  SUT1   = 1
  SUT0   = 0
  CKSEL3 = 0
  CKSEL2 = 0
  CKSEL1 = 0
  CKSEL0 = 0

If you are unsure what the current fuse setting are on the atmega
then you can read the fuse settings with a command like: 
          avrdude -p m328p -c stk500v2 -v -q

The result should be this (default factory settings for atmega328p):
          avrdude: safemode: lfuse reads as 62
          avrdude: safemode: hfuse reads as D9
          avrdude: safemode: efuse reads as 7
    Note: the efuse might be different on the atmega328p, the upper
    bits are not used and their settings depend on the chip revision.


Compiling on non-Unix systems
-----------------------------
Please use the provided Makefile !!!

It will also work under Windows.

Take also a look at the supplied winmake.bat file. This bat script
might be needed to set the environment correctly.

Edit the Makefile to make the needed adjustments at the top
of the file.

More information about Makefiles can be found at:
http://tuxgraphics.org/electronics/200912/makefiles.shtml

Using the web server
--------------------
Point your web browser to
http://10.0.0.29   (or what ever IP address you have given your hardware)

You should see a page like this:

------------------------------------------
[water] [graph] [config] [timer] [refresh]

Sensors

Temperature:26.9'C [80'F]
Humi level: 115 [normal]

------------------------------------------
(C) tuxgraphics

The temperature and humidity history graphs use javascript. You need a 
javascript capable web browser to see them. Even web browsers inside 
mobile phone are these days javascript capable. It should not be a
problem. The javascript code is well written and tested.

Authors/Copyright
-----------------
Most of the software was written by Guido Socher.
The ds18x20 and onewire code is taken from 
http://www.siwawi.arubi.uni-kl.de/avr_projects/tempsensor/index.html
It was written by Martin Thomas and based on code of Peter Dannegger,
Colin O'Flynn and others.

Guido Socher modified the ds18x20 and one-wire code to fit to this
application.

The enc28j60 driver is based on code from Pascal Stang and updated
by Guido Socher.

All code is copyright GPL V2.

Revision history
----------------
2009-08-25: version 0.6 -- first public version
2009-09-02: version 0.7 -- minor fault in pump control code fixed
2009-09-07: version 0.8 -- clean-up buf pointer
2009-09-17: version 0.9 -- minimum graph width
2009-12-30: version 1.0 -- improved makefile
2010-02-28: version 1.1 -- new stack files, timeout if there is no sensor attached
2010-03-03: version 2.0 -- button (PB0) to locally water the plant or stop
                           watering
2010-06-20: version 3.0 -- add a timer function
                        -- clean-up code for enc28j60 B4 errata point 13
                        -- version 3.0 should be used with an atmega328p.
                           The code just fits into an atmega168 but there
                           is not much space left or modifications.