From 09d380d31366d3f965b376031964bfd76526f018 Mon Sep 17 00:00:00 2001 From: tmk Date: Thu, 1 Feb 2018 14:56:25 +0900 Subject: [PATCH] hhkb: Update README and remove makefiles --- keyboard/hhkb/Makefile.editor | 5 --- keyboard/hhkb/Makefile.editor.rn42 | 5 --- keyboard/hhkb/README.md | 55 ++++++++++++------------------ keyboard/hhkb/doc/V-USB.md | 5 +-- 4 files changed, 24 insertions(+), 46 deletions(-) delete mode 100644 keyboard/hhkb/Makefile.editor delete mode 100644 keyboard/hhkb/Makefile.editor.rn42 diff --git a/keyboard/hhkb/Makefile.editor b/keyboard/hhkb/Makefile.editor deleted file mode 100644 index ae8e12ff..00000000 --- a/keyboard/hhkb/Makefile.editor +++ /dev/null @@ -1,5 +0,0 @@ -# build firmware for keymap editor -# -TARGET = hhkb_editor -KEYMAP_SECTION_ENABLE = yes # fixed address keymap for keymap editor -include Makefile diff --git a/keyboard/hhkb/Makefile.editor.rn42 b/keyboard/hhkb/Makefile.editor.rn42 deleted file mode 100644 index a081dcd0..00000000 --- a/keyboard/hhkb/Makefile.editor.rn42 +++ /dev/null @@ -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 diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md index da85bceb..70d9384d 100644 --- a/keyboard/hhkb/README.md +++ b/keyboard/hhkb/README.md @@ -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. -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/ [AltController]: http://geekhack.org/index.php?topic=12047.0 @@ -12,10 +12,9 @@ See [this thread][AltController] in geekhack.org. ## Update * 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 * More keymap layers(more Fn keys) * Mouse keys @@ -26,39 +25,43 @@ See README of [tmk_keyboard] for more. [tmk_keyboard]: http://github.com/tmk/tmk_keyboard -###Pros +### Pros * No risks: Everything is all reversible * No need for PCB trace patching, case cutting or any other destructive mod * Can keep original controller intact * Can change all HHKB behavior as you like -###Cons +### Cons * Void your warranty * Lose USB hub function of Pro2 -##DISCLAIMER +## DISCLAIMER 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. -##Documents +## HHKB Internals See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller. -##Build Firmware & Program -See [this document](../../tmk_core/doc/build.md) first. +## Build Firmware & Program +See [this document](../../tmk_core/doc/build.md) and [this](https://github.com/tmk/tmk_keyboard/wiki#build-firmware) first. ### 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_.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 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. KEYMAP=(hasu|hhkb|spacefn|) + $ make -f Makefile. KEYMAP= clean + $ make -f Makefile. KEYMAP= -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 @@ -72,31 +75,15 @@ Or you can also use [FLIP] command to program. Also the tool should be installed $ make -f Makefile. KEYMAP= flip -Use [Teensy Loader] if your controller is Teensy/Teensy++. - - -##Keymap -To define your own keymap create file named `keymap_.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files. - - -##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). +## Hardware +### TMK Alt Controller Board +Preassmbled controller is available from [here](https://geekhack.org/index.php?topic=71517.0). -###3. V-USB version -See [V-USB controller for HHKB](doc/V-USB.md). +You can find design files of the controller at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller). -[LUFA]: http://www.fourwalledcubicle.com/LUFA.php -[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html [dfu-programmer]: http://dfu-programmer.sourceforge.net/ [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 diff --git a/keyboard/hhkb/doc/V-USB.md b/keyboard/hhkb/doc/V-USB.md index 7ae86f45..ad4337ba 100644 --- a/keyboard/hhkb/doc/V-USB.md +++ b/keyboard/hhkb/doc/V-USB.md @@ -4,10 +4,11 @@ Not supported actively any more. ## Build Use `Makefile.vusb` for [V-USB] controller. + $ make -f Makefile.vusb -##Hardware -###3. V-USB connection +## Hardware + +---+ +---------------+ USB GND | | ATmega328p | ~~~ C3 | | -- 2.46.2