summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorFlorian Jung <flo@windfisch.org>2014-06-04 01:37:45 +0200
committerFlorian Jung <flo@windfisch.org>2014-06-19 23:51:36 +0200
commita941c5a42a476244569d9c0b97631dfc77f87462 (patch)
treede4c0436ae2170c5ad8b023b885670689eaef490 /README
parent8e526ebb68f90672fb9305537adbde89001326f2 (diff)
readme, license, foo
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 41 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b21f704
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+This is a Rotary-Dial-to-USB-Interface, based on the USB AVR Lab
+(http://www.ullihome.de/wiki/USBAVRLab/index).
+
+This is a tiny board with an ATMEGA8 speaking USB using the V-USB
+library. It features a 10-pin-port with some AVR pins routed out,
+and also has a bootloader, so it can be programmed without an
+ISP adapter, using USB.
+
+
+The Rotary-Dial-to-USB-Interface expects a rotary dial to be attached against PB4/5.
+
+The program expects the "idle"-switch to be open when the dial is idle, and to be closed
+when the rotary dial is not in its idle position.
+The "pulse" switch is expected to be closed most of the time, and to be only opened shortly
+for each pulse.
+(This can be adapted easily).
+
+When attached to a computer, the device acts like a USB HID keyboard, no
+additional drivers are needed.
+
+
+If you want to enter the bootloader, then generate more than 17 dial pulses by
+dialing a zero, not letting the dial go fully back into idle position yet,
+and pulling it to zero again.
+
+
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ For details, see main.c