<h2>Smartphone Garage Door Opener</h2>
<pre>
This is the software for the tuxgraphics.org smartphone garage door opener
(aka iPhone garage door opener).
See http://tuxgraphics.org/electronics/

Copyright of most software and all diagrams: Guido Socher

License for everything: GPL V2
See http://www.gnu.org/licenses/gpl.html
---------------------------------------------------------------------------

 All parts needed to build this AVR ethernet solution can be ordered from 
 http://shop.tuxgraphics.org/                                          

This software is from a user interface primarily targeted for smartphone such as iPhone
or Android phones but works even with older phones that have a web browser. No software 
installation on the phone is required. 

The switch which senses the state of the door is connected
between GND and PC0..PC3. The door relays are controlled via PD7..PD4
This software supports 1 to 4 garage doors

The default master pw is "secret". You can either change this in the file main.c
or when the system is up and running. If you do ever forget a master pw that was
changed during run-time then you can go back to the compile time default by
connecting pin PD2 to gnd during power on of the board.

No door passcode is configured by default. You must first use
the master password and set a door passcode in the [set] menu.
A max of 2 passcodes are possible.

<h2>Compiling the software</h2>

!! READ THIS FIRST !!
---------------------
Edit the file main.c and change the 2 lines:

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

For the first device you build you will not need to change the mymac line.
But you will probably need to change the IP address (myip). It must be a
free address from the address range in your home network.

Use an IP address in the same network as you DSL router.

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. 

Edit the file main.c and change the following line according to
the number of doors you want to control:
static uint8_t maxdoornum=2; // The number of doors you have. Range: 1..4

Edit the beginning of the Makefile. And adjust those lines according to the
CPU you use (atmega328p or atmega644):

  MCU=atmega328p
  DUDECPUTYPE=m328p
  or
  MCU=atmega644
  DUDECPUTYPE=m644
  or
  MCU=atmega644
  DUDECPUTYPE=m644p


Edit the avrdude command definition:
# linux (plug in the avrusb500 and type dmesg to see which device it is):
LOADCMD=avrdude -P /dev/ttyUSB0

# mac (plug in the programmer and use ls /dev/tty.usbserial* to get the name):
LOADCMD=avrdude -P /dev/tty.usbserial-A9006MOb

# windows (check which com-port you get when you plug in the avrusb500):
LOADCMD=avrdude -P COM4

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

To compile the final software use the command:
make

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

The above command will compile the following hex file:
main.hex 


<h2>Loading the software into the board</h2>

The makefile included as well a command to load
the hex file using avrusb500 in combination with avrdude.
You may use your own method to load the file.

make load

The "make load" command will run something like: 
   avrdude -p m328p -c stk500v2 -e -U flash:w:main.hex

Note: your programmer might interfere with the enc28j60! If you use
an avrusb500 then you can normally leave the cable on. For all other 
programmers it is saver to remove the programmer cable and power down/up 
the ethernet board. 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

<h2>Selecting the right clock source</h2>
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. It is as well recommended to enable
brownout detection by changing the extended fuse byte:

<b>
avrdude -p m328p -c stk500v2 -u -v -U lfuse:w:0x60:m
avrdude -p m328p -c stk500v2 -u -v -U efuse:w:0x5:m
or
avrdude -p m644 -c stk500v2 -u -v -U lfuse:w:0x60:m
avrdude -p m644 -c stk500v2 -u -v -U efuse:w:0x5:m
</b>

The above command can as well be executed by using the make
file. In a Linux shell you can just type:

make fuse

Note: windows users may use and modify the supplied winsetfuse.bat script.

The fuse settings of the atmega328p are after programming
should be as below (default factory settings for atmega328p, the
efuse has some not used bits and is dependent on the chip revision):
 lfuse reads as 0x60
 hfuse reads as 0xD9
 efuse reads as 0x05

Fuses of the atmega644/atmega644a after programming:
 Device signature = 0x1e9609
 lfuse reads as 60
 hfuse reads as 99
 efuse reads as FF

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 below list of fuses shows for reference purpose the settings
of a new and never programmed chip. 

The result should be this (default factory settings for atmega328p):
          lfuse reads as 62
          hfuse reads as D9
          efuse reads as 7

The result should be this (default factory settings for atmega644/atmega644a):
          Device signature = 0x1e9609
          lfuse reads as 62
          hfuse reads as 99
          efuse reads as FF

<h2>Compilation on non-Unix systems</h2>
Please use the provided Makefile !!!

It will also work under Windows.

Take a look at the supplied winmake.bat and winload.bat file. The bat script
might be needed to set the environment correctly.

Take a look at the supplied winmake.bat and winload.bat file. The bat script
might be needed to set the environment correctly in order to use
the Makefile under windows.

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

<h2>Using the Garage Door Opener</h2>
Point your javascript capable 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:

[set] [keyFree] [history] [refresh]

door states: |=|.|

activate door [1]

[         ] [Enter]
---------------------------

<h2>Revision history</h2>
2011-04-21: version 1.0 -- First version 
2011-09-29: version 1.1 -- The month in the history info is one month behind
2014-02-21: version 1.2 -- fixed incorrect handling of non TCP packets in ip_arp_udp_tcp.c
# vim:sw=8:ts=8:si:et
</pre>