You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk_firmware/keyboards/phantom
Jack Humbert b476d65b9c
Update keyboards' rules.mk/Makefiles (#1442)
7 years ago
..
keymaps Adjust Phantom for standard PCB 7 years ago
Makefile Split keyboard makefiles into rules and Makefile 8 years ago
config.h Adjust Phantom for standard PCB 7 years ago
phantom.c Move Phantom LED handling to phantom.c 7 years ago
phantom.h Adjust Phantom for standard PCB 7 years ago
readme.md Update Phantom readme 7 years ago
rules.mk Update keyboards' rules.mk/Makefiles (#1442) 7 years ago

readme.md

Phantom keyboard firmware

A community-developed keyboard PCB designed to fit inside the case of a Filco Majestouch.

See the Deskthority wiki for more information.

Bootloader

The Phantom uses a Teensy 2.0 as a controller.

The Teensy has a special bootloader that can be accessed by pressing the button on the Teensy PCB. It is also possible to use Boot Magic and Command to access the bootloader.

To write the firmware to the Teensy use Teensy loader.

Quantum MK Firmware

For the full Quantum feature list, see the documentation.

RGB underlight

It is possible to connect a WS2812B LED strip to the Teensy for RGB underlight support.

For this to work the DIN connection on the WS2812B strip should be soldered to PE2 on the Teensy (see reference image https://i.imgur.com/aDfNoHT.jpg).

See rgbmod for a keymap that utilizes the RGB underlight feature.

Building

The Phantom allows for a huge amount of different layouts.

Depending on which layout and keymap you would like to use, you will have to compile the firmware slightly differently. All of the commands should be run in the keyboards/phantom folder.

Custom keymaps

To define your own keymap, copy one of the existing keymap folders and give it the name of your keymap. Then check the keymap documentation for details on how to modify the keymap.

To make it easy to define keymaps for the most common layouts a few macros are provided.

Layout Macro
Winkey ANSI KEYMAP()
Winkeyless ANSI KEYMAP_WINKEYLESS()
Winkey ISO KEYMAP_ISO()
Winkeyless ISO KEYMAP_ISO_WINKEYLESS()
7BIT KEYMAP_7BIT()

To build the firmware with a custom keymap, run make <keymap name>