From 644f3a525019610e117b945f13e53893ac8775b5 Mon Sep 17 00:00:00 2001 From: Ronald Schaten Date: Mon, 2 Oct 2006 16:56:11 +0000 Subject: [PATCH] Small changes --- common/usbledfader.h | 51 ++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/common/usbledfader.h b/common/usbledfader.h index b519f3d..1841405 100644 --- a/common/usbledfader.h +++ b/common/usbledfader.h @@ -5,7 +5,7 @@ * \file usbledfader.h * \brief Global definitions and datatypes, used by the firmware and the commandline-client. Also contains the main doxygen-documentation. * \author Ronald Schaten & Thomas Stegemann - * \version $Id: usbledfader.h,v 1.2 2006/10/01 16:28:01 rschaten Exp $ + * \version $Id: usbledfader.h,v 1.3 2006/10/02 16:56:11 rschaten Exp $ * * License: See documentation. */ @@ -26,10 +26,10 @@ * in the device is a number of 'waveforms' that can be displayed on the LEDs. * That way, one LED can display some kind of a sinus- or triangular wave * without any interaction with the controlling host. - * + * * Every LED can be controlled individually, each one can display it's own * waveforms. - * + * * You can assign three different waves to every LED: two 'eternal' waves (0 & * 1). They are displayed alternating until anything different is required. The * third wave (2) is only displayed once, afterwards the device will switch @@ -38,45 +38,45 @@ * One wave is described by three parameters: the waveform, the duration for * one repetition of the wave and the number of repetitions before switching to * the next wave. - * + * * This version supports four LEDs, it should be quite easy to change that * number between one and eight. I have not tested any number greater than * four, but I can imagine that the load on the controller can be too high to * reliably communicate via USB. - * + * * There are three parts included in the distribution: The firmware for an * ATmega8 microcontroller, a commandline-client that can be run under Linux, * and the circuits needed to build the device. - * + * * This project is based on the PowerSwitch example application by Objective * Development. Like that, it uses Objective Development's firmware-only USB * driver for Atmel's AVR microcontrollers. - * + * * Objective Development's USB driver is a firmware-only implementation of the * USB 1.1 standard (low speed device) on cheap single chip microcomputers of * Atmel's AVR series, such as the ATtiny2313 or even some of the small 8 pin * devices. It implements the standard to the point where useful applications * can be implemented. See the file "firmware/usbdrv/usbdrv.h" for features and * limitations. - * + * * \section sec_install Building and installing - * + * * Both, the firmware and Unix command line tool are built with "make". You may * need to customize both makefiles. - * + * * \subsection sec_fw Firmware * * The firmware for this project requires avr-gcc and avr-libc (a C-library for * the AVR controller). Please read the instructions at * http://www.nongnu.org/avr-libc/user-manual/install_tools.html for how to * install the GNU toolchain (avr-gcc, assembler, linker etc.) and avr-libc. - * + * * Once you have the GNU toolchain for AVR microcontrollers installed, you can * run "make" in the subdirectory "firmware". You may have to edit the Makefile * to use your preferred downloader with "make program". The current version is * built for avrdude with a parallel connection to an stk200-compatible * programmer. - * + * * If working with a brand-new controller, you may have to set the fuse-bits to * use the external crystal: * @@ -96,7 +96,7 @@ * system's distribution or download libusb from http://libusb.sourceforge.net/ * and install it before you compile. Change to directory "commandline", check * the Makefile and edit the settings if required and type - * + * * \code * make * \endcode @@ -129,8 +129,7 @@ * circuit). * - \e waveId: ID of the wave (0-1: constant waves, 2: override). * - \e waveformId: ID of the waveform (0-31: brightness, 32-37: patterns). For - * a reference to the patterns, consult the function fade_calculateWaveform() - * in the file "firmware/main.c". + * a reference to the patterns, use the show-function. * - \e periodDuration: Time in sec/10 for one repetition of the waveform. A * value of 0 can be used to reset the wave. * - \e repetitionCount: Number of repetitions before switching to the next @@ -283,15 +282,15 @@ * combined result in a lot of load on the device, so the communication with * the device is not 100% reliable. More than 99% though, at least in our * tests. - * + * * SO BE WARNED: You should not use this device to control the state of * your nuclear reactor. If you intend to use it in that way despite of this * warning, please let me know... ;-) - * - * + * + * * \section sec_files Files in the distribution - * - * - \e Readme.txt: The file you are currently reading. + * + * - \e Readme.txt: Documentation, created from the htmldoc-directory. * - \e firmware: Source code of the controller firmware. * - \e firmware/usbdrv: USB driver -- See Readme.txt in this directory for * info @@ -304,25 +303,25 @@ * for the USB driver. Look in firmware/usbdrv/License.txt for further info. * - \e Changelog.txt: Logfile documenting changes in soft-, firm- and * hardware. - * + * * \section sec_thanks Thanks! - * + * * I'd like to thank Objective Development for the possibility to use * their driver for my project. In fact, this project wouldn't exist without * the driver. - * + * * And I'd like to give special credits to Thomas Stegemann. He wrote * the PWM-stuff, and I guess it would have been nearly to impossible to me to * write the rest of the project without his help since C isn't my natural * language. - * + * * \section sec_license About the license - * + * * Our work - all contents except for the USB driver - are licensed under the * GNU General Public License (GPL). A copy of the GPL is included in * License.txt. The driver itself is licensed under a special license by * Objective Development. See firmware/usbdrv/License.txt for further info. - * + * * (c) 2006 by Ronald Schaten - http://www.schatenseite.de */