tmk
12 years ago
2 changed files with 51 additions and 51 deletions
+ 51
- 49
README.md
View File
| @@ -7,37 +7,29 @@ Source code is available here: <http://github.com/tmk/tmk_keyboard> | |||
| Features | |||
| -------- | |||
| * Mouse key - Mouse control by keyboard | |||
| * System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up | |||
| * Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc. | |||
| * USB NKRO - Can send 120 keys(+ 8 modifiers) simultaneously. | |||
| * PS/2 mouse support - integrate PS/2 mouse(TrackPoint) into keyboard as composite device. | |||
| * Mouse key - Mouse control by keyboard. | |||
| * System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up. | |||
| * Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc. | |||
| * USB NKRO - Can send 120 keys(+ 8 modifiers) simultaneously. | |||
| * PS/2 mouse support - integrate PS/2 mouse(TrackPoint) into keyboard as composite device. | |||
| * keyboard protocols - PS/2, ADB and old keyboard protocols. | |||
| Projects | |||
| -------- | |||
| ### converter | |||
| * [ps2_usb][c1] - [PS/2 keyboard to USB][GH_ps2] | |||
| * [adb_usb][c2] - [ADB keyboard to USB][GH_adb] | |||
| * [m0110_usb][c3] - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110] | |||
| * [terminal_usb][c4] - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal] | |||
| * [news_usb][c5] - [Sony NEWS keyboard to USB][GH_news] | |||
| * [x68k_usb][c6] - [Sharp X68000 keyboard to USB][GH_x68k] | |||
| * ps2_usb - [PS/2 keyboard to USB][GH_ps2] | |||
| * adb_usb - [ADB keyboard to USB][GH_adb] | |||
| * m0110_usb - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110] | |||
| * terminal_usb - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal] | |||
| * news_usb - [Sony NEWS keyboard to USB][GH_news] | |||
| * x68k_usb - [Sharp X68000 keyboard to USB][GH_x68k] | |||
| ### keyboard | |||
| * [hhkb][k1] - [Happy Hacking Keyboard professional][GH_hhkb] | |||
| * [macway][k2] - [Compact keyboard mod][GH_macway] | |||
| * [hbkb][k3] - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb] | |||
| [c1]: converter/ps2_usb/ | |||
| [c2]: converter/adb_usb/ | |||
| [c3]: converter/m0110_usb/ | |||
| [c4]: converter/terminal_usb/ | |||
| [c5]: converter/news_usb/ | |||
| [c6]: converter/x68k_usb/ | |||
| [k1]: keyboard/hhkb | |||
| [k2]: keyboard/macway | |||
| [k3]: keyboard/hbkb | |||
| * hhkb - [Happy Hacking Keyboard professional][GH_hhkb] | |||
| * macway - [Compact keyboard mod][GH_macway] | |||
| * hbkb - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb] | |||
| [GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930 | |||
| [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047 | |||
| [GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618 | |||
| @@ -54,21 +46,24 @@ Projects | |||
| Files & Directories | |||
| ------------------- | |||
| ### Top | |||
| * [common/](common/) - common codes | |||
| * [protocol/](protocol/) - keyboard protocol support | |||
| * [keyboard/](keyboard/) - keyboard projects | |||
| * [converter/](converter/) - protocol converter projects | |||
| * [doc/](doc/) - documents | |||
| * common/ - common codes | |||
| * protocol/ - keyboard protocol support | |||
| * keyboard/ - keyboard projects | |||
| * converter/ - protocol converter projects | |||
| * doc/ - documents | |||
| * common.mk - Makefile for common | |||
| * protoco.mk - Makefile for protocol | |||
| * rules.mk - Makefile for build rules | |||
| ### Keyboard Protocols | |||
| * [pjrc/](protocol/pjrc/) - PJRC USB stack | |||
| * [vusb/](protocol/vusb/) - Objective Development V-USB | |||
| * [iwrap/](protocol/iwrap) - Bluetooth HID for Bluegiga iWRAP | |||
| * [ps2.c](protocol/ps2.c) - PS/2 protocol | |||
| * [adb.c](protocol/adb.c) - Apple Desktop Bus protocol | |||
| * [m0110.c](protocol/m0110.c) - Macintosh 128K/512K/Plus keyboard protocol | |||
| * [news.c](protocol/news.c) - Sony NEWS keyboard protocol | |||
| * [x68k.c](protocol/x68k.c) - Sharp X68000 keyboard protocol | |||
| * pjrc/ - PJRC USB stack | |||
| * vusb/ - Objective Development V-USB | |||
| * iwrap/ - Bluetooth HID for Bluegiga iWRAP | |||
| * ps2.c - PS/2 protocol | |||
| * adb.c - Apple Desktop Bus protocol | |||
| * m0110.c - Macintosh 128K/512K/Plus keyboard protocol | |||
| * news.c - Sony NEWS keyboard protocol | |||
| * x68k.c - Sharp X68000 keyboard protocol | |||
| Build & Program | |||
| @@ -86,7 +81,7 @@ The firmware will be compiled as a file `tmk_<project>.hex`. | |||
| [crosspack]: http://www.obdev.at/products/crosspack/index.html | |||
| ### Program Controller | |||
| If you have proper program command in Makefile just type this. | |||
| If you have a proper program command in `Makefile` just type this. | |||
| $ make program | |||
| @@ -94,23 +89,25 @@ As for `Teensy` you can use `PJRC's loader` to program hex file. <http://www.pjr | |||
| Build Options | |||
| ------------- | |||
| ### `Makefile` | |||
| #### 1. MCU and Frequency. | |||
| Makefile Options | |||
| ---------------- | |||
| ### 1. MCU and Frequency. | |||
| MCU = atmega32u4 # Teensy 2.0 | |||
| #MCU = at90usb1286 # Teensy++ 2.0 | |||
| F_CPU = 16000000 | |||
| #### 2. Features | |||
| ### 2. Features | |||
| Note that ***comment out*** to disable them. | |||
| MOUSEKEY_ENABLE = yes # Mouse keys | |||
| PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support | |||
| EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control) | |||
| NKRO_ENABLE = yes # USB Nkey Rollover | |||
| #### 3. Programmer | |||
| ### 3. Programmer | |||
| Set proper command for your controller, bootloader and programmer. | |||
| # for PJRC Teensy | |||
| PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex | |||
| @@ -122,8 +119,9 @@ Set proper command for your controller, bootloader and programmer. | |||
| PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex | |||
| PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex | |||
| ### `config.h` | |||
| #### 1. USB vendor/product ID and device description | |||
| config.h Options | |||
| ---------------- | |||
| ### 1. USB vendor/product ID and device description | |||
| #define VENDOR_ID 0xFEED | |||
| #define PRODUCT_ID 0xBEEF | |||
| /* device description */ | |||
| @@ -131,14 +129,18 @@ Set proper command for your controller, bootloader and programmer. | |||
| #define PRODUCT Macway mod | |||
| #define DESCRIPTION t.m.k. keyboard firmware for Macway mod | |||
| #### 2. Keyboard matrix configuration | |||
| ### 2. Keyboard matrix configuration | |||
| #define MATRIX_ROWS 8 | |||
| #define MATRIX_COLS 8 | |||
| #define MATRIX_HAS_GHOST | |||
| ### 3. Mouse keys configuration | |||
| ### 3. Mouse keys | |||
| ### 4. PS/2 mouse | |||
| ### 5. COMMAND key combination | |||
| ### 4. PS/2 mouse configuration | |||
| #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT))) | |||
| Keymap | |||
+ 0
- 2
keyboard/hhkb/doc/Bluetooth_img/.picasa.ini
View File
| @@ -1,2 +0,0 @@ | |||
| [Picasa] | |||
| name=Bluetooth_img | |||
Loading…