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