Epiphanies TMK Keyboard Firmware Collection
This repository includes keyboard and controller firmware projects
built with [
tmk_core][tmk_core] keyboard library.
The latest source code for the core library is available here: http://github.com/tmk/tmk_keyboard
The latest source code for the individual projects is available here: https://github.com/BathroomEpiphanies/epiphanies_tmk_keyboard
This repository only contains the configuration files for the Bathroom Epiphaneis projects. To build the firmwares with tmk_keyboard you need to check out the tmk_keyboard repository and move the be_controller or be_keyboard folders to the root of that repository.
- Black Petal 2013 - geekhack forum
- Cool Talk 2015 - geekhack forum
- Frosty Flake 2013 - geekhack forum
- Frosty Flake 2014 - geekhack forum
- Ghost Squid 2014 - geekhack forum
- Hid Liberation Device - geekhack forum
- Kitten Paw 2013 - geekhack forum
- Kitten Paw 2016 - geekhack forum
- Pegasus Hoof 2013 - geekhack forum
- Pegasus Hoof 2015 - geekhack forum
GPLv2 or later. Some protocol files are under Modified BSD License.
Third party libraries like LUFA, PJRC and V-USB have their own license respectively.
Build Firmware and Program Controller
Change your keymap
To see help press
Magic key combination is
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.
----- Command Help ----- c: enter console mode d: toggle debug enable x: toggle matrix debug k: toggle keyboard debug m: toggle mouse debug v: print device version & info t: print timer count s: print status e: print eeprom config n: toggle NKRO 0/F10: switch to Layer0 1/F1: switch to Layer1 2/F2: switch to Layer2 3/F3: switch to Layer3 4/F4: switch to Layer4 PScr: power down/remote wake-up Caps: Lock Keyboard(Child Proof) Paus: jump to bootloader
Boot Magic Configuration - Virtual DIP Switch
Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable. Note that you must use keys of Layer 0 as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
To avoid configuring accidentally additive salt key
KC_SPACE also needs to be pressed along with the following configuration keys. The salt key is configurable in
config.h. See tmk_core/common/bootmagic.h.
- Skip reading EEPROM to start with default configuration(
- Clear configuration stored in EEPROM to reset configuration(
- Kick up Bootloader(
- Debug enable(
- Debug matrix enable(
- Debug keyboard enable(
- Debug mouse enable(
- Swap Control and CapsLock(
- Change CapsLock to Control(
- Swap LeftAlt and Gui(
- Swap RightAlt and Gui(
- Disable Gui(
- Swap Grave and Escape(
- Swap BackSlash and BackSpace(
- Enable NKRO on boot(
- Set Default Layer to 0(
- Set Default Layer to 1(
- Set Default Layer to 2(
- Set Default Layer to 3(
- Set Default Layer to 4(
- Set Default Layer to 5(
- Set Default Layer to 6(
- Set Default Layer to 7(
Mechanical Locking support
This feature makes it possible for you to use mechanical locking switch for
ScrollLock. To enable this feature define these macros in
config.h and use
KC_LN UM or
KC_LSCR in keymap for locking key instead of normal
ync option tries to keep switch state consistent with keyboard LED state.
#define LOCKING_SUPPORT_ENABLE #define LOCKING_RESYNC_ENABLE
Start Your Own Project
tmk_coreinto your repository using
- Copy files from
tmk_keybaordor other project similar to yours
- Edit those files to support your keyboard.
See these as examples.
hid_listen to see debug messages. You can use xprintf() to display debug info, see
Files and Directories
- keyboard/ - keyboard projects
- controller/ - keyboard controller projects
- tmk_core/ - core library
- tmk_core/doc/ - documents