aboutsummaryrefslogtreecommitdiff
path: root/keyboard/hhkb/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboard/hhkb/README.md')
-rw-r--r--keyboard/hhkb/README.md72
1 files changed, 25 insertions, 47 deletions
diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md
index b9e0b534a..3959ae85a 100644
--- a/keyboard/hhkb/README.md
+++ b/keyboard/hhkb/README.md
@@ -8,7 +8,6 @@ See [this thread][AltController] in geekhack.org.
8 8
9[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/ 9[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
10[AltController]: http://geekhack.org/index.php?topic=12047.0 10[AltController]: http://geekhack.org/index.php?topic=12047.0
11[Teensy]: http://www.pjrc.com/teensy/
12 11
13 12
14##Features 13##Features
@@ -22,8 +21,8 @@ See README of [tmk_keyboard] for more.
22[tmk_keyboard]: http://github.com/tmk/tmk_keyboard 21[tmk_keyboard]: http://github.com/tmk/tmk_keyboard
23 22
24###Pros 23###Pros
25* No risk: Everything is all reversible 24* No risks: Everything is all reversible
26* Without PCB trace cutting, case mod or any destructives 25* No need for PCB trace patching, case cutting or any other destructive mod
27* Can keep original controller intact 26* Can keep original controller intact
28* Can change all HHKB behaviour as you like 27* Can change all HHKB behaviour as you like
29 28
@@ -41,61 +40,35 @@ See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HH
41 40
42 41
43##Build Firmware & Program 42##Build Firmware & Program
44You can choose some combination of hardware and USB protocol stack([LUFA], [PJRC]). 43See [this document](../../doc/build.md) first.
45 44
46### Install Tools 45### Configuration
47See [this document](../../doc/build.md). 46Set `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`.
48 47
49### TMK Alt Controller Board 48### Build
50 $ make -f Makefile.tmk 49Just run make after intall tools.
51 50
52This programs the controller with [dfu-programmer] if the tool is intalled and configured properly. 51 $ make
53 52
54 $ make -f Makefile.tmk dfu 53Use `Makefile.pjrc` if you want to use PJRC stack instead of LUFA.(LUFA is recommended.)
55
56Push reset button and program with [FLIP]. The tool should be intalled and configured properly.
57
58 $ make -f Makefile.tmk flip
59
60Or you can also program with FLIP GUI.
61
62[dfu-programmer]: http://dfu-programmer.sourceforge.net/
63[FLIP]: http://www.atmel.com/tools/FLIP.aspx
64
65
66### PJRC Teensy++
67Build with [LUFA] USB stack:
68
69 $ make -f Makefile.lufa
70
71or with [PJRC] USB stack:
72 54
73 $ make -f Makefile.pjrc 55 $ make -f Makefile.pjrc
74 56
75Push reset button and program with [Teensy Loader(command line)]. The tool should be intalled and configured properly. 57Use `Makefile.vusb` for [V-USB] controller.(not supported actively any more.)
76 58 $ make -f Makefile.vusb
77 $ make -f Makefile.lufa teensy
78 $ make -f Makefile.pjrc teensy
79
80Or you can also program with [Teensy Loader(GUI)].
81 59
82[LUFA]: http://www.fourwalledcubicle.com/LUFA.php 60### Program
83[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html 61First, push reset button on board to start bootloader.
84[Teensy Loader(command line)]: http://www.pjrc.com/teensy/loader_cli.html
85[Teensy Loader(GUI)]: http://www.pjrc.com/teensy/loader.html
86 62
63This command programs the controller with [dfu-programmer] if the tool is intalled and configured properly.
87 64
88###AVR Mega with [V-USB] 65 $ make dfu
89Build:
90 $ make -f Makefile.vusb
91 66
92Program [USBaspLoader] on MCU with AVR programmer like [AVRISPmkII] and tool like [avrdude]. 67Or you can also use [FLIP] command to program. Also the tool should be intalled and configured properly. FLIP GUI app is also available.
93 68
94You can programs with [avrdude] once you have programmed [USBaspLoader] on MCU. 69 $ make flip
95 $ make -f Makefile.vusb program
96 70
97[AVRISPmkII]: http://www.atmel.com/tools/AVRISPMKII.aspx 71Use [Teensy Loader] if your controller is Teensy/Teensy++.
98[avrdude]: http://www.nongnu.org/avrdude/
99 72
100 73
101##How to Customize 74##How to Customize
@@ -103,7 +76,7 @@ See [tmk_keyboard] documents.
103 76
104 77
105##Hardware 78##Hardware
106You have some options for hardware. Development boards with USB AVR family(ATMega32U4, AT90USB1286) like Teensy will work while MegaAVR with V-USB library is also cheapear option for DIY. 79You have some options for hardware. Development boards with USB AVR family(ATMega32U4, AT90USB1286) like Teensy will work while MegaAVR with [V-USB] library is also cheapear option for DIY.
107 80
108###1. TMK Alt Controller Board 81###1. TMK Alt Controller Board
109TMK designed [Keyboard Controller Board for HHKB Pro2(KiCad project)](https://github.com/tmk/HHKB_controller). 82TMK designed [Keyboard Controller Board for HHKB Pro2(KiCad project)](https://github.com/tmk/HHKB_controller).
@@ -127,7 +100,6 @@ See [this post](http://geekhack.org/index.php?topic=12047.msg948923#msg948923).
127 +---------------+ 100 +---------------+
128 101
129- NOTE: PJRC [Teensy](http://www.pjrc.com/teensy/) 102- NOTE: PJRC [Teensy](http://www.pjrc.com/teensy/)
130[Teensy Loader]: http://www.pjrc.com/teensy/loader.html
131 103
132###3. V-USB connection 104###3. V-USB connection
133 +---+ +---------------+ 105 +---+ +---------------+
@@ -156,5 +128,11 @@ See [this post](http://geekhack.org/index.php?topic=12047.msg948923#msg948923).
156- NOTE: See [V-USB] documentation for more detail of hardware and the USB stack. 128- NOTE: See [V-USB] documentation for more detail of hardware and the USB stack.
157- NOTE: [USBaspLoader] is very useful for firmware update. 129- NOTE: [USBaspLoader] is very useful for firmware update.
158 130
131
132[LUFA]: http://www.fourwalledcubicle.com/LUFA.php
133[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html
134[dfu-programmer]: http://dfu-programmer.sourceforge.net/
135[FLIP]: http://www.atmel.com/tools/FLIP.aspx
136[Teensy Loader]: http://www.pjrc.com/teensy/loader.html
159[V-USB]: http://www.obdev.at/products/vusb/index.html 137[V-USB]: http://www.obdev.at/products/vusb/index.html
160[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html 138[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html