Browse Source

Merge branch 'orphans'

master
tmk 7 years ago
parent
commit
649151cbeb
100 changed files with 38 additions and 57 deletions
  1. 33
    57
      README.md
  2. 0
    0
      orphan/IIgs/Makefile
  3. 0
    0
      orphan/IIgs/README
  4. 0
    0
      orphan/IIgs/config.h
  5. 0
    0
      orphan/IIgs/doc/PIN_BYPASS.jpg
  6. 0
    0
      orphan/IIgs/doc/Teensy++_Mod.jpg
  7. 0
    0
      orphan/IIgs/hid_listen.mac
  8. 0
    0
      orphan/IIgs/keymap.c
  9. 0
    0
      orphan/IIgs/led.c
  10. 0
    0
      orphan/IIgs/matrix.c
  11. 5
    0
      orphan/README.md
  12. 0
    0
      orphan/ascii_usb/Makefile
  13. 0
    0
      orphan/ascii_usb/README
  14. 0
    0
      orphan/ascii_usb/config.h
  15. 0
    0
      orphan/ascii_usb/keymap.c
  16. 0
    0
      orphan/ascii_usb/led.c
  17. 0
    0
      orphan/ascii_usb/matrix.c
  18. 0
    0
      orphan/ghost_squid/Makefile.lufa
  19. 0
    0
      orphan/ghost_squid/README.md
  20. 0
    0
      orphan/ghost_squid/config.h
  21. 0
    0
      orphan/ghost_squid/keymap.c
  22. 0
    0
      orphan/ghost_squid/keymap_ansi.h
  23. 0
    0
      orphan/ghost_squid/led.c
  24. 0
    0
      orphan/ghost_squid/matrix.c
  25. 0
    0
      orphan/hid_liber/Makefile.lufa
  26. 0
    0
      orphan/hid_liber/Makefile.pjrc
  27. 0
    0
      orphan/hid_liber/README.md
  28. 0
    0
      orphan/hid_liber/config.h
  29. 0
    0
      orphan/hid_liber/keymap.c
  30. 0
    0
      orphan/hid_liber/keymap_alaricljs.h
  31. 0
    0
      orphan/hid_liber/keymap_ansi.h
  32. 0
    0
      orphan/hid_liber/keymap_custom.h
  33. 0
    0
      orphan/hid_liber/keymap_iso.h
  34. 0
    0
      orphan/hid_liber/led.c
  35. 0
    0
      orphan/hid_liber/matrix.c
  36. 0
    0
      orphan/kitten_paw/Makefile.lufa
  37. 0
    0
      orphan/kitten_paw/README.md
  38. 0
    0
      orphan/kitten_paw/config.h
  39. 0
    0
      orphan/kitten_paw/keymap.c
  40. 0
    0
      orphan/kitten_paw/keymap_ansi.h
  41. 0
    0
      orphan/kitten_paw/led.c
  42. 0
    0
      orphan/kitten_paw/matrix.c
  43. 0
    0
      orphan/kmac/Makefile.lufa
  44. 0
    0
      orphan/kmac/Makefile.pjrc
  45. 0
    0
      orphan/kmac/README.md
  46. 0
    0
      orphan/kmac/backlight.c
  47. 0
    0
      orphan/kmac/config.h
  48. 0
    0
      orphan/kmac/keymap.c
  49. 0
    0
      orphan/kmac/keymap_winkey.h
  50. 0
    0
      orphan/kmac/keymap_winkeyless.h
  51. 0
    0
      orphan/kmac/led.c
  52. 0
    0
      orphan/kmac/matrix.c
  53. 0
    0
      orphan/lightpad/Makefile.lufa
  54. 0
    0
      orphan/lightpad/README.md
  55. 0
    0
      orphan/lightpad/backlight.c
  56. 0
    0
      orphan/lightpad/backlight.h
  57. 0
    0
      orphan/lightpad/config.h
  58. 0
    0
      orphan/lightpad/keymap.c
  59. 0
    0
      orphan/lightpad/keymap_lightpad.h
  60. 0
    0
      orphan/lightpad/led.c
  61. 0
    0
      orphan/lightpad/matrix.c
  62. 0
    0
      orphan/lightsaber/Makefile.lufa
  63. 0
    0
      orphan/lightsaber/Makefile.pjrc
  64. 0
    0
      orphan/lightsaber/README.md
  65. 0
    0
      orphan/lightsaber/backlight.c
  66. 0
    0
      orphan/lightsaber/backlight.h
  67. 0
    0
      orphan/lightsaber/config.h
  68. 0
    0
      orphan/lightsaber/keymap.c
  69. 0
    0
      orphan/lightsaber/keymap_winkey.h
  70. 0
    0
      orphan/lightsaber/led.c
  71. 0
    0
      orphan/lightsaber/matrix.c
  72. 0
    0
      orphan/macway/Makefile.lufa
  73. 0
    0
      orphan/macway/Makefile.pjrc
  74. 0
    0
      orphan/macway/config.h
  75. 0
    0
      orphan/macway/doc/back.jpg
  76. 0
    0
      orphan/macway/doc/case.jpg
  77. 0
    0
      orphan/macway/doc/keys.jpg
  78. 0
    0
      orphan/macway/doc/side.jpg
  79. 0
    0
      orphan/macway/doc/switch.jpg
  80. 0
    0
      orphan/macway/doc/teensy.jpg
  81. 0
    0
      orphan/macway/doc/wiring.jpg
  82. 0
    0
      orphan/macway/doc/withHHKB.jpg
  83. 0
    0
      orphan/macway/doc/withThinkPad.jpg
  84. 0
    0
      orphan/macway/keymap.c
  85. 0
    0
      orphan/macway/led.c
  86. 0
    0
      orphan/macway/matrix.c
  87. 0
    0
      orphan/nerd/Makefile
  88. 0
    0
      orphan/nerd/README.md
  89. 0
    0
      orphan/nerd/backlight.c
  90. 0
    0
      orphan/nerd/backlight.h
  91. 0
    0
      orphan/nerd/config.h
  92. 0
    0
      orphan/nerd/keymap_60_ansi150.c
  93. 0
    0
      orphan/nerd/keymap_80_ansi150.c
  94. 0
    0
      orphan/nerd/keymap_common.c
  95. 0
    0
      orphan/nerd/keymap_common.h
  96. 0
    0
      orphan/nerd/matrix.c
  97. 0
    0
      orphan/phantom/Makefile.lufa
  98. 0
    0
      orphan/phantom/Makefile.pjrc
  99. 0
    0
      orphan/phantom/README.md
  100. 0
    0
      orphan/phantom/config.h

+ 33
- 57
README.md View File

@@ -1,12 +1,15 @@
TMK Keyboard Firmware Collection
================================
This is a keyboard firmware with some useful features for Atmel AVR controller.
This repository includes keyboard and converter firmware projects built with [`tmk_core`][tmk_core] keyboard library.

Source code is available here: <http://github.com/tmk/tmk_keyboard>
The latest source code is available here: <http://github.com/tmk/tmk_keyboard>


Updates
-------
#### 2016/06/22
Some projects were moved from `converter` and `keyboard` to `orphan` directory. Those might be removed in some future but you will be able to access them with `orphans` tag. See <https://github.com/tmk/tmk_keyboard/issues/173>

#### 2016/02/10
core: flabbergast's Chibios protocol was merged from <https://github.com/flabbergast/tmk_keyboard/tree/chibios> (@72b1668). See [tmk_core/protocol/chibios/README.md](tmk_core/protocol/chibios/README.md). Chibios protocol supports Cortex-M such as STM32 and Kinetis.

@@ -19,28 +22,6 @@ In `Makefile` you need to set `TMK_DIR` to indicate core library location now.



Features
--------
These features can be used in your keyboard.

* Multi-layer Keymap - Multiple keyboard layouts with layer switching
* Mouse key - Mouse control with 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 - 120 keys(+ 8 modifiers) simultaneously
* PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
* Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
* User Function - Customizable function of key with writing code
* Macro - Very primitive at this time
* Keyboard Tricks - Oneshot modifier and modifier with tapping feature
* Debug Console - Messages for debug and interaction with firmware
* Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
* Locking CapsLock - Mechanical switch support for CapsLock
* Breathing Sleep LED - Sleep indicator with charm during USB suspend
* Backlight - Control backlight levels



Projects
--------
You can find some keyboard specific projects under `converter` and `keyboard` directory.
@@ -54,32 +35,23 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
* [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
* [pc98_usb](converter/pc98_usb/) - [PC98] to USB
* [usb_usb](converter/usb_usb/) - USB to USB(experimental)
* [ascii_usb](converter/ascii_usb/) - ASCII(Serial console terminal) to USB
* [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard Converter][GH_ibm4704]
* [usb_usb](converter/usb_usb/) - [USB to USB][GH_usb]
* [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard to USB][GH_ibm4704]
* [next_usb](converter/next_usb) - NeXT(Non-ADB) to USB, contributed by [BCG](https://github.com/bgould) and based on [Adafruit's work](https://learn.adafruit.com/usb-next-keyboard-with-arduino-micro/overview)

### keyboard
* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
* [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
* [alps64](keyboard/alps64/) - [Alps64 PCB](https://geekhack.org/index.php?topic=69740.0)
* [hbkb](keyboard/hbkb/) - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
* [hid_liber](keyboard/hid_liber/) - [HID liberation][HID_liber] controller (by alaricljs)
* [phantom](keyboard/phantom/) - [Phantom] keyboard (by Tranquilite)
* [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] [retired]
* [KMAC](keyboard/kmac/) - Korean custom keyboard
* [Lightsaber](keyboard/lightsaber/) - Korean custom keyboard
* [Infinity](keyboard/infinity/) - Massdrop [Infinity keyboard][Infinity]
* [NerD](keyboard/nerd/) - Korean custom keyboard
* [KittenPaw](keyboard/kitten_paw) - Custom Majestouch controller
* [Lightpad](keyboard/lightpad) - Korean custom keypad
* [ghost_squid](keyboard/ghost_squid/) - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt]
* [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
* [onekey](keyboard/onekey/) - Simple one key keyboard example

### External projects using tmk_keyboard
* [ErgoDox_cub-uanic][cub-uanic] - Split Ergonomic Keyboard [ErgoDox][ergodox_org]
* [mcdox][mcdox_tmk] - [mcdox][mcdox]

### Projects based tmk_keyboard or tmk_core
https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects


[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
[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
@@ -90,20 +62,11 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
[GH_ibm4704]: http://geekhack.org/index.php?topic=54706.0
[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
[Phantom]: http://geekhack.org/index.php?topic=26742
[GH60]: http://geekhack.org/index.php?topic=34959
[GH60_proto]: http://geekhack.org/index.php?topic=37570.0
[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
[Sun]: http://en.wikipedia.org/wiki/Sun-3
[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
[Infinity]: https://www.massdrop.com/buy/infinity-keyboard-kit
[ghost_squid]: http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid
[cmxt]: http://gaming.coolermaster.com/en/products/keyboards/quickfirext/
[ergodox_org]: http://ergodox.org/
[cub-uanic]: https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox
[mcdox]: https://github.com/DavidMcEwan/mcdox
[mcdox_tmk]: https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox



@@ -131,7 +94,7 @@ Magic Commands
--------------
To see help press `Magic` + `H`.

`Magic` key combination is `LShift` + `RShift` in many project, but `Power` key on ADB converter.
`Magic` key combination is `LShift` + `RShift` in many projects, but `Power` key on ADB converter.
`Magic` keybind can be vary on each project, check `config.h` in project directory.

Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
@@ -202,11 +165,11 @@ To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be

Mechanical Locking support
--------------------------
This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN
UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res
ync option tries to keep switch state consistent with keyboard LED state.
#define LOCKING_SUPPORT_ENABLE
#define LOCKING_RESYNC_ENABLE

@@ -214,15 +177,21 @@ ync option tries to keep switch state consistent with keyboard LED state.

Start Your Own Project
-----------------------
**TBD**
1. Add `tmk_core` into your repository using `git submodule` or `git subtree`.
2. Copy files from `tmk_keybaord` or other project similar to yours
3. Edit those files to support your keyboard.

See these as examples.
- https://github.com/tmk/infinity_ergodox
- https://github.com/tmk/whitefox



Debugging
--------
Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
Use PJRC's `hid_listen` to see debug messages. You can use xprintf() to display debug info, see `tmk_core/common/xprintf.h`.

You can use xprintf() to display debug info on `hid_listen`, see `tmk_core/common/xprintf.h`.
- https://www.pjrc.com/teensy/hid_listen.html



@@ -236,6 +205,13 @@ Files and Directories



Contribution
------------
- Report bugs in github **[Issues](https://github.com/tmk/tmk_keyboard/issues)**.
- Pull requets are also welcomed.



Coding Style
-------------
- Doesn't use Tab to indent, use 4-spaces instead.

keyboard/IIgs/Makefile → orphan/IIgs/Makefile View File


keyboard/IIgs/README → orphan/IIgs/README View File


keyboard/IIgs/config.h → orphan/IIgs/config.h View File


keyboard/IIgs/doc/PIN_BYPASS.jpg → orphan/IIgs/doc/PIN_BYPASS.jpg View File


keyboard/IIgs/doc/Teensy++_Mod.jpg → orphan/IIgs/doc/Teensy++_Mod.jpg View File


keyboard/IIgs/hid_listen.mac → orphan/IIgs/hid_listen.mac View File


keyboard/IIgs/keymap.c → orphan/IIgs/keymap.c View File


converter/serialmouse_usb/led.c → orphan/IIgs/led.c View File


keyboard/IIgs/matrix.c → orphan/IIgs/matrix.c View File


+ 5
- 0
orphan/README.md View File

@@ -0,0 +1,5 @@
Orphan Projects
===============
These projects won't be updated anymore and might be removed sometime in the future.

https://github.com/tmk/tmk_keyboard/issues/173

converter/ascii_usb/Makefile → orphan/ascii_usb/Makefile View File


converter/ascii_usb/README → orphan/ascii_usb/README View File


converter/ascii_usb/config.h → orphan/ascii_usb/config.h View File


converter/ascii_usb/keymap.c → orphan/ascii_usb/keymap.c View File


converter/ascii_usb/led.c → orphan/ascii_usb/led.c View File


converter/ascii_usb/matrix.c → orphan/ascii_usb/matrix.c View File


keyboard/ghost_squid/Makefile.lufa → orphan/ghost_squid/Makefile.lufa View File


keyboard/ghost_squid/README.md → orphan/ghost_squid/README.md View File


keyboard/ghost_squid/config.h → orphan/ghost_squid/config.h View File


keyboard/ghost_squid/keymap.c → orphan/ghost_squid/keymap.c View File


keyboard/ghost_squid/keymap_ansi.h → orphan/ghost_squid/keymap_ansi.h View File


keyboard/ghost_squid/led.c → orphan/ghost_squid/led.c View File


keyboard/ghost_squid/matrix.c → orphan/ghost_squid/matrix.c View File


keyboard/hid_liber/Makefile.lufa → orphan/hid_liber/Makefile.lufa View File


keyboard/hid_liber/Makefile.pjrc → orphan/hid_liber/Makefile.pjrc View File


keyboard/hid_liber/README.md → orphan/hid_liber/README.md View File


keyboard/hid_liber/config.h → orphan/hid_liber/config.h View File


keyboard/hid_liber/keymap.c → orphan/hid_liber/keymap.c View File


keyboard/hid_liber/keymap_alaricljs.h → orphan/hid_liber/keymap_alaricljs.h View File


keyboard/hid_liber/keymap_ansi.h → orphan/hid_liber/keymap_ansi.h View File


keyboard/hid_liber/keymap_custom.h → orphan/hid_liber/keymap_custom.h View File


keyboard/hid_liber/keymap_iso.h → orphan/hid_liber/keymap_iso.h View File


keyboard/hid_liber/led.c → orphan/hid_liber/led.c View File


keyboard/hid_liber/matrix.c → orphan/hid_liber/matrix.c View File


keyboard/kitten_paw/Makefile.lufa → orphan/kitten_paw/Makefile.lufa View File


keyboard/kitten_paw/README.md → orphan/kitten_paw/README.md View File


keyboard/kitten_paw/config.h → orphan/kitten_paw/config.h View File


keyboard/kitten_paw/keymap.c → orphan/kitten_paw/keymap.c View File


keyboard/kitten_paw/keymap_ansi.h → orphan/kitten_paw/keymap_ansi.h View File


keyboard/kitten_paw/led.c → orphan/kitten_paw/led.c View File


keyboard/kitten_paw/matrix.c → orphan/kitten_paw/matrix.c View File


keyboard/kmac/Makefile.lufa → orphan/kmac/Makefile.lufa View File


keyboard/kmac/Makefile.pjrc → orphan/kmac/Makefile.pjrc View File


keyboard/kmac/README.md → orphan/kmac/README.md View File


keyboard/kmac/backlight.c → orphan/kmac/backlight.c View File


keyboard/kmac/config.h → orphan/kmac/config.h View File


keyboard/kmac/keymap.c → orphan/kmac/keymap.c View File


keyboard/kmac/keymap_winkey.h → orphan/kmac/keymap_winkey.h View File


keyboard/kmac/keymap_winkeyless.h → orphan/kmac/keymap_winkeyless.h View File


keyboard/kmac/led.c → orphan/kmac/led.c View File


keyboard/kmac/matrix.c → orphan/kmac/matrix.c View File


keyboard/lightpad/Makefile.lufa → orphan/lightpad/Makefile.lufa View File


keyboard/lightpad/README.md → orphan/lightpad/README.md View File


keyboard/lightpad/backlight.c → orphan/lightpad/backlight.c View File


keyboard/lightpad/backlight.h → orphan/lightpad/backlight.h View File


keyboard/lightpad/config.h → orphan/lightpad/config.h View File


keyboard/lightpad/keymap.c → orphan/lightpad/keymap.c View File


keyboard/lightpad/keymap_lightpad.h → orphan/lightpad/keymap_lightpad.h View File


keyboard/lightpad/led.c → orphan/lightpad/led.c View File


keyboard/lightpad/matrix.c → orphan/lightpad/matrix.c View File


keyboard/lightsaber/Makefile.lufa → orphan/lightsaber/Makefile.lufa View File


keyboard/lightsaber/Makefile.pjrc → orphan/lightsaber/Makefile.pjrc View File


keyboard/lightsaber/README.md → orphan/lightsaber/README.md View File


keyboard/lightsaber/backlight.c → orphan/lightsaber/backlight.c View File


keyboard/lightsaber/backlight.h → orphan/lightsaber/backlight.h View File


keyboard/lightsaber/config.h → orphan/lightsaber/config.h View File


keyboard/lightsaber/keymap.c → orphan/lightsaber/keymap.c View File


keyboard/lightsaber/keymap_winkey.h → orphan/lightsaber/keymap_winkey.h View File


keyboard/lightsaber/led.c → orphan/lightsaber/led.c View File


keyboard/lightsaber/matrix.c → orphan/lightsaber/matrix.c View File


keyboard/macway/Makefile.lufa → orphan/macway/Makefile.lufa View File


keyboard/macway/Makefile.pjrc → orphan/macway/Makefile.pjrc View File


keyboard/macway/config.h → orphan/macway/config.h View File


keyboard/macway/doc/back.jpg → orphan/macway/doc/back.jpg View File


keyboard/macway/doc/case.jpg → orphan/macway/doc/case.jpg View File


keyboard/macway/doc/keys.jpg → orphan/macway/doc/keys.jpg View File


keyboard/macway/doc/side.jpg → orphan/macway/doc/side.jpg View File


keyboard/macway/doc/switch.jpg → orphan/macway/doc/switch.jpg View File


keyboard/macway/doc/teensy.jpg → orphan/macway/doc/teensy.jpg View File


keyboard/macway/doc/wiring.jpg → orphan/macway/doc/wiring.jpg View File


keyboard/macway/doc/withHHKB.jpg → orphan/macway/doc/withHHKB.jpg View File


keyboard/macway/doc/withThinkPad.jpg → orphan/macway/doc/withThinkPad.jpg View File


keyboard/macway/keymap.c → orphan/macway/keymap.c View File


keyboard/IIgs/led.c → orphan/macway/led.c View File


keyboard/macway/matrix.c → orphan/macway/matrix.c View File


keyboard/nerd/Makefile → orphan/nerd/Makefile View File


keyboard/nerd/README.md → orphan/nerd/README.md View File


keyboard/nerd/backlight.c → orphan/nerd/backlight.c View File


keyboard/nerd/backlight.h → orphan/nerd/backlight.h View File


keyboard/nerd/config.h → orphan/nerd/config.h View File


keyboard/nerd/keymap_60_ansi150.c → orphan/nerd/keymap_60_ansi150.c View File


keyboard/nerd/keymap_80_ansi150.c → orphan/nerd/keymap_80_ansi150.c View File


keyboard/nerd/keymap_common.c → orphan/nerd/keymap_common.c View File


keyboard/nerd/keymap_common.h → orphan/nerd/keymap_common.h View File


keyboard/nerd/matrix.c → orphan/nerd/matrix.c View File


keyboard/phantom/Makefile.lufa → orphan/phantom/Makefile.lufa View File


keyboard/phantom/Makefile.pjrc → orphan/phantom/Makefile.pjrc View File


keyboard/phantom/README.md → orphan/phantom/README.md View File


keyboard/phantom/config.h → orphan/phantom/config.h View File


Some files were not shown because too many files changed in this diff