/* Copyright (c) 2007 Axel Wachtler
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
   * Neither the name of the authors nor the names of its contributors
     may be used to endorse or promote products derived from this software
     without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   POSSIBILITY OF SUCH DAMAGE. */

/* $Id: wintools.dox,v 1.5 2009/11/26 09:13:20 joerg_wunsch Exp $ */

/**
 @page pgToolChainWin Tool Chain Setup on Windows

 The following steps describe the @uracoli toolchain installation
 for Windows.

 The packages referenced below was installed in December 2008.

 @note
 Generally I did install all tools in a separate directory,
 e.g. "D:\\DevTools" instead of "C:\\Programm Files" and it worked.

@section secToolsWinL1 Tools for @l1usr

  - @ref avrstudio


@section secToolsWinL2 Tools for @l2usr

If you want to modify the examples and install it on your platform,
you will need:

  - @ref avrstudio
  - @ref winavr

For using the packet capture tool,  you need:

  - @ref winpython "Python"
  - @ref winpywin32 "PyWin32"
  - @ref winpyserial "PySerial"
  - @ref winwshark "Wireshark"
  - @ref winftdi "FTDI driver for Windows"
    (You need this driver, if you want to use the
     <a href="http://uracoli.nongnu.org/hwlist.html#STK541">AVR Z-Link 2.4 GHz Packet Sniffer Kit</a>
     or the
     <a href="http://uracoli.nongnu.org/hwlist.html#STB230">STB Sensor Terminal Board</a>.)

@section secToolsWinL3 Tools for  @l3usr

If you want to build the libraries and applications
directly from the sources, you need:

<em>This tools you have probably already installed:</em>
  - @ref avrstudio, @ref winavr
  - @ref winpywin32, @ref winpyserial, @ref winwshark, @ref winftdi

<em>This tools you will need:</em>
  - @ref winpython
  - @ref winscons
  - @ref windox
  - @ref windot
  - @ref winxslt

If you want to run the packet capture tool you need additionaly:

  - @ref winpywin32
  - @ref winpyserial
  - @ref winwshark
  - @ref winftdi

For check out of the latest state of the repository:
  - @ref wincvs


@section secToolsWinL4 Tools for @l4usr

You need now nearly the complete tool chain (except ssh):

  - @ref avrstudio
  - @ref winavr
  - @ref winpython
  - @ref winscons
  - @ref windox
  - @ref windot
  - @ref winxslt
  - @ref winpywin32
  - @ref winpyserial
  - @ref winwshark
  - @ref winftdi
  - @ref wincvs
  - @ref winpy2exe


@section secToolsWinL5 Tools for  @l5usr
You need now the complete tool chain:
  - @ref avrstudio
  - @ref winavr
  - @ref winpython
  - @ref winscons
  - @ref windox
  - @ref windot
  - @ref winxslt
  - @ref winpywin32
  - @ref winpyserial
  - @ref winwshark
  - @ref winftdi
  - @ref wincvs
  - @ref winssh
  - @ref winpy2exe

@section secToolsList Tools List

 @anchor avrstudio
 -# @b AVR Studio 4 (mandatory)
	- @e URL: http://www.atmel.com/dyn/products/tools_card.asp?tool_id=2725
	- @e Download: http://www.atmel.com/dyn/resources/prod_documents/AvrStudio416Setup.exe
    - @e Remarks: None
    - @e Why? ... it provides embedded @ref motprog "programmer" and @ref motdeb "debugger"
 @anchor winavr
 -# @b WinAVR (mandatory)@n
   This package provides a complete set of all tools around AVR microcontroller,
   including compiler, linker, assembler, avrdude, ... and many other more.
	- @e URL: http://winavr.sourceforge.net/
	- @e Download: http://downloads.sourceforge.net/winavr/WinAVR-20081205-install.exe
    - @e Remarks: None
    - @e Why? ... it provides @ref motbinutils "avr-binutils", @ref motgcc "avr-gcc"
 @anchor winpython
 -# @b Python (mandatory)
	- @e URL: http://www.python.org
	- @e Download: http://www.python.org/ftp/python/2.5.2/python-2.5.2.msi
    - @e Remarks: None
    - @e Why? ... it provides a @ref motpython "swiss army knife" for everything
  @anchor winscons
 -# @b Scons (mandatory)
	- @e URL: http://www.scons.org/
	- @e Download: http://prdownloads.sourceforge.net/scons/scons-1.1.0.win32.exe
    - @e Remarks: None
    - @e Why? ... it provides a @ref motscons "a comfortable modern build system"
 @anchor windox
 -# @b Doxygen (required for creating documentation)
	- @e URL: http://www.doxygen.org/
	- @e Download: http://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.7.1-setup.exe
    - @e Remarks: None
 @anchor windot
 -# @b Graphviz (required for creating documentation)
	- @e URL: http://www.graphviz.org/
	- @e Download: http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.20.3.msi
    - @e Remarks: None
 @anchor winxslt
 -# @b XMLTools, xsltproc (required for generating AvrStudio example aps files)
	- @e URL: http://www.xmlsoft.org/
	- @e Download: @n
        http://www.zlatkovic.com/pub/libxml/zlib-1.2.3.win32.zip @n
        http://www.zlatkovic.com/pub/libxml/libxslt-1.1.24.win32.zip @n
        http://www.zlatkovic.com/pub/libxml/libxml2-2.7.2+.win32.zip
    - @e Remarks: @n
        Unizip this packages and copy all files from
        [PACKAGE]/bin/ directory to  your misc. tools directory,
        e.g. D:\\DevTool\\Misc
 @anchor winpywin32
 -# @b Pywin32 (required if packet capture tool is used)
	- @e URL: http://sourceforge.net/projects/pywin32/
	- @e Download: http://downloads.sourceforge.net/pywin32/pywin32-212.win32-py2.5.exe
    - @e Remarks: prerequisite for pyserial and used in ieee802154.py for named pipes.
 @anchor winpyserial
 -# @b Pyserial (required if packet capture tool is used)
	- @e URL: http://pyserial.wiki.sourceforge.net/pySerial
	- @e Download: http://downloads.sourceforge.net/pyserial/pyserial-2.4.win32.exe
    - @e Remarks: None
 @anchor winwshark
 -# @b Wireshark (required if packet capture tool is used)
	- @e URL: http://www.wireshark.org
	- @e Download: http://www.wireshark.org/download.html (wireshark-setup-1.0.5.exe)
    - @e Remarks: None
 @anchor winftdi
 -# @b Driver FTDI FR245
    (required if DE sensor terminal board or Atmel sniffer kit is used)
    - @e URL: http://www.ftdichip.com
    - @e Download: TODO make the patched package available
    - @e Remarks: see @pgDevFTDI245Windows
 @anchor wincvs
 -# @b TortoiseCVS (recommended) @n
    Since @uracoli is rapidly changing, a direct access to
    the @uracoli source code repository helps to stay up to date with bug fixes and
    enhancements.
	- @e URL: http://www.tortoisecvs.org/
	- @e Download: http://prdownloads.sourceforge.net/tortoisecvs/TortoiseCVS-1.10.9.exe
    - @e Remarks: @n
      Unable to install 11.1.3 on WinXP, version 1.10.9 did work fine.@n
	  <em>For anonymous cvs use: </em> simply add cvs url to tortoise config
	  <em>for developer cvs use:</em>
        - install Putty (see below)
  		- convert your ssh2 privte key to putty ppk format, use puttygen.exe / Load / Save private key.
  		- start pageant /path/to/uracoli.ppk, e.g.@n
          @em "d:\\DevTools\\Misc\\PAGEANT.EXE \\path\\to\\uracoli.ppk"
 @anchor winssh
 -# @b Putty (required for @uracoli developer access) @n
    If you have a @uracoli developer account, you will need this package
    in order to do a SSH connection with the repository (not needed for
    anonymous checkout).
	- @e URL: http://www.putty.org/
	- @e Donwload: ftp://ftp.chiark.greenend.org.uk/users/sgtatham/putty-latest/x86/putty.zip
    - @e Remarks: @n
      Unpack the contents of the zip file in a general tool directory, which
      is in the path variable, e.g. D:\\DevTool\\Misc
 @anchor winpy2exe
 -# @b py2exe (optional)
	- @e URL: http://www.py2exe.org
	- @e Download: http://sourceforge.net/project/showfiles.php?group_id=15583
    - @e Remarks: Version 0.6.9 was used.

*/

/*
@par Tools that maybe needed later on

---
OPT (build wireshark)
	http://www.mingw.org/
	http://downloads.sourceforge.net/mingw/MinGW-5.1.4.exe

----

OPT

TODO make seperate patched driver package available
http://www.ftdichip.com/FTDrivers.htm
VCP Drivers: http://www.ftdichip.com/Drivers/VCP.htm
http://www.ftdichip.com/Drivers/CDM/CDM%202.04.06.exe
http://www.ftdichip.com/Documents/InstallGuides.htm


----
OPT

---
[OPT]
py2exe installs under python directory
http://www.p2exe.org
---
7-zip

http://www.7-zip.org/
http://ovh.dl.sourceforge.net/sourceforge/sevenzip/7z464.exe

-----
OPT
	http://www.textpad.com/download/#downloads
----


*/
