/* 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: trx.dox,v 1.16 2010/11/14 22:17:16 awachtler Exp $ */

/**
 @page pgUracoliIntro Introduction

 @section secOverview Overview

 @uracoli provides libraries, example code and demo applications for
 use on different platforms with Atmels 8-bit-AVR-microcontrollers
 and IEEE 802.15.4 radio transceivers AT86RF{230,231,212} as well
 as ATmega128RFA1.

 @uracoli provides the following software components:

  - @ref grpLibRadio "Radio Library"\n
    The @RadioLib provides functions at two abstraction levels,
    (1) a set of basic functions for low level control
        of the radio transceiver, e.g. register read/write,
        frame buffer r/w, ... and
    (2) a set of high layer functions, e.g. transmit_frame()
        or set_radio_channel().
  - @ref grpLibIoutil "IoUtil Library"\n
    The @IoLib provides utility functions that
    are usefull in a embedded applications, like
    UART communication and timer functions as well as general
    purpose IO control (LEDs, keys, one wire bus).
    However, the @IoLib is @b not used by the @RadioLib, so
    it is just used for completion of the examples and demo applications.
    So the @IoLib can be used in own applications but this is not mandatory.
  - @ref pgXmplMain "Examples"\n
    These simple mini applications are used to,
    illustrate the use of the library functions. The examples
    can be used as starting point for the own applications.
  - @ref pgAppMain "Demo Applications"\n
    This standalone radio applications are
    generic tools that can be used
    out of the box, like a wireless UART.
  - @ref pgContribMain "Contributions"\n
    Here is demontsrated, how embedded @uracoli radio applications
    are interfaced with PC applications, e.g. with Wireshark, Arduino,
    or a wireless bootloader application.

 @section secGetStarted Getting Started

 Before you can start, check if you have:
  - the necesarry tools installed\n
    The GNU AVR tools (WinAVR) are used
    for compiling the firmware, avrdude/avarice
    (AVR-Studio)
    are used for flashing and debugging it.
    Additionally you probably want to install python
    (@b prior version 3.0!, e.g. 2.4, 2.5, 2.6) and
    pyserial in order to run and create small applications.
    If you want to build all libraries and applications
    from scratch, scons is needed. Builduing the documentation
    requires doxygen and graphviz.
  - Two or more supported radio modules (see @ref pgBoards).
  - A AVR programmer for flashing the firmware
    (ISP, JTAG ICE, Dragon, ...) is available.

  In the next step, download the binary package that supports
  your radio modules. The recent @uracoli software packages
  you'll find at http://uracoli.nongnu.org/.
  Unpack the package and change into it.

  I order to test your hard- and software environment, run a
  example application and verify if your boards
  are able to communicate wirelessly. How to do
  this is described in section @ref pgStartSetupCheck.

  Now it depends, if you want to run a preconfigured application
  (see @ref pgStartRunApps)
  or if you want to write your own application
  (see @ref pgStartWriteApps).

*/
