summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAndreas Auras <yak54@gmx.net>2010-02-09 22:55:50 +0100
committerAndreas Auras <yak54@gmx.net>2010-02-09 22:55:50 +0100
commitf976b28761dd376e94d584c0b3fc9d33d257ef12 (patch)
tree0dce4f132a134a42577ee2204ff2d1f8fe0bed6c /README
parent69175ad4105845f2a766c308aa246cc0b624ac08 (diff)
downloaddf10ch-atmolight-controller-f976b28761dd376e94d584c0b3fc9d33d257ef12.tar.gz
df10ch-atmolight-controller-f976b28761dd376e94d584c0b3fc9d33d257ef12.tar.bz2
Prepare for public use
Diffstat (limited to 'README')
-rw-r--r--README52
1 files changed, 31 insertions, 21 deletions
diff --git a/README b/README
index 7d9f862..963cb90 100644
--- a/README
+++ b/README
@@ -4,31 +4,33 @@ Written by: Andreas Auras (yak54@gmx.net)
See the file COPYING for license information.
-This project uses Objective Development's firmware-only USB driver V-USB
-for Atmel AVR microcontrollers. For more information please visit
-http://www.obdev.at/vusb/
-
+This project is hosted at:
+http://projects.vdr-developer.org/projects/show/atmolight-controller
More documentation (currently only in german language) about this project can be found at:
-
http://www.vdr-wiki.de/wiki/index.php/VDR_Wiki:DF10CH_Atmolight_Kontroller
+This project uses Objective Development's firmware-only USB driver V-USB
+for Atmel AVR microcontrollers. For more information please visit
+http://www.obdev.at/vusb/
+
+
This directory contains the firmware, DF10CH setup program and KiCad files of hardware design:
-README The file you are currently reading
-df10ch_setup_pkg/ Python modules needed by the DF10CH setup program
-pwm_appl/ Application firmware for PWM-Prozessor
-pwm_boot/ Bootloader firmware for PWM-Prozessor
-usb_appl/ Application firmware for USB-Prozessor
-usb_boot/ Bootloader firmware for USB-Prozessor
-usbdrv/ Objective Development's firmware-only USB driver V-USB for Atmel AVR microcontrollers
-kicad/ KiCad files of hardware design: circuit and board layout
-df10ch_common.h Common include file used by firmware
-df10ch_usb_proto.h Include file with definitions of implemented USB communication protocol
-df10ch_setup.py Main python script of DF10CH setup program
-setup.py Python script used for installation of Df10CH setup program
-MANIFEST.in File used by Python installation script
+README The file you are currently reading
+df10ch_setup_pkg/ Python modules needed by the DF10CH setup program
+pwm_appl/ Application firmware for PWM-Prozessor
+pwm_boot/ Bootloader firmware for PWM-Prozessor
+usb_appl/ Application firmware for USB-Prozessor
+usb_boot/ Bootloader firmware for USB-Prozessor
+usbdrv/ Objective Development's firmware-only USB driver V-USB for Atmel AVR microcontrollers
+kicad/ KiCad files of hardware design: circuit and board layout
+df10ch_common.h Common include file used by firmware
+df10ch_usb_proto.h Include file with definitions of implemented USB communication protocol
+df10ch_setup.py Main python script of DF10CH setup program
+setup.py Python script used for installation of Df10CH setup program
+MANIFEST.in File used by Python installation script
@@ -38,14 +40,22 @@ Building the hardware:
You will find design files of circuit and board layout for use in KiCad within the kicad/ subdirectory.
The files are generated with KiCad version 20090216-final.
+File "10ch_pwm_ctrl-Lötseite.ps" is a postscript plot of the board layout
+File "10ch_pwm_ctrl.lst" is a list of the needed hardware components for the board
+
+You can produce other plot formats (e.g. Gerber, HPGL) and drill files by using KiCads plot features.
+You can download KiCad from here: http://kicad.sourceforge.net
+
----------------------
Building the firmware:
----------------------
-For building the firmware for the two Atmel AVR microcontrollers you need AVR-GCC (>=20090313) installed.
-Each firmware subdirectory contains a Makefile for compiling and flashing of firmware:
+For building the firmware for the two Atmel AVR microcontrollers you need AVR-GCC installed.
+On debian based systems these are packages avr-gcc, binutils-avr, avr-libc, avrdude
+
+Each firmware sub directory contains a Makefile for compiling and flashing of firmware:
Compiling firmware:
@@ -79,7 +89,7 @@ On debian based systems these are packages: python2.6, python-tk, python-usb, li
You can start the program directly from this distribution directory with:
- ./df10ch_setup.py
+ python df10ch_setup.py
You can also install the program to the default python installation location with: