]> git.friedersdorff.com Git - max/tmk_keyboard.git/blob - orphan/phantom/README.md
ibmpc_usb: Fix Disable/Enable keyboard
[max/tmk_keyboard.git] / orphan / phantom / README.md
1 Phantom keyboard firmware
2 ======================
3 DIY keyboard developed by Geekhack and Deskthority communities.
4 The PCB was engineered by bpiphany from the original idea of HaveANiceDay.
5
6 ## Wiki on Deskthority.net
7 - [Info](http://deskthority.net/wiki/Phantom)
8 - [Assembly Instructions](http://deskthority.net/wiki/Phantom)
9
10
11 Build
12 -----
13 Move to this directory then just run `make` like:
14
15     $ make -f Makefile.[pjrc|lufa] [ansi|ansi_150|iso|iso_150|7bit]
16
17 Use `Makefile.pjrc` if you want to use PJRC stack or use `Makefile.lufa` for LUFA stack.
18
19
20 LEDs
21 ----
22 It is possible to configure the LEDs in 2 different ways.
23
24 ### 1. LED Brightness
25 The brightness of the LEDs can be controlled by software.
26
27 To select brightness edit [config.h](config.h) and set `LED_BRIGHTNESS` to a value
28 between 0 and 255:
29
30     #define LED_BRIGHTNESS  250
31
32
33 ### 2. Sleep LED
34 It is possible to have the LEDs fade in and out when the computer is suspended.
35
36 To enable this feature, uncomment the `SLEEP_LED_ENABLE` line in the makefile you are using:
37
38     SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
39
40 *Note that this will set the LEDs to full brightness as this feature can't be combined with the brightness control.*
41
42
43 Keymap
44 ------
45 The PCB supports multiple physical layouts.
46 Each layout have their own keymap file.
47
48 *Note that only the ANSI keymap is tested on actual hardware.*
49
50 To customize a keymap:
51
52 1. Edit the file that corresponds to your layout.
53 2. Specify your layout when building.
54
55 See [keymap.c](keymap.c) to define your own custom layout.
56
57
58 ### 1. ANSI
59 This is the default keymap.
60
61 See [keymap_ansi.h](keymap_ansi.h) for detail.
62
63 #### 1.0. ANSI Default Layer
64      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
65      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
66      `---'   `---------------' `---------------' `---------------' `-----------'
67      ,-----------------------------------------------------------. ,-----------.
68      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
69      |-----------------------------------------------------------| |-----------|
70      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
71      |-----------------------------------------------------------| '-----------'
72      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
73      |-----------------------------------------------------------|     ,---.
74      |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
75      |-----------------------------------------------------------| ,-----------.
76      |Ctl|Gui|Alt|             Space             |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
77      `-----------------------------------------------------------' `-----------'
78
79 #### 1.1. ANSI Media Layer
80      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
81      |   |   |   |   |   |   | |   |   |   |   | |   |   |   |   | |   |   |Slp|
82      `---'   `---------------' `---------------' `---------------' `-----------'
83      ,-----------------------------------------------------------. ,-----------.
84      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |       | |   |   |   |
85      |-----------------------------------------------------------| |-----------|
86      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|Media| |   |   |   |
87      |-----------------------------------------------------------| '-----------'
88      |      |   |   |   |   |   |   |   |   |   |   |   |        |
89      |-----------------------------------------------------------|     ,---.
90      |        |   |   |Clc|   |   |   |   |   |   |   |Caps      |     |   |
91      |-----------------------------------------------------------| ,-----------.
92      |   |   |   |                               |   |   |   |   | |   |   |   |
93      `-----------------------------------------------------------' `-----------'
94
95
96 ### 2. ANSI 150
97 Layout with 1.5 unit modifiers.
98
99 See [keymap_ansi_150.h](keymap_ansi_150.h) for detail.
100
101 #### 2.0. ANSI 150 Default Layer
102      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
103      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
104      `---'   `---------------' `---------------' `---------------' `-----------'
105      ,-----------------------------------------------------------. ,-----------.
106      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
107      |-----------------------------------------------------------| |-----------|
108      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
109      |-----------------------------------------------------------| '-----------'
110      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
111      |-----------------------------------------------------------|     ,---.
112      |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
113      |-----------------------------------------------------------| ,-----------.
114      |Ctl |Gui|Alt |             Space             |Alt |Gui|Ctl | |Lef|Dow|Rig|
115      `-----------------------------------------------------------' `-----------'
116
117 #### 2.1. ANSI 150 Media Layer
118      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
119      |   |   |   |   |   |   | |   |   |   |   | |   |   |   |   | |   |   |Slp|
120      `---'   `---------------' `---------------' `---------------' `-----------'
121      ,-----------------------------------------------------------. ,-----------.
122      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |       | |   |   |   |
123      |-----------------------------------------------------------| |-----------|
124      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|Media| |   |   |   |
125      |-----------------------------------------------------------| '-----------'
126      |      |   |   |   |   |   |   |   |   |   |   |   |        |
127      |-----------------------------------------------------------|     ,---.
128      |        |   |   |Clc|   |   |   |   |   |   |   |Caps      |     |   |
129      |-----------------------------------------------------------| ,-----------.
130      |    |   |    |                               |    |   |    | |   |   |   |
131      `-----------------------------------------------------------' `-----------'
132
133
134 ### 3. ISO
135 ISO layout.
136
137 See [keymap_iso.h](keymap_iso.h) for detail.
138
139 #### 3.0. ISO Default Layer
140      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
141      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
142      `---'   `---------------' `---------------' `---------------' `-----------'
143      ,-----------------------------------------------------------. ,-----------.
144      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
145      |-----------------------------------------------------------| |-----------|
146      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|     | |Del|End|PgD|
147      |------------------------------------------------------` Ret| '-----------'
148      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|  #|    |
149      |-----------------------------------------------------------|     ,---.
150      |Shif|  \|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
151      |-----------------------------------------------------------| ,-----------.
152      |Ctl|Gui|Alt|             Space             |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
153      `-----------------------------------------------------------' `-----------'
154
155 #### 3.1. ISO Media Layer
156      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
157      |   |   |   |   |   |   | |   |   |   |   | |   |   |   |   | |   |   |Slp|
158      `---'   `---------------' `---------------' `---------------' `-----------'
159      ,-----------------------------------------------------------. ,-----------.
160      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |       | |   |   |   |
161      |-----------------------------------------------------------| |-----------|
162      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|     | |   |   |   |
163      |------------------------------------------------------` Med| '-----------'
164      |      |   |   |   |   |   |   |   |   |   |   |   |   |    |
165      |-----------------------------------------------------------|     ,---.
166      |    |   |   |   |Clc|   |   |   |   |   |   |   |Caps      |     |   |
167      |-----------------------------------------------------------| ,-----------.
168      |   |   |   |                               |   |   |   |   | |   |   |   |
169      `-----------------------------------------------------------' `-----------'
170
171
172 ### 4. ISO 150
173 ISO layout with 1.5 unit modifiers.
174
175 See [keymap_iso_150.h](keymap_iso_150.h) for detail.
176
177 #### 4.0. ISO 150 Default Layer
178      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
179      |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
180      `---'   `---------------' `---------------' `---------------' `-----------'
181      ,-----------------------------------------------------------. ,-----------.
182      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
183      |-----------------------------------------------------------| |-----------|
184      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|     | |Del|End|PgD|
185      |------------------------------------------------------` Ret| '-----------'
186      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|  #|    |
187      |-----------------------------------------------------------|     ,---.
188      |Shif|  \|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
189      |-----------------------------------------------------------| ,-----------.
190      |Ctl |Gui|Alt |             Space             |Alt |Gui|Ctl | |Lef|Dow|Rig|
191      `-----------------------------------------------------------' `-----------'
192
193 #### 4.1. ISO 150 Media Layer
194      ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
195      |   |   |   |   |   |   | |   |   |   |   | |   |   |   |   | |   |   |Slp|
196      `---'   `---------------' `---------------' `---------------' `-----------'
197      ,-----------------------------------------------------------. ,-----------.
198      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |       | |   |   |   |
199      |-----------------------------------------------------------| |-----------|
200      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|     | |   |   |   |
201      |------------------------------------------------------` Med| '-----------'
202      |      |   |   |   |   |   |   |   |   |   |   |   |   |    |
203      |-----------------------------------------------------------|     ,---.
204      |    |   |   |   |Clc|   |   |   |   |   |   |   |Caps      |     |   |
205      |-----------------------------------------------------------| ,-----------.
206      |    |   |    |                               |    |   |    | |   |   |   |
207      `-----------------------------------------------------------' `-----------'
208
209
210 ### 5. 7bit
211 Layout using all the available keys on the PCB.
212
213 This keymap is only provided as an example of what can be done using this layout.
214 No real thought has been put into this keymap.
215
216 See [keymap_7bit.h](keymap_7bit.h) for detail.
217
218 #### 5.0. 7bit Default Layer
219      ,-----------------------------------------------------------. ,-----------.
220      |Esc|F1 |F2 |F3 |F4 |F5 |F6 |F7 |F8 |F9 |F10|F11|F12|V- |V+ | |PrS|ScL|Pau|
221      `-----------------------------------------------------------' `-----------'
222      ,-----------------------------------------------------------. ,-----------.
223      |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  (|  )| |Ins|Hom|PgU|
224      |-----------------------------------------------------------| |-----------|
225      |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs| |Del|End|PgD|
226      |-----------------------------------------------------------| |-----------|
227      |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|  \| Ret| |Stp|Ply|Med|
228      |-----------------------------------------------------------| |-----------|
229      |Cap|Shif|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Cap| |Prv|Up |Nxt|
230      |-----------------------------------------------------------| |-----------|
231      |Ctrl |Gui|Alt  |Spc  |Bspc |Del|Ret  |Alt  |Gui  |App|Ctrl | |Lef|Dow|Rig|
232      `-----------------------------------------------------------' `-----------'
233
234 #### 5.1. 7bit Media Layer
235      ,-----------------------------------------------------------. ,-----------.
236      |   |   |   |   |   |   |   |   |   |   |   |   |   |   |   | |   |   |Slp|
237      `-----------------------------------------------------------' `-----------'
238      ,-----------------------------------------------------------. ,-----------.
239      |   |   |   |   |   |   |   |   |   |   |Mut|V- |V+ |   |   | |   |   |   |
240      |-----------------------------------------------------------| |-----------|
241      |     |   |   |   |   |   |   |   |   |Stp|Ply|Prv|Nxt|Media| |   |   |   |
242      |-----------------------------------------------------------| |-----------|
243      |      |   |   |   |   |   |   |   |   |   |   |   |   |    | |   |   |   |
244      |-----------------------------------------------------------| |-----------|
245      |   |    |   |   |   |   |   |   |   |   |   |   |      |   | |   |   |   |
246      |-----------------------------------------------------------| |-----------|
247      |     |   |     |     |     |   |     |     |     |   |     | |   |   |   |
248      `-----------------------------------------------------------' `-----------'