Dependencies
============

make
avr-libc
binutils-avr
gcc-avr
avrdude
dfu-programmer
libusb-dev (for teensy_loader_cli)


udev example rules
==================

DFU programmable Boards:
------------------------

(something like this is likley is already installed via the avrdude package)
SUBSYSTEM=="usb", ATTR{idVendor}=="03eb", ATTR{idProduct}=="*", TAG+="uaccess"

Teensy Boards:
--------------

ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="04[789]?", ENV{ID_MM_DEVICE_IGNORE}="1"
ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="04[789]?", ENV{MTP_NO_PROBE}="1"
SUBSYSTEMS=="usb", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="04[789]?", TAG+="uaccess"

Arduino Boards:
---------------

SUBSYSTEMS=="usb", KERNEL=="ttyUSB*", ATTRS{serial}=="A6008hTA", SYMLINK+="arduino", TAG+="uaccess"

Replace "A6008hTA" with the serial of your arduino board. You can obtain it
with the following command:

udevadm info --name /dev/ttyUSB0 --attribute-walk | grep ATTRs{serial}

(replace ttyUSB0 with the actual device your arduino uses)


Build
=====

Getting the source via GIT:
---------------------------

git clone git://git.spreadspace.org/avr-utils.git
cd avr-utils
make -C contrib

build and flash blink example
-----------------------------

# cd blink
adapt Makefile (set BOARD_TYPE)
# make program


Some Hints
==========

The object files for builded libs will be called lib-<name>.o so make sure
not to use files named like this for your own code. i.e. if you want
to use the `led` library it's not possible to have a source file name
lib-led.c inside your project.

The anyio lib provides a failover between serial and usb-serial (using LUFA)
streams. It's not safe to use any STDIO functions inside interrupts.

To use LUFA in your project you have to provide the path to the LUFA
source code. You may do this by calling `make` inside the contrib tree.
But any external path is ok. In order to build the lufa object file the
build system has to call `make clean` inside the LUFA_PATH so make sure
there is no lufa build inside which you still need. Also paralell builds
of several projects using the same LUFA_PATH is not possible.


License
=======

The spreadspace AVR utils are licensed under GPLv3. You can find the
full text of the license in the file LICENSE.

Some examples are based on LUFA which has been licensed under the
following conditions.

/*
             LUFA Library
     Copyright (C) Dean Camera, 2012.

  dean [at] fourwalledcubicle [dot] com
           www.lufa-lib.org
*/

/*
  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, distribute, and sell this
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/