hhkb: Update README and remove makefiles
This commit is contained in:
parent
9a9b8edfa9
commit
09d380d313
4 changed files with 26 additions and 48 deletions
|
|
@ -1,5 +0,0 @@
|
||||||
# build firmware for keymap editor
|
|
||||||
#
|
|
||||||
TARGET = hhkb_editor
|
|
||||||
KEYMAP_SECTION_ENABLE = yes # fixed address keymap for keymap editor
|
|
||||||
include Makefile
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
# build firmware for keymap editor
|
|
||||||
#
|
|
||||||
TARGET = hhkb_rn42_editor
|
|
||||||
KEYMAP_SECTION_ENABLE = yes # fixed address keymap for keymap editor
|
|
||||||
include Makefile.rn42
|
|
||||||
|
|
@ -2,9 +2,9 @@ Alternative Controller for HHKB Pro
|
||||||
===================================
|
===================================
|
||||||
I wanted to add some features like vi cursor and mouse keys to my [HHKB][HHKB] but its controller is not programmable and firmware source code is not open, of course. This means customizing this keyboard needs to replace original controller with programmable one.
|
I wanted to add some features like vi cursor and mouse keys to my [HHKB][HHKB] but its controller is not programmable and firmware source code is not open, of course. This means customizing this keyboard needs to replace original controller with programmable one.
|
||||||
|
|
||||||
This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**.
|
This controller can work with HHKB **Professional**, **Professional 2**, **JP** and **Type-S**.
|
||||||
|
|
||||||
See [this thread][AltController] in geekhack.org.
|
See [this thread][AltController] in geekhack.org for details.
|
||||||
|
|
||||||
[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
|
[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
|
||||||
[AltController]: http://geekhack.org/index.php?topic=12047.0
|
[AltController]: http://geekhack.org/index.php?topic=12047.0
|
||||||
|
|
@ -12,10 +12,9 @@ See [this thread][AltController] in geekhack.org.
|
||||||
|
|
||||||
## Update
|
## Update
|
||||||
* Bluetooth module RN-42 is supported.(2015/01)
|
* Bluetooth module RN-42 is supported.(2015/01)
|
||||||
* V-USB and iWRAP are no longer supported now, but still it'll works with a little fix. See not_supported directory.(2015/01)
|
|
||||||
|
|
||||||
|
|
||||||
##Features
|
## Features
|
||||||
* Customizable keymap
|
* Customizable keymap
|
||||||
* More keymap layers(more Fn keys)
|
* More keymap layers(more Fn keys)
|
||||||
* Mouse keys
|
* Mouse keys
|
||||||
|
|
@ -26,39 +25,43 @@ See README of [tmk_keyboard] for more.
|
||||||
|
|
||||||
[tmk_keyboard]: http://github.com/tmk/tmk_keyboard
|
[tmk_keyboard]: http://github.com/tmk/tmk_keyboard
|
||||||
|
|
||||||
###Pros
|
### Pros
|
||||||
* No risks: Everything is all reversible
|
* No risks: Everything is all reversible
|
||||||
* No need for PCB trace patching, case cutting or any other destructive mod
|
* No need for PCB trace patching, case cutting or any other destructive mod
|
||||||
* Can keep original controller intact
|
* Can keep original controller intact
|
||||||
* Can change all HHKB behavior as you like
|
* Can change all HHKB behavior as you like
|
||||||
|
|
||||||
###Cons
|
### Cons
|
||||||
* Void your warranty
|
* Void your warranty
|
||||||
* Lose USB hub function of Pro2
|
* Lose USB hub function of Pro2
|
||||||
|
|
||||||
##DISCLAIMER
|
## DISCLAIMER
|
||||||
I'm not a professional of electronics nor MCU programming. This may damage your HHKB.
|
I'm not a professional of electronics nor MCU programming. This may damage your HHKB.
|
||||||
And my English writing is poor, I'm not sure I can convey my notions accurately.
|
And my English writing is poor, I'm not sure I can convey my notions accurately.
|
||||||
|
|
||||||
|
|
||||||
##Documents
|
## HHKB Internals
|
||||||
See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
|
See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
|
||||||
|
|
||||||
|
|
||||||
##Build Firmware & Program
|
## Build Firmware & Program
|
||||||
See [this document](../../tmk_core/doc/build.md) first.
|
See [this document](../../tmk_core/doc/build.md) and [this](https://github.com/tmk/tmk_keyboard/wiki#build-firmware) first.
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
If your target is **HHKB JP** you need to set `HHKB_JP` build option in `Makefile` or use `Makefile.jp` instead of `Makefile`.
|
Build options and firmware settings are available in `Makefile` and `config.h` or `config_rn42.h`.
|
||||||
|
|
||||||
|
|
||||||
|
### Keymap
|
||||||
|
To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.
|
||||||
|
|
||||||
If you use other than **TMK Alt Controller Board** set proper `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`. At least PJRC Teensy requires changing `BOOTLOADER_SIZE` to 512.
|
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
|
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
|
||||||
|
|
||||||
$ make -f Makefile.<jp|pjrc|rn42> KEYMAP=(hasu|hhkb|spacefn|<name>)
|
$ make -f Makefile.<variant> KEYMAP=<name> clean
|
||||||
|
$ make -f Makefile.<variant> KEYMAP=<name>
|
||||||
|
|
||||||
You can omit `-f` option when you use `Makefile`. `Makefile` is used for **Pro2 and Pro**, `Makefile.jp` fits for **JP** model and `Makefile.rn42` supports Bluetooth module **RN-42**. `Makefile.pjrc` uses **PJRC** as output protocol instead of **LUFA**.
|
`Makefile` can be used for **Pro2 and Pro** USB controller, `Makefile.jp` for **JP**, `Makefile.rn42` for **Pro2** Bluetooth and `Makefile.rn42.jp` for **JP** Bluetooth.
|
||||||
|
|
||||||
|
|
||||||
### Program
|
### Program
|
||||||
|
|
@ -72,31 +75,15 @@ Or you can also use [FLIP] command to program. Also the tool should be installed
|
||||||
|
|
||||||
$ make -f Makefile.<variant> KEYMAP=<name> flip
|
$ make -f Makefile.<variant> KEYMAP=<name> flip
|
||||||
|
|
||||||
Use [Teensy Loader] if your controller is Teensy/Teensy++.
|
|
||||||
|
|
||||||
|
|
||||||
##Keymap
|
## Hardware
|
||||||
To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.
|
|
||||||
|
### TMK Alt Controller Board
|
||||||
|
Preassmbled controller is available from [here](https://geekhack.org/index.php?topic=71517.0).
|
||||||
|
|
||||||
|
You can find design files of the controller at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller).
|
||||||
|
|
||||||
|
|
||||||
##Hardware
|
|
||||||
You 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 cheaper option for DIY.
|
|
||||||
|
|
||||||
###1. TMK Alt Controller Board
|
|
||||||
Design files are available at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller) and see [Controller Distribution thread](http://geekhack.org/index.php?topic=56494.0) if you get an assembled one.
|
|
||||||
|
|
||||||
|
|
||||||
###2. PJRC Teensy
|
|
||||||
See [this thread](http://geekhack.org/index.php?topic=57008.0).
|
|
||||||
|
|
||||||
|
|
||||||
###3. V-USB version
|
|
||||||
See [V-USB controller for HHKB](doc/V-USB.md).
|
|
||||||
|
|
||||||
|
|
||||||
[LUFA]: http://www.fourwalledcubicle.com/LUFA.php
|
|
||||||
[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html
|
|
||||||
[dfu-programmer]: http://dfu-programmer.sourceforge.net/
|
[dfu-programmer]: http://dfu-programmer.sourceforge.net/
|
||||||
[FLIP]: http://www.atmel.com/tools/FLIP.aspx
|
[FLIP]: http://www.atmel.com/tools/FLIP.aspx
|
||||||
[Teensy Loader]: http://www.pjrc.com/teensy/loader.html
|
|
||||||
[V-USB]: http://www.obdev.at/products/vusb/index.html
|
|
||||||
|
|
|
||||||
|
|
@ -4,10 +4,11 @@ Not supported actively any more.
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
Use `Makefile.vusb` for [V-USB] controller.
|
Use `Makefile.vusb` for [V-USB] controller.
|
||||||
|
|
||||||
$ make -f Makefile.vusb
|
$ make -f Makefile.vusb
|
||||||
|
|
||||||
##Hardware
|
## Hardware
|
||||||
###3. V-USB connection
|
|
||||||
+---+ +---------------+
|
+---+ +---------------+
|
||||||
USB GND | | ATmega328p |
|
USB GND | | ATmega328p |
|
||||||
~~~ C3 | |
|
~~~ C3 | |
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue