tmk_keyboard/keyboard/gh60/README.md

GH60 keyboard firmware
======================
DIY compact keyboard designed and run by komar007 and Geekhack community.

- Both Rev.A and Rev.B PCB are supported by one firmware binary(issue #64)

## GH60 Resources
- [KOMAR's project page](http://blog.komar.be/projects/gh60-programmable-keyboard/)
- [Prototyping](http://geekhack.org/index.php?topic=34959.0)
- [Rev.A PCB test](http://geekhack.org/index.php?topic=37570.0)
- [Rev.B PCB test](http://geekhack.org/index.php?topic=50685.0)
- [Group buy](http://geekhack.org/index.php?topic=41464.0)


## Build
Move to this directory then just run `make` like:

    $ make

Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.


## Keymap
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.

To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:

    $ make KEYMAP=[poker|poker_set|poker_bit|plain|hasu|spacefn|hhkb|<name>]


### 1  Poker
[keymap_poker.c](keymap_poker.c) emulates original Poker layers
while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.

    Fn + Esc = `
    Fn + {left, down, up, right}  = {home, pgdown, pgup, end}

#### 1.0 Default layer
    ,-----------------------------------------------------------.
    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
    |-----------------------------------------------------------|
    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
    |-----------------------------------------------------------|
    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
    |-----------------------------------------------------------|
    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
    |-----------------------------------------------------------|
    |Ctrl|Gui |Alt |      Space             |Fn  |Gui |App |Ctrl|
    `-----------------------------------------------------------'
#### 1.1 Poker Fn layer
    ,-----------------------------------------------------------.
    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |
    |-----------------------------------------------------------|
    |     |FnQ| Up|   |   |   |   |   |   |Cal|   |Hom|Ins|     |
    |-----------------------------------------------------------|
    |      |Lef|Dow|Rig|   |   |Psc|Slk|Pau|   |Tsk|End|        |
    |-----------------------------------------------------------|
    |        |Del|   |Web|Mut|VoU|VoD|   |PgU|PgD|Del|   Up     |
    |-----------------------------------------------------------|
    |    |    |    |         FnS            |Fn  |Left|Down|Righ|
    `-----------------------------------------------------------'


### 2. Plain
Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
See [keymap_plain.c](keymap_plain.c) for detail.

#### 1.0 Plain Default layer
    ,-----------------------------------------------------------.
    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
    |-----------------------------------------------------------|
    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
    |-----------------------------------------------------------|
    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
    |-----------------------------------------------------------|
    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
    |-----------------------------------------------------------|
    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
    `-----------------------------------------------------------'


### 3. Hasu
This is my favourite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.


### 4. SpaceFN
This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).

#### 4.0 Default layer
    ,-----------------------------------------------------------.
    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
    |-----------------------------------------------------------|
    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
    |-----------------------------------------------------------|
    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
    |-----------------------------------------------------------|
    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
    |-----------------------------------------------------------|
    |Ctrl|Gui |Alt |      Space/Fn          |Alt |Gui |App |Ctrl|
    `-----------------------------------------------------------'
#### 4.1 SpaceFN layer
    ,-----------------------------------------------------------.
    |`  | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
    |-----------------------------------------------------------|
    |     |   |   |   |   |   |   |Hom|Up |End|Psc|Slk|Pau|Ins  |
    |-----------------------------------------------------------|
    |      |   |   |   |   |   |PgU|Lef|Dow|Rig|   |   |        |
    |-----------------------------------------------------------|
    |        |   |   |   |   |Spc|PgD|`  |~  |   |   |          |
    |-----------------------------------------------------------|
    |    |    |    |            Fn          |    |    |    |    |
    `-----------------------------------------------------------'


### 5. HHKB
[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers.
#### 5.0: Default layer
    ,-----------------------------------------------------------.
    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
    |-----------------------------------------------------------|
    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Bspc |
    |-----------------------------------------------------------|
    |Ctrl  |  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
    |-----------------------------------------------------------|
    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn |
    |-----------------------------------------------------------|
    |    |Gui |Alt |      Space             |    |Alt |Gui |    |
    `-----------------------------------------------------------'
#### 5.1: HHKB Fn layer
    ,-----------------------------------------------------------.
    |Pwr| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
    |-----------------------------------------------------------|
    |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |     |
    |-----------------------------------------------------------|
    |      |VoD|VoU|Mut|Ejc|   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
    |-----------------------------------------------------------|
    |        |   |   |   |   |   |  +|  -|End|PgD|Dow|      |   |
    |-----------------------------------------------------------|
    |    |    |    |                        |    |    |    |    |
    `-----------------------------------------------------------'
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`GH60 keyboard firmware`
			`======================`
			`DIY compact keyboard designed and run by komar007 and Geekhack community.`

Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`- Both Rev.A and Rev.B PCB are supported by one firmware binary(issue #64)`

			`## GH60 Resources`
			`- [KOMAR's project page](http://blog.komar.be/projects/gh60-programmable-keyboard/)`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`- [Prototyping](http://geekhack.org/index.php?topic=34959.0)`
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`- [Rev.A PCB test](http://geekhack.org/index.php?topic=37570.0)`
			`- [Rev.B PCB test](http://geekhack.org/index.php?topic=50685.0)`
			`- [Group buy](http://geekhack.org/index.php?topic=41464.0)`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00

			`## Build`
			Move to this directory then just run `make` like:

Add new keymap management on gh60 2013-11-21 07:32:45 +00:00			`$ make`
Boot Magic key for gh60 2013-02-11 04:56:05 +00:00
Add new keymap management on gh60 2013-11-21 07:32:45 +00:00			Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00

			`## Keymap`
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
Add transparent layer feature in gh60 2013-02-12 08:08:51 +00:00
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`$ make KEYMAP=[poker\|poker_set\|poker_bit\|plain\|hasu\|spacefn\|hhkb\|<name>]`
Boot Magic key for gh60 2013-02-11 04:56:05 +00:00

Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`### 1 Poker`
			`[keymap_poker.c](keymap_poker.c) emulates original Poker layers`
			`while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.`
Apply new keymap for gh60 2013-02-20 01:40:07 +00:00
Add new keymap management on gh60 2013-11-21 07:32:45 +00:00			Fn + Esc = `
			`Fn + {left, down, up, right} = {home, pgdown, pgup, end}`

Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`#### 1.0 Default layer`
Add transparent layer feature in gh60 2013-02-12 08:08:51 +00:00			`,-----------------------------------------------------------.`
			\| `\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|
			`\|-----------------------------------------------------------\|`
			`\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|`
			`\|-----------------------------------------------------------\|`
			`\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|`
			`\|-----------------------------------------------------------\|`
			`\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|`
			`\|-----------------------------------------------------------\|`
			`\|Ctrl\|Gui \|Alt \| Space \|Fn \|Gui \|App \|Ctrl\|`
			`-----------------------------------------------------------'
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`#### 1.1 Poker Fn layer`
Add transparent layer feature in gh60 2013-02-12 08:08:51 +00:00			`,-----------------------------------------------------------.`
			`\|Esc\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\| \|`
			`\|-----------------------------------------------------------\|`
			`\| \|FnQ\| Up\| \| \| \| \| \| \|Cal\| \|Hom\|Ins\| \|`
			`\|-----------------------------------------------------------\|`
			`\| \|Lef\|Dow\|Rig\| \| \|Psc\|Slk\|Pau\| \|Tsk\|End\| \|`
			`\|-----------------------------------------------------------\|`
Add new keymap management on gh60 2013-11-21 07:32:45 +00:00			`\| \|Del\| \|Web\|Mut\|VoU\|VoD\| \|PgU\|PgD\|Del\| Up \|`
Add transparent layer feature in gh60 2013-02-12 08:08:51 +00:00			`\|-----------------------------------------------------------\|`
Add new keymap management on gh60 2013-11-21 07:32:45 +00:00			`\| \| \| \| FnS \|Fn \|Left\|Down\|Righ\|`
Add transparent layer feature in gh60 2013-02-12 08:08:51 +00:00			`-----------------------------------------------------------'
Boot Magic key for gh60 2013-02-11 04:56:05 +00:00

Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`### 2. Plain`
			`Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.`
			`See [keymap_plain.c](keymap_plain.c) for detail.`
Add transparent layer feature in gh60 2013-02-12 08:08:51 +00:00
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`#### 1.0 Plain Default layer`
			`,-----------------------------------------------------------.`
			`\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|`
			`\|-----------------------------------------------------------\|`
			`\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|`
			`\|-----------------------------------------------------------\|`
			`\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|`
			`\|-----------------------------------------------------------\|`
			`\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|`
			`\|-----------------------------------------------------------\|`
			`\|Ctrl\|Gui \|Alt \| Space \|Alt \|Gui \|App \|Ctrl\|`
			`-----------------------------------------------------------'
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00

Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`### 3. Hasu`
			`This is my favourite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.`


			`### 4. SpaceFN`
			`This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).`

			`#### 4.0 Default layer`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`,-----------------------------------------------------------.`
			`\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|`
			`\|-----------------------------------------------------------\|`
			`\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|`
			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			`\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			`\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			`\|Ctrl\|Gui \|Alt \| Space/Fn \|Alt \|Gui \|App \|Ctrl\|`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`-----------------------------------------------------------'
Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`#### 4.1 SpaceFN layer`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`,-----------------------------------------------------------.`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			\|` \| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Delete \|
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			`\| \| \| \| \| \| \| \|Hom\|Up \|End\|Psc\|Slk\|Pau\|Ins \|`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			`\| \| \| \| \| \| \|PgU\|Lef\|Dow\|Rig\| \| \| \|`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			\| \| \| \| \| \|Spc\|PgD\|` \|~ \| \| \| \|
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`\|-----------------------------------------------------------\|`
Add SpaceFN layout to gh60 2013-11-21 10:32:17 +00:00			`\| \| \| \| Fn \| \| \| \| \|`
Add README and keymap layers.(GH60) 2012-12-27 07:06:13 +00:00			`-----------------------------------------------------------'


Add HHKB keymap file on gh60 2013-11-25 00:27:25 +00:00			`### 5. HHKB`
			`[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers.`
			`#### 5.0: Default layer`
			`,-----------------------------------------------------------.`
			\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\| \\| `\|
			`\|-----------------------------------------------------------\|`
			`\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\|Bspc \|`
			`\|-----------------------------------------------------------\|`
			`\|Ctrl \| A\| S\| D\| F\| G\| H\| J\| K\| L\|Fn3\| '\|Return \|`
			`\|-----------------------------------------------------------\|`
			`\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|Fn \|`
			`\|-----------------------------------------------------------\|`
			`\| \|Gui \|Alt \| Space \| \|Alt \|Gui \| \|`
			`-----------------------------------------------------------'
			`#### 5.1: HHKB Fn layer`
			`,-----------------------------------------------------------.`
			`\|Pwr\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Ins\|Del\|`
			`\|-----------------------------------------------------------\|`
			`\|Caps \| \| \| \| \| \| \| \|Psc\|Slk\|Pus\|Up \| \| \|`
			`\|-----------------------------------------------------------\|`
			`\| \|VoD\|VoU\|Mut\|Ejc\| \| *\| /\|Hom\|PgU\|Lef\|Rig\|Enter \|`
			`\|-----------------------------------------------------------\|`
			`\| \| \| \| \| \| \| +\| -\|End\|PgD\|Dow\| \| \|`
			`\|-----------------------------------------------------------\|`
			`\| \| \| \| \| \| \| \| \|`
			`-----------------------------------------------------------'