allow building with nix on darwin

add avrdude do dependency list

common_features.mk

@@ -197,6 +197,12 @@ ifeq ($(strip $(USB_HID_ENABLE)), yes)
     include $(TMK_DIR)/protocol/usb_hid.mk
 endif
 
+
+ifeq ($(strip $(HD44780_ENABLE)), yes)
+    SRC += drivers/avr/hd44780.c
+	OPT_DEFS += -DHD44780_ENABLE
+endif
+
 QUANTUM_SRC:= \
     $(QUANTUM_DIR)/quantum.c \
     $(QUANTUM_DIR)/keymap_common.c \

docs/_summary.md

@@ -53,18 +53,22 @@
   * [Userspace](feature_userspace.md)
 
 * [Keycodes](keycodes.md)
-  * [Backlight](feature_backlight.md#backlight-keycodes)
   * [Basic](keycodes_basic.md)
-  * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
+  * [Quantum](quantum_keycodes.md)
+  * [Audio](feature_audio.md#audio-keycodes)
+  * [Backlight](feature_backlight.md#backlight-keycodes)
   * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
+  * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
   * [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
   * [Mod+Key](feature_advanced_keycodes.md#modifier-keys)
   * [Mod Tap](feature_advanced_keycodes.md#mod-tap)
+  * [Mouse Keys](feature_mouse_keys.md#mapping-mouse-actions-to-keyboard-keys)
   * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
-  * [Quantum](quantum_keycodes.md)
   * [RGB Light](feature_rgblight.md#rgblight-keycodes)
+  * [RGB Matrix](feature_rgb_matrix.md#keycodes)
   * [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes)
   * [Stenography](feature_stenography.md#keycode-reference)
+  * [Swap Hands](feature_swap_hands.md#swap-keycodes)
   * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
   * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
 

docs/config_options.md

@@ -126,14 +126,18 @@ If you define these options you will enable the associated feature, which may in
   * how long before a tap becomes a hold, if set above 500, a key tapped during the tapping term will turn it into a hold too
 * `#define RETRO_TAPPING`
   * tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
+  * See [Retro Tapping](feature_advanced_keycodes.md#retro-tapping) for details
 * `#define TAPPING_TOGGLE 2`
   * how many taps before triggering the toggle
 * `#define PERMISSIVE_HOLD`
   * makes tap and hold keys work better for fast typers who don't want tapping term set above 500
+  * See [Permissive Hold](feature_advanced_keycodes.md#permissive-hold) for details
 * `#define IGNORE_MOD_TAP_INTERRUPT`
   * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold
+  * See [Mod tap interrupt](feature_advanced_keycodes.md#mod-tap-interrupt) for details
 * `#define TAPPING_FORCE_HOLD`
   * makes it possible to use a dual role key as modifier shortly after having been tapped
+  * See [Hold after tap](feature_advanced_keycodes.md#hold-after-tap)
 * `#define LEADER_TIMEOUT 300`
   * how long before the leader key times out
 * `#define ONESHOT_TIMEOUT 300`

docs/contributing.md

@@ -11,7 +11,7 @@ Third-party contributions help us grow and improve QMK. We want to make the pull
 
 ## I Don't Want to Read This Whole Thing! I Just Have a Question!
 
-If you'd like to ask questions about QMK you can do so on the [OLKB Subreddit](https://reddit.com/r/olkb) or on [Gitter](https://gitter.im/qmk/qmk_firmware).
+If you'd like to ask questions about QMK you can do so on the [OLKB Subreddit](https://reddit.com/r/olkb) or on [Discord](https://discord.gg/Uq7gcHh).
 
 Please keep these things in mind:
 
@@ -29,7 +29,7 @@ QMK is largely written in C, with specific features and parts written in C++. It
 
 # Where Can I Go for Help?
 
-If you need help you can [open an issue](https://github.com/qmk/qmk_firmware/issues) or [chat on gitter](http://gitter.im/QMK/qmk_firmware).
+If you need help you can [open an issue](https://github.com/qmk/qmk_firmware/issues) or [chat on Discord](https://discord.gg/Uq7gcHh).
 
 # How Do I Make a Contribution?
 
@@ -124,7 +124,7 @@ We also ask that you follow these guidelines:
 
 Before you put a lot of work into building your new feature you should make sure you are implementing it in the best way. You can get a basic understanding of QMK by reading [Understanding QMK](understanding_qmk.md), which will take you on a tour of the QMK program flow. From here you should talk to us to get a sense of the best way to implement your idea. There are two main ways to do this:
 
-* [Chat on Gitter](https://gitter.im/qmk/qmk_firmware)
+* [Chat on Discord](https://discord.gg/Uq7gcHh)
 * [Open an Issue](https://github.com/qmk/qmk_firmware/issues/new)
 
 Feature and Bug Fix PR's affect all keyboards. We are also in the process of restructuring QMK. For this reason it is especially important for significant changes to be discussed before implementation has happened. If you open a PR without talking to us first please be prepared to do some significant rework if your choices do not mesh well with our planned direction.

docs/custom_quantum_functions.md

@@ -167,7 +167,7 @@ Whenever possible you should customize your keyboard by using `process_record_*(
 
 ### Example `matrix_scan_*` Implementation
 
-This example has been deliberately omitted. You should understand enough about QMK internals to write this without an example before hooking into such a performance sensitive area. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on gitter](https://gitter.im/qmk/qmk_firmware).
+This example has been deliberately omitted. You should understand enough about QMK internals to write this without an example before hooking into such a performance sensitive area. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/Uq7gcHh).
 
 ### `matrix_scan_*` Function Documentation
 

docs/feature_advanced_keycodes.md

@@ -203,3 +203,9 @@ With default settings, `a` will be sent on the first release, then `a` will be s
 With `TAPPING_FORCE_HOLD`, the second press will be interpreted as a Shift, allowing to use it as a modifier shortly after having used it as a tap.
 
 !> `TAPPING_FORCE_HOLD` will break anything that uses tapping toggles (Such as the `TT` layer keycode, and the One Shot Tapping Toggle).
+
+# Retro Tapping
+
+When you hold a dual function key, and haven't pressed anything when you release the key, normally nothing happens.  However, if you enable this, if you release the key without pressing another key, it will send the original key, even if it is outside of the tapping term. 
+
+For instance, if you're using `LT(2, KC_SPACE)`, if you hold the key, don't hit anything else and then release it, normally, nothing happens. But with `RETRO_TAPPING` defined in your `config.h`, it will send `KC_SPACE`. 

docs/feature_audio.md

@@ -3,6 +3,7 @@
 Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any AVR keyboard that allows access to certain PWM-capable pins, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
 
 Up to two simultaneous audio voices are supported, one driven by timer 1 and another driven by timer 3.  The following pins can be defined as audio outputs in config.h:
+
 Timer 1:
 `#define B5_AUDIO`
 `#define B6_AUDIO`
@@ -58,6 +59,13 @@ PLAY_LOOP(my_song);
 
 It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif` to avoid causing problems when audio isn't built into the keyboard.
 
+The available keycodes for audio are: 
+
+* `AU_ON` - Turn audio mode on
+* `AU_OFF` - Turn audio mode off
+* `AU_TOG` - Toggle audio mode
+
+
 ## Music Mode
 
 The music mode maps your columns to a chromatic scale, and your rows to octaves. This works best with ortholinear keyboards, but can be made to work with others. All keycodes less than `0xFF` get blocked, so you won't type while playing notes - if you have special keys/mods, those will still work. A work-around for this is to jump to a different layer with KC_NOs before (or after) enabling music mode.
@@ -145,6 +153,23 @@ You can configure the default, min and max frequencies, the stepping and built i
 
 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
 
+
+## Audio Keycodes
+
+|Key             |Aliases  |Description                       |
+|----------------|---------|----------------------------------|
+|`AU_ON`         |         |Audio mode on                     |
+|`AU_OFF`        |         |Audio mode off                    |
+|`AU_TOG`        |         |Toggles Audio mode                |
+|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode         |
+|`CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks |
+|`CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks |
+|`CLICKY_RESET`  |`CK_RST` |Resets frequency to default       |
+|`MU_ON`         |         |Turns on Music Mode               |
+|`MU_OFF`        |         |Turns off Music Mode              |
+|`MU_TOG`        |         |Toggles Music Mode                |
+|`MU_MOD`        |         |Cycles through the music modes    |
+
 <!-- FIXME: this formatting needs work
 
 ## Audio

docs/feature_hd44780.md

@@ -0,0 +1,56 @@
+# HD44780 LCD Displays
+
+This is an integration of Peter Fleury's LCD library. This page will explain the basics. [For in depth documentation visit his page.](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html)
+
+You can enable support for HD44780 Displays by setting the `HD44780_ENABLE` flag in your keyboards `rules.mk` to yes. This will use about 400 KB of extra space.
+
+## Configuration
+
+You will need to configure the pins used by your display and its number of lines and collumn in your keyboards `config.h`.
+
+Uncomment the section labled HD44780 and change the parameters as needed.
+````
+/*
+ * HD44780 LCD Display Configuration
+ */
+
+#define LCD_LINES           2     //< number of visible lines of the display
+#define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
+#define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
+#if LCD_IO_MODE
+#define LCD_PORT         PORTB        //< port for the LCD lines
+#define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
+#define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
+#define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
+#define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
+#define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
+#define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
+#define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2 
+#define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
+#define LCD_RS_PORT      LCD_PORT     //< port for RS line        
+#define LCD_RS_PIN       3            //< pin  for RS line        
+#define LCD_RW_PORT      LCD_PORT     //< port for RW line        
+#define LCD_RW_PIN       2            //< pin  for RW line        
+#define LCD_E_PORT       LCD_PORT     //< port for Enable line     
+#define LCD_E_PIN        1            //< pin  for Enable line    
+#endif
+````
+
+Should you need to configure other properties you can copy them from `quantum/hd44780.h` and set them in your `config.h`
+
+## Usage 
+
+To initialize your display call lcd_init() with one of these parameters:
+````
+LCD_DISP_OFF             : display off
+LCD_DISP_ON              : display on, cursor off
+LCD_DISP_ON_CURSOR       : display on, cursor on
+LCD_DISP_ON_CURSOR_BLINK : display on, cursor on flashing 
+````
+This is best done in your keyboards `matrix_init_kb` or your keymaps `matrix_init_user`.  
+It is advised to clear the display before use.  
+To do so call `lcd_clrsrc()`.
+
+To now print something to your Display you first call `lcd_gotoxy(column, line)`. To go to the start of the first line you would call `lcd_gotoxy(0, 0)` and then print a string with `lcd_puts("example string")`.
+
+There are more posible methods to control the display. [For in depth documentation please visit the linked page.](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html)

docs/features.md

@@ -9,6 +9,7 @@ QMK has a staggering number of features for building your keyboard. It can take
 * [Backlight](feature_backlight.md) - LED lighting support for your keyboard.
 * [Bootmagic](feature_bootmagic.md) - Adjust the behavior of your keyboard using hotkeys.
 * [Dynamic Macros](feature_dynamic_macros.md) - Record and playback macros from the keyboard itself.
+* [HD44780 LCD Display](feature_hd44780.md) - Support for LCD character displays using the HD44780 standard.
 * [Key Lock](feature_key_lock.md) - Lock a key in the "down" state.
 * [Layouts](feature_layouts.md) - Use one keymap with any keyboard that supports your layout.
 * [Leader Key](feature_leader_key.md) - Tap the leader key followed by a sequence to trigger custom behavior.

docs/getting_started_getting_help.md

@@ -4,13 +4,7 @@ There are a lot of resources for getting help with QMK.
 
 ## Realtime Chat
 
-You can find QMK developers and users on our main [gitter chat room](https://gitter.im/qmk/qmk_firmware). We also have other rooms for more specific discussion:
+You can find QMK developers and users on our main [Discord server](https://discord.gg/Uq7gcHh). There are specific channels in the server for chatting about the firmware, Toolbox, hardware, and configurator.
-
-* [Main Firmware Chat](https://gitter.im/qmk/qmk_firmware)
-* [QMK Toolbox](https://gitter.im/qmk/qmk_toolbox)
-* [Hardware Design Discussion](https://gitter.im/qmk/qmk_hardware)
-* [Web Configurator](https://gitter.im/qmk/qmk_configurator)
-* [Compiler API](https://gitter.im/qmk/qmk_compiler_api)
 
 ## OLKB Subreddit
 

docs/getting_started_introduction.md

@@ -6,12 +6,16 @@ This page attempts to explain the basic information you need to know to work wit
 
 QMK is a fork of [Jun Wako](https://github.com/tmk)'s [tmk_keyboard](https://github.com/tmk/tmk_keyboard) project. The original TMK code, with modifications, can be found in the `tmk` folder. The QMK additions to the project may be found in the `quantum` folder. Keyboard projects may be found in the `handwired` and `keyboard` folders.
 
+### Userspace Structure
+
+Within the folder `users` is a directory for each user. This is a place for users to put code that they might use between keyboards. See the docs for [Userspace feature](feature_userspace.md) for more information.
+
 ### Keyboard Project Structure
 
 Within the folder `keyboards` and its subfolder `handwired` is a directory for each keyboard project, for example `qmk_firmware/keyboards/clueboard`. Within it you'll find the following structure:
 
 * `keymaps/`: Different keymaps that can be built
-* `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `Makefile`
+* `rules.mk`: The file that sets the default "make" options. Do not edit this file directly, instead use a keymap specific `rules.mk`.
 * `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
 
 ### Keymap Structure
@@ -25,23 +29,26 @@ In every keymap folder, the following files may be found. Only `keymap.c` is req
 
 # The `config.h` File
 
-There are 2 `config.h` locations:
+There are 3 possible `config.h` locations:
 
 * keyboard (`/keyboards/<keyboard>/config.h`)
+* userspace (`/users/<user>/config.h`)
 * keymap (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`)
 
-If the keymap `config.h` exists, that file is included by the build system and the keyboard `config.h` is not included. If you wish to override settings in your keymap's `config.h` you will need to include some glue code:
+The build system automatically picks up the config files in the above order. If you wish to override any setting set by a previous `config.h` you will need to first include some boilerplate code for the settings you wish to change.
 
 ```
-#ifndef CONFIG_USER_H
+#pragma once
-#define CONFIG_USER_H
-
-#include "config_common.h"
 ```
 
-If you want to override a setting from the parent `config.h` file, you need to `#undef` and then `#define` the setting again, like this:
+Then to override a setting from the previous `config.h` file you must `#undef` and then `#define` the setting again.
 
-```c
+The boilerplate code and setting look like this together:
+
+```
+#pragma once
+
+// overrides go here!
 #undef MY_SETTING
 #define MY_SETTING 4
 ```

docs/keycodes.md

@@ -191,27 +191,6 @@ This is a reference only. Each group of keys links to the page documenting their
 |`KC_NO`                |                    |Ignore this key (NOOP)                         |
 |`KC_TRANSPARENT`       |`KC_TRNS`           |Use the next lowest non-transparent key        |
 
-## [Mouse Keys](feature_mouse_keys.md)
-
-|Key             |Aliases  |Description                |
-|----------------|---------|---------------------------|
-|`KC_MS_UP`      |`KC_MS_U`|Mouse Cursor Up            |
-|`KC_MS_DOWN`    |`KC_MS_D`|Mouse Cursor Down          |
-|`KC_MS_LEFT`    |`KC_MS_L`|Mouse Cursor Left          |
-|`KC_MS_RIGHT`   |`KC_MS_R`|Mouse Cursor Right         |
-|`KC_MS_BTN1`    |`KC_BTN1`|Mouse Button 1             |
-|`KC_MS_BTN2`    |`KC_BTN2`|Mouse Button 2             |
-|`KC_MS_BTN3`    |`KC_BTN3`|Mouse Button 3             |
-|`KC_MS_BTN4`    |`KC_BTN4`|Mouse Button 4             |
-|`KC_MS_BTN5`    |`KC_BTN5`|Mouse Button 5             |
-|`KC_MS_WH_UP`   |`KC_WH_U`|Mouse Wheel Up             |
-|`KC_MS_WH_DOWN` |`KC_WH_D`|Mouse Wheel Down           |
-|`KC_MS_WH_LEFT` |`KC_WH_L`|Mouse Wheel Left           |
-|`KC_MS_WH_RIGHT`|`KC_WH_R`|Mouse Wheel Right          |
-|`KC_MS_ACCEL0`  |`KC_ACL0`|Set mouse acceleration to 0|
-|`KC_MS_ACCEL1`  |`KC_ACL1`|Set mouse acceleration to 1|
-|`KC_MS_ACCEL2`  |`KC_ACL2`|Set mouse acceleration to 2|
-
 ## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
 
 |Key          |Aliases    |Description                                                          |
@@ -227,6 +206,36 @@ This is a reference only. Each group of keys links to the page documenting their
 |`M(n)`       |           |Call macro `n`                                                       |
 |`MACROTAP(n)`|           |Macro-tap `n` idk FIXME                                              |
 
+## [Audio Keys](feature_audio.md)
+
+|Key             |Aliases  |Description                       |
+|----------------|---------|----------------------------------|
+|`AU_ON`         |         |Audio mode on                     |
+|`AU_OFF`        |         |Audio mode off                    |
+|`AU_TOG`        |         |Toggles Audio mode                |
+|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode         |
+|`CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks |
+|`CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks |
+|`CLICKY_RESET`  |`CK_RST` |Resets frequency to default       |
+|`MU_ON`         |         |Turns on Music Mode               |
+|`MU_OFF`        |         |Turns off Music Mode              |
+|`MU_TOG`        |         |Toggles Music Mode                |
+|`MU_MOD`        |         |Cycles through the music modes    |
+
+
+
+## [Backlighting](feature_backlight.md)
+
+|Key      |Description                               |
+|---------|------------------------------------------|
+|`BL_TOGG`|Turn the backlight on or off              |
+|`BL_STEP`|Cycle through backlight levels            |
+|`BL_ON`  |Set the backlight to max brightness       |
+|`BL_OFF` |Turn the backlight off                    |
+|`BL_INC` |Increase the backlight level              |
+|`BL_DEC` |Decrease the backlight level              |
+|`BL_BRTG`|Toggle backlight breathing                |
+
 ## [Bootmagic](feature_bootmagic.md)
 
 |Key                               |Aliases  |Description                         |
@@ -251,17 +260,88 @@ This is a reference only. Each group of keys links to the page documenting their
 |`MAGIC_UNSWAP_ALT_GUI`            |`AG_NORM`|Unswap Alt and GUI on both sides    |
 |`MAGIC_TOGGLE_NKRO`               |         |Turn NKRO on or off                 |
 
-## [Backlighting](feature_backlight.md)
+## [Bluetooth](feature_bluetooth.md)
 
-|Key      |Description                               |
+|Key       |Description                                   |
-|---------|------------------------------------------|
+|----------|----------------------------------------------|
-|`BL_TOGG`|Turn the backlight on or off              |
+|`OUT_AUTO`|Automatically switch between USB and Bluetooth|
-|`BL_STEP`|Cycle through backlight levels            |
+|`OUT_USB` |USB only                                      |
-|`BL_ON`  |Set the backlight to max brightness       |
+|`OUT_BT`  |Bluetooth only                                |
-|`BL_OFF` |Turn the backlight off                    |
+
-|`BL_INC` |Increase the backlight level              |
+
-|`BL_DEC` |Decrease the backlight level              |
+## [Layer Switching](feature_advanced_keycodes.md# Switching and Toggling Layers)
-|`BL_BRTG`|Toggle backlight breathing                |
+
+|Key         |Description                                                               |
+|-----------------|---------------------------------------------------------------------|
+|`DF(layer)`      |Switches the default layer                                           |
+|`MO(layer)`      |Momentarily activates layer, switches off when you let go            |
+|`LM(layer, mod)` |As `MO(layer)` but with `mod` active                                 |
+|`LT(layer, kc)`  |Momentarily activates layer if held, sends kc if tapped              |
+|`TG(layer)`      |Toggles the layer (enables it if no active, and vise versa)          |
+|`TO(layer)`      |Activates layer and deactivates all other layers                     |
+|`TT(layer)`      |Momentarily activates layer if held, toggles it if tapped repeatedly |
+
+## [Mouse Keys](feature_mouse_keys.md)
+
+|Key             |Aliases  |Description                |
+|----------------|---------|---------------------------|
+|`KC_MS_UP`      |`KC_MS_U`|Mouse Cursor Up            |
+|`KC_MS_DOWN`    |`KC_MS_D`|Mouse Cursor Down          |
+|`KC_MS_LEFT`    |`KC_MS_L`|Mouse Cursor Left          |
+|`KC_MS_RIGHT`   |`KC_MS_R`|Mouse Cursor Right         |
+|`KC_MS_BTN1`    |`KC_BTN1`|Mouse Button 1             |
+|`KC_MS_BTN2`    |`KC_BTN2`|Mouse Button 2             |
+|`KC_MS_BTN3`    |`KC_BTN3`|Mouse Button 3             |
+|`KC_MS_BTN4`    |`KC_BTN4`|Mouse Button 4             |
+|`KC_MS_BTN5`    |`KC_BTN5`|Mouse Button 5             |
+|`KC_MS_WH_UP`   |`KC_WH_U`|Mouse Wheel Up             |
+|`KC_MS_WH_DOWN` |`KC_WH_D`|Mouse Wheel Down           |
+|`KC_MS_WH_LEFT` |`KC_WH_L`|Mouse Wheel Left           |
+|`KC_MS_WH_RIGHT`|`KC_WH_R`|Mouse Wheel Right          |
+|`KC_MS_ACCEL0`  |`KC_ACL0`|Set mouse acceleration to 0|
+|`KC_MS_ACCEL1`  |`KC_ACL1`|Set mouse acceleration to 1|
+|`KC_MS_ACCEL2`  |`KC_ACL2`|Set mouse acceleration to 2|
+
+## [Modifiers](feature_advanced_keycodes.md#modifier-keys)
+
+|Key       |Aliases               |Description                                         |
+|----------|----------            |----------------------------------------------------|
+|`KC_HYPR` |                      |Hold Left Control, Shift, Alt and GUI               |
+|`KC_MEH`  |                      |Hold Left Control, Shift and Alt                    |
+|`LCTL(kc)`|                      |Hold Left Control and press `kc`                    |
+|`LSFT(kc)`|`S(kc)`               |Hold Left Shift and press `kc`                      |
+|`LALT(kc)`|                      |Hold Left Alt and press `kc`                        |
+|`LGUI(kc)`|`LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc`                        |
+|`RCTL(kc)`|                      |Hold Right Control and press `kc`                   |
+|`RSFT(kc)`|                      |Hold Right Shift and press `kc`                     |
+|`RALT(kc)`|                      |Hold Right Alt and press `kc`                       |
+|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`|Hold Right GUI and press `kc`                       |
+|`HYPR(kc)`|                      |Hold Left Control, Shift, Alt and GUI and press `kc`|
+|`MEH(kc)` |                      |Hold Left Control, Shift and Alt and press `kc`     |
+|`LCAG(kc)`|                      |Hold Left Control, Alt and GUI and press `kc`       |
+|`ALTG(kc)`|                      |Hold Right Control and Alt and press `kc`           |
+|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc`              |
+|`LCA(kc)` |                      |Hold Left Control and Alt and press `kc`            |
+
+## [Mod-Tap Keys](feature_advanced_keycodes.md#mod-tap)
+
+|Key         |Aliases                                |Description                                            |
+|------------|---------------------------------------|-------------------------------------------------------|
+|`LCTL_T(kc)`|`CTL_T(kc)`                            |Left Control when held, `kc` when tapped               |
+|`RCTL_T(kc)`|                                       |Right Control when held, `kc` when tapped              |
+|`LSFT_T(kc)`|`SFT_T(kc)`                            |Left Shift when held, `kc` when tapped                 |
+|`RSFT_T(kc)`|                                       |Right Shift when held, `kc` when tapped                |
+|`LALT_T(kc)`|`ALT_T(kc)`                            |Left Alt when held, `kc` when tapped                   |
+|`RALT_T(kc)`|`ALGR_T(kc)`                           |Right Alt when held, `kc` when tapped                  |
+|`LGUI_T(kc)`|`LCMD_T(kc)`, `RWIN_T(kc)`, `GUI_T(kc)`|Left GUI when held, `kc` when tapped                   |
+|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)`             |Right GUI when held, `kc` when tapped                  |
+|`C_S_T(kc)` |                                       |Left Control and Shift when held, `kc` when tapped     |
+|`MEH_T(kc)` |                                       |Left Control, Shift and Alt when held, `kc` when tapped|
+|`LCAG_T(kc)`|                                       |Left Control, Alt and GUI when held, `kc` when tapped  |
+|`RCAG_T(kc)`|                                       |Right Control, Alt and GUI when held, `kc` when tapped |
+|`ALL_T(kc)` |                                       |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
+|`SCMD_T(kc)`|`SWIN_T(kc)`                           |Left Shift and GUI when held, `kc` when tapped         |
+|`LCA_T(kc)` |                                       |Left Control and Alt when held, `kc` when tapped       |
 
 ## [RGB Lighting](feature_rgblight.md)
 
@@ -309,55 +389,6 @@ This is a reference only. Each group of keys links to the page documenting their
 |`PRINT_ON` |Start printing everything the user types|
 |`PRINT_OFF`|Stop printing everything the user types |
 
-## [Bluetooth](feature_bluetooth.md)
-
-|Key       |Description                                   |
-|----------|----------------------------------------------|
-|`OUT_AUTO`|Automatically switch between USB and Bluetooth|
-|`OUT_USB` |USB only                                      |
-|`OUT_BT`  |Bluetooth only                                |
-
-## [Modifiers](quantum_keycodes.md#modifiers)
-
-|Key       |Aliases               |Description                                         |
-|----------|----------            |----------------------------------------------------|
-|`KC_HYPR` |                      |Hold Left Control, Shift, Alt and GUI               |
-|`KC_MEH`  |                      |Hold Left Control, Shift and Alt                    |
-|`LCTL(kc)`|                      |Hold Left Control and press `kc`                    |
-|`LSFT(kc)`|`S(kc)`               |Hold Left Shift and press `kc`                      |
-|`LALT(kc)`|                      |Hold Left Alt and press `kc`                        |
-|`LGUI(kc)`|`LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc`                        |
-|`RCTL(kc)`|                      |Hold Right Control and press `kc`                   |
-|`RSFT(kc)`|                      |Hold Right Shift and press `kc`                     |
-|`RALT(kc)`|                      |Hold Right Alt and press `kc`                       |
-|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`|Hold Right GUI and press `kc`                       |
-|`HYPR(kc)`|                      |Hold Left Control, Shift, Alt and GUI and press `kc`|
-|`MEH(kc)` |                      |Hold Left Control, Shift and Alt and press `kc`     |
-|`LCAG(kc)`|                      |Hold Left Control, Alt and GUI and press `kc`       |
-|`ALTG(kc)`|                      |Hold Right Control and Alt and press `kc`           |
-|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc`              |
-|`LCA(kc)` |                      |Hold Left Control and Alt and press `kc`            |
-
-## [Mod-Tap Keys](quantum_keycodes.md#mod-tap-keys)
-
-|Key         |Aliases                                |Description                                            |
-|------------|---------------------------------------|-------------------------------------------------------|
-|`LCTL_T(kc)`|`CTL_T(kc)`                            |Left Control when held, `kc` when tapped               |
-|`RCTL_T(kc)`|                                       |Right Control when held, `kc` when tapped              |
-|`LSFT_T(kc)`|`SFT_T(kc)`                            |Left Shift when held, `kc` when tapped                 |
-|`RSFT_T(kc)`|                                       |Right Shift when held, `kc` when tapped                |
-|`LALT_T(kc)`|`ALT_T(kc)`                            |Left Alt when held, `kc` when tapped                   |
-|`RALT_T(kc)`|`ALGR_T(kc)`                           |Right Alt when held, `kc` when tapped                  |
-|`LGUI_T(kc)`|`LCMD_T(kc)`, `RWIN_T(kc)`, `GUI_T(kc)`|Left GUI when held, `kc` when tapped                   |
-|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)`             |Right GUI when held, `kc` when tapped                  |
-|`C_S_T(kc)` |                                       |Left Control and Shift when held, `kc` when tapped     |
-|`MEH_T(kc)` |                                       |Left Control, Shift and Alt when held, `kc` when tapped|
-|`LCAG_T(kc)`|                                       |Left Control, Alt and GUI when held, `kc` when tapped  |
-|`RCAG_T(kc)`|                                       |Right Control, Alt and GUI when held, `kc` when tapped |
-|`ALL_T(kc)` |                                       |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)|
-|`SCMD_T(kc)`|`SWIN_T(kc)`                           |Left Shift and GUI when held, `kc` when tapped         |
-|`LCA_T(kc)` |                                       |Left Control and Alt when held, `kc` when tapped       |
-
 ## [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
 
 |Key                     |Aliases           |Description        |
@@ -396,19 +427,13 @@ This is a reference only. Each group of keys links to the page documenting their
 |`TT(layer)`     |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
 |`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well.                  |
 
-## [One Shot Keys](quantum_keycodes.md#one-shot-keys)
+## [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
 
 |Key         |Description                       |
 |------------|----------------------------------|
 |`OSM(mod)`  |Hold `mod` for one keypress       |
 |`OSL(layer)`|Switch to `layer` for one keypress|
 
-## [Unicode Support](feature_unicode.md)
-
-|Key         |Aliases|                                                 |
-|------------|-------|-------------------------------------------------|
-|`UNICODE(n)`|`UC(n)`|Send Unicode character `n`                       |
-|`X(n)`      |       |Send Unicode character `n` via a different method|
 
 ## [Swap Hands](feature_swap_hands.md)
 
@@ -421,3 +446,9 @@ This is a reference only. Each group of keys links to the page documenting their
 |`SH_MOFF`  |Momentarily turns off swap.                                              |
 |`SH_TG`    |Toggles swap on and off with every key press.                            |
 |`SH_TT`    |Toggles with a tap; momentary when held.                                 |
+## [Unicode Support](feature_unicode.md)
+
+|Key         |Aliases|                                                 |
+|------------|-------|-------------------------------------------------|
+|`UNICODE(n)`|`UC(n)`|Send Unicode character `n`                       |
+|`X(n)`      |       |Send Unicode character `n` via a different method|

docs/newbs.md

@@ -1,4 +1,4 @@
-# The Compelete Newbs Guide To QMK
+# The Complete Newbs Guide To QMK
 
 QMK is a powerful Open Source firmware for your mechanical keyboard. You can use QMK to customize your keyboard in ways both simple and powerful. People of all skill levels, from complete newbie to master programmer, have successfully used QMK to customize their keyboard. This guide will help you do the same, no matter your skill level.
 
@@ -12,5 +12,7 @@ There are 4 main sections to this guide:
 * [Building Your First Firmware](newbs_building_firmware.md)
 * [Flashing Firmware](newbs_flashing.md)
 * [Testing and Debugging](newbs_testing_debugging.md)
+* [Learn More with these Resources](newbs_learn_more_resources.md)
 
 This guide is focused on helping someone who has never compiled software before. It makes choices and recommendations based on that viewpoint. There are alternative methods for many of these procedures, and we support most of those alternatives. If you have any doubt about how to accomplish a task you can [ask us for guidance](getting_started_getting_help.md).
+

docs/newbs_learn_more_resources.md

@@ -0,0 +1,13 @@
+# Learning Resources
+These resources are aimed at giving new members in the qmk community more understanding to the information provided in the newbs docs.
+
+Git resources:
+*
+*[Great General Tutorial](https://www.codecademy.com/learn/learn-git)
+*[Git Game To Learn From Examples](https://learngitbranching.js.org/)
+*[Git Resources to Learn More About Github](getting_started_github.md)
+*[Git Resources Aimed Specificly toward QMK](contributing.md)
+
+
+Command Line resources:
+*[Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)

drivers/avr/hd44780.c

@@ -0,0 +1,592 @@
+/****************************************************************************
+ Title:     HD44780U LCD library
+ Author:    Peter Fleury <[email protected]>  http://tinyurl.com/peterfleury
+ License:   GNU General Public License Version 3
+ File:	    $Id: lcd.c,v 1.15.2.2 2015/01/17 12:16:05 peter Exp $
+ Software:  AVR-GCC 3.3 
+ Target:    any AVR device, memory mapped mode only for AT90S4414/8515/Mega
+
+ DESCRIPTION
+       Basic routines for interfacing a HD44780U-based text lcd display
+
+       Originally based on Volker Oth's lcd library,
+       changed lcd_init(), added additional constants for lcd_command(),
+       added 4-bit I/O mode, improved and optimized code.
+
+       Library can be operated in memory mapped mode (LCD_IO_MODE=0) or in 
+       4-bit IO port mode (LCD_IO_MODE=1). 8-bit IO port mode not supported.
+       
+       Memory mapped mode compatible with Kanda STK200, but supports also
+       generation of R/W signal through A8 address line.
+
+ USAGE
+       See the C include lcd.h file for a description of each function
+       
+*****************************************************************************/
+#include <inttypes.h>
+#include <avr/io.h>
+#include <avr/pgmspace.h>
+#include <util/delay.h>
+#include "hd44780.h"
+
+/* 
+** constants/macros 
+*/
+#define DDR(x) (*(&x - 1))      /* address of data direction register of port x */
+#if defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__)
+    /* on ATmega64/128 PINF is on port 0x00 and not 0x60 */
+    #define PIN(x) ( &PORTF==&(x) ? _SFR_IO8(0x00) : (*(&x - 2)) )
+#else
+	#define PIN(x) (*(&x - 2))    /* address of input register of port x          */
+#endif
+
+
+#if LCD_IO_MODE
+#define lcd_e_delay()   _delay_us(LCD_DELAY_ENABLE_PULSE)
+#define lcd_e_high()    LCD_E_PORT  |=  _BV(LCD_E_PIN);
+#define lcd_e_low()     LCD_E_PORT  &= ~_BV(LCD_E_PIN);
+#define lcd_e_toggle()  toggle_e()
+#define lcd_rw_high()   LCD_RW_PORT |=  _BV(LCD_RW_PIN)
+#define lcd_rw_low()    LCD_RW_PORT &= ~_BV(LCD_RW_PIN)
+#define lcd_rs_high()   LCD_RS_PORT |=  _BV(LCD_RS_PIN)
+#define lcd_rs_low()    LCD_RS_PORT &= ~_BV(LCD_RS_PIN)
+#endif
+
+#if LCD_IO_MODE
+#if LCD_LINES==1
+#define LCD_FUNCTION_DEFAULT    LCD_FUNCTION_4BIT_1LINE 
+#else
+#define LCD_FUNCTION_DEFAULT    LCD_FUNCTION_4BIT_2LINES 
+#endif
+#else
+#if LCD_LINES==1
+#define LCD_FUNCTION_DEFAULT    LCD_FUNCTION_8BIT_1LINE
+#else
+#define LCD_FUNCTION_DEFAULT    LCD_FUNCTION_8BIT_2LINES
+#endif
+#endif
+
+#if LCD_CONTROLLER_KS0073
+#if LCD_LINES==4
+
+#define KS0073_EXTENDED_FUNCTION_REGISTER_ON  0x2C   /* |0|010|1100 4-bit mode, extension-bit RE = 1 */
+#define KS0073_EXTENDED_FUNCTION_REGISTER_OFF 0x28   /* |0|010|1000 4-bit mode, extension-bit RE = 0 */
+#define KS0073_4LINES_MODE                    0x09   /* |0|000|1001 4 lines mode */
+
+#endif
+#endif
+
+/* 
+** function prototypes 
+*/
+#if LCD_IO_MODE
+static void toggle_e(void);
+#endif
+
+/*
+** local functions
+*/
+
+
+/************************************************************************* 
+delay for a minimum of <us> microseconds
+the number of loops is calculated at compile-time from MCU clock frequency
+*************************************************************************/
+#define delay(us)  _delay_us(us) 
+
+
+#if LCD_IO_MODE
+/* toggle Enable Pin to initiate write */
+static void toggle_e(void)
+{
+    lcd_e_high();
+    lcd_e_delay();
+    lcd_e_low();
+}
+#endif
+
+
+/*************************************************************************
+Low-level function to write byte to LCD controller
+Input:    data   byte to write to LCD
+          rs     1: write data    
+                 0: write instruction
+Returns:  none
+*************************************************************************/
+#if LCD_IO_MODE
+static void lcd_write(uint8_t data,uint8_t rs) 
+{
+    unsigned char dataBits ;
+
+
+    if (rs) {        /* write data        (RS=1, RW=0) */
+       lcd_rs_high();
+    } else {         /* write instruction (RS=0, RW=0) */
+       lcd_rs_low();
+    }
+    lcd_rw_low();    /* RW=0  write mode      */
+
+    if ( ( &LCD_DATA0_PORT == &LCD_DATA1_PORT) && ( &LCD_DATA1_PORT == &LCD_DATA2_PORT ) && ( &LCD_DATA2_PORT == &LCD_DATA3_PORT )
+      && (LCD_DATA0_PIN == 0) && (LCD_DATA1_PIN == 1) && (LCD_DATA2_PIN == 2) && (LCD_DATA3_PIN == 3) )
+    {
+        /* configure data pins as output */
+        DDR(LCD_DATA0_PORT) |= 0x0F;
+
+        /* output high nibble first */
+        dataBits = LCD_DATA0_PORT & 0xF0;
+        LCD_DATA0_PORT = dataBits |((data>>4)&0x0F);
+        lcd_e_toggle();
+
+        /* output low nibble */
+        LCD_DATA0_PORT = dataBits | (data&0x0F);
+        lcd_e_toggle();
+
+        /* all data pins high (inactive) */
+        LCD_DATA0_PORT = dataBits | 0x0F;
+    }
+    else
+    {
+        /* configure data pins as output */
+        DDR(LCD_DATA0_PORT) |= _BV(LCD_DATA0_PIN);
+        DDR(LCD_DATA1_PORT) |= _BV(LCD_DATA1_PIN);
+        DDR(LCD_DATA2_PORT) |= _BV(LCD_DATA2_PIN);
+        DDR(LCD_DATA3_PORT) |= _BV(LCD_DATA3_PIN);
+        
+        /* output high nibble first */
+        LCD_DATA3_PORT &= ~_BV(LCD_DATA3_PIN);
+        LCD_DATA2_PORT &= ~_BV(LCD_DATA2_PIN);
+        LCD_DATA1_PORT &= ~_BV(LCD_DATA1_PIN);
+        LCD_DATA0_PORT &= ~_BV(LCD_DATA0_PIN);
+    	if(data & 0x80) LCD_DATA3_PORT |= _BV(LCD_DATA3_PIN);
+    	if(data & 0x40) LCD_DATA2_PORT |= _BV(LCD_DATA2_PIN);
+    	if(data & 0x20) LCD_DATA1_PORT |= _BV(LCD_DATA1_PIN);
+    	if(data & 0x10) LCD_DATA0_PORT |= _BV(LCD_DATA0_PIN);   
+        lcd_e_toggle();
+        
+        /* output low nibble */
+        LCD_DATA3_PORT &= ~_BV(LCD_DATA3_PIN);
+        LCD_DATA2_PORT &= ~_BV(LCD_DATA2_PIN);
+        LCD_DATA1_PORT &= ~_BV(LCD_DATA1_PIN);
+        LCD_DATA0_PORT &= ~_BV(LCD_DATA0_PIN);
+    	if(data & 0x08) LCD_DATA3_PORT |= _BV(LCD_DATA3_PIN);
+    	if(data & 0x04) LCD_DATA2_PORT |= _BV(LCD_DATA2_PIN);
+    	if(data & 0x02) LCD_DATA1_PORT |= _BV(LCD_DATA1_PIN);
+    	if(data & 0x01) LCD_DATA0_PORT |= _BV(LCD_DATA0_PIN);
+        lcd_e_toggle();        
+        
+        /* all data pins high (inactive) */
+        LCD_DATA0_PORT |= _BV(LCD_DATA0_PIN);
+        LCD_DATA1_PORT |= _BV(LCD_DATA1_PIN);
+        LCD_DATA2_PORT |= _BV(LCD_DATA2_PIN);
+        LCD_DATA3_PORT |= _BV(LCD_DATA3_PIN);
+    }
+}
+#else
+#define lcd_write(d,rs) if (rs) *(volatile uint8_t*)(LCD_IO_DATA) = d; else *(volatile uint8_t*)(LCD_IO_FUNCTION) = d;
+/* rs==0 -> write instruction to LCD_IO_FUNCTION */
+/* rs==1 -> write data to LCD_IO_DATA */
+#endif
+
+
+/*************************************************************************
+Low-level function to read byte from LCD controller
+Input:    rs     1: read data    
+                 0: read busy flag / address counter
+Returns:  byte read from LCD controller
+*************************************************************************/
+#if LCD_IO_MODE
+static uint8_t lcd_read(uint8_t rs) 
+{
+    uint8_t data;
+    
+    
+    if (rs)
+        lcd_rs_high();                       /* RS=1: read data      */
+    else
+        lcd_rs_low();                        /* RS=0: read busy flag */
+    lcd_rw_high();                           /* RW=1  read mode      */
+    
+    if ( ( &LCD_DATA0_PORT == &LCD_DATA1_PORT) && ( &LCD_DATA1_PORT == &LCD_DATA2_PORT ) && ( &LCD_DATA2_PORT == &LCD_DATA3_PORT )
+      && ( LCD_DATA0_PIN == 0 )&& (LCD_DATA1_PIN == 1) && (LCD_DATA2_PIN == 2) && (LCD_DATA3_PIN == 3) )
+    {
+        DDR(LCD_DATA0_PORT) &= 0xF0;         /* configure data pins as input */
+        
+        lcd_e_high();
+        lcd_e_delay();        
+        data = PIN(LCD_DATA0_PORT) << 4;     /* read high nibble first */
+        lcd_e_low();
+        
+        lcd_e_delay();                       /* Enable 500ns low       */
+        
+        lcd_e_high();
+        lcd_e_delay();
+        data |= PIN(LCD_DATA0_PORT)&0x0F;    /* read low nibble        */
+        lcd_e_low();
+    }
+    else
+    {
+        /* configure data pins as input */
+        DDR(LCD_DATA0_PORT) &= ~_BV(LCD_DATA0_PIN);
+        DDR(LCD_DATA1_PORT) &= ~_BV(LCD_DATA1_PIN);
+        DDR(LCD_DATA2_PORT) &= ~_BV(LCD_DATA2_PIN);
+        DDR(LCD_DATA3_PORT) &= ~_BV(LCD_DATA3_PIN);
+                
+        /* read high nibble first */
+        lcd_e_high();
+        lcd_e_delay();        
+        data = 0;
+        if ( PIN(LCD_DATA0_PORT) & _BV(LCD_DATA0_PIN) ) data |= 0x10;
+        if ( PIN(LCD_DATA1_PORT) & _BV(LCD_DATA1_PIN) ) data |= 0x20;
+        if ( PIN(LCD_DATA2_PORT) & _BV(LCD_DATA2_PIN) ) data |= 0x40;
+        if ( PIN(LCD_DATA3_PORT) & _BV(LCD_DATA3_PIN) ) data |= 0x80;
+        lcd_e_low();
+
+        lcd_e_delay();                       /* Enable 500ns low       */
+    
+        /* read low nibble */    
+        lcd_e_high();
+        lcd_e_delay();
+        if ( PIN(LCD_DATA0_PORT) & _BV(LCD_DATA0_PIN) ) data |= 0x01;
+        if ( PIN(LCD_DATA1_PORT) & _BV(LCD_DATA1_PIN) ) data |= 0x02;
+        if ( PIN(LCD_DATA2_PORT) & _BV(LCD_DATA2_PIN) ) data |= 0x04;
+        if ( PIN(LCD_DATA3_PORT) & _BV(LCD_DATA3_PIN) ) data |= 0x08;        
+        lcd_e_low();
+    }
+    return data;
+}
+#else
+#define lcd_read(rs) (rs) ? *(volatile uint8_t*)(LCD_IO_DATA+LCD_IO_READ) : *(volatile uint8_t*)(LCD_IO_FUNCTION+LCD_IO_READ)
+/* rs==0 -> read instruction from LCD_IO_FUNCTION */
+/* rs==1 -> read data from LCD_IO_DATA */
+#endif
+
+
+/*************************************************************************
+loops while lcd is busy, returns address counter
+*************************************************************************/
+static uint8_t lcd_waitbusy(void)
+
+{
+    register uint8_t c;
+    
+    /* wait until busy flag is cleared */
+    while ( (c=lcd_read(0)) & (1<<LCD_BUSY)) {}
+    
+    /* the address counter is updated 4us after the busy flag is cleared */
+    delay(LCD_DELAY_BUSY_FLAG);
+
+    /* now read the address counter */
+    return (lcd_read(0));  // return address counter
+    
+}/* lcd_waitbusy */
+
+
+/*************************************************************************
+Move cursor to the start of next line or to the first line if the cursor 
+is already on the last line.
+*************************************************************************/
+static inline void lcd_newline(uint8_t pos)
+{
+    register uint8_t addressCounter;
+
+
+#if LCD_LINES==1
+    addressCounter = 0;
+#endif
+#if LCD_LINES==2
+    if ( pos < (LCD_START_LINE2) )
+        addressCounter = LCD_START_LINE2;
+    else
+        addressCounter = LCD_START_LINE1;
+#endif
+#if LCD_LINES==4
+#if KS0073_4LINES_MODE
+    if ( pos < LCD_START_LINE2 )
+        addressCounter = LCD_START_LINE2;
+    else if ( (pos >= LCD_START_LINE2) && (pos < LCD_START_LINE3) )
+        addressCounter = LCD_START_LINE3;
+    else if ( (pos >= LCD_START_LINE3) && (pos < LCD_START_LINE4) )
+        addressCounter = LCD_START_LINE4;
+    else 
+        addressCounter = LCD_START_LINE1;
+#else
+    if ( pos < LCD_START_LINE3 )
+        addressCounter = LCD_START_LINE2;
+    else if ( (pos >= LCD_START_LINE2) && (pos < LCD_START_LINE4) )
+        addressCounter = LCD_START_LINE3;
+    else if ( (pos >= LCD_START_LINE3) && (pos < LCD_START_LINE2) )
+        addressCounter = LCD_START_LINE4;
+    else 
+        addressCounter = LCD_START_LINE1;
+#endif
+#endif
+    lcd_command((1<<LCD_DDRAM)+addressCounter);
+
+}/* lcd_newline */
+
+
+/*
+** PUBLIC FUNCTIONS 
+*/
+
+/*************************************************************************
+Send LCD controller instruction command
+Input:   instruction to send to LCD controller, see HD44780 data sheet
+Returns: none
+*************************************************************************/
+void lcd_command(uint8_t cmd)
+{
+    lcd_waitbusy();
+    lcd_write(cmd,0);
+}
+
+
+/*************************************************************************
+Send data byte to LCD controller 
+Input:   data to send to LCD controller, see HD44780 data sheet
+Returns: none
+*************************************************************************/
+void lcd_data(uint8_t data)
+{
+    lcd_waitbusy();
+    lcd_write(data,1);
+}
+
+
+
+/*************************************************************************
+Set cursor to specified position
+Input:    x  horizontal position  (0: left most position)
+          y  vertical position    (0: first line)
+Returns:  none
+*************************************************************************/
+void lcd_gotoxy(uint8_t x, uint8_t y)
+{
+#if LCD_LINES==1
+    lcd_command((1<<LCD_DDRAM)+LCD_START_LINE1+x);
+#endif
+#if LCD_LINES==2
+    if ( y==0 ) 
+        lcd_command((1<<LCD_DDRAM)+LCD_START_LINE1+x);
+    else
+        lcd_command((1<<LCD_DDRAM)+LCD_START_LINE2+x);
+#endif
+#if LCD_LINES==4
+    if ( y==0 )
+        lcd_command((1<<LCD_DDRAM)+LCD_START_LINE1+x);
+    else if ( y==1)
+        lcd_command((1<<LCD_DDRAM)+LCD_START_LINE2+x);
+    else if ( y==2)
+        lcd_command((1<<LCD_DDRAM)+LCD_START_LINE3+x);
+    else /* y==3 */
+        lcd_command((1<<LCD_DDRAM)+LCD_START_LINE4+x);
+#endif
+
+}/* lcd_gotoxy */
+
+
+/*************************************************************************
+*************************************************************************/
+int lcd_getxy(void)
+{
+    return lcd_waitbusy();
+}
+
+
+/*************************************************************************
+Clear display and set cursor to home position
+*************************************************************************/
+void lcd_clrscr(void)
+{
+    lcd_command(1<<LCD_CLR);
+}
+
+
+/*************************************************************************
+Set cursor to home position
+*************************************************************************/
+void lcd_home(void)
+{
+    lcd_command(1<<LCD_HOME);
+}
+
+
+/*************************************************************************
+Display character at current cursor position 
+Input:    character to be displayed                                       
+Returns:  none
+*************************************************************************/
+void lcd_putc(char c)
+{
+    uint8_t pos;
+
+
+    pos = lcd_waitbusy();   // read busy-flag and address counter
+    if (c=='\n')
+    {
+        lcd_newline(pos);
+    }
+    else
+    {
+#if LCD_WRAP_LINES==1
+#if LCD_LINES==1
+        if ( pos == LCD_START_LINE1+LCD_DISP_LENGTH ) {
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE1,0);
+        }
+#elif LCD_LINES==2
+        if ( pos == LCD_START_LINE1+LCD_DISP_LENGTH ) {
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE2,0);    
+        }else if ( pos == LCD_START_LINE2+LCD_DISP_LENGTH ){
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE1,0);
+        }
+#elif LCD_LINES==4
+        if ( pos == LCD_START_LINE1+LCD_DISP_LENGTH ) {
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE2,0);    
+        }else if ( pos == LCD_START_LINE2+LCD_DISP_LENGTH ) {
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE3,0);
+        }else if ( pos == LCD_START_LINE3+LCD_DISP_LENGTH ) {
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE4,0);
+        }else if ( pos == LCD_START_LINE4+LCD_DISP_LENGTH ) {
+            lcd_write((1<<LCD_DDRAM)+LCD_START_LINE1,0);
+        }
+#endif
+        lcd_waitbusy();
+#endif
+        lcd_write(c, 1);
+    }
+
+}/* lcd_putc */
+
+
+/*************************************************************************
+Display string without auto linefeed 
+Input:    string to be displayed
+Returns:  none
+*************************************************************************/
+void lcd_puts(const char *s)
+/* print string on lcd (no auto linefeed) */
+{
+    register char c;
+
+    while ( (c = *s++) ) {
+        lcd_putc(c);
+    }
+
+}/* lcd_puts */
+
+
+/*************************************************************************
+Display string from program memory without auto linefeed 
+Input:     string from program memory be be displayed                                        
+Returns:   none
+*************************************************************************/
+void lcd_puts_p(const char *progmem_s)
+/* print string from program memory on lcd (no auto linefeed) */
+{
+    register char c;
+
+    while ( (c = pgm_read_byte(progmem_s++)) ) {
+        lcd_putc(c);
+    }
+
+}/* lcd_puts_p */
+
+
+/*************************************************************************
+Initialize display and select type of cursor 
+Input:    dispAttr LCD_DISP_OFF            display off
+                   LCD_DISP_ON             display on, cursor off
+                   LCD_DISP_ON_CURSOR      display on, cursor on
+                   LCD_DISP_CURSOR_BLINK   display on, cursor on flashing
+Returns:  none
+*************************************************************************/
+void lcd_init(uint8_t dispAttr)
+{
+#if LCD_IO_MODE
+    /*
+     *  Initialize LCD to 4 bit I/O mode
+     */
+     
+    if ( ( &LCD_DATA0_PORT == &LCD_DATA1_PORT) && ( &LCD_DATA1_PORT == &LCD_DATA2_PORT ) && ( &LCD_DATA2_PORT == &LCD_DATA3_PORT )
+      && ( &LCD_RS_PORT == &LCD_DATA0_PORT) && ( &LCD_RW_PORT == &LCD_DATA0_PORT) && (&LCD_E_PORT == &LCD_DATA0_PORT)
+      && (LCD_DATA0_PIN == 0 ) && (LCD_DATA1_PIN == 1) && (LCD_DATA2_PIN == 2) && (LCD_DATA3_PIN == 3) 
+      && (LCD_RS_PIN == 4 ) && (LCD_RW_PIN == 5) && (LCD_E_PIN == 6 ) )
+    {
+        /* configure all port bits as output (all LCD lines on same port) */
+        DDR(LCD_DATA0_PORT) |= 0x7F;
+    }
+    else if ( ( &LCD_DATA0_PORT == &LCD_DATA1_PORT) && ( &LCD_DATA1_PORT == &LCD_DATA2_PORT ) && ( &LCD_DATA2_PORT == &LCD_DATA3_PORT )
+           && (LCD_DATA0_PIN == 0 ) && (LCD_DATA1_PIN == 1) && (LCD_DATA2_PIN == 2) && (LCD_DATA3_PIN == 3) )
+    {
+        /* configure all port bits as output (all LCD data lines on same port, but control lines on different ports) */
+        DDR(LCD_DATA0_PORT) |= 0x0F;
+        DDR(LCD_RS_PORT)    |= _BV(LCD_RS_PIN);
+        DDR(LCD_RW_PORT)    |= _BV(LCD_RW_PIN);
+        DDR(LCD_E_PORT)     |= _BV(LCD_E_PIN);
+    }
+    else
+    {
+        /* configure all port bits as output (LCD data and control lines on different ports */
+        DDR(LCD_RS_PORT)    |= _BV(LCD_RS_PIN);
+        DDR(LCD_RW_PORT)    |= _BV(LCD_RW_PIN);
+        DDR(LCD_E_PORT)     |= _BV(LCD_E_PIN);
+        DDR(LCD_DATA0_PORT) |= _BV(LCD_DATA0_PIN);
+        DDR(LCD_DATA1_PORT) |= _BV(LCD_DATA1_PIN);
+        DDR(LCD_DATA2_PORT) |= _BV(LCD_DATA2_PIN);
+        DDR(LCD_DATA3_PORT) |= _BV(LCD_DATA3_PIN);
+    }
+    delay(LCD_DELAY_BOOTUP);             /* wait 16ms or more after power-on       */
+    
+    /* initial write to lcd is 8bit */
+    LCD_DATA1_PORT |= _BV(LCD_DATA1_PIN);    // LCD_FUNCTION>>4;
+    LCD_DATA0_PORT |= _BV(LCD_DATA0_PIN);    // LCD_FUNCTION_8BIT>>4;
+    lcd_e_toggle();
+    delay(LCD_DELAY_INIT);               /* delay, busy flag can't be checked here */
+   
+    /* repeat last command */ 
+    lcd_e_toggle();      
+    delay(LCD_DELAY_INIT_REP);           /* delay, busy flag can't be checked here */
+    
+    /* repeat last command a third time */
+    lcd_e_toggle();      
+    delay(LCD_DELAY_INIT_REP);           /* delay, busy flag can't be checked here */
+
+    /* now configure for 4bit mode */
+    LCD_DATA0_PORT &= ~_BV(LCD_DATA0_PIN);   // LCD_FUNCTION_4BIT_1LINE>>4
+    lcd_e_toggle();
+    delay(LCD_DELAY_INIT_4BIT);          /* some displays need this additional delay */
+    
+    /* from now the LCD only accepts 4 bit I/O, we can use lcd_command() */    
+#else
+    /*
+     * Initialize LCD to 8 bit memory mapped mode
+     */
+    
+    /* enable external SRAM (memory mapped lcd) and one wait state */        
+    MCUCR = _BV(SRE) | _BV(SRW);
+
+    /* reset LCD */
+    delay(LCD_DELAY_BOOTUP);                    /* wait 16ms after power-on     */
+    lcd_write(LCD_FUNCTION_8BIT_1LINE,0);   /* function set: 8bit interface */                   
+    delay(LCD_DELAY_INIT);                      /* wait 5ms                     */
+    lcd_write(LCD_FUNCTION_8BIT_1LINE,0);   /* function set: 8bit interface */                 
+    delay(LCD_DELAY_INIT_REP);                  /* wait 64us                    */
+    lcd_write(LCD_FUNCTION_8BIT_1LINE,0);   /* function set: 8bit interface */                
+    delay(LCD_DELAY_INIT_REP);                  /* wait 64us                    */
+#endif
+
+#if KS0073_4LINES_MODE
+    /* Display with KS0073 controller requires special commands for enabling 4 line mode */
+	lcd_command(KS0073_EXTENDED_FUNCTION_REGISTER_ON);
+	lcd_command(KS0073_4LINES_MODE);
+	lcd_command(KS0073_EXTENDED_FUNCTION_REGISTER_OFF);
+#else
+    lcd_command(LCD_FUNCTION_DEFAULT);      /* function set: display lines  */
+#endif
+    lcd_command(LCD_DISP_OFF);              /* display off                  */
+    lcd_clrscr();                           /* display clear                */ 
+    lcd_command(LCD_MODE_DEFAULT);          /* set entry mode               */
+    lcd_command(dispAttr);                  /* display/cursor control       */
+
+}/* lcd_init */
+

drivers/avr/hd44780.h

@@ -0,0 +1,371 @@
+#ifndef LCD_H
+#define LCD_H
+/*************************************************************************
+ Title	:   C include file for the HD44780U LCD library (lcd.c)
+ Author:    Peter Fleury <[email protected]>  http://tinyurl.com/peterfleury
+ License:   GNU General Public License Version 3
+ File:	    $Id: lcd.h,v 1.14.2.4 2015/01/20 17:16:07 peter Exp $
+ Software:  AVR-GCC 4.x
+ Hardware:  any AVR device, memory mapped mode only for AVR with 
+            memory mapped interface (AT90S8515/ATmega8515/ATmega128)
+***************************************************************************/
+
+/**
+ @mainpage
+ Collection of libraries for AVR-GCC
+ @author Peter Fleury [email protected] http://tinyurl.com/peterfleury
+ @copyright (C) 2015 Peter Fleury, GNU General Public License Version 3
+ 
+ @file
+ @defgroup pfleury_lcd LCD library <lcd.h>
+ @code #include <lcd.h> @endcode
+ 
+ @brief Basic routines for interfacing a HD44780U-based character LCD display
+
+ LCD character displays can be found in many devices, like espresso machines, laser printers. 
+ The Hitachi HD44780 controller and its compatible controllers like Samsung KS0066U have become an industry standard for these types of displays. 
+ 
+ This library allows easy interfacing with a HD44780 compatible display and can be
+ operated in memory mapped mode (LCD_IO_MODE defined as 0 in the include file lcd.h.) or in 
+ 4-bit IO port mode (LCD_IO_MODE defined as 1). 8-bit IO port mode is not supported.
+
+ Memory mapped mode is compatible with old Kanda STK200 starter kit, but also supports
+ generation of R/W signal through A8 address line.
+
+ @see The chapter <a href=" http://homepage.hispeed.ch/peterfleury/avr-lcd44780.html" target="_blank">Interfacing a HD44780 Based LCD to an AVR</a>
+      on my home page, which shows example circuits how to connect an LCD to an AVR controller. 
+
+ @author Peter Fleury [email protected] http://tinyurl.com/peterfleury
+ 
+ @version   2.0
+ 
+ @copyright (C) 2015 Peter Fleury, GNU General Public License Version 3
+  
+*/
+
+#include <inttypes.h>
+#include <avr/pgmspace.h>
+
+#if (__GNUC__ * 100 + __GNUC_MINOR__) < 405
+#error "This library requires AVR-GCC 4.5 or later, update to newer AVR-GCC compiler !"
+#endif
+
+
+/**@{*/
+
+/*
+ * LCD and target specific definitions below can be defined in a separate include file with name lcd_definitions.h instead modifying this file 
+ * by adding -D_LCD_DEFINITIONS_FILE to the CDEFS section in the Makefile
+ * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
+ */
+#ifdef _LCD_DEFINITIONS_FILE
+#include "lcd_definitions.h"
+#endif
+
+
+/**
+ * @name  Definition for LCD controller type
+ * Use 0 for HD44780 controller, change to 1 for displays with KS0073 controller.
+ */
+#ifndef LCD_CONTROLLER_KS0073 
+#define LCD_CONTROLLER_KS0073 0  /**< Use 0 for HD44780 controller, 1 for KS0073 controller */
+#endif
+
+/** 
+ * @name  Definitions for Display Size 
+ * Change these definitions to adapt setting to your display
+ *
+ * These definitions can be defined in a separate include file \b lcd_definitions.h instead modifying this file by 
+ * adding -D_LCD_DEFINITIONS_FILE to the CDEFS section in the Makefile.
+ * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
+ *
+ */
+#ifndef LCD_LINES
+#define LCD_LINES           2     /**< number of visible lines of the display */
+#endif
+#ifndef LCD_DISP_LENGTH
+#define LCD_DISP_LENGTH    16     /**< visibles characters per line of the display */
+#endif
+#ifndef LCD_LINE_LENGTH
+#define LCD_LINE_LENGTH  0x40     /**< internal line length of the display    */
+#endif
+#ifndef LCD_START_LINE1
+#define LCD_START_LINE1  0x00     /**< DDRAM address of first char of line 1 */
+#endif
+#ifndef LCD_START_LINE2
+#define LCD_START_LINE2  0x40     /**< DDRAM address of first char of line 2 */
+#endif
+#ifndef LCD_START_LINE3
+#define LCD_START_LINE3  0x14     /**< DDRAM address of first char of line 3 */
+#endif
+#ifndef LCD_START_LINE4
+#define LCD_START_LINE4  0x54     /**< DDRAM address of first char of line 4 */
+#endif
+#ifndef LCD_WRAP_LINES
+#define LCD_WRAP_LINES      0     /**< 0: no wrap, 1: wrap at end of visibile line */
+#endif
+
+
+/**
+ * @name Definitions for 4-bit IO mode
+ *
+ * The four LCD data lines and the three control lines RS, RW, E can be on the 
+ * same port or on different ports. 
+ * Change LCD_RS_PORT, LCD_RW_PORT, LCD_E_PORT if you want the control lines on
+ * different ports. 
+ *
+ * Normally the four data lines should be mapped to bit 0..3 on one port, but it
+ * is possible to connect these data lines in different order or even on different
+ * ports by adapting the LCD_DATAx_PORT and LCD_DATAx_PIN definitions.
+ *
+ * Adjust these definitions to your target.\n 
+ * These definitions can be defined in a separate include file \b lcd_definitions.h instead modifying this file by 
+ * adding \b -D_LCD_DEFINITIONS_FILE to the \b CDEFS section in the Makefile.
+ * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
+ *  
+ */
+#define LCD_IO_MODE      1            /**< 0: memory mapped mode, 1: IO port mode */
+
+#if LCD_IO_MODE
+
+#ifndef LCD_PORT
+#define LCD_PORT         PORTA        /**< port for the LCD lines   */
+#endif
+#ifndef LCD_DATA0_PORT
+#define LCD_DATA0_PORT   LCD_PORT     /**< port for 4bit data bit 0 */
+#endif
+#ifndef LCD_DATA1_PORT
+#define LCD_DATA1_PORT   LCD_PORT     /**< port for 4bit data bit 1 */
+#endif
+#ifndef LCD_DATA2_PORT
+#define LCD_DATA2_PORT   LCD_PORT     /**< port for 4bit data bit 2 */
+#endif
+#ifndef LCD_DATA3_PORT
+#define LCD_DATA3_PORT   LCD_PORT     /**< port for 4bit data bit 3 */
+#endif
+#ifndef LCD_DATA0_PIN
+#define LCD_DATA0_PIN    4            /**< pin for 4bit data bit 0  */
+#endif
+#ifndef LCD_DATA1_PIN
+#define LCD_DATA1_PIN    5            /**< pin for 4bit data bit 1  */
+#endif
+#ifndef LCD_DATA2_PIN
+#define LCD_DATA2_PIN    6            /**< pin for 4bit data bit 2  */
+#endif
+#ifndef LCD_DATA3_PIN
+#define LCD_DATA3_PIN    7            /**< pin for 4bit data bit 3  */
+#endif
+#ifndef LCD_RS_PORT
+#define LCD_RS_PORT      LCD_PORT     /**< port for RS line         */
+#endif
+#ifndef LCD_RS_PIN
+#define LCD_RS_PIN       3            /**< pin  for RS line         */
+#endif
+#ifndef LCD_RW_PORT
+#define LCD_RW_PORT      LCD_PORT     /**< port for RW line         */
+#endif
+#ifndef LCD_RW_PIN
+#define LCD_RW_PIN       2            /**< pin  for RW line         */
+#endif
+#ifndef LCD_E_PORT
+#define LCD_E_PORT       LCD_PORT     /**< port for Enable line     */
+#endif
+#ifndef LCD_E_PIN
+#define LCD_E_PIN        1            /**< pin  for Enable line     */
+#endif
+
+#elif defined(__AVR_AT90S4414__) || defined(__AVR_AT90S8515__) || defined(__AVR_ATmega64__) || \
+      defined(__AVR_ATmega8515__)|| defined(__AVR_ATmega103__) || defined(__AVR_ATmega128__) || \
+      defined(__AVR_ATmega161__) || defined(__AVR_ATmega162__)
+/*
+ * memory mapped mode is only supported when the device has an external data memory interface
+ */
+#define LCD_IO_DATA      0xC000    /* A15=E=1, A14=RS=1                 */
+#define LCD_IO_FUNCTION  0x8000    /* A15=E=1, A14=RS=0                 */
+#define LCD_IO_READ      0x0100    /* A8 =R/W=1 (R/W: 1=Read, 0=Write   */
+
+#else
+#error "external data memory interface not available for this device, use 4-bit IO port mode"
+
+#endif
+
+
+/**
+ * @name Definitions of delays
+ * Used to calculate delay timers.
+ * Adapt the F_CPU define in the Makefile to the clock frequency in Hz of your target
+ *
+ * These delay times can be adjusted, if some displays require different delays.\n 
+ * These definitions can be defined in a separate include file \b lcd_definitions.h instead modifying this file by 
+ * adding \b -D_LCD_DEFINITIONS_FILE to the \b CDEFS section in the Makefile.
+ * All definitions added to the file lcd_definitions.h will override the default definitions from lcd.h
+ */
+#ifndef LCD_DELAY_BOOTUP
+#define LCD_DELAY_BOOTUP   16000      /**< delay in micro seconds after power-on  */
+#endif
+#ifndef LCD_DELAY_INIT
+#define LCD_DELAY_INIT      5000      /**< delay in micro seconds after initialization command sent  */
+#endif
+#ifndef LCD_DELAY_INIT_REP
+#define LCD_DELAY_INIT_REP    64      /**< delay in micro seconds after initialization command repeated */
+#endif
+#ifndef LCD_DELAY_INIT_4BIT
+#define LCD_DELAY_INIT_4BIT   64      /**< delay in micro seconds after setting 4-bit mode */ 
+#endif
+#ifndef LCD_DELAY_BUSY_FLAG
+#define LCD_DELAY_BUSY_FLAG    4      /**< time in micro seconds the address counter is updated after busy flag is cleared */
+#endif
+#ifndef LCD_DELAY_ENABLE_PULSE
+#define LCD_DELAY_ENABLE_PULSE 1      /**< enable signal pulse width in micro seconds */
+#endif
+
+
+/**
+ * @name Definitions for LCD command instructions
+ * The constants define the various LCD controller instructions which can be passed to the 
+ * function lcd_command(), see HD44780 data sheet for a complete description.
+ */
+
+/* instruction register bit positions, see HD44780U data sheet */
+#define LCD_CLR               0      /* DB0: clear display                  */
+#define LCD_HOME              1      /* DB1: return to home position        */
+#define LCD_ENTRY_MODE        2      /* DB2: set entry mode                 */
+#define LCD_ENTRY_INC         1      /*   DB1: 1=increment, 0=decrement     */
+#define LCD_ENTRY_SHIFT       0      /*   DB2: 1=display shift on           */
+#define LCD_ON                3      /* DB3: turn lcd/cursor on             */
+#define LCD_ON_DISPLAY        2      /*   DB2: turn display on              */
+#define LCD_ON_CURSOR         1      /*   DB1: turn cursor on               */
+#define LCD_ON_BLINK          0      /*     DB0: blinking cursor ?          */
+#define LCD_MOVE              4      /* DB4: move cursor/display            */
+#define LCD_MOVE_DISP         3      /*   DB3: move display (0-> cursor) ?  */
+#define LCD_MOVE_RIGHT        2      /*   DB2: move right (0-> left) ?      */
+#define LCD_FUNCTION          5      /* DB5: function set                   */
+#define LCD_FUNCTION_8BIT     4      /*   DB4: set 8BIT mode (0->4BIT mode) */
+#define LCD_FUNCTION_2LINES   3      /*   DB3: two lines (0->one line)      */
+#define LCD_FUNCTION_10DOTS   2      /*   DB2: 5x10 font (0->5x7 font)      */
+#define LCD_CGRAM             6      /* DB6: set CG RAM address             */
+#define LCD_DDRAM             7      /* DB7: set DD RAM address             */
+#define LCD_BUSY              7      /* DB7: LCD is busy                    */
+
+/* set entry mode: display shift on/off, dec/inc cursor move direction */
+#define LCD_ENTRY_DEC            0x04   /* display shift off, dec cursor move dir */
+#define LCD_ENTRY_DEC_SHIFT      0x05   /* display shift on,  dec cursor move dir */
+#define LCD_ENTRY_INC_           0x06   /* display shift off, inc cursor move dir */
+#define LCD_ENTRY_INC_SHIFT      0x07   /* display shift on,  inc cursor move dir */
+
+/* display on/off, cursor on/off, blinking char at cursor position */
+#define LCD_DISP_OFF             0x08   /* display off                            */
+#define LCD_DISP_ON              0x0C   /* display on, cursor off                 */
+#define LCD_DISP_ON_BLINK        0x0D   /* display on, cursor off, blink char     */
+#define LCD_DISP_ON_CURSOR       0x0E   /* display on, cursor on                  */
+#define LCD_DISP_ON_CURSOR_BLINK 0x0F   /* display on, cursor on, blink char      */
+
+/* move cursor/shift display */
+#define LCD_MOVE_CURSOR_LEFT     0x10   /* move cursor left  (decrement)          */
+#define LCD_MOVE_CURSOR_RIGHT    0x14   /* move cursor right (increment)          */
+#define LCD_MOVE_DISP_LEFT       0x18   /* shift display left                     */
+#define LCD_MOVE_DISP_RIGHT      0x1C   /* shift display right                    */
+
+/* function set: set interface data length and number of display lines */
+#define LCD_FUNCTION_4BIT_1LINE  0x20   /* 4-bit interface, single line, 5x7 dots */
+#define LCD_FUNCTION_4BIT_2LINES 0x28   /* 4-bit interface, dual line,   5x7 dots */
+#define LCD_FUNCTION_8BIT_1LINE  0x30   /* 8-bit interface, single line, 5x7 dots */
+#define LCD_FUNCTION_8BIT_2LINES 0x38   /* 8-bit interface, dual line,   5x7 dots */
+
+
+#define LCD_MODE_DEFAULT     ((1<<LCD_ENTRY_MODE) | (1<<LCD_ENTRY_INC) )
+
+
+
+/** 
+ *  @name Functions
+ */
+
+
+/**
+ @brief    Initialize display and select type of cursor
+ @param    dispAttr \b LCD_DISP_OFF display off\n
+                    \b LCD_DISP_ON display on, cursor off\n
+                    \b LCD_DISP_ON_CURSOR display on, cursor on\n
+                    \b LCD_DISP_ON_CURSOR_BLINK display on, cursor on flashing             
+ @return  none
+*/
+extern void lcd_init(uint8_t dispAttr);
+
+
+/**
+ @brief    Clear display and set cursor to home position
+ @return   none
+*/
+extern void lcd_clrscr(void);
+
+
+/**
+ @brief    Set cursor to home position
+ @return   none
+*/
+extern void lcd_home(void);
+
+
+/**
+ @brief    Set cursor to specified position
+ 
+ @param    x horizontal position\n (0: left most position)
+ @param    y vertical position\n   (0: first line)
+ @return   none
+*/
+extern void lcd_gotoxy(uint8_t x, uint8_t y);
+
+
+/**
+ @brief    Display character at current cursor position
+ @param    c character to be displayed                                       
+ @return   none
+*/
+extern void lcd_putc(char c);
+
+
+/**
+ @brief    Display string without auto linefeed
+ @param    s string to be displayed                                        
+ @return   none
+*/
+extern void lcd_puts(const char *s);
+
+
+/**
+ @brief    Display string from program memory without auto linefeed
+ @param    progmem_s string from program memory be be displayed                                        
+ @return   none
+ @see      lcd_puts_P
+*/
+extern void lcd_puts_p(const char *progmem_s);
+
+
+/**
+ @brief    Send LCD controller instruction command
+ @param    cmd instruction to send to LCD controller, see HD44780 data sheet
+ @return   none
+*/
+extern void lcd_command(uint8_t cmd);
+
+
+/**
+ @brief    Send data byte to LCD controller 
+ 
+ Similar to lcd_putc(), but without interpreting LF
+ @param    data byte to send to LCD controller, see HD44780 data sheet
+ @return   none
+*/
+extern void lcd_data(uint8_t data);
+
+
+/**
+ @brief macros for automatically storing string constant in program memory
+*/
+#define lcd_puts_P(__s)         lcd_puts_p(PSTR(__s))
+
+/**@}*/
+
+#endif //LCD_H
+

drivers/avr/i2c_slave.c

@@ -0,0 +1,100 @@
+/* Library made by: g4lvanix
+ * Github repository: https://github.com/g4lvanix/I2C-slave-lib
+ */
+
+#include <avr/io.h>
+#include <util/twi.h>
+#include <avr/interrupt.h>
+
+#include "i2c_slave.h"
+
+void i2c_init(uint8_t address){
+	// load address into TWI address register
+	TWAR = (address << 1);
+	// set the TWCR to enable address matching and enable TWI, clear TWINT, enable TWI interrupt
+	TWCR = (1<<TWIE) | (1<<TWEA) | (1<<TWINT) | (1<<TWEN);
+}
+
+void i2c_stop(void){
+	// clear acknowledge and enable bits
+	TWCR &= ~( (1<<TWEA) | (1<<TWEN) );
+}
+
+ISR(TWI_vect){
+	
+	// temporary stores the received data
+	uint8_t data;
+	
+	// own address has been acknowledged
+	if( (TWSR & 0xF8) == TW_SR_SLA_ACK ){  
+		buffer_address = 0xFF;
+		// clear TWI interrupt flag, prepare to receive next byte and acknowledge
+		TWCR |= (1<<TWIE) | (1<<TWINT) | (1<<TWEA) | (1<<TWEN); 
+	}
+	else if( (TWSR & 0xF8) == TW_SR_DATA_ACK ){ // data has been received in slave receiver mode
+		
+		// save the received byte inside data 
+		data = TWDR;
+		
+		// check wether an address has already been transmitted or not
+		if(buffer_address == 0xFF){
+			
+			buffer_address = data; 
+			
+			// clear TWI interrupt flag, prepare to receive next byte and acknowledge
+			TWCR |= (1<<TWIE) | (1<<TWINT) | (1<<TWEA) | (1<<TWEN); 
+		}
+		else{ // if a databyte has already been received
+			
+			// store the data at the current address
+			rxbuffer[buffer_address] = data;
+			
+			// increment the buffer address
+			buffer_address++;
+			
+			// if there is still enough space inside the buffer
+			if(buffer_address < 0xFF){
+				// clear TWI interrupt flag, prepare to receive next byte and acknowledge
+				TWCR |= (1<<TWIE) | (1<<TWINT) | (1<<TWEA) | (1<<TWEN); 
+			}
+			else{
+				// Don't acknowledge
+				TWCR &= ~(1<<TWEA); 
+				// clear TWI interrupt flag, prepare to receive last byte.
+				TWCR |= (1<<TWIE) | (1<<TWINT) | (1<<TWEN); 
+			}
+		}
+	}
+	else if( (TWSR & 0xF8) == TW_ST_DATA_ACK ){ // device has been addressed to be a transmitter
+		
+		// copy data from TWDR to the temporary memory
+		data = TWDR;
+		
+		// if no buffer read address has been sent yet
+		if( buffer_address == 0xFF ){
+			buffer_address = data;
+		}
+		
+		// copy the specified buffer address into the TWDR register for transmission
+		TWDR = txbuffer[buffer_address];
+		// increment buffer read address
+		buffer_address++;
+		
+		// if there is another buffer address that can be sent
+		if(buffer_address < 0xFF){
+			// clear TWI interrupt flag, prepare to send next byte and receive acknowledge
+			TWCR |= (1<<TWIE) | (1<<TWINT) | (1<<TWEA) | (1<<TWEN); 
+		}
+		else{
+			// Don't acknowledge
+			TWCR &= ~(1<<TWEA); 
+			// clear TWI interrupt flag, prepare to receive last byte.
+			TWCR |= (1<<TWIE) | (1<<TWINT) | (1<<TWEN); 
+		}
+		
+	}
+	else{
+		// if none of the above apply prepare TWI to be addressed again
+		TWCR |= (1<<TWIE) | (1<<TWEA) | (1<<TWEN);
+	} 
+}

drivers/avr/i2c_slave.h

@@ -0,0 +1,19 @@
+/* Library made by: g4lvanix
+ * Github repository: https://github.com/g4lvanix/I2C-slave-lib
+
+ Info: Inititate the library by giving the required address.
+       Read or write to the necessary buffer according to the opperation.
+ */
+
+#ifndef I2C_SLAVE_H
+#define I2C_SLAVE_H
+
+volatile uint8_t buffer_address;
+volatile uint8_t txbuffer[0xFF];
+volatile uint8_t rxbuffer[0xFF];
+
+void i2c_init(uint8_t address);
+void i2c_stop(void);
+ISR(TWI_vect);
+
+#endif // I2C_SLAVE_H

keyboards/al1/al1.c

@@ -15,14 +15,6 @@
  */
 #include "al1.h"
 
-void matrix_init_kb(void) {
-	matrix_init_user();
-}
-
-void matrix_scan_kb(void) {
-    matrix_scan_user();
-}
-
 bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
 	return process_record_user(keycode, record);
 }

keyboards/al1/keymaps/splitbs/keymap.c

@@ -1,4 +1,4 @@
-#include "al1.h"
+#include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	[0] = LAYOUT_split_bs(\

keyboards/al1/matrix.c

@@ -28,6 +28,23 @@ inline uint8_t matrix_cols(void) {
   return MATRIX_COLS;
 }
 
+__attribute__ ((weak))
+void matrix_init_kb(void) {
+	matrix_init_user();
+}
+
+__attribute__ ((weak))
+void matrix_scan_kb(void) {
+    matrix_scan_user();
+}
+
+__attribute__ ((weak))
+void matrix_init_user(void) {
+}
+
+__attribute__ ((weak))
+void matrix_scan_user(void) {
+}
 
 void matrix_init(void) {
   // initialize row and col

keyboards/bfo9000/keymaps/andylikescandy6x18/config.h

@@ -0,0 +1,43 @@
+/*
+This is the c configuration file for the keymap
+
+Copyright 2012 Jun Wako <[email protected]>
+Copyright 2015 Jack Humbert
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.h"
+
+/* Use I2C or Serial, not both */
+
+#define USE_SERIAL
+// #define USE_I2C
+
+/* Select hand configuration */
+
+#define MASTER_LEFT
+// #define MASTER_RIGHT
+// #define EE_HANDS
+
+
+ #define PERMISSIVE_HOLD
+
+ #define PREVENT_STUCK_MODIFIERS
+
+
+#endif

keyboards/bfo9000/keymaps/andylikescandy6x18/keymap.c

@@ -0,0 +1,64 @@
+#include QMK_KEYBOARD_H
+
+#include "action_layer.h"
+
+
+
+#define _BASE 0
+#define _RAISE 1
+#define _NAVIGATION 3
+
+
+// Fillers to make layering more clear
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+
+// layer access
+#define RSESPC LT( 1, KC_SPC)
+#define NAVSPC LT( 3, KC_SPC)
+
+// Key Combos
+#define CTRLSFT LCTL(KC_LSFT)
+#define CTLALTSFT LALT(LCTL(KC_LSFT))
+#define CTLALTDEL LALT(LCTL(KC_DEL))
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+
+
+
+
+
+[_BASE] = LAYOUT( \
+    KC_KP_SLASH,  KC_KP_ASTERISK,   KC_PMNS,  KC_PPLS,    KC_PSCREEN,       KC_CAPS,    KC_F1,    KC_F2,    KC_F3,   KC_F4,    KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,       KC_F10,         KC_F11,         KC_F12,   \
+    KC_P7,        KC_P8,            KC_P9,    KC_LBRC,    KC_RBRC,          KC_GRV,     KC_1,     KC_2,     KC_3,    KC_4,     KC_5,    KC_6,    KC_7,    KC_8,    KC_9,        KC_0,           KC_MINS,        KC_EQL,   \
+    KC_P4,        KC_P5,            KC_P6,    KC_HOME,    KC_END,           KC_TAB,     KC_Q,     KC_W,     KC_F,    KC_P,     KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,        KC_SCLN,        KC_BSPC,        KC_BSLS,  \
+    KC_P1,        KC_P2,            KC_P3,    KC_SLCK,    KC_PGUP,          KC_ESC,     KC_A,     KC_R,     KC_S,    KC_T,     KC_D,    KC_H,    KC_N,    KC_E,    KC_I,        KC_O,           KC_QUOT,        KC_ENT,   \
+    KC_P0,        KC_PDOT,          KC_PENT,  KC_UP,      KC_PGDN,          KC_LSFT,    KC_Z,     KC_X,     KC_C,    KC_V,     KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,      KC_SLSH,        SFT_T(KC_ENT),  KC_PGUP,    \
+    CTLALTDEL,    KC_LCTL,          KC_LEFT,  KC_DOWN,    KC_RGHT,          KC_LCTL,    CTRLSFT,  KC_LGUI,  KC_LALT,  RSESPC,   NAVSPC,  NAVSPC,  RSESPC,  KC_RGUI, KC_RALT,    KC_APPLICATION, KC_RCTL,        KC_PGDN \
+),
+[_RAISE] = LAYOUT( \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    KC_PAUSE,       KC_NUMLOCK, XXXXXXX,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    _______,    _______,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        _______,    KC_EXLM,      KC_AT,      KC_HASH,    KC_DLR,         KC_PERC,    KC_CIRC,    KC_AMPR,    KC_ASTR,    KC_LPRN,        KC_RPRN,    _______,    XXXXXXX,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,        KC_DEL,     KC_1,         KC_2,       KC_3,       KC_4,           KC_5,       KC_6,       KC_7,       KC_8,       KC_9,           KC_0,       _______,    _______,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,        _______,    XXXXXXX,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,    _______,        _______,    _______,    XXXXXXX,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,    _______,        _______,    _______,      _______,    _______,    _______,        XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,        XXXXXXX,    _______,    XXXXXXX    \
+),
+[_NAVIGATION] = LAYOUT( \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    KC_PAUSE,       KC_NUMLOCK, XXXXXXX,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    _______,    _______,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,        _______,    XXXXXXX,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    KC_HOME,    KC_PGDN,    KC_PGUP,        KC_END,     _______,    XXXXXXX,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,        KC_DEL,     _______,      XXXXXXX,    KC_LSFT,    KC_LCTL,        XXXXXXX,    XXXXXXX,    KC_LEFT,    KC_DOWN,    KC_UP,          KC_RIGHT,   _______,    _______,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,        _______,    _______,      XXXXXXX,    XXXXXXX,    XXXXXXX,        XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,    _______,        _______,    _______,    XXXXXXX,    \
+XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,    _______,        _______,    _______,      _______,    _______,    _______,        XXXXXXX,    XXXXXXX,    XXXXXXX,    XXXXXXX,    _______,        XXXXXXX,    _______,    XXXXXXX    \
+)
+// ),
+/// [_NAVIGATION] = {
+//   {XXXXXXX,             XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_HOME, KC_PGDN, KC_PGUP, KC_END, LCTL(KC_BSPC) },
+//   {KC_DEL,              LCTL(KC_A), XXXXXXX, KC_LSFT, KC_LCTL, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT,  KC_DEL},
+//   {LCTL(KC_LSFT),       XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_RSFT, KC_RSFT, KC_RSFT, KC_ENT},
+//   {LCTL(LALT(KC_LSFT)),LCTL(KC_Z),  LCTL(KC_X), LCTL(KC_C),  LCTL(KC_V), _______, _______, _______, LCTL(KC_LEFT), LCTL(KC_DOWN), LCTL(KC_UP),   LCTL(KC_RGHT)}
+// }
+
+};

keyboards/chimera_ergo/chimera_ergo.h

@@ -49,7 +49,7 @@
 // This a shortcut to help you visually see your layout.
 // The first section contains all of the arguements
 // The second converts the arguments into a two-dimensional array
-#define KC_KEYMAP( \
+#define LAYOUT_kc( \
   k00, k01, k02, k03, k04, k05,      k06, k07, k08, k09, k10, k11, \
   k12, k13, k14, k15, k16, k17,      k18, k19, k20, k21, k22, k23, \
   k24, k25, k26, k27, k28, k29,      k30, k31, k32, k33, k34, k35, \
@@ -64,7 +64,7 @@
 	{ KC_##k29, KC_##k41, KC_##k03, KC_##k40, KC_##k37, KC_NO,         KC_##k30, KC_##k43, KC_##k08, KC_##k10, KC_##k46, KC_NO     }, \
 }
 
-#define KEYMAP( \
+#define LAYOUT( \
   k00, k01, k02, k03, k04, k05,      k06, k07, k08, k09, k10, k11, \
   k12, k13, k14, k15, k16, k17,      k18, k19, k20, k21, k22, k23, \
   k24, k25, k26, k27, k28, k29,      k30, k31, k32, k33, k34, k35, \

keyboards/chimera_ergo/info.json

@@ -0,0 +1,13 @@
+{
+  "keyboard_name": "Chimera Ergo",
+  "url": "",
+  "maintainer": "qmk",
+  "width": 13,
+  "height": 6,
+  "layouts": {
+    "LAYOUT": {
+      "key_count": 52,
+      "layout": [{"label":"k00", "x":0, "y":1}, {"label":"k01", "x":1, "y":0.75}, {"label":"k02", "x":2, "y":0.25}, {"label":"k03", "x":3, "y":0}, {"label":"k04", "x":4, "y":0.25}, {"label":"k05", "x":5, "y":0.5}, {"label":"k06", "x":7, "y":0.5}, {"label":"k07", "x":8, "y":0.25}, {"label":"k08", "x":9, "y":0}, {"label":"k09", "x":10, "y":0.25}, {"label":"k10", "x":11, "y":0.75}, {"label":"k11", "x":12, "y":1}, {"label":"k12", "x":0, "y":2}, {"label":"k13", "x":1, "y":1.75}, {"label":"k14", "x":2, "y":1.25}, {"label":"k15", "x":3, "y":1}, {"label":"k16", "x":4, "y":1.25}, {"label":"k17", "x":5, "y":1.5}, {"label":"k18", "x":7, "y":1.5}, {"label":"k19", "x":8, "y":1.25}, {"label":"k20", "x":9, "y":1}, {"label":"k21", "x":10, "y":1.25}, {"label":"k22", "x":11, "y":1.75}, {"label":"k23", "x":12, "y":2}, {"label":"k24", "x":0, "y":3}, {"label":"k25", "x":1, "y":2.75}, {"label":"k26", "x":2, "y":2.25}, {"label":"k27", "x":3, "y":2}, {"label":"k28", "x":4, "y":2.25}, {"label":"k29", "x":5, "y":2.5}, {"label":"k30", "x":7, "y":2.5}, {"label":"k31", "x":8, "y":2.25}, {"label":"k32", "x":9, "y":2}, {"label":"k33", "x":10, "y":2.25}, {"label":"k34", "x":11, "y":2.75}, {"label":"k35", "x":12, "y":3}, {"label":"k36", "x":0, "y":4}, {"label":"k37", "x":1, "y":3.75}, {"label":"k38", "x":2, "y":3.25}, {"label":"k39", "x":3, "y":3}, {"label":"k40", "x":4, "y":3.25}, {"label":"k41", "x":5, "y":3.5}, {"label":"k42", "x":7, "y":3.5}, {"label":"k43", "x":8, "y":3.25}, {"label":"k44", "x":9, "y":3}, {"label":"k45", "x":10, "y":3.25}, {"label":"k46", "x":11, "y":3.75}, {"label":"k47", "x":12, "y":4}, {"label":"k48", "x":4, "y":4.75}, {"label":"k49", "x":5, "y":5}, {"label":"k50", "x":7, "y":5}, {"label":"k51", "x":8, "y":4.75}]
+    }
+  }
+}

keyboards/chimera_ergo/keymaps/default/keymap.c

@@ -1,7 +1,7 @@
 // this is the style you want to emulate.
 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
 
-#include "chimera_ergo.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
@@ -9,30 +9,29 @@
 // entirely and just use numbers.
 enum chimera_ergo_layers
 {
-	_QWERTY,
+  _QWERTY,
-	_CAPS,
+  _CAPS,
-	_NUMPAD,
+  _NUMPAD,
-	_SYMBOLS,
+  _SYMBOLS,
-	_MACROS,
+  _MACROS,
-	_NAV
+  _NAV
 };
 
-#define KC_NMPD TG(_NUMPAD)
+#define SC_NMPD TG(_NUMPAD)
-#define KC_SYMB TG(_SYMBOLS)
+#define SC_SYMB TG(_SYMBOLS)
-#define KC_SPFN LT(_NAV,KC_EQL)
+#define SC_SPFN LT(_NAV,KC_EQL)
-#define KC_SCTL MT(MOD_LCTL, KC_LBRC)
+#define SC_SCTL MT(MOD_LCTL, KC_LBRC)
-#define KC_SCTR MT(MOD_LCTL, KC_RBRC)
+#define SC_SCTR MT(MOD_LCTL, KC_RBRC)
-#define KC_SPLT MT(MOD_LALT, KC_MINS)
+#define SC_SPLT MT(MOD_LALT, KC_MINS)
-#define KC_SPRT MT(MOD_LALT, KC_1)
+#define SC_SPRT MT(MOD_LALT, KC_1)
-#define KC_GBRC MT(MOD_RGUI, KC_RBRC)
+#define SC_GBRC MT(MOD_RGUI, KC_RBRC)
-#define KC_GQOT MT(MOD_LGUI, KC_QUOT)
+#define SC_MESC LT(_MACROS, KC_ESC)
-#define KC_MESC LT(_MACROS, KC_ESC)
+#define SC_INCL M(0)
-#define KC_INCL M(0)
+#define SC_PULL M(1)
-#define KC_PULL M(1)
+#define SC_PUSH M(2)
-#define KC_PUSH M(2)
+#define SC_SCAP M(3)
-#define KC_SCAP M(3)
+#define SC_SCOF M(4)
-#define KC_SCOF M(4)
+#define SC_CAD LALT(LCTL(KC_DEL))
-#define KC_CAD LALT(LCTL(KC_DEL))
 
 #define LONGPRESS_DELAY 150
 //#define LAYER_TOGGLE_DELAY 300
@@ -40,95 +39,57 @@ enum chimera_ergo_layers
 // Fillers to make layering more clear
 #define _______ KC_TRNS
 #define XXXXXXX KC_NO
-#define KC_ KC_TRNS 
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-  [_QWERTY] = KC_KEYMAP(
+  [_QWERTY] = LAYOUT(
-  //,----+----+----+----+----+----.     ,----+----+----+----+----+----.
+     KC_LBRC, KC_1,    SC_SCTL, SC_SPLT, SC_SPFN, KC_5,          KC_6,    SC_GBRC, SC_SPRT, SC_SCTR, KC_0,    KC_RBRC,
-     LBRC, 1  ,SCTL,SPLT,SPFN, 5  ,       6  ,GBRC,SPRT,SCTR, 0  ,RBRC,
+     SC_MESC, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,          KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_QUOT,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+     KC_TAB,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,          KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT,
-     MESC, Q  , W  , E  , R  , T  ,       Y  , U  , I  , O  , P  ,QUOT,
+     KC_LSPO, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,          KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSPC,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+                                         SC_NMPD, KC_BSPC,       KC_SPC,  SC_SYMB
-     TAB , A  , S  , D  , F  , G  ,       H  , J  , K  , L  ,SCLN,ENT ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-     LSPO, Z  , X  , C  , V  , B  ,       N  , M  ,COMM,DOT ,SLSH,RSPC,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-                         NMPD,BSPC,      SPC ,SYMB
-  // \------------------+----+----/      \---+----+----+--------------/
   ),
 
-  [_CAPS] = KC_KEYMAP(
+  [_CAPS] = LAYOUT(
-  //,----+----+----+----+----+----.     ,----+----+----+----+----+----.
+     _______, KC_UNDS, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______,
-         ,UNDS,    ,    ,    ,    ,          ,    ,    ,    ,    ,    ,
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, KC_COLN, _______,
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,    ,    ,
+     SC_SCOF, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, SC_SCOF,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+                                         _______, _______,       _______, _______
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,COLN,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-     SCOF,    ,    ,    ,    ,    ,          ,    ,    ,    ,    ,SCOF,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-                             ,    ,          ,
-  // \------------------+----+----/      \---+----+----+--------------/
   ),
 
-  [_NUMPAD] = KC_KEYMAP(
+  [_NUMPAD] = LAYOUT(
-  //,----+----+----+----+----+----.     ,----+----+----+----+----+----.
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, KC_MINS, _______,
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,MINS,    ,
+     _______, _______, KC_COLN, _______, _______, _______,       _______, KC_7,    KC_8,    KC_9,    KC_ASTR, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+     _______, _______, KC_DOT , _______, _______, _______,       _______, KC_4,    KC_5,    KC_6,    KC_PLUS, _______,
-         ,    ,COLN,    ,    ,    ,          , 7  , 8  , 9  ,ASTR,    ,
+     _______, _______, _______, _______, _______, _______,       _______, KC_1,    KC_2,    KC_3,    KC_SLSH, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+                                         _______, _______,       _______, KC_0
-         ,    ,DOT ,    ,    ,    ,          , 4  , 5  , 6  ,PLUS,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-         ,    ,    ,    ,    ,    ,          , 1  , 2  , 3  ,SLSH,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-                             ,    ,          , 0
-  // \------------------+----+----/      \---+----+----+--------------/
   ),
 
-  [_SYMBOLS] = KC_KEYMAP(
+  [_SYMBOLS] = LAYOUT(
-  //,----+----+----+----+----+----.     ,----+----+----+----+----+----.
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______,
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,    ,    ,
+     _______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC,       KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSLS,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+     KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,         KC_TILD, KC_EQL,  KC_UNDS, KC_LCBR, KC_RCBR, _______,
-         ,EXLM, AT ,HASH,DLR ,PERC,      CIRC,AMPR,ASTR,LPRN,RPRN,BSLS,
+     KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,        KC_GRV,  KC_PLUS, KC_MINS, KC_LBRC, KC_RBRC, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+                                         KC_PIPE, _______,       _______, _______
-      F1 , F2 , F3 , F4 , F5 , F6 ,      TILD,EQL ,UNDS,LCBR,RCBR,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-      F7 , F8 , F9 ,F10 ,F11 ,F12 ,      GRV ,PLUS,MINS,LBRC,RBRC,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-                         PIPE,    ,          ,
-  // \------------------+----+----/      \---+----+----+--------------/
   ),
 
-  [_MACROS] = KC_KEYMAP(  
+  [_MACROS] = LAYOUT(
-  //,----+----+----+----+----+----.     ,----+----+----+----+----+----.
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______,
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,    ,    ,
+     _______, _______, _______, _______, _______, _______,       _______, _______, SC_INCL, _______, _______, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+     _______, _______, _______, SC_CAD,  _______, _______,       _______, _______, _______, _______, _______, _______,
-         ,    ,    ,    ,    ,    ,          ,    ,INCL,    ,    ,    ,
+     SC_SCAP, _______, _______, _______, _______, _______,       _______, _______, SC_PULL, SC_PUSH, _______, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+                                         _______, _______,       _______, _______
-         ,    ,    ,CAD ,    ,    ,          ,    ,    ,    ,    ,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-     SCAP,    ,    ,    ,    ,    ,          ,    ,PULL,PUSH,    ,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-                             ,    ,          ,    
-  // \------------------+----+----/      \---+----+----+--------------/
   ),
 
-  [_NAV] = KC_KEYMAP(  
+  [_NAV] = LAYOUT(
-  //,----+----+----+----+----+----.     ,----+----+----+----+----+----.
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______,
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,    ,    ,
+     _______, _______, _______, _______, _______, _______,       _______, KC_PGUP, KC_UP,   KC_PGDN, KC_PSCR, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+     _______, _______, _______, _______, _______, _______,       _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______,
-         ,    ,    ,    ,    ,    ,          ,PGUP, UP ,PGDN,PSCR,    ,
+     _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
+                                         _______, KC_DEL,        _______, _______
-         ,    ,    ,    ,    ,    ,          ,LEFT,DOWN,RGHT,    ,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-         ,    ,    ,    ,    ,    ,          ,    ,    ,    ,    ,    ,
-  //|----+----+----+----+----+----|     |----+----+----+----+----+----|
-                             ,DEL ,          ,    
-  // \------------------+----+----/      \---+----+----+--------------/
   ),
 
-
 };
 
 
@@ -181,12 +142,12 @@ void matrix_scan_user(void) {
     uint8_t layer = biton32(layer_state);
 
     switch (layer) {
-    	case _QWERTY:
+      case _QWERTY:
-    	    set_led_green;
+          set_led_green;
-    	    break;
+          break;
         case _CAPS:
-	    set_led_white;
+      set_led_white;
-	    break;
+      break;
         case _NUMPAD:
             set_led_blue;
             break;
@@ -194,11 +155,11 @@ void matrix_scan_user(void) {
             set_led_red;
             break;
         case _NAV:
-	    set_led_magenta;
+      set_led_magenta;
-	    break;
+      break;
         case _MACROS:
-	    set_led_cyan;
+      set_led_cyan;
-	    break;
+      break;
        default:
             set_led_green;
             break;

keyboards/chimera_ergo/readme.md

@@ -5,10 +5,7 @@
 A split wireless 40% ergonomic keyboard 
 
 Keyboard Maintainer: [William Wilson](https://github.com/GlenPickle)  
-
-
 Hardware Supported: Chimera Ergo PCB, WaveShare core nRF51822  
-
 Hardware Availability: [Gerbers](https://github.com/GlenPickle/Chimera/tree/master/ergo/gerbers)
 
 Make example for this keyboard (after setting up your build environment):

keyboards/christmas_tree/info.json

@@ -6,7 +6,7 @@
   "width": 3,
   "height": 3,
   "layouts": {
-    "2017": {
+    "LAYOUT": {
       "key_count": 6,
       "layout": [{"x":1, "y":0}, {"x":0.5, "y":1}, {"x":1.5, "y":1}, {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}]
     }

keyboards/comet46/comet46.c

@@ -0,0 +1,30 @@
+#include "comet46.h"
+
+void uart_init(void) {
+	SERIAL_UART_INIT();
+}
+
+void led_init(void) {
+	DDRD  |= (1<<1);
+	PORTD |= (1<<1);
+	DDRF  |= (1<<4) | (1<<5);
+	PORTF |= (1<<4) | (1<<5);
+}
+
+void matrix_init_kb(void) {
+	// put your keyboard start-up code here
+	// runs once when the firmware starts up
+	matrix_init_user();
+	uart_init();
+	led_init();
+}
+
+void matrix_scan_kb(void) {
+	// put your looping keyboard code here
+	// runs every cycle (a lot)
+	matrix_scan_user();
+}
+
+void led_set_kb(uint8_t usb_led) {
+
+}

keyboards/comet46/comet46.h

@@ -0,0 +1,79 @@
+#ifndef COMET46_H
+#define COMET46_H
+
+#include "quantum.h"
+#include "matrix.h"
+#include "backlight.h"
+#include <stddef.h>
+
+#define red_led_off   PORTF |= (1<<5)
+#define red_led_on    PORTF &= ~(1<<5)
+#define blu_led_off   PORTF |= (1<<4)
+#define blu_led_on    PORTF &= ~(1<<4)
+#define grn_led_off   PORTD |= (1<<1)
+#define grn_led_on    PORTD &= ~(1<<1)
+
+#define set_led_off     red_led_off; grn_led_off; blu_led_off
+#define set_led_red     red_led_on;  grn_led_off; blu_led_off
+#define set_led_blue    red_led_off; grn_led_off; blu_led_on
+#define set_led_green   red_led_off; grn_led_on;  blu_led_off
+#define set_led_yellow  red_led_on;  grn_led_on;  blu_led_off
+#define set_led_magenta red_led_on;  grn_led_off; blu_led_on
+#define set_led_cyan    red_led_off; grn_led_on;  blu_led_on
+#define set_led_white   red_led_on;  grn_led_on;  blu_led_on
+
+/*
+#define LED_B 5
+#define LED_R 6
+#define LED_G 7
+
+#define all_leds_off PORTF &= ~(1<<LED_B) & ~(1<<LED_R) & ~(1<<LED_G)
+
+#define red_led_on   PORTF |= (1<<LED_R)
+#define red_led_off  PORTF &= ~(1<<LED_R)
+#define grn_led_on   PORTF |= (1<<LED_G)
+#define grn_led_off  PORTF &= ~(1<<LED_G)
+#define blu_led_on   PORTF |= (1<<LED_B)
+#define blu_led_off  PORTF &= ~(1<<LED_B)
+
+#define set_led_off     PORTF &= ~(1<<LED_B) & ~(1<<LED_R) & ~(1<<LED_G)
+#define set_led_red     PORTF = PORTF & ~(1<<LED_B) & ~(1<<LED_G) | (1<<LED_R)
+#define set_led_blue    PORTF = PORTF & ~(1<<LED_G) & ~(1<<LED_R) | (1<<LED_B)
+#define set_led_green   PORTF = PORTF & ~(1<<LED_B) & ~(1<<LED_R) | (1<<LED_G)
+#define set_led_yellow  PORTF = PORTF & ~(1<<LED_B) | (1<<LED_R) | (1<<LED_G)
+#define set_led_magenta PORTF = PORTF & ~(1<<LED_G) | (1<<LED_R) | (1<<LED_B)
+#define set_led_cyan    PORTF = PORTF & ~(1<<LED_R) | (1<<LED_B) | (1<<LED_G)
+#define set_led_white   PORTF |= (1<<LED_B) | (1<<LED_R) | (1<<LED_G)
+*/
+
+// This a shortcut to help you visually see your layout.
+// The first section contains all of the arguements
+// The second converts the arguments into a two-dimensional array
+#define LAYOUT_kc( \
+  k00, k01, k02, k03, k04, k05,                k06, k07, k08, k09, k10, k11,\
+  k12, k13, k14, k15, k16, k17, k18,      k19, k20, k21, k22, k23, k24, k25,\
+  k26, k27, k28, k29, k31, k32, k33,      k34, k35, k36, k37, k38, k41, k42,\
+                      k43, k44, k45,      k46, k47, k48     \
+) \
+{ \
+	{ KC_##k13, KC_##k01, KC_##k26, KC_##k12, KC_##k00,      KC_##k11, KC_##k25, KC_##k42, KC_##k10, KC_##k24}, \
+	{ KC_##k03, KC_##k28, KC_##k14, KC_##k02, KC_##k27,      KC_##k41, KC_##k09, KC_##k23, KC_##k38, KC_##k08}, \
+	{ KC_##k31, KC_##k16, KC_##k04, KC_##k29, KC_##k15,      KC_##k22, KC_##k37, KC_##k07, KC_##k21, KC_##k36}, \
+	{ KC_NO,    KC_##k32, KC_##k17, KC_##k05, KC_##k43,      KC_##k48, KC_##k06, KC_##k20, KC_##k35, KC_NO   },  \
+	{ KC_NO,    KC_##k45, KC_##k33, KC_##k18, KC_##k44,      KC_##k47, KC_##k19, KC_##k34, KC_##k46, KC_NO   }, \
+}
+
+#define LAYOUT( \
+  k00, k01, k02, k03, k04, k05,                k06, k07, k08, k09, k10, k11,\
+  k12, k13, k14, k15, k16, k17, k18,      k19, k20, k21, k22, k23, k24, k25,\
+  k26, k27, k28, k29, k31, k32, k33,      k34, k35, k36, k37, k38, k41, k42,\
+                      k43, k44, k45,      k46, k47, k48     \
+) \
+{ \
+	{ k13,   k01, k26, k12, k00,      k11, k25, k42, k10, k24}, \
+	{ k03,   k28, k14, k02, k27,      k41, k09, k23, k38, k08}, \
+	{ k31,   k16, k04, k29, k15,      k22, k37, k07, k21, k36}, \
+	{ KC_NO, k32, k17, k05, k43,      k48, k06, k20, k35, KC_NO },  \
+	{ KC_NO, k45, k33, k18, k44,      k47, k19, k34, k46, KC_NO }, \
+}
+#endif

keyboards/comet46/config.h

@@ -0,0 +1,87 @@
+/*
+Copyright 2012 Jun Wako <[email protected]>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x6060
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    SatT
+#define PRODUCT         Comet46
+#define DESCRIPTION     qmk keyboard firmware for Comet46
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 10
+
+/* define if matrix has ghost */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+//#define BACKLIGHT_LEVELS 3
+
+#define ONESHOT_TIMEOUT 500
+
+
+/* key combination for command */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+#define PREVENT_STUCK_MODIFIERS
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
+
+//UART settings for communication with the RF microcontroller
+#define SERIAL_UART_BAUD 1000000
+#define SERIAL_UART_DATA UDR1
+#define SERIAL_UART_UBRR (F_CPU / (16UL * SERIAL_UART_BAUD) - 1)
+#define SERIAL_UART_TXD_READY (UCSR1A & _BV(UDRE1))
+#define SERIAL_UART_RXD_PRESENT (UCSR1A & _BV(RXC1))
+#define SERIAL_UART_INIT() do { \
+    	/* baud rate */ \
+    	UBRR1L = SERIAL_UART_UBRR; \
+    	/* baud rate */ \
+    	UBRR1H = SERIAL_UART_UBRR >> 8; \
+    	/* enable TX and RX */ \
+    	UCSR1B = _BV(TXEN1) | _BV(RXEN1); \
+    	/* 8-bit data */ \
+    	UCSR1C = _BV(UCSZ11) | _BV(UCSZ10); \
+  	} while(0)
+
+#endif

keyboards/comet46/keymaps/default/keymap.c

@@ -0,0 +1,103 @@
+// this is the style you want to emulate.
+// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
+
+#include QMK_KEYBOARD_H
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum comet46_layers
+{
+    _QWERTY,
+    _LOWER,
+    _RAISE,
+};
+
+enum custom_keycodes {
+  QWERTY = SAFE_RANGE,
+  LOWER,
+  RAISE,
+};
+
+// Fillers to make layering more clear
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+#define LOWER MO(_LOWER)
+#define RAISE MO(_RAISE)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  /* Qwerty
+   * ,-----------------------------------------+                    +-----------------------------------------.
+   * | Tab  |   Q  |   W  |   E  |   R  |   T  |                    |   Y  |   U  |   I  |   O  |   P  | Bksp |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+------+------|
+   * | Ctl  |   A  |   S  |   D  |   F  |   G  | Esc  |      | Del  |   H  |   J  |   K  |   L  |   ;  |   "  |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+------+------|
+   * | Shift|   Z  |   X  |   C  |   V  |   B  |   {  |      |   }  |   N  |   M  |   ,  |   .  |   /  | Shift|
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+-------------|
+   *                             | GUI  | Lower| Space|      | Enter| Raise| Alt  |
+   *                             +--------------------/      \--------------------+
+   */
+  [_QWERTY] = LAYOUT(
+    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                             KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
+    KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_ESC,         KC_DEL,  KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
+    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_LCBR,        KC_RCBR, KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
+                                        KC_LGUI, LOWER,   KC_SPC,         KC_ENT,  RAISE,   KC_LALT
+  ),
+
+  /* Lower
+   * ,-----------------------------------------+                    +-----------------------------------------.
+   * |      |   !  |   @  |   #  |   $  |   %  |                    |   ^  |   &  |   *  |   (  |   )  |      |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+------+------|
+   * |      |      |      |      |      |      |      |      |   `  |   \  |   -  |   =  |   [  |   ]  |      |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+------+------|
+   * |      |      |      |      |      |      |      |      |   ~  |   |  |   _  |   +  |   {  |   }  |      |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+-------------|
+   *                             |      |      |      |      |      |      |      |
+   *                             +--------------------/      \--------------------+
+   */
+  [_LOWER] = LAYOUT(
+    _______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC,                          KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
+    _______, _______, _______, _______, _______, _______, _______,        KC_GRV,  KC_BSLS, KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, _______,
+    _______, _______, _______, _______, _______, _______, _______,        KC_TILD, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, _______,
+                                        _______, _______, _______,        _______, _______, _______
+  ),
+
+  /* Raise
+   * ,-----------------------------------------+                    +-----------------------------------------.
+   * |      |   1  |   2  |   3  |   4  |   5  |                    |      |      |      |      |      |      |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+------+------|
+   * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |      |      | Left | Down |  Up  |Right | End  |      |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+------+------|
+   * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |      | Home |      |      |      |      |      |      |
+   * |------+------+------+------+------+------+------+      +------+------+------+------+------+-------------|
+   *                             |      |      |      |      |      |      |      |
+   *                             +--------------------/      \--------------------+
+   */
+  [_RAISE] = LAYOUT(
+    _______, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,                             KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______,
+    _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,          XXXXXXX, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_END,  _______,
+    _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,         KC_HOME, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______,
+                                        _______, _______, _______,        _______, _______, _______
+  )
+};
+
+
+void matrix_scan_user(void) {
+    uint8_t layer = biton32(layer_state);
+    switch (layer) {
+    	case _QWERTY:
+    	    set_led_green;
+    	    break;
+        case _RAISE:
+            set_led_blue;
+            break;
+        case _LOWER:
+            set_led_red;
+            break;
+        default:
+            set_led_green;
+            break;
+    }
+}

keyboards/comet46/keymaps/satt/action_pseudo_lut.c

@@ -0,0 +1,142 @@
+#include "quantum.h"
+#include "action_pseudo_lut.h"
+
+static uint8_t send_key_shift_bit[SHIFT_BIT_SIZE];
+
+/*
+ * Pseudo layout action.
+ * This action converts a keycode in order to output the character according to the keymap you specified
+ * still your keyboard layout recognized wrongly on your OS.
+ * Memo: Using other layer keymap to get keycode
+ */
+void action_pseudo_lut(keyrecord_t *record, uint8_t base_keymap_id, const uint16_t (*keymap)[2]) {
+    uint8_t prev_shift;
+    uint16_t keycode;
+    uint16_t pseudo_keycode;
+
+    /* get keycode from keymap you specified */
+    keycode = keymap_key_to_keycode(base_keymap_id, record->event.key);
+
+    prev_shift = keyboard_report->mods & (MOD_BIT(KC_LSFT) | MOD_BIT(KC_RSFT));
+
+    if (record->event.pressed) {
+        /* when magic commands entered, keycode does not converted */
+        if (IS_COMMAND()) {
+            if (prev_shift) {
+                add_shift_bit(keycode);
+            }
+            register_code(keycode);
+            return;
+        }
+
+        if (prev_shift) {
+            pseudo_keycode = convert_keycode(keymap, keycode, true);
+            dprintf("pressed: %02X, converted: %04X\n", keycode, pseudo_keycode);
+            add_shift_bit(keycode);
+
+            if (IS_LSFT(pseudo_keycode)) {
+                register_code(QK_LSFT ^ pseudo_keycode);
+            } else {
+                /* delete shift mod temporarily */
+                del_mods(prev_shift);
+                send_keyboard_report();
+                register_code(pseudo_keycode);
+                add_mods(prev_shift);
+                send_keyboard_report();
+            }
+        } else {
+            pseudo_keycode = convert_keycode(keymap, keycode, false);
+            dprintf("pressed: %02X, converted: %04X\n", keycode, pseudo_keycode);
+
+            if (IS_LSFT(pseudo_keycode)) {
+                add_weak_mods(MOD_BIT(KC_LSFT));
+                send_keyboard_report();
+                register_code(QK_LSFT ^ pseudo_keycode);
+                /* on Windows, prevent key repeat to avoid unintended output */
+                unregister_code(QK_LSFT ^ pseudo_keycode);
+                del_weak_mods(MOD_BIT(KC_LSFT));
+                send_keyboard_report();
+            } else {
+                register_code(pseudo_keycode);
+            }
+        }
+    } else {
+        if (get_shift_bit(keycode)) {
+            del_shift_bit(keycode);
+            pseudo_keycode = convert_keycode(keymap, keycode, true);
+        } else {
+            pseudo_keycode = convert_keycode(keymap, keycode, false);
+        }
+        dprintf("released: %02X, converted: %04X\n", keycode, pseudo_keycode);
+
+        if (IS_LSFT(pseudo_keycode)) {
+            unregister_code(QK_LSFT ^ pseudo_keycode);
+        } else {
+            unregister_code(pseudo_keycode);
+        }
+    }
+}
+
+uint16_t convert_keycode(const uint16_t (*keymap)[2], uint16_t keycode, bool shift_modded)
+{
+    uint16_t pseudo_keycode;
+
+    switch (keycode) {
+        case KC_A ... KC_CAPSLOCK:
+#if defined(__AVR__)
+            if (shift_modded) {
+                pseudo_keycode = pgm_read_word(&keymap[keycode][1]);
+            } else {
+                pseudo_keycode = pgm_read_word(&keymap[keycode][0]);
+            }
+#else
+            if (shift_modded) {
+                pseudo_keycode = keymap[keycode][1];
+            } else {
+                pseudo_keycode = keymap[keycode][0];
+            }
+#endif
+            /* if undefined, use got keycode as it is */
+            if (pseudo_keycode == 0x00) {
+                if (shift_modded) {
+                    pseudo_keycode = S(keycode);
+                } else {
+                    pseudo_keycode = keycode;
+                }
+            }
+            break;
+        default:
+            if (shift_modded) {
+                pseudo_keycode = S(keycode);
+            } else {
+                pseudo_keycode = keycode;
+            }
+            break;
+    }
+    return pseudo_keycode;
+}
+
+uint8_t get_shift_bit(uint16_t keycode) {
+    if ((keycode >> 3) < SHIFT_BIT_SIZE) {
+        return send_key_shift_bit[keycode >> 3] & (1 << (keycode & 7));
+    } else {
+        dprintf("get_shift_bit: Can't get shift bit. keycode: %02X\n", keycode);
+        return 0;
+    }
+}
+
+void add_shift_bit(uint16_t keycode) {
+    if ((keycode >> 3) < SHIFT_BIT_SIZE) {
+        send_key_shift_bit[keycode >> 3] |= (1 << (keycode & 7));
+    } else {
+        dprintf("add_shift_bit: Can't add shift bit. keycode: %02X\n", keycode);
+    }
+}
+
+void del_shift_bit(uint16_t keycode) {
+    if ((keycode >> 3) < SHIFT_BIT_SIZE) {
+        send_key_shift_bit[keycode >> 3] &= ~(1 << (keycode & 7));
+    } else {
+        dprintf("del_shift_bit: Can't delete shift bit. keycode: %02X\n", keycode);
+    }
+}

keyboards/comet46/keymaps/satt/action_pseudo_lut.h

@@ -0,0 +1,15 @@
+#ifndef ACTION_PSEUDO_LUT_H
+#define ACTION_PSEUDO_LUT_H
+
+#define SHIFT_BIT_SIZE (0xE7 / 8 + 1) // 1bit per 1key
+
+#define IS_LSFT(kc) ((QK_LSFT & (kc)) == QK_LSFT)
+
+void action_pseudo_lut(keyrecord_t *, uint8_t, const uint16_t (*)[2]);
+uint16_t convert_keycode(const uint16_t (*)[2], uint16_t, bool);
+
+uint8_t get_shift_bit(uint16_t);
+void add_shift_bit(uint16_t);
+void del_shift_bit(uint16_t);
+
+#endif

keyboards/comet46/keymaps/satt/keymap.c

@@ -0,0 +1,220 @@
+// this is the style you want to emulate.
+// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
+
+#include QMK_KEYBOARD_H
+#include "keymap_jis2us.h"
+#include "action_pseudo_lut.h"
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum comet46_layers {
+    _QWERTY,
+    _LOWER,
+    _RAISE,
+    _PSEUDO_US,
+    _PSEUDO_US_LOWER,
+    _PSEUDO_US_RAISE,
+    _ADJUST
+};
+
+enum custom_keycodes {
+  QWERTY = SAFE_RANGE,
+  PSEUDO_US,
+};
+
+#define KC_LWR MO(_LOWER)
+#define KC_RSE MO(_RAISE)
+#define KC_P_LW MO(_PSEUDO_US_LOWER)
+#define KC_P_RS MO(_PSEUDO_US_RAISE)
+#define KC_QWRT QWERTY
+#define KC_P_US PSEUDO_US
+#define KC_SPCT CTL_T(KC_SPC)
+#define KC_ENSF SFT_T(KC_ENT)
+#define KC_SFTA SFT_T(KC_A)
+#define KC_CTSF S(KC_LCTL)
+#define KC_IMON ALT_T(KC_F13)
+#define KC_IMOF GUI_T(KC_F14)
+#define KC_SRO S(KC_RO)
+#define KC_SYEN S(KC_JYEN)
+#define KC_CAD LCA(KC_DEL)
+#define KC_RST RESET
+
+#define LONGPRESS_DELAY 150
+
+// Fillers to make layering more clear
+#define KC_ KC_TRNS 
+#define KC_XXXX KC_NO
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [_QWERTY] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+     ESC , Q  , W  , E  , R  , T  ,                 Y  , U  , I  , O  , P  ,DEL ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+     TAB ,SFTA, S  , D  , F  , G  ,LPRN,      RPRN, H  , J  , K  , L  ,SCLN,BSPC,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+     CTSF, Z  , X  , C  , V  , B  ,LBRC,      RBRC, N  , M  ,COMM,DOT ,SLSH,QUOT,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                         IMOF,LWR ,SPCT,      ENSF,RSE ,IMON
+  //                    +----+----+---/       \---+----+----+
+  ),
+
+  [_LOWER] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+         ,EXLM, AT ,HASH,DLR ,PERC,                CIRC,AMPR,ASTR,LPRN,RPRN,    ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+         , F1 , F2 , F3 , F4 , F5 , F6 ,      GRV ,BSLS,MINS,EQL ,LBRC,RBRC,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+         , F7 , F8 , F9 , F10, F11, F12,      TILD,PIPE,UNDS,PLUS,LCBR,RCBR,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                             ,    ,    ,          ,    ,    
+  //                    +----+----+---/       \---+----+----+
+  ),
+
+  [_RAISE] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+         , 1  , 2  , 3  , 4  , 5  ,                 6  , 7  , 8  , 9  , 0  ,    ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,      XXXX,LEFT,DOWN, UP ,RGHT,END ,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,      HOME,XXXX,XXXX,XXXX,XXXX,XXXX,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                             ,    ,    ,          ,    ,    
+  //                    +----+----+---/       \---+----+----+
+  ),
+
+  [_PSEUDO_US] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+     ESC , Q  , W  , E  , R  , T  ,                 Y  , U  , I  , O  , P  ,DEL ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+     TAB ,SFTA, S  , D  , F  , G  ,ASTR,      LPRN, H  , J  , K  , L  ,FN0 ,BSPC,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+     CTSF, Z  , X  , C  , V  , B  ,FN0 ,      FN0 , N  , M  ,COMM,DOT ,SLSH,FN0 ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                         IMOF,P_LW,SPCT,      ENSF,P_RS,IMON
+  //                    +----+----+---/       \---+----+----+
+  ),
+
+
+  [_PSEUDO_US_LOWER] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+         ,EXLM,LBRC,HASH,DLR ,PERC,                EQL ,CIRC, DQT,ASTR,LPRN,    ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+         , F1 , F2 , F3 , F4 , F5 , F6 ,      LCBR,JYEN,MINS,UNDS,RBRC,BSLS,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+         , F7 , F8 , F9 , F10, F11, F12,      PLUS,SYEN,SRO ,COLN,RCBR,PIPE,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                             ,    ,    ,          ,    ,    
+  //                    +----+----+---/       \---+----+----+
+  ),
+
+  [_PSEUDO_US_RAISE] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+         , 1  , 2  , 3  , 4  , 5  ,                 6  , 7  , 8  , 9  , 0  ,    ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    , GRV,      XXXX,LEFT,DOWN, UP ,RGHT,END ,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,      HOME,XXXX,XXXX,XXXX,XXXX,XXXX,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                             ,    ,    ,          ,    ,    
+  //                    +----+----+---/       \---+----+----+
+  ),
+
+  [_ADJUST] = LAYOUT_kc(  
+  //,----+----+----+----+----+----+               +----+----+----+----+----+----.
+         ,    ,    ,    ,    ,    ,                    ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----+     +----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,CAD ,      QWRT,    ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,RST ,      P_US,    ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----|     |----+----+----+----+----+----+----|
+                             ,    ,    ,          ,    ,    
+  //                    +----+----+---/       \---+----+----+
+  )
+
+};
+
+
+/*
+ * user defined action function
+ */
+enum function_id {
+    PSEUDO_US_FUNCTION,
+};
+
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch (id)
+    {
+    case PSEUDO_US_FUNCTION:
+        action_pseudo_lut(record, _QWERTY, keymap_jis2us);
+        break;
+    }
+}
+
+/*
+ * Fn action definition
+ */
+const uint16_t PROGMEM fn_actions[] = {
+    [0] = ACTION_FUNCTION(PSEUDO_US_FUNCTION),
+};
+
+void matrix_scan_user(void) {
+    uint8_t layer = biton32(layer_state);
+    switch (layer) {
+      case _LOWER:
+          set_led_red;
+          break;
+      case _RAISE:
+          set_led_blue;
+          break;
+      case _PSEUDO_US_LOWER:
+          set_led_yellow;
+          break;
+      case _PSEUDO_US_RAISE:
+          set_led_cyan;
+          break;
+      case _ADJUST:
+          set_led_magenta;
+          break;
+      default:
+          set_led_green;
+          break;
+    }
+};
+
+uint32_t layer_state_set_user(uint32_t state) {
+  switch (biton32(state)) {
+    case _PSEUDO_US:
+      return update_tri_layer_state(state, _PSEUDO_US_RAISE, _PSEUDO_US_LOWER, _ADJUST);
+      break;
+    case _PSEUDO_US_LOWER:
+      return update_tri_layer_state(state, _PSEUDO_US_RAISE, _PSEUDO_US_LOWER, _ADJUST);
+      break;
+    case _PSEUDO_US_RAISE: 
+      return update_tri_layer_state(state, _PSEUDO_US_RAISE, _PSEUDO_US_LOWER, _ADJUST);
+      break;
+    default:
+      return update_tri_layer_state(state, _RAISE, _LOWER, _ADJUST);
+      break;
+  }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_QWERTY);
+      }
+      return false;
+      break;
+    case PSEUDO_US:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_PSEUDO_US);
+      }
+      return false;
+      break;
+  }
+  return true;
+}

keyboards/comet46/keymaps/satt/keymap_jis2us.h

@@ -0,0 +1,32 @@
+#ifndef KEYMAP_JIS2US_H
+#define KEYMAP_JIS2US_H
+
+/* keymap for convert from JIS to US */
+const uint16_t PROGMEM keymap_jis2us[][2] = {
+    [KC_A ... KC_CAPS] = { 0x00, 0x00 }, /* default value */
+
+    [KC_1]    = { KC_1,    KC_EXLM    }, /* 1 and ! -> 1 and ! */
+    [KC_2]    = { KC_2,    KC_LBRC    }, /* 2 and " -> 2 and @ */
+    [KC_3]    = { KC_3,    KC_HASH    }, /* 3 and # -> 3 and # */
+    [KC_4]    = { KC_4,    KC_DLR     }, /* 4 and $ -> 4 and $ */
+    [KC_5]    = { KC_5,    KC_PERC    }, /* 5 and % -> 5 and % */
+    [KC_6]    = { KC_6,    KC_EQL     }, /* 6 and & -> 6 and ^ */
+    [KC_7]    = { KC_7,    KC_CIRC    }, /* 7 and ' -> 7 and & */
+    [KC_8]    = { KC_8,    KC_DQT     }, /* 8 and ( -> 8 and * */
+    [KC_9]    = { KC_9,    KC_ASTR    }, /* 9 and ) -> 9 and ( */
+    [KC_0]    = { KC_0,    KC_LPRN    }, /* 0 and (no assign) -> 0 and ) */
+    [KC_MINS] = { KC_MINS, S(KC_RO)   }, /* - and = -> - and _ */
+    [KC_EQL]  = { KC_UNDS, KC_COLN    }, /* ^ and ~ -> = and + */
+    [KC_LBRC] = { KC_RBRC, KC_RCBR    }, /* @ and ` -> [ and { */
+    [KC_RBRC] = { KC_BSLS, KC_PIPE    }, /* [ and { -> ] and } */
+    [KC_BSLS] = { KC_JYEN, S(KC_JYEN) }, /* ] and } -> / and | */
+    [KC_NUHS] = { KC_NUHS, S(KC_NUHS) }, /* (no assign) */
+    [KC_SCLN] = { KC_SCLN, KC_QUOT    }, /* ; and + -> ; and : */
+    [KC_QUOT] = { KC_AMPR, KC_AT      }, /* : and * -> ' and " */
+    [KC_GRV]  = { KC_LCBR, KC_PLUS    }, /* (no assign) -> ` and ~ */
+    [KC_COMM] = { KC_COMM, KC_LT      }, /* , and < -> , and < */
+    [KC_DOT]  = { KC_DOT,  KC_GT      }, /* . and > -> . and > */
+    [KC_SLSH] = { KC_SLSH, KC_QUES    }, /* / and ? -> / and ? */
+};
+
+#endif

keyboards/comet46/keymaps/satt/readme.md

@@ -0,0 +1,6 @@
+## Pseudo US Layout
+
+On a Japanese Windows environment, ANSI keyboards may be recognized wrongly as a JIS keyboard.  
+By using this code, you can use your ANSI keyboard under a JIS keyboard environment without changing the settings and registry of your environment.
+
+Original code by [Shela](https://github.com/qmk/qmk_firmware/tree/master/keyboards/hhkb/keymaps/shela)

keyboards/comet46/keymaps/satt/rules.mk

@@ -0,0 +1,26 @@
+SRC += action_pseudo_lut.c
+
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = no       # Audio control and System control(+450)
+CONSOLE_ENABLE = no         # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+NKRO_ENABLE = no            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no      # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = no           # Audio output on port C6
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+ONEHAND_ENABLE = no        # Enable one-hand typing
+
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif

keyboards/comet46/matrix.c

@@ -0,0 +1,154 @@
+/*
+Copyright 2012 Jun Wako
+Copyright 2014 Jack Humbert
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+#include <stdint.h>
+#include <stdbool.h>
+#if defined(__AVR__)
+#include <avr/io.h>
+#endif
+#include "wait.h"
+#include "print.h"
+#include "debug.h"
+#include "util.h"
+#include "matrix.h"
+#include "timer.h"
+
+#if (MATRIX_COLS <= 8)
+#    define print_matrix_header()  print("\nr/c 01234567\n")
+#    define print_matrix_row(row)  print_bin_reverse8(matrix_get_row(row))
+#    define matrix_bitpop(i)       bitpop(matrix[i])
+#    define ROW_SHIFTER ((uint8_t)1)
+#elif (MATRIX_COLS <= 16)
+#    define print_matrix_header()  print("\nr/c 0123456789ABCDEF\n")
+#    define print_matrix_row(row)  print_bin_reverse16(matrix_get_row(row))
+#    define matrix_bitpop(i)       bitpop16(matrix[i])
+#    define ROW_SHIFTER ((uint16_t)1)
+#elif (MATRIX_COLS <= 32)
+#    define print_matrix_header()  print("\nr/c 0123456789ABCDEF0123456789ABCDEF\n")
+#    define print_matrix_row(row)  print_bin_reverse32(matrix_get_row(row))
+#    define matrix_bitpop(i)       bitpop32(matrix[i])
+#    define ROW_SHIFTER  ((uint32_t)1)
+#endif
+
+/* matrix state(1:on, 0:off) */
+static matrix_row_t matrix[MATRIX_ROWS];
+
+__attribute__ ((weak))
+void matrix_init_kb(void) {
+    matrix_init_user();
+}
+
+__attribute__ ((weak))
+void matrix_scan_kb(void) {
+    matrix_scan_user();
+}
+
+__attribute__ ((weak))
+void matrix_init_user(void) {
+}
+
+__attribute__ ((weak))
+void matrix_scan_user(void) {
+}
+
+inline
+uint8_t matrix_rows(void) {
+    return MATRIX_ROWS;
+}
+
+inline
+uint8_t matrix_cols(void) {
+    return MATRIX_COLS;
+}
+
+void matrix_init(void) {
+
+    matrix_init_quantum();
+}
+
+uint8_t matrix_scan(void)
+{
+    SERIAL_UART_INIT();
+
+    uint32_t timeout = 0;
+
+    //the s character requests the RF slave to send the matrix
+    SERIAL_UART_DATA = 's';
+
+    //trust the external keystates entirely, erase the last data
+    uint8_t uart_data[11] = {0};
+
+    //there are 10 bytes corresponding to 10 columns, and an end byte
+    for (uint8_t i = 0; i < 11; i++) {
+        //wait for the serial data, timeout if it's been too long
+        //this only happened in testing with a loose wire, but does no
+        //harm to leave it in here
+        while(!SERIAL_UART_RXD_PRESENT){
+            timeout++;
+            if (timeout > 10000){
+                break;
+            }
+        } 
+        uart_data[i] = SERIAL_UART_DATA;
+    }
+
+    //check for the end packet, the key state bytes use the LSBs, so 0xE0
+    //will only show up here if the correct bytes were recieved
+    if (uart_data[10] == 0xE0)
+    {
+        //shifting and transferring the keystates to the QMK matrix variable
+        for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+            matrix[i] = (uint16_t) uart_data[i*2] | (uint16_t) uart_data[i*2+1] << 5;
+        }
+    }
+
+
+    matrix_scan_quantum();
+    return 1;
+}
+
+inline
+bool matrix_is_on(uint8_t row, uint8_t col)
+{
+    return (matrix[row] & ((matrix_row_t)1<col));
+}
+
+inline
+matrix_row_t matrix_get_row(uint8_t row)
+{
+    return matrix[row];
+}
+
+void matrix_print(void)
+{
+    print_matrix_header();
+
+    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+        phex(row); print(": ");
+        print_matrix_row(row);
+        print("\n");
+    }
+}
+
+uint8_t matrix_key_count(void)
+{
+    uint8_t count = 0;
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        count += matrix_bitpop(i);
+    }
+    return count;
+}

keyboards/comet46/readme.md

@@ -0,0 +1,16 @@
+# Comet46
+
+![Comet46](https://user-images.githubusercontent.com/39004890/42418180-d5bb188c-82d5-11e8-99fa-65020ce5ac5d.jpg)
+
+A split wireless 40% column-staggered keyboard 
+
+Keyboard Maintainer: [SatT](https://github.com/satt99)  
+Hardware Supported: Comet46 PCB, atmega32u4, nRF51822  
+Hardware Availability: [Comet46 PCB, case, and receiver](https://github.com/satt99/comet46-hardware)  
+Firmware for nordic MCUs: [SRC and precompiled](https://github.com/satt99/comet46-firmware)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make comet46:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.

keyboards/comet46/rules.mk

@@ -0,0 +1,73 @@
+
+OPT_DEFS += -DCOMET46_ORTHO_===PROMICRO
+COMET46_UPLOAD_COMMAND = while [ ! -r $(USB) ]; do sleep 1; done; \
+                         avrdude -p $(MCU) -c avr109 -U flash:w:$(TARGET).hex -P $(USB)
+
+# # project specific files
+SRC = matrix.c
+
+
+# MCU name
+#MCU = at90usb1287
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Bootloader
+#     This definition is optional, and if your keyboard supports multiple bootloaders of
+#     different sizes, comment this out, and the correct address will be loaded 
+#     automatically (+60). See bootloader.mk for all options.
+BOOTLOADER = caterina
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+# Build Options
+#   comment out to disable the options.
+#
+BOOTMAGIC_ENABLE = no   # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no    # Mouse keys(+4700)
+EXTRAKEY_ENABLE = no    # Audio control and System control(+450)
+CONSOLE_ENABLE = no     # Console for debug(+400)
+COMMAND_ENABLE = no     # Commands for debug and configuration
+CUSTOM_MATRIX = yes     # Remote matrix from the wireless bridge
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+# SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
+NKRO_ENABLE = yes		# USB Nkey Rollover - not yet supported in LUFA
+# BACKLIGHT_ENABLE = yes  # Enable keyboard backlight functionality
+# MIDI_ENABLE = YES 		# MIDI controls
+UNICODE_ENABLE = YES 		# Unicode
+# BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
+
+USB = /dev/ttyACM0

keyboards/dz60/keymaps/eric/keymap.c

@@ -23,7 +23,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 		KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
 		KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
 		KC_LSFT, KC_NO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(1),
-		KC_CAPS, KC_LGUI, KC_LALT, KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_RALT, KC_RGUI, KC_RGUI, KC_RCTL),
+		KC_CAPS, KC_LALT, KC_LGUI, KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_RGUI, KC_RALT, KC_RALT, KC_RCTL),
 
 
 

keyboards/e6v2/le/keymaps/eric/keymap.c

@@ -0,0 +1,31 @@
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /*rBase layer */
+  [0] = LAYOUT(
+      KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,     KC_6,    KC_7,    KC_8,      KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSLS, KC_GRV,
+      KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,     KC_Y,    KC_U,    KC_I,      KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSPC,
+      KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,     KC_H,    KC_J,    KC_K,      KC_L,    KC_SCLN, KC_QUOT, KC_ENT,
+      KC_LSFT, KC_NUBS, KC_Z,    KC_X,    KC_C,    KC_V,     KC_B,    KC_N,    KC_M,      KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_RSFT, MO(1),
+      KC_LCTL, KC_LALT, KC_LGUI, KC_LGUI,          KC_SPACE,                   KC_SPACE,  KC_RGUI, KC_RGUI, KC_RALT, KC_RCTL, KC_RCTL
+      ),
+
+  /* Function layer */
+  [1] = LAYOUT(
+      KC_CAPS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,    KC_F6,   KC_F7,   KC_F8,     KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_INS,  KC_DEL,
+      KC_TRNS, KC_PGUP, KC_UP,   KC_PGDN, KC_HOME, KC_AMPR,  KC_TILD, KC_TRNS, KC_TRNS,   KC_TRNS, KC_PSCR, KC_UP,   KC_DEL,  KC_BSPC,
+      KC_TRNS, KC_LEFT, KC_DOWN, KC_RGHT, KC_END,  KC_ASTR,  KC_TRNS, KC_TRNS, KC_PGUP,   KC_HOME, KC_LEFT, KC_RGHT, KC_TRNS,
+      KC_TRNS, KC_TRNS, KC_UNDS, KC_PLUS, KC_LPRN, KC_RPRN,  KC_PIPE, KC_TRNS, KC_TRNS,   KC_PGDN, KC_END,  KC_DOWN, KC_TRNS, KC_TRNS, KC_TRNS,
+      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,          KC_TRNS,                    KC_TRNS,   KC_TRNS, KC_TRNS, MO(2),   MO(2),   KC_TRNS
+      ),
+
+  /* Reset layer */
+  [2] = LAYOUT(
+      RESET,   KC_A,    KC_NO,   KC_NO,   KC_NO,   KC_NO,    KC_NO,   KC_NO,   KC_NO,     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+      KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,    KC_NO,   KC_NO,   KC_NO,     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+      KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,    KC_NO,   KC_NO,   KC_NO,     KC_NO,   KC_NO,   KC_NO,   KC_NO, 
+      KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,    KC_NO,   KC_NO,   KC_NO,     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+      KC_NO,   KC_NO,   KC_NO,   KC_NO,            KC_NO,                      KC_NO,     KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO
+      ),
+
+};

keyboards/ergodash/ergodash.h

@@ -0,0 +1,46 @@
+#ifndef ERGODASH_H
+#define ERGODASH_H
+
+#include "quantum.h"
+
+#ifdef KEYBOARD_ergodash_rev1
+    #include "rev1.h"
+
+    // Used to create a keymap using only KC_ prefixed keys
+    #define LAYOUT_kc( \
+        L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, \
+        L10, L11, L12, L13, L14, L15, L16, R10, R11, R12, R13, R14, R15, R16, \
+        L20, L21, L22, L23, L24, L25, L26, R20, R21, R22, R23, R24, R25, R26, \
+        L30, L31, L32, L33, L34, L35, L36, R30, R31, R32, R33, R34, R35, R36, \
+        LT0, LT1, LT2, LT3,      LT4, LT5, RT0, RT1,      RT2, RT3, RT4, RT5  \
+        ) \
+        LAYOUT( \
+            KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##L06, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, KC_##R06, \
+            KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##L16, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, KC_##R16, \
+            KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##L26, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, KC_##R26, \
+            KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##L36, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, KC_##R36, \
+            KC_##LT0, KC_##LT1, KC_##LT2, KC_##LT3,           KC_##LT4, KC_##LT5, KC_##RT0, KC_##RT1,           KC_##RT2, KC_##RT3, KC_##RT4, KC_##RT5  \
+        )
+#endif // #ifdef KEYBOARD_ergodash_rev1
+
+#ifdef KEYBOARD_ergodash_rev2
+    #include "rev2.h"
+
+    // Used to create a keymap using only KC_ prefixed keys
+    #define LAYOUT_kc( \
+        L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, \
+        L10, L11, L12, L13, L14, L15, L16, R10, R11, R12, R13, R14, R15, R16, \
+        L20, L21, L22, L23, L24, L25, L26, R20, R21, R22, R23, R24, R25, R26, \
+        L30, L31, L32, L33, L34, L35, L36, R30, R31, R32, R33, R34, R35, R36, \
+        L40, L41, L42, L43, L44, L45, L46, R40, R41, R42, R43, R44, R45, R46  \
+        ) \
+        LAYOUT( \
+            KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##L06, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, KC_##R06, \
+            KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##L16, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, KC_##R16, \
+            KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##L26, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, KC_##R26, \
+            KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##L36, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, KC_##R36, \
+            KC_##L40, KC_##L41, KC_##L42, KC_##L43, KC_##L44, KC_##L45, KC_##L46, KC_##R40, KC_##R41, KC_##R42, KC_##R43, KC_##R44, KC_##R45, KC_##R46  \
+        )
+#endif // #ifdef KEYBOARD_ergodash_rev2
+
+#endif

keyboards/ergodash/rev1/ergodash.h

@@ -1,26 +0,0 @@
-#ifndef ERGODASH_H
-#define ERGODASH_H
-
-#include "quantum.h"
-
-#ifdef KEYBOARD_ergodash_rev1
-    #include "rev1.h"
-#endif
-
-// Used to create a keymap using only KC_ prefixed keys
-#define LAYOUT_kc( \
-    L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, \
-    L10, L11, L12, L13, L14, L15, L16, R10, R11, R12, R13, R14, R15, R16, \
-    L20, L21, L22, L23, L24, L25, L26, R20, R21, R22, R23, R24, R25, R26, \
-    L30, L31, L32, L33, L34, L35, L36, R30, R31, R32, R33, R34, R35, R36, \
-    LT0, LT1, LT2, LT3,      LT4, LT5, RT0, RT1,      RT2, RT3, RT4, RT5  \
-    ) \
-    LAYOUT( \
-        KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##L06, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, KC_##R06, \
-        KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##L16, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, KC_##R16, \
-        KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##L26, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, KC_##R26, \
-        KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##L36, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, KC_##R36, \
-        KC_##LT0, KC_##LT1, KC_##LT2, KC_##LT3,           KC_##LT4, KC_##LT5, KC_##RT0, KC_##RT1,           KC_##RT2, KC_##RT3, KC_##RT4, KC_##RT5  \
-    )
-
-#endif

keyboards/ergodash/rev1/info.json

@@ -1,5 +1,5 @@
 {
-  "keyboard_name": "ErgoDash",
+  "keyboard_name": "ErgoDash rev1",
   "url": "",
   "maintainer": "qmk",
   "width": 16,

keyboards/ergodash/rev2/ergodash.h

@@ -1,26 +0,0 @@
-#ifndef ERGODASH_H
-#define ERGODASH_H
-
-#include "quantum.h"
-
-#ifdef KEYBOARD_ergodash_rev2
-    #include "rev2.h"
-#endif
-
-// Used to create a keymap using only KC_ prefixed keys
-#define LAYOUT_kc( \
-    L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, \
-    L10, L11, L12, L13, L14, L15, L16, R10, R11, R12, R13, R14, R15, R16, \
-    L20, L21, L22, L23, L24, L25, L26, R20, R21, R22, R23, R24, R25, R26, \
-    L30, L31, L32, L33, L34, L35, L36, R30, R31, R32, R33, R34, R35, R36, \
-    L40, L41, L42, L43, L44, L45, L46, R40, R41, R42, R43, R44, R45, R46  \
-    ) \
-    LAYOUT( \
-        KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##L06, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, KC_##R06, \
-        KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##L16, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, KC_##R16, \
-        KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##L26, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, KC_##R26, \
-        KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##L36, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, KC_##R36, \
-        KC_##L40, KC_##L41, KC_##L42, KC_##L43, KC_##L44, KC_##L45, KC_##L46, KC_##R40, KC_##R41, KC_##R42, KC_##R43, KC_##R44, KC_##R45, KC_##R46  \
-    )
-
-#endif

keyboards/ergodash/rev2/info.json

@@ -0,0 +1,13 @@
+{
+  "keyboard_name": "ErgoDash rev2",
+  "url": "",
+  "maintainer": "qmk",
+  "width": 18,
+  "height": 6.25,
+  "layouts": {
+    "LAYOUT": {
+      "key_count": 70,
+      "layout": [{"label":"L00", "x":0, "y":0.375}, {"label":"L01", "x":1, "y":0.375}, {"label":"L02", "x":2, "y":0.125}, {"label":"L03", "x":3, "y":0}, {"label":"L04", "x":4, "y":0.125}, {"label":"L05", "x":5, "y":0.25}, {"label":"L06", "x":6, "y":0.75}, {"label":"R00", "x":11, "y":0.75}, {"label":"R01", "x":12, "y":0.25}, {"label":"R02", "x":13, "y":0.125}, {"label":"R03", "x":14, "y":0}, {"label":"R04", "x":15, "y":0.125}, {"label":"R05", "x":16, "y":0.375}, {"label":"R06", "x":17, "y":0.375}, {"label":"L10", "x":0, "y":1.375}, {"label":"L11", "x":1, "y":1.375}, {"label":"L12", "x":2, "y":1.125}, {"label":"L13", "x":3, "y":1}, {"label":"L14", "x":4, "y":1.125}, {"label":"L15", "x":5, "y":1.25}, {"label":"L16", "x":6, "y":1.75}, {"label":"R10", "x":11, "y":1.75}, {"label":"R11", "x":12, "y":1.25}, {"label":"R12", "x":13, "y":1.125}, {"label":"R13", "x":14, "y":1}, {"label":"R14", "x":15, "y":1.125}, {"label":"R15", "x":16, "y":1.375}, {"label":"R16", "x":17, "y":1.375}, {"label":"L20", "x":0, "y":2.375}, {"label":"L21", "x":1, "y":2.375}, {"label":"L22", "x":2, "y":2.125}, {"label":"L23", "x":3, "y":2}, {"label":"L24", "x":4, "y":2.125}, {"label":"L25", "x":5, "y":2.25}, {"label":"L26", "x":6, "y":2.75}, {"label":"R20", "x":11, "y":2.75}, {"label":"R21", "x":12, "y":2.25}, {"label":"R22", "x":13, "y":2.125}, {"label":"R23", "x":14, "y":2}, {"label":"R24", "x":15, "y":2.125}, {"label":"R25", "x":16, "y":2.375}, {"label":"R26", "x":17, "y":2.375}, {"label":"L30", "x":0, "y":3.375}, {"label":"L31", "x":1, "y":3.375}, {"label":"L32", "x":2, "y":3.125}, {"label":"L33", "x":3, "y":3}, {"label":"L34", "x":4, "y":3.125}, {"label":"L35", "x":5, "y":3.25}, {"label":"L36", "x":6.5, "y":4.25}, {"label":"R30", "x":10.5, "y":4.25}, {"label":"R31", "x":12, "y":3.25}, {"label":"R32", "x":13, "y":3.125}, {"label":"R33", "x":14, "y":3}, {"label":"R34", "x":15, "y":3.125}, {"label":"R35", "x":16, "y":3.375}, {"label":"R36", "x":17, "y":3.375}, {"label":"L40", "x":0, "y":4.375}, {"label":"L41", "x":1, "y":4.375}, {"label":"L42", "x":2, "y":4.125}, {"label":"L43", "x":3, "y":4}, {"label":"L44", "x":5.5, "y":5.25}, {"label":"L45", "x":6.5, "y":5.25}, {"label":"L46", "x":7.5, "y":4.25, "h":2}, {"label":"R40", "x":9.5, "y":4.25, "h":2}, {"label":"R41", "x":10.5, "y":5.25}, {"label":"R42", "x":11.5, "y":5.25}, {"label":"R43", "x":14, "y":4}, {"label":"R44", "x":15, "y":4.125}, {"label":"R45", "x":16, "y":4.375}, {"label":"R46", "x":17, "y":4.375}]
+    }
+  }
+}

keyboards/ergodox_ez/config.h

@@ -81,9 +81,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* fix space cadet rollover issue */
 #define DISABLE_SPACE_CADET_ROLLOVER
 
-// #define RGBW_BB_TWI
+#define RGBW_BB_TWI
 
-// #define RGBW 1
+#define RGBW 1
 
 /* "debounce" is measured in keyboard scans. Some users reported
  * needing values as high as 15, which was at the time around 50ms.

keyboards/ergodox_ez/rules.mk

@@ -82,7 +82,7 @@ UNICODE_ENABLE   = yes # Unicode
 SWAP_HANDS_ENABLE= yes # Allow swapping hands of keyboard
 SLEEP_LED_ENABLE = no
 API_SYSEX_ENABLE = no
-RGBLIGHT_ENABLE = no
+RGBLIGHT_ENABLE = yes
-RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_ENABLE = no // enable later
 
 LAYOUTS = ergodox

keyboards/h87a/config.h

@@ -0,0 +1,81 @@
+/*
+Copyright 2018 Josh Hinnebusch
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x0000
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    hineybush
+#define PRODUCT         h87a
+#define DESCRIPTION     QMK-programmable TKL PCB for custom keyboards
+
+#define CONFIG_H
+
+#include "config_common.h"
+
+/* key matrix size */
+#define MATRIX_ROWS 12
+#define MATRIX_COLS 9
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+*/
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, D0, D1, B5, B6, D7, B4, D6, D4 }
+#define MATRIX_COL_PINS { F0, F1, F4, F5, F6, F7, C7, C6, D2 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
+#define DIODE_DIRECTION COL2ROW
+
+#define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 3
+
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCING_DELAY 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* key combination for magic key command */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+#define RGB_DI_PIN D3
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 24
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#endif

keyboards/h87a/h87a.c

@@ -0,0 +1,45 @@
+/* Copyright 2018 Josh Hinnebusch
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include "h87a.h"
+
+void matrix_init_kb(void) {
+	// put your keyboard start-up code here
+	// runs once when the firmware starts up
+
+	matrix_init_user();
+}
+
+void matrix_scan_kb(void) {
+	// put your looping keyboard code here
+	// runs every cycle (a lot)
+
+	matrix_scan_user();
+}
+
+bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
+	// put your per-action keyboard code here
+	// runs for every action, just before processing by the firmware
+
+	return process_record_user(keycode, record);
+}
+
+void led_set_kb(uint8_t usb_led) {
+	// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+
+	led_set_user(usb_led);
+}
+
+

keyboards/h87a/h87a.h

@@ -0,0 +1,47 @@
+/* Copyright 2018 Josh Hinnebusch
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef H87A_H
+#define H87A_H
+
+#include "quantum.h"
+
+// This a shortcut to help you visually see your layout.
+// The following is an example using the Planck MIT layout
+// The first section contains all of the arguments
+// The second converts the arguments into a two-dimensional array
+#define LAYOUT_all(\
+	K000,       K001, K011, K002, K012,    K003, K013, K004, K014,    K015, K006, K016, K007,    K017, K008, K018,  \
+	K020, K030, K021, K031, K022, K032, K023, K033, K024, K034, K025, K035, K026, K036, K027,    K037, K028, K038,  \
+	K040, K050, K041, K051, K042, K052, K043, K053, K044, K054, K045, K055, K046, K056,                K057, K048, K058,  \
+	K060, K070, K061, K071, K062, K072, K063, K073, K064, K074, K065, K075, K066, K076,                             \
+ 	K080, K090, K081, K091, K082, K092, K083, K093, K084, K094, K085, K095, K086, K096,                K088,        \
+	K100, K110, K101,                   K113,                   K105, K115, K106, K116,          K117, K108, K118   \
+) { \
+	{ K000,  K001,  K002,  K003,  K004,  KC_NO, K006,  K007,  K008 }, \
+	{ KC_NO, K011,  K012,  K013,  K014,  K015,  K016,  K017,  K018 }, \
+	{ K020,  K021,  K022,  K023,  K024,  K025,  K026,  K027,  K028 }, \
+	{ K030,  K031,  K032,  K033,  K034,  K035,  K036,  K037,  K038 }, \
+	{ K040,  K041,  K042,  K043,  K044,  K045,  K046,  KC_NO, K048 }, \
+	{ K050,  K051,  K052,  K053,  K054,  K055,  K056,  K057,  K058 }, \
+	{ K060,  K061,  K062,  K063,  K064,  K065,  K066,  KC_NO, KC_NO }, \
+	{ K070,  K071,  K072,  K073,  K074,  K075,  K076,  KC_NO, KC_NO }, \
+	{ K080,  K081,  K082,  K083,  K084,  K085,  K086,  KC_NO, K088 }, \
+	{ K090,  K091,  K092,  K093,  K094,  K095,  K096,  KC_NO, KC_NO }, \
+	{ K100,  K101,  KC_NO, KC_NO, KC_NO, K105,  K106,  KC_NO, K108 }, \
+	{ K110,  KC_NO, KC_NO, K113,  KC_NO, K115,  K116,  K117,  K118 }  \
+}
+
+#endif

keyboards/h87a/info.json

@@ -0,0 +1,12 @@
+{
+    "keyboard_name": "h87a", 
+    "url": "", 
+    "maintainer": "hineybush", 
+    "width": 18.25, 
+    "height": 6.5, 
+    "layouts": {
+        "LAYOUT": {
+            "layout": [{"label":"Esc", "x":0, "y":0}, {"label":"F1", "x":2, "y":0}, {"label":"F2", "x":3, "y":0}, {"label":"F3", "x":4, "y":0}, {"label":"F4", "x":5, "y":0}, {"label":"F5", "x":6.5, "y":0}, {"label":"F6", "x":7.5, "y":0}, {"label":"F7", "x":8.5, "y":0}, {"label":"F8", "x":9.5, "y":0}, {"label":"F9", "x":11, "y":0}, {"label":"F10", "x":12, "y":0}, {"label":"F11", "x":13, "y":0}, {"label":"F12", "x":14, "y":0}, {"label":"PrtSc", "x":15.25, "y":0}, {"label":"Scroll Lock", "x":16.25, "y":0}, {"label":"Pause", "x":17.25, "y":0}, {"label":"~", "x":0, "y":1.5}, {"label":"!", "x":1, "y":1.5}, {"label":"@", "x":2, "y":1.5}, {"label":"#", "x":3, "y":1.5}, {"label":"$", "x":4, "y":1.5}, {"label":"%", "x":5, "y":1.5}, {"label":"^", "x":6, "y":1.5}, {"label":"&", "x":7, "y":1.5}, {"label":"*", "x":8, "y":1.5}, {"label":"(", "x":9, "y":1.5}, {"label":")", "x":10, "y":1.5}, {"label":"_", "x":11, "y":1.5}, {"label":"+", "x":12, "y":1.5}, {"x":13, "y":1.5}, {"x":14, "y":1.5}, {"label":"Insert", "x":15.25, "y":1.5}, {"label":"Home", "x":16.25, "y":1.5}, {"label":"PgUp", "x":17.25, "y":1.5}, {"label":"Tab", "x":0, "y":2.5, "w":1.5}, {"label":"Q", "x":1.5, "y":2.5}, {"label":"W", "x":2.5, "y":2.5}, {"label":"E", "x":3.5, "y":2.5}, {"label":"R", "x":4.5, "y":2.5}, {"label":"T", "x":5.5, "y":2.5}, {"label":"Y", "x":6.5, "y":2.5}, {"label":"U", "x":7.5, "y":2.5}, {"label":"I", "x":8.5, "y":2.5}, {"label":"O", "x":9.5, "y":2.5}, {"label":"P", "x":10.5, "y":2.5}, {"label":"{", "x":11.5, "y":2.5}, {"label":"}", "x":12.5, "y":2.5}, {"label":"|", "x":13.5, "y":2.5, "w":1.5}, {"label":"Delete", "x":15.25, "y":2.5}, {"label":"End", "x":16.25, "y":2.5}, {"label":"PgDn", "x":17.25, "y":2.5}, {"label":"Caps Lock", "x":0, "y":3.5, "w":1.75}, {"label":"A", "x":1.75, "y":3.5}, {"label":"S", "x":2.75, "y":3.5}, {"label":"D", "x":3.75, "y":3.5}, {"label":"F", "x":4.75, "y":3.5}, {"label":"G", "x":5.75, "y":3.5}, {"label":"H", "x":6.75, "y":3.5}, {"label":"J", "x":7.75, "y":3.5}, {"label":"K", "x":8.75, "y":3.5}, {"label":"L", "x":9.75, "y":3.5}, {"label":":", "x":10.75, "y":3.5}, {"label":"\"", "x":11.75, "y":3.5}, {"x":12.75, "y":3.5}, {"label":"Enter", "x":13.75, "y":3.5, "w":1.25}, {"label":"Shift", "x":0, "y":4.5, "w":1.25}, {"x":1.25, "y":4.5}, {"label":"Z", "x":2.25, "y":4.5}, {"label":"X", "x":3.25, "y":4.5}, {"label":"C", "x":4.25, "y":4.5}, {"label":"V", "x":5.25, "y":4.5}, {"label":"B", "x":6.25, "y":4.5}, {"label":"N", "x":7.25, "y":4.5}, {"label":"M", "x":8.25, "y":4.5}, {"label":"<", "x":9.25, "y":4.5}, {"label":">", "x":10.25, "y":4.5}, {"label":"?", "x":11.25, "y":4.5}, {"label":"Shift", "x":12.25, "y":4.5, "w":1.75}, {"x":14, "y":4.5}, {"label":"\u2191", "x":16.25, "y":4.5}, {"label":"Ctrl", "x":0, "y":5.5, "w":1.25}, {"label":"Win", "x":1.25, "y":5.5, "w":1.25}, {"label":"Alt", "x":2.5, "y":5.5, "w":1.25}, {"x":3.75, "y":5.5, "w":6.25}, {"label":"Alt", "x":10, "y":5.5, "w":1.25}, {"label":"Win", "x":11.25, "y":5.5, "w":1.25}, {"label":"Menu", "x":12.5, "y":5.5, "w":1.25}, {"label":"Ctrl", "x":13.75, "y":5.5, "w":1.25}, {"label":"\u2190", "x":15.25, "y":5.5}, {"label":"\u2193", "x":16.25, "y":5.5}, {"label":"\u2192", "x":17.25, "y":5.5}]
+        }
+    }
+}

keyboards/h87a/keymaps/default/keymap.c

@@ -0,0 +1,89 @@
+/* Copyright 2018 Josh Hinnebusch
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [0] = LAYOUT_all(
+    KC_ESC,           KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,    KC_F10,     KC_F11,     KC_F12,                  KC_PSCR, KC_SLCK, KC_PAUS,
+    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,     KC_MINS,    KC_EQL,     KC_BSPC,   KC_BSPC,      KC_INS,  KC_HOME, KC_PGUP,
+    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,     KC_LBRC,    KC_RBRC,    KC_BSLS,                 KC_DEL,  KC_END,  KC_PGDN,
+    KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN,  KC_QUOT,    KC_NUHS,    KC_ENT,
+    KC_LSFT, KC_NUBS, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,   KC_SLSH,    KC_LSFT,    KC_TRNS,                          KC_UP,
+    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                      KC_RALT,  KC_RGUI,    MO(1),      KC_RCTL,                 KC_LEFT, KC_DOWN, KC_RGHT),
+
+  [1] = LAYOUT_all(
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI,          RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI,                        BL_TOGG, BL_DEC,  BL_INC,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,               KC_TRNS, KC_TRNS, KC_VOLU,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RESET,  KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                        KC_MPLY, KC_MNXT, KC_VOLD,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+};
+
+const uint16_t PROGMEM fn_actions[] = {
+
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+  // MACRODOWN only works in this function
+      switch(id) {
+        case 0:
+          if (record->event.pressed) {
+            register_code(KC_RSFT);
+          } else {
+            unregister_code(KC_RSFT);
+          }
+        break;
+      }
+    return MACRO_NONE;
+};
+
+
+void matrix_init_user(void) {
+
+}
+
+void matrix_scan_user(void) {
+
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  return true;
+}
+
+void led_init_ports(void) {
+  DDRD |= (1<<5); // OUT
+  DDRE |= (1<<6); // OUT
+}
+
+void led_set_user(uint8_t usb_led) {
+
+  if (usb_led & (1 << USB_LED_CAPS_LOCK)) {
+    DDRD |= (1 << 5); PORTD &= ~(1 << 5);
+  } else {
+    DDRD &= ~(1 << 5); PORTD &= ~(1 << 5);
+  }
+
+  if (usb_led & (1 << USB_LED_SCROLL_LOCK)) {
+    DDRE |= (1 << 6); PORTE &= ~(1 << 6);
+  } else {
+    DDRE &= ~(1 << 6); PORTE &= ~(1 << 6);
+  }
+
+}

keyboards/h87a/readme.md

@@ -0,0 +1,42 @@
+h87a
+===
+
+A QMK-powered replacement PCB for custom TKL keyboards. This PCB has the same size of the b.87 PCB, while using the USB port placement and spacebar stabilizer orientation as the a.87 PCB.
+
+Keyboard Maintainer: hineybush (Josh Hinnebusch)  
+
+Hardware Supported: h87a Rev 1  
+
+Hardware Availability: Currently prototyped, group buy TBD  
+
+Make example for this keyboard (after setting up your build environment):
+     
+     make h87a:default
+   
+## h87a hardware information
+
+Controller: Atmega32u4
+
+    /* Column pin configuration
+    * col: 0   1   2   3   4   5   6   7   8   
+    * pin: F0  F1  F4  F5  F6  F7  C7  C6  D2
+    */
+     
+    /* Row pin configuration
+    * row: 0   1   2   3   4   5   6   7   8   9   10  11
+    * pin: B0  B1  B2  B3  D0  D1  B5  B6  D7  B4  D6  D4  (Rev 1)
+    */
+    
+The H87a PCB utilizes duplex matrix organization.
+
+    Caps Lock LED: D5
+    Scroll Lock LED: E6
+    Num Lock LED: not supported
+    Backlight Pin: B7
+    RGB Data Pin: D3
+    
+To connect the Caps Lock LED to the main backlight matrix, jump the middle pad and the left pad on J1. To use the Caps Lock LED as an indicator, jump the middle pad and the right pad on J1.
+
+To connect the Scroll Lock LED to the main backlight matrix, jump the middle pad and the right pad on J2. To use the Scroll Lock LED as an indicator, jump the middle pad and the left pad on J2.
+
+Note: The different orientations of J1 and J2 will be fixed with Rev 2.

keyboards/h87a/rules.mk

@@ -0,0 +1,70 @@
+# MCU name
+#MCU = at90usb1286
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+
+# Boot Section Size in *bytes*
+#   Teensy halfKay   512
+#   Teensy++ halfKay 1024
+#   Atmel DFU loader 4096
+#   LUFA bootloader  4096
+#   USBaspLoader     2048
+OPT_DEFS += -DBOOTLOADER_SIZE=4096
+
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no      # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = no        # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality on B7 by default
+RGBLIGHT_ENABLE = yes       # Enable RGB underglow
+MIDI_ENABLE = no            # MIDI support (+2400 to 4200, depending on config)
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no           # Audio output on port C6
+FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
+EXTRAFLAGS += -flto

keyboards/handwired/atreus50/keymaps/ajp10304/config.h

@@ -0,0 +1,14 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+#define PREVENT_STUCK_MODIFIERS
+
+#undef MATRIX_ROW_PINS
+#undef MATRIX_COL_PINS
+
+#define MATRIX_ROW_PINS { D4, D5, C7, C6 }
+#define MATRIX_COL_PINS { F0, F1, F4, F5, F6, D7, D1, B7, D0, B3, B2, B1, B0 }
+
+#endif

keyboards/handwired/atreus50/keymaps/ajp10304/keymap.c

@@ -0,0 +1,348 @@
+#include "atreus50.h"
+#include "action_layer.h"
+#include "eeconfig.h"
+#include "keymap_uk.h"
+
+extern keymap_config_t keymap_config;
+
+enum planck_layers {
+  _QWERTY,
+  _MAC,
+  _LOWER,
+  _MLWR,
+  _RAISE,
+  _MRSE,
+  _FUNC,
+  _MFNC,
+  _FUNC2,
+  _MFNC2,
+  _ADJUST,
+  _MOUSE
+};
+
+enum planck_keycodes {
+  QWERTY = SAFE_RANGE,
+  MAC,
+  FUNC,
+  MFNC,
+  FUNC2,
+  MFNC2,
+  LOWER,
+  MLWR,
+  RAISE,
+  MRSE,
+  MOUSE,
+  DYNAMIC_MACRO_RANGE
+};
+
+#include "dynamic_macro.h"
+
+// Fillers to make layering more clear
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty
+ * ,-----------------------------------------|             |-----------------------------------------.
+ * | Esc  |   Q  |   W  |   E  |   R  |   T  |             |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * | Tab  |   A  |   S  |   D  |   F  |   G  |             |   H  |   J  |   K  |   L  |  ;:  | Enter|
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * | Shft |   Z  |   X  |   C  |   V  |   B  |             |   N  |   M  |  ,<  |  .>  |  /?  | Shft |
+ * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Fn   | Ctrl | Alt  | GUI  |Lower | Bksp | Ctrl | Alt  |Space |Raise | Shift| MENU | Ctrl | Fn2  |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_QWERTY] = KEYMAP(
+  KC_ESC,                KC_Q,       KC_W,        KC_E,      KC_R,    KC_T,                      KC_Y,    KC_U,    KC_I,      KC_O,      KC_P,       KC_BSPC              ,
+  MT(MOD_LSFT, KC_TAB),  KC_A,       KC_S,        KC_D,      KC_F,    KC_G,                      KC_H,    KC_J,    KC_K,      KC_L,      KC_SCLN,    MT(MOD_RSFT, KC_ENT) ,
+  KC_LSHIFT,             KC_Z,       KC_X,        KC_C,      KC_V,    KC_B,                      KC_N,    KC_M,    KC_COMM,   KC_DOT,    KC_SLSH,    KC_RSHIFT            ,
+  MO(_FUNC),             KC_LCTL,    KC_LALT,     KC_LGUI,   LOWER,   KC_BSPC, KC_LCTL, KC_LALT, KC_SPC,  RAISE,   KC_LSHIFT, KC_BTN2,   KC_RCTL,    MO(_FUNC2)
+),
+
+/* Function
+ * ,------------------------------------------             |-----------------------------------------.
+ * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |             |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+ * |------+------+------+------+------+-------             |------+------+------+------+------+------|
+ * |  1!  |  2"  |  3£  |  4$  |  5%  |  6^  |             |  7&  |  8*  |  9(  |  0)  |  ~   |INSERT|
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * | Shift|  \|  |  `¬  |  #~  |   *  |  -_  |             |  =+  |  \|  |  [{  |  ]}  |  '@  |Shift |
+ * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Fn   | Ctrl | Alt  | GUI  |Lower | Bksp | Ctrl | Alt  |Space |Mouse | MENU | Alt  | Ctrl | Fn   |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_FUNC] = KEYMAP(
+  KC_F1,     KC_F2,           KC_F3,    KC_F4,         KC_F5,   KC_F6,                     KC_F7,   KC_F8,      KC_F9,    KC_F10,  KC_F11,  KC_F12               ,
+  KC_1,      KC_2,            KC_3,     KC_4,          KC_5,    KC_6,                      KC_7,    KC_8,       KC_9,     KC_0,    UK_TILD, KC_INSERT            ,
+  KC_LSHIFT, KC_NONUS_BSLASH, KC_GRAVE, KC_NONUS_HASH, KC_PAST, KC_MINS,                   KC_EQL,  KC_BSLASH,  KC_LBRC,  KC_RBRC, KC_QUOT, MT(MOD_RSFT, KC_ENT) ,
+  _______,   _______,         _______,  _______,       _______, _______, _______, _______, _______, MO(_MOUSE), _______,  _______, _______, _______
+),
+
+/* Lower
+ * ,------------------------------------------             |-----------------------------------------.
+ * |  1!  |  2"  |  3£  |  4$  |  5%  |  6^  |             |  7&  |  8*  |  9(  |  0)  | DEL  | Bksp |
+ * |------+------+------+------+------+-------             |------+------+------+------+------+------|
+ * |  !   |   "  |   £  |   $  |   %  |   ^  |             |   &  |   *  |   (  |   )  |WrdDel|WrdBks|
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * | Shift|  \|  |  `¬  |  #~  |  '@  |  -_  |             |  =+  |  #~  |  [{  |  ]}  |  '@  |Shift |
+ * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |Lower | Del  | Ctrl | Alt  |Space |      | Next | Vol- | Vol+ | Play |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_LOWER] = KEYMAP(
+  KC_1,        KC_2,            KC_3,        KC_4,           KC_5,        KC_6,                         KC_7,       KC_8,          KC_9,       KC_0,       KC_DEL,       KC_BSPC              ,
+  LSFT(KC_1),  LSFT(KC_2),      LSFT(KC_3),  LSFT(KC_4),     LSFT(KC_5),  LSFT(KC_6),                   LSFT(KC_7), LSFT(KC_8),    LSFT(KC_9), LSFT(KC_0), LCTL(KC_DEL), LCTL(KC_BSPC)        ,
+  KC_LSPO,     KC_NONUS_BSLASH, KC_GRAVE,    KC_NONUS_HASH,  KC_QUOT,     KC_MINS,                      KC_EQL,     KC_NONUS_HASH, KC_LBRC,    KC_RBRC,    KC_QUOT,      MT(MOD_RSFT, KC_ENT) ,
+  _______,     _______,         _______,     _______,        _______,     KC_DEL,     _______, _______, _______,    _______,       KC_MNXT,    KC_VOLD,    KC_VOLU,      KC_MPLY
+),
+
+/* Raise
+ * ,------------------------------------------             |-----------------------------------------.
+ * |   `  |      |WRDSEL|  [   |   ]  |      |             |      | PGUP | HOME |PGDOWN|      |PRNTSC|
+ * |------+------+------+------+------+-------             |------+------+------+------+------+------|
+ * |   `  |      |      |  (   |   )  |      |             |      | HOME |  UP  | END  |      |ZOOM +|
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * |      |      |      |  {   |   }  |      |             |  |<  | LEFT | DOWN |RIGHT |  >|  |ZOOM -|
+ * |------+------+------+------+------+------|------+------+------+------+------+------+------+------|
+ * | Mouse|      |      |      |      |  Alt | Ctrl | Alt  |Enter |Raise |      |      |      |      |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_RAISE] = KEYMAP(
+  KC_GRV,     XXXXXXX, M(1),    KC_LBRC,       KC_RBRC,       XXXXXXX,                   XXXXXXX,       KC_PGUP,  KC_HOME,  KC_PGDOWN,  XXXXXXX,        KC_PSCREEN         ,
+  KC_GRV,     XXXXXXX, XXXXXXX, LSFT(KC_9),    LSFT(KC_0),    XXXXXXX,                   XXXXXXX,       KC_HOME,  KC_UP,    KC_END,     XXXXXXX,        LCTL(LSFT(KC_EQL)) ,
+  _______,    XXXXXXX, XXXXXXX, LSFT(KC_LBRC), LSFT(KC_RBRC), XXXXXXX,                   LCTL(KC_LEFT), KC_LEFT,  KC_DOWN,  KC_RIGHT,   LCTL(KC_RIGHT), LCTL(KC_MINS)      ,
+  MO(_MOUSE), _______, _______, _______,       _______,       KC_LALT, _______, _______, KC_ENT,        _______,  XXXXXXX,  _______,    _______,        _______
+),
+
+/* Adjust (Lower + Raise)
+ * ,------------------------------------------             |-----------------------------------------.
+ * | ???? | Reset|Qwerty|      |      | REC1 |             | REC2 |      |      |      |      |  Del |
+ * |------+------+------+------+------+-------             |------+------+------+------+------+------|
+ * | CAPS |      |      |      |      | PLAY1|             | PLAY2| Mute | Vol+ | Play |      |      |
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * | PC/MC|      |      |      |      | STOP |             | STOP | Prev | Vol- | Next |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |      |      |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_ADJUST] = KEYMAP(
+  M(0),     RESET,   QWERTY,  _______, _______, DYN_REC_START1,                    DYN_REC_START2,  _______,             _______,           _______,              _______,  KC_DEL  ,
+  KC_CAPS,  _______, _______, _______, _______, DYN_MACRO_PLAY1,                   DYN_MACRO_PLAY2, KC_AUDIO_MUTE,       KC_AUDIO_VOL_UP,   KC_MEDIA_PLAY_PAUSE,  _______,  _______ ,
+  TG(_MAC), _______, _______, _______, _______, DYN_REC_STOP,                      DYN_REC_STOP,    KC_MEDIA_PREV_TRACK, KC_AUDIO_VOL_DOWN, KC_MEDIA_NEXT_TRACK,  _______,  _______ ,
+  _______,  _______, _______, _______, _______, _______,         _______, _______, _______,         _______,             _______,           _______,              _______,  _______ 
+),
+
+/* Mouse
+ * ,------------------------------------------             |-----------------------------------------.
+ * | ESC  |      |      |      |      |      |             |      |      |      |      |      |      |
+ * |------+------+------+------+------+-------             |------+------+------+------+------+------|
+ * | ACC0 | ACC1 | ACC2 |      |      |      |             |      | BTN1 |  UP  | BTN2 |      |      |
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * | ACC0 | ACC1 | ACC2 |      |      |      |             |      | LEFT | DOWN |RIGHT |      |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |      |      |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_MOUSE] = KEYMAP(
+    KC_ESC ,      _______,      _______,      _______, _______, _______,                   _______, _______,    _______,     _______,    _______, _______ ,
+    KC_MS_ACCEL0, KC_MS_ACCEL1, KC_MS_ACCEL2, _______, _______, _______,                   _______, KC_MS_BTN1, KC_MS_UP,   KC_MS_BTN2,  _______, _______ ,
+    KC_MS_ACCEL0, KC_MS_ACCEL1, KC_MS_ACCEL2, _______, _______, _______,                   _______, KC_MS_LEFT, KC_MS_DOWN, KC_MS_RIGHT, _______, _______ ,
+    _______,      _______,      _______,      _______, _______, _______, _______, _______, _______, _______,    _______,    _______,     _______, _______
+),
+
+/* Function 2 (Right hand side)
+ * ,------------------------------------------             |-----------------------------------------.
+ * |      |      |WRDSEL|      |      |      |             | LNDEL|      |      |      |      |      |
+ * |------+------+------+------+------+-------             |------+------+------+------+------+------|
+ * |      |      | LNSEL| DUP  |      |      |             |      |      |LNJOIN|      |      |      |
+ * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ * |      | UNDO | CUT  | COPY | PASTE|      |             |      |      |      |      |      | MODE |
+ * |------+------+------+------+------+------|------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |      |      |      |      |      |      |      |      |      |
+ * `-------------------------------------------------------------------------------------------------'
+ */
+[_FUNC2] = KEYMAP(
+    _______,  _______,    M(1),       _______,    _______,    _______,                   M(5),    _______, _______, _______, _______, _______,
+    _______,  _______,    M(3),       M(7),       _______,    _______,                   _______, M(10),   _______, _______, _______, _______,
+    _______,  LCTL(KC_Z), LCTL(KC_X), LCTL(KC_C), LCTL(KC_V), _______,                   _______, _______, _______, _______, _______, M(98)  ,
+    _______,  _______,    _______,    _______,    _______,    _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+[_MAC] = KEYMAP(
+    _______,  _______, _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______,
+    _______,  _______, _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______,
+    _______,  _______, _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______,
+    MFNC,     _______, _______, _______, MLWR,    _______, _______, _______, _______, MRSE,    _______, _______, _______, MFNC2
+),
+
+[_MLWR] = KEYMAP(
+    _______,  _______,  _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______,
+    _______,  _______,  _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______,
+    _______,  _______,  _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______,
+    _______,  _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+[_MRSE] = KEYMAP(
+    _______,  _______,  M(2),    _______, _______, _______,                   _______,       _______,    _______, _______,    _______,        _______       ,
+    _______,  _______,  _______, _______, _______, _______,                   _______,       LCTL(KC_A), _______, LCTL(KC_E), _______,        LGUI(KC_EQL)  ,
+    _______,  _______,  _______, _______, _______, _______,                   LALT(KC_LEFT), _______,    _______, _______,    LALT(KC_RIGHT), LGUI(KC_MINS) ,
+    _______,  _______,  _______, _______, _______, _______, _______, _______, _______,       _______,    _______, _______,    _______,        _______
+),
+
+[_MFNC] = KEYMAP(
+    _______,  _______,  _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______       ,
+    _______,  _______,  _______, _______, _______, _______,                   _______, _______, _______, _______, _______, LGUI(KC_PENT) ,
+    _______,  _______,  _______, _______, _______, _______,                   _______, _______, _______, _______, _______, _______       ,
+    _______,  _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+[_MFNC2] = KEYMAP(
+    _______,  _______,    M(2),       _______,    _______,    _______,                   M(6),    _______, _______, _______, _______, _______,
+    _______,  _______,    M(4),       M(8),       _______,    _______,                   _______, M(10),   _______, _______, _______, _______,
+    _______,  LGUI(KC_Z), LGUI(KC_X), LGUI(KC_C), LGUI(KC_V), _______,                   _______, _______, _______, _______, _______, M(99)  ,
+    _______,  _______,    _______,    _______,    _______,    _______, _______, _______, _______, _______, _______, _______, _______, _______
+)
+
+};
+
+void persistant_default_layer_set(uint16_t default_layer) {
+  eeconfig_update_default_layer(default_layer);
+  default_layer_set(default_layer);
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+
+  if (!process_record_dynamic_macro(keycode, record)) {
+      return false;
+  }
+
+   switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+        persistant_default_layer_set(1UL<<_QWERTY);
+      }
+      return false;
+    case LOWER:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+    case RAISE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+    case MLWR:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        layer_on(_MLWR);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_LOWER);
+        layer_off(_MLWR);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+    case MRSE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        layer_on(_MRSE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_RAISE);
+        layer_off(_MRSE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+    case MFNC:
+      if (record->event.pressed) {
+        layer_on(_FUNC);
+        layer_on(_MFNC);
+      } else {
+        layer_off(_FUNC);
+        layer_off(_MFNC);
+      }
+      return false;
+    case MFNC2:
+      if (record->event.pressed) {
+        layer_on(_FUNC2);
+        layer_on(_MFNC2);
+      } else {
+        layer_off(_FUNC2);
+        layer_off(_MFNC2);
+      }
+      return false;
+    }
+  return true;
+}
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t keycode, uint8_t opt) {
+  // These would trigger when you hit a key mapped as M(0)
+  if (record->event.pressed) {
+    switch(keycode) {
+      case 0: // Some custom string here
+        SEND_STRING("");
+        return false;
+
+      case 1: // Word Select
+        SEND_STRING(SS_DOWN(X_LCTRL) SS_TAP(X_RIGHT) SS_DOWN(X_LSHIFT) SS_TAP(X_LEFT) SS_UP(X_LSHIFT) SS_UP(X_LCTRL));
+        return false;
+
+      case 2: // Word Select Mac
+        SEND_STRING(SS_DOWN(X_LALT) SS_TAP(X_RIGHT) SS_DOWN(X_LSHIFT) SS_TAP(X_LEFT) SS_UP(X_LSHIFT) SS_UP(X_LALT));
+        return false;
+
+      case 3: // Line Select
+        SEND_STRING(SS_TAP(X_HOME) SS_DOWN(X_LSHIFT) SS_TAP(X_END) SS_UP(X_LSHIFT));
+        return false;
+
+      case 4: // Line Select Mac
+        SEND_STRING(SS_LCTRL("a") SS_DOWN(X_LSHIFT) SS_LCTRL("e") SS_UP(X_LSHIFT));
+        return false;
+
+      case 5: // Line Delete
+        SEND_STRING(SS_TAP(X_HOME) SS_DOWN(X_LSHIFT) SS_TAP(X_END) SS_UP(X_LSHIFT));
+        SEND_STRING(SS_TAP(X_BSPACE));
+        return false;
+
+      case 6: // Line Delete Mac
+        SEND_STRING(SS_LCTRL("a") SS_DOWN(X_LSHIFT) SS_LCTRL("e") SS_UP(X_LSHIFT));
+        SEND_STRING(SS_TAP(X_BSPACE));
+        return false;
+
+      case 7: // Duplicate Selection
+        SEND_STRING(SS_LCTRL("c") SS_TAP(X_RIGHT) SS_LCTRL("v"));
+        return false;
+
+      case 8: // Duplicate Selection Mac
+        SEND_STRING(SS_LGUI("c") SS_TAP(X_RIGHT) SS_LGUI("v"));
+        return false;
+
+      case 9: // Join line
+        SEND_STRING(SS_TAP(X_END) SS_TAP(X_DELETE));
+        return false;
+
+      case 10: // Join line Mac
+        SEND_STRING(SS_LCTRL("e") SS_TAP(X_DELETE));
+        return false;
+
+      case 98: // Print mode
+        SEND_STRING("PC");
+        return false;
+
+      case 99: // Print mode
+        SEND_STRING("OSX");
+        return false;
+    }
+  }
+  return MACRO_NONE;
+};

keyboards/handwired/atreus50/keymaps/ajp10304/readme.md

@@ -0,0 +1,108 @@
+# AJP10304 Custom Atreus50 Layout
+# Also available for the Planck and JJ40
+
+**Note:** In the tables below where there are two characters on a key,
+the second is the output when shift is applied.
+
+**Note:** The below tables assume a UK layout.
+
+##### Main Qwerty Layer
+
+* Tab: when held, operates as shift.
+* Enter: when held, operates as shift.
+* MENU: perform right-click
+
+|      |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| ---- |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| ----:|
+| Esc  |   Q  |   W  |   E  |   R  |   T  |      |      |   Y  |   U  |   I  |   O  |   P  | Bksp |
+| Tab  |   A  |   S  |   D  |   F  |   G  |      |      |   H  |   J  |   K  |   L  |  ;:  | Enter|
+| Shft |   Z  |   X  |   C  |   V  |   B  |      |      |   N  |   M  |  ,<  |  .>  |  /?  | Shft |
+| Fn   | Ctrl | Alt  | GUI  |Lower | Bksp | Ctrl | Alt  |Space |Raise | Shift| MENU | Ctrl | Fn2  |
+
+##### Function Layer
+Activated when `fn` held in the above `qwerty` layer.
+
+|       |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
+|  F1   |  F2  |  F3  |  F4  |  F5  |  F6  |      |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+|  1!   |  2"  |  3£  |  4$  |  5%  |  6^  |      |      |  7&  |  8*  |  9(  |  0)  |  ~   |INSERT|
+| Shift |  \|  |  `¬  |  #~  |   *  |  -_  |      |      |  =+  |  \|  |  [{  |  ]}  |  '@  |Shift |
+| Fn    | Ctrl | Alt  | GUI  |Lower | Bksp | Ctrl | Alt  |Space |Mouse | MENU | Alt  | Ctrl | Fn2  |
+
+##### Lower Layer
+Activated when `Lower` is held in the above `qwerty` layer.
+
+* Numbers are along the top row, their shifted counterparts are on row 2.
+* WrdBks: `backspace` with `ctrl` applied. I.e. delete a word.
+* WrdDel: `delete` with `ctrl` applied. I.e. forward delete a word.
+
+|       |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
+|  1!   |  2"  |  3£  |  4$  |  5%  |  6^  |      |      |  7&  |  8*  |  9(  |  0)  | DEL  | Bksp |
+|  !    |   "  |   £  |   $  |   %  |   ^  |      |      |   &  |   *  |   (  |   )  |WrdDel|WrdBks|
+| Shift |  \|  |  `¬  |  #~  |  '@  |  -_  |      |      |  =+  |  #~  |  [{  |  ]}  |  '@  |Shift |
+|       |      |      |      |Lower | Del  | Ctrl | Alt  |Space |      | Next | Vol- | Vol+ | Play |
+
+ ##### Raise Layer
+ Activated when `Raise` is held in the above `qwerty` layer.
+
+ * Preferred layer for typing brackets.
+ * Allows for cursor navigation to be used solely with the right hand.
+ * WRDSEL: Select the word where the cursor is.
+ * |< and >|: Apply `ctrl` to `left` and `right` respectively for word jumping.
+
+|       |      |      |      |      |      |      |      |       |      |      |      |       |      |
+| :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---: | :---:| :---:| :---:| :---: | :---:|
+|   `   |      |WRDSEL|  [   |   ]  |      |      |      |       | PGUP | HOME |PGDOWN|       |PRNTSC|
+|   `   |      |      |  (   |   )  |      |      |      |       | HOME |  UP  | END  |       |ZOOM +|
+|       |      |      |  {   |   }  |      |      |      |&#124;<| LEFT | DOWN |RIGHT |>&#124;|ZOOM -|
+| Mouse |      |      |      |      |  Alt | Ctrl | Alt  | Enter |Raise |      |      |       |      |
+
+##### Lower + Raise
+Activated when `Lower` and `Raise` are held together in the above `qwerty` layer.
+
+* Audio controls in the same position as cursor keys from the `Raise` layer.
+* ????: Runs a macro for outputting a text string.  Do not use this store passwords.
+* Reset: Enter bootloader for flashing firmware to the keyboard.
+* CAPS: Toggle caps lock.
+* Macro functions: Allows recording of macros.  To start recording the macro, press either REC1 or REC2. 
+To finish the recording, press STOP. To replay the macro, press either PLAY1 or PLAY2.
+* MAC: Toggle MAC OS extensions to layers. This allows MLWR to be enabled with LOWER,
+MRSE with RAISE, MFNC with FUNC and MFNC2 with FUNC2 respectively.
+
+|       |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
+| ????  | Reset|Qwerty|      |      | REC1 |      |      | REC2 |      |      |      |      |  Del |
+| CAPS  |      |      |      |      | PLAY1|      |      |PLAY2 | Mute | Vol+ | Play |      |      |
+| MAC   |      |      |      |      | STOP1|      |      |STOP2 | Prev | Vol- | Next |      |      |
+|       |      |      |      |      |      | Ctrl | Alt  |      |      | DYN  |      |      |      |
+
+##### Function 2 Layer
+Activated when `fn` held in the above `qwerty` layer.
+* WRDSEL: Select the word where the cursor is.
+* LNDEL: Delete the line where the cursor is.
+* LNSEL: Select the line where the cursor is.
+* DUP: Duplicate the selected text.
+* LNJOIN: Join the line where the cursor is with the following line.
+* MODE: Print either `PC` or `OSX` depending on what layer mode is active.
+
+|       |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| :---: | :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
+|       |      |WRDSEL|      |      |      |      |      | LNDEL|      |      |      |      |      |
+|       |      | LNSEL| DUP  |      |      |      |      |      |      |LNJOIN|      |      |      |
+|       | UNDO | CUT  | COPY | PASTE|      |      |      |      |      |      |      |      | MODE |
+|       |      |      |      |      |      | Ctrl | Alt  |      |      |      |      |      |      |
+
+##### Mouse Layer
+Activated when `fn` and `raise` held together.
+
+|       |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| :---: | :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
+| ESC   |      |      |      |      |      |      |      |      |      |      |      |      |      |
+| ACC0  | ACC1 | ACC2 |      |      |      |      |      |      | BTN1 |  UP  | BTN2 |      |      |
+| ACC0  | ACC1 | ACC2 |      |      |      |      |      |      | LEFT | DOWN | RIGHT|      |      |
+|       |      |      |      |      |      | Ctrl | Alt  |      |      |      |      |      |      |
+
+
+##Program Command
+teensy_loader_cli -w -mmcu=atmega32u4 handwired_atreus50_ajp10304.hex

keyboards/handwired/atreus50/keymaps/ajp10304/rules.mk

@@ -0,0 +1,12 @@
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif
+
+AUDIO_ENABLE = no
+MOUSEKEY_ENABLE = yes
+
+TEMP := $(OPT_DEFS)
+OPT_DEFS = $(filter-out -DBOOTLOADER_SIZE=4096,$(TEMP))
+OPT_DEFS += -DBOOTLOADER_SIZE=512
+
+BOOTLOADER = halfkay

keyboards/helix/config.h

@@ -21,8 +21,22 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #include "config_common.h"
 
-#ifdef SUBPROJECT_rev1
+// GCC include 'config.h" sequence in qmk_firmware/keyboards/helix/
-    #include "rev1/config.h"
+//   -include keyboards/helix/config.h
-#endif
+//   -include keyboards/helix/rev?/config.h
+//   -include keyboards/helix/rev?/keymaps/MAPNAME/config.h
+//   XXXX.c
 
-#endif
+#include <serial_config.h>
+
+// GCC include search path in qmk_firmare/keyboards/helix/
+//    #include "..." search starts here:
+//    #include <...> search starts here:
+//     keyboards/helix/rev?/keymaps/MAPNAME
+//     keyboards/helix
+//     keyboards/helix/rev?
+//     .
+//     ./tmk_core
+//     ......
+
+#endif /* CONFIG_H */

keyboards/helix/helix.h

@@ -8,48 +8,6 @@
     #include "rev2.h"
 #endif
 
-#if HELIX_ROWS == 3
-  #define LAYOUT_kc( \
-      L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
-      L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
-      L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
-      ) \
-      LAYOUT( \
-          KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
-          KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
-          KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
-      )
-#elif HELIX_ROWS == 4
-  // Used to create a keymap using only KC_ prefixed keys
-  #define LAYOUT_kc( \
-      L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
-      L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
-      L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
-      L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35 \
-      ) \
-      LAYOUT( \
-          KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
-          KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
-          KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
-          KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35 \
-      )
-#else
-  #define LAYOUT_kc( \
-      L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
-      L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
-      L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
-      L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35, \
-      L40, L41, L42, L43, L44, L45, R40, R41, R42, R43, R44, R45 \
-      ) \
-      LAYOUT( \
-          KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
-          KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
-          KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
-          KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, \
-          KC_##L40, KC_##L41, KC_##L42, KC_##L43, KC_##L44, KC_##L45, KC_##R40, KC_##R41, KC_##R42, KC_##R43, KC_##R44, KC_##R45 \
-      )
-#endif
-
 #include "quantum.h"
 
 #endif

keyboards/helix/rev1/config.h

@@ -19,8 +19,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef REV1_CONFIG_H
 #define REV1_CONFIG_H
 
-#include "../config.h"
-
 /* USB Device descriptor parameter */
 #define VENDOR_ID       0xFEED
 #define PRODUCT_ID      0x3060

keyboards/helix/rev1/keymaps/OLED_sample/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 /* Use I2C or Serial */
 
 #define USE_I2C
@@ -37,8 +35,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #define SSD1306OLED
 
-#define USE_SERIAL_PD2
-
 #define PREVENT_STUCK_MODIFIERS
 #define TAPPING_FORCE_HOLD
 #define TAPPING_TERM 100

keyboards/helix/rev1/keymaps/OLED_sample/serial_config.h

@@ -0,0 +1,16 @@
+#ifndef SOFT_SERIAL_CONFIG_H
+#define SOFT_SERIAL_CONFIG_H
+
+/* Soft Serial defines */
+#define SERIAL_PIN_DDR DDRD
+#define SERIAL_PIN_PORT PORTD
+#define SERIAL_PIN_INPUT PIND
+#define SERIAL_PIN_MASK _BV(PD2)
+#define SERIAL_PIN_INTERRUPT INT2_vect
+
+#define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
+#define SERIAL_MASTER_BUFFER_LENGTH 1
+
+//// #error rev1/keymaps/OLED_sample serial config
+
+#endif /* SOFT_SERIAL_CONFIG_H */

keyboards/helix/rev1/keymaps/default/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 /* Use I2C or Serial, not both */
 
 #define USE_SERIAL

keyboards/helix/rev1/rev1.h

@@ -10,8 +10,8 @@
 #ifdef USE_I2C
 #include <stddef.h>
 #ifdef __AVR__
-	#include <avr/io.h>
+  #include <avr/io.h>
-	#include <avr/interrupt.h>
+  #include <avr/interrupt.h>
 #endif
 #endif
 
@@ -25,7 +25,7 @@
   #define LAYOUT( \
     L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
     L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
-    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
+    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25  \
     ) \
     { \
       { L00, L01, L02, L03, L04, L05 }, \
@@ -41,7 +41,7 @@
   #define LAYOUT( \
     L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
     L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
-    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
+    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25  \
     ) \
     { \
       { L00, L01, L02, L03, L04, L05 }, \
@@ -142,4 +142,46 @@
   #error "expected HELIX_ROWS 3 or 4 or 5"
 #endif
 
+// Used to create a keymap using only KC_ prefixed keys
+#if HELIX_ROWS == 3
+  #define LAYOUT_kc( \
+    L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
+    L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
+    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25  \
+    ) \
+    LAYOUT( \
+      KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
+      KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
+      KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25  \
+    )
+#elif HELIX_ROWS == 4
+  #define LAYOUT_kc( \
+    L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
+    L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
+    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
+    L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35 \
+    ) \
+    LAYOUT( \
+      KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
+      KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
+      KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
+      KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35 \
+    )
+#else
+  #define LAYOUT_kc( \
+    L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
+    L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
+    L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
+    L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35, \
+    L40, L41, L42, L43, L44, L45, R40, R41, R42, R43, R44, R45 \
+    ) \
+    LAYOUT( \
+      KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
+      KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
+      KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
+      KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, \
+      KC_##L40, KC_##L41, KC_##L42, KC_##L43, KC_##L44, KC_##L45, KC_##R40, KC_##R41, KC_##R42, KC_##R43, KC_##R44, KC_##R45 \
+    )
+#endif
+
 #endif

keyboards/helix/rev1/serial_config.h

@@ -0,0 +1,16 @@
+#ifndef SOFT_SERIAL_CONFIG_H
+#define SOFT_SERIAL_CONFIG_H
+
+/* Soft Serial defines */
+#define SERIAL_PIN_DDR DDRD
+#define SERIAL_PIN_PORT PORTD
+#define SERIAL_PIN_INPUT PIND
+#define SERIAL_PIN_MASK _BV(PD0)
+#define SERIAL_PIN_INTERRUPT INT0_vect
+
+#define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
+#define SERIAL_MASTER_BUFFER_LENGTH 1
+
+/// #error rev1 serial config
+
+#endif /* SOFT_SERIAL_CONFIG_H */

keyboards/helix/rev2/config.h

@@ -19,8 +19,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef REV2_CONFIG_H
 #define REV2_CONFIG_H
 
-#include "../config.h"
-
 /* USB Device descriptor parameter */
 #define VENDOR_ID       0xFEED
 #define PRODUCT_ID      0x3060
@@ -37,7 +35,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /* Use I2C or Serial */
 #define USE_I2C
 #define USE_SERIAL
-#define USE_SERIAL_PD2
 //#define USE_MATRIX_I2C
 
 /* Select hand configuration */

keyboards/helix/rev2/keymaps/default/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 // place overrides here
 
 #endif /* CONFIG_USER_H */

keyboards/helix/rev2/keymaps/edvorakjp/config.h

@@ -0,0 +1,8 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#undef TAPPING_FORCE_HOLD
+#undef TAPPING_TERM
+#define TAPPING_TERM 120
+
+#endif /* CONFIG_USER_H */

keyboards/helix/rev2/keymaps/edvorakjp/keymap.c

@@ -0,0 +1,61 @@
+#include QMK_KEYBOARD_H
+#include "split_util.h"
+#include "keymap_xrows.h"
+#ifdef SSD1306OLED
+  #include "oled.h"
+#endif
+
+// keymaps definitions are moved to keymap_Xrows.c.
+
+bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
+  switch(keycode) {
+    case KC_LOCK:
+      if (record->event.pressed) {
+        if (edvorakjp_config.enable_kc_lang) {
+          SEND_STRING( SS_LCTRL(SS_LSFT(SS_TAP(X_POWER))) );
+        } else {
+          SEND_STRING( SS_LGUI("l") );
+        }
+      }
+      return false;
+  }
+  return true;
+}
+
+#ifdef SSD1306OLED
+void matrix_init_keymap(void) {
+  //SSD1306 OLED init, make sure to add #define SSD1306OLED in config.h
+  iota_gfx_init(!has_usb());   // turns on the display
+}
+
+void matrix_scan_user(void) {
+  iota_gfx_task();  // this is what updates the display continuously
+}
+#endif
+
+#ifdef RGBLIGHT_ENABLE
+uint32_t layer_state_set_keymap(uint32_t state) {
+  rgblight_mode_noeeprom(1);
+  switch (biton32(state)) {
+    case _EDVORAKJ1:
+    case _EDVORAKJ2:
+      // _EDVORAKJ1 & J2 are same colored
+      rgblight_sethsv_noeeprom_white();
+      break;
+    case _LOWER:
+      rgblight_sethsv_noeeprom_red();
+      break;
+    case _RAISE:
+      rgblight_sethsv_noeeprom_blue();
+      break;
+    case _ADJUST:
+      rgblight_sethsv_noeeprom_green();
+      break;
+    default: //  for any other layers, or the default layer
+      rgblight_mode_noeeprom(28);
+      rgblight_sethsv_noeeprom_red();
+      break;
+  }
+  return state;
+}
+#endif

keyboards/helix/rev2/keymaps/edvorakjp/keymap_4rows.c

@@ -0,0 +1,89 @@
+#include "helix.h"
+#include "keymap_xrows.h"
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [_EDVORAK] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+     LBRC,RBRC,COMM,DOT , P  , Y  ,                F  , G  , R  , W  , Q  ,BSLS,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     EQL , A  , O  , E  , I  , U  ,                D  , T  , N  , S  , M  ,MINS,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     QUOT,SCLN, X  , C  , V  , Z  ,                B  , H  , J  , K  , L  ,SLSH,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     LEFT,DOWN, UP ,RGHT,TMB1,TMB2,TMB3,     TMB6,TMB7,TMB8,LEFT,DOWN, UP ,RGHT
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_EDVORAKJ1] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         , AI , OU , EI ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,                   ,    ,    , Y  ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,ANN ,ONN ,ENN ,INN ,UNN ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_EDVORAKJ2] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         , AI , OU , EI ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,                   , Y  ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,ANN ,ONN ,ENN ,INN ,UNN ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_QWERTY] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+     EQL , Q  , W  , E  , R  , T  ,                Y  , U  , I  , O  , P  ,MINS,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     LBRC, A  , S  , D  , F  , G  ,                H  , J  , K  , L  ,SCLN,QUOT,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     RBRC, Z  , X  , C  , V  , B  ,                N  , M  ,COMM,DOT ,SLSH,BSLS,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_LOWER] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+      F1 , F2 , F3 , F4 , F5 ,LCBR,               RCBR, 7  , 8  , 9  ,MINS,SLSH,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+      F6 , F7 , F8 , F9 ,F10 ,LPRN,               RPRN, 4  , 5  , 6  ,PLUS,ASTR,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     F11 ,F12 ,PSCR,SLCK,PAUS,LBRC,               RBRC, 1  , 2  , 3  , NO , NO ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     HOME,PGDN,PGUP,END ,    ,    ,    ,         ,ESC , 0  ,HOME,PGDN,PGUP,END
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_RAISE] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+      F1 , F2 , F3 , F4 , F5 , F6 ,                F7 , F8 , F9 ,F10 ,F11 ,F12 ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     TILD,EXLM, AT ,HASH,DLR ,PERC,               CIRC,AMPR,ASTR,LPRN,RPRN, NO ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     GRV , 1  , 2  , 3  , 4  , 5  ,                6  , 7  , 8  , 9  , 0  , NO ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     HOME,PGDN,PGUP,END ,TMB9,ESC ,    ,         ,    ,    ,HOME,PGDN,PGUP,END
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_ADJUST] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         ,    ,    ,   ,EXTOFF,   ,                   ,EXTON,   ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,RST ,DBUG,RTOG,WIN ,    ,                   ,MAC ,QWER,EDJP,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  )
+};

keyboards/helix/rev2/keymaps/edvorakjp/keymap_5rows.c

@@ -0,0 +1,103 @@
+#include "helix.h"
+#include "keymap_xrows.h"
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [_EDVORAK] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+     GRV ,EXLM, AT ,HASH,DLR ,PERC,               CIRC,AMPR,ASTR,LPRN,RPRN,BSPC,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     LBRC,RBRC,COMM,DOT , P  , Y  ,                F  , G  , R  , W  , Q  ,BSLS,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     EQL , A  , O  , E  , I  , U  ,                D  , T  , N  , S  , M  ,MINS,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     QUOT,SCLN, X  , C  , V  , Z  ,TMB4,     TMB5, B  , H  , J  , K  , L  ,SLSH,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+     LEFT,DOWN, UP ,RGHT,TMB1,TMB2,TMB3,     TMB6,TMB7,TMB8,LEFT,DOWN, UP ,RGHT
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_EDVORAKJ1] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         ,    ,    ,    ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         , AI , OU , EI ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,                   ,    ,    , Y  ,    ,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,ANN ,ONN ,ENN ,INN ,UNN ,    ,         ,    ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_EDVORAKJ2] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         ,    ,    ,    ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         , AI , OU , EI ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,                   , Y  ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,ANN ,ONN ,ENN ,INN ,UNN ,    ,         ,    ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_QWERTY] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+     GRV ,EXLM, AT ,HASH,DLR ,PERC,               CIRC,AMPR,ASTR,LPRN,RPRN,BSPC,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     EQL , Q  , W  , E  , R  , T  ,                Y  , U  , I  , O  , P  ,MINS,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+     LBRC, A  , S  , D  , F  , G  ,                H  , J  , K  , L  ,SCLN,QUOT,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     RBRC, Z  , X  , C  , V  , B  ,    ,         , N  , M  ,COMM,DOT ,SLSH,BSLS,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_LOWER] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         ,    ,    ,    ,    ,    ,                   ,    ,SLSH,ASTR,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+      F1 , F2 , F3 , F4 , F5 ,LCBR,               RCBR, 7  , 8  , 9  ,MINS,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+      F6 , F7 , F8 , F9 ,F10 ,LPRN,               RPRN, 4  , 5  , 6  ,PLUS,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     F11 ,F12 ,PSCR,SLCK,PAUS,LBRC,LOCK,         ,RBRC, 1  , 2  , 3  ,    ,    ,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+     HOME,PGDN,PGUP,END ,TMB9,    ,    ,         ,    , 0  ,HOME,PGDN,PGUP,END
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_RAISE] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         ,    ,    ,    ,    ,    ,                   ,    ,SLSH,ASTR,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+      F1 , F2 , F3 , F4 , F5 ,LCBR,               RCBR, 7  , 8  , 9  ,MINS,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+      F6 , F7 , F8 , F9 ,F10 ,LPRN,               RPRN, 4  , 5  , 6  ,PLUS,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+     F11 ,F12 ,PSCR,SLCK,PAUS,LBRC,LOCK,         ,RBRC, 1  , 2  , 3  ,    ,    ,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+     HOME,PGDN,PGUP,END ,TMB9,    ,    ,         ,    , 0  ,HOME,PGDN,PGUP,END
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  ),
+
+  [_ADJUST] = LAYOUT_kc(
+  //,----+----+----+----+----+----.              ,----+----+----+----+----+----.
+         ,    ,    ,    ,    ,    ,                   ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,    ,    ,   ,EXTOFF,   ,                   ,EXTON,   ,    ,    ,    ,
+  //|----+----+----+----+----+----|              |----+----+----+----+----+----|
+         ,RST ,DBUG,RTOG,WIN ,    ,                   ,MAC ,QWER,EDJP,    ,    ,
+  //|----+----+----+----+----+----+----.    ,----|----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,    ,
+  //|----+----+----+----+----+----+----|    |----+----+----+----+----+----+----|
+         ,    ,    ,    ,    ,    ,    ,         ,    ,    ,    ,    ,    ,
+  //`----+----+----+----+----+----+----/    \----+----+----+----+----+----+----'
+  )
+};

keyboards/helix/rev2/keymaps/edvorakjp/keymap_xrows.h

@@ -0,0 +1,28 @@
+#ifndef KEYMAP_XROWS_H
+#define KEYMAP_XROWS_H
+
+#include "edvorakjp.h"
+
+enum custom_keycodes {
+  KC_LOCK = NEW_SAFE_RANGE,
+};
+
+#define KC_ KC_TRNS
+
+#define KC_TMB1 LGUI_T(KC_TAB)
+#define KC_TMB2 LSFT_T(KC_SPC)
+#define KC_TMB3 LOWER // act as LOWER when hold, as KC_LANG2(=English) when tapped
+#define KC_TMB4 LCTL_T(KC_ESC)
+#define KC_TMB5 RSFT_T(KC_DEL)
+#define KC_TMB6 RAISE // act as RAISE when hold, as KC_LANG1(=Japanese) when tapped
+#define KC_TMB7 RCTL_T(KC_BSPC)
+#define KC_TMB8 RALT_T(KC_ENT)
+#define KC_TMB9 LGUI(KC_TAB)
+
+#define KC_RST  RESET
+#define KC_DBUG DEBUG
+#define KC_RTOG RGB_TOG
+#define KC_EDJP EDVORAK
+#define KC_QWER QWERTY
+
+#endif

keyboards/helix/rev2/keymaps/edvorakjp/oled.c

@@ -0,0 +1,87 @@
+#include <string.h>
+#include "oled.h"
+
+static void render_logo(struct CharacterMatrix *matrix) {
+
+  static char logo[] = {
+    0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94,
+    0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4,
+    0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,
+    0};
+  matrix_write(matrix, logo);
+}
+
+void matrix_update(struct CharacterMatrix *dest,
+                   const struct CharacterMatrix *source) {
+  if (memcmp(dest->display, source->display, sizeof(dest->display))) {
+    memcpy(dest->display, source->display, sizeof(dest->display));
+    dest->dirty = true;
+  }
+}
+
+void render_status(struct CharacterMatrix *matrix) {
+
+  // Render to mode icon
+  static char logo[][2][3] = {{{0x95,0x96,0},{0xb5,0xb6,0}},{{0x97,0x98,0},{0xb7,0xb8,0}}};
+  if (edvorakjp_config.enable_kc_lang) {
+    matrix_write(matrix, logo[0][0]);
+    matrix_write_P(matrix, PSTR("\n"));
+    matrix_write(matrix, logo[0][1]);
+  } else {
+    matrix_write(matrix, logo[1][0]);
+    matrix_write_P(matrix, PSTR("\n"));
+    matrix_write(matrix, logo[1][1]);
+  }
+
+  // Define layers here, Have not worked out how to have text displayed for each layer. Copy down the number you see and add a case for it below
+  char buf[40];
+  snprintf(buf,sizeof(buf), "Undef-%ld", layer_state);
+  matrix_write_P(matrix, PSTR("\nLayer: "));
+  switch (biton32(layer_state)) {
+    case L_BASE:
+      matrix_write_P(matrix,
+          default_layer_state == 1UL<<_EDVORAK ? PSTR("EDVORAK") : PSTR("QWERTY")
+          );
+      break;
+    case _EDVORAKJ1:
+    case _EDVORAKJ2:
+      matrix_write_P(matrix, PSTR("JP_EXT"));
+      break;
+    case _RAISE:
+      matrix_write_P(matrix, PSTR("Raise"));
+      break;
+    case _LOWER:
+      matrix_write_P(matrix, PSTR("Lower"));
+      break;
+    case _ADJUST:
+      matrix_write_P(matrix, PSTR("Adjust"));
+      break;
+    default:
+      matrix_write(matrix, buf);
+  }
+
+  // Host Keyboard LED Status
+  char led[40];
+  snprintf(led, sizeof(led), "\n%s %s %s %s",
+      edvorakjp_config.enable_jp_extra_layer && japanese_mode ? "EXT" : "   ",
+      (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) ? "NMLK" : "    ",
+      (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) ? "CAPS" : "    ",
+      (host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK)) ? "SCLK" : "    ");
+  matrix_write(matrix, led);
+}
+
+void iota_gfx_task_user(void) {
+  struct CharacterMatrix matrix;
+
+#if DEBUG_TO_SCREEN
+  if (debug_enable) { return; }
+#endif
+
+  matrix_clear(&matrix);
+  if (is_master) {
+    render_status(&matrix);
+  } else {
+    render_logo(&matrix);
+  }
+  matrix_update(&display, &matrix);
+}

keyboards/helix/rev2/keymaps/edvorakjp/oled.h

@@ -0,0 +1,19 @@
+#ifndef OLED_USER_H
+#define OLED_USER_H
+
+//SSD1306 OLED update loop, make sure to add #define SSD1306OLED in config.h
+#include "ssd1306.h"
+#include "edvorakjp.h"
+
+//assign the right code to your layers for OLED display
+#define L_BASE 0
+
+extern uint8_t is_master;
+extern bool japanese_mode;
+
+void matrix_update(struct CharacterMatrix *dest,
+                   const struct CharacterMatrix *source);
+void render_status(struct CharacterMatrix *matrix);
+void iota_gfx_task_user(void);
+
+#endif // OLED_CONFIG_USER_H

keyboards/helix/rev2/keymaps/edvorakjp/readme.md

@@ -0,0 +1,21 @@
+# edvorakjp
+
+Epaew's Enhanced Dvorak layout for Japanese Programmer  
+see [here](/users/edvorakjp) for more informations.
+
+## License
+
+Copyright 2018 Ryo Maeda epaew.333@gmail.com @epaew
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

keyboards/helix/rev2/keymaps/edvorakjp/rules.mk

@@ -0,0 +1,126 @@
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
+EXTRAKEY_ENABLE = no        # Audio control and System control(+450)
+CONSOLE_ENABLE = no         # Console for debug(+400)
+COMMAND_ENABLE = no         # Commands for debug and configuration
+NKRO_ENABLE = no            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = no           # Audio output on port C6
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+SWAP_HANDS_ENABLE = no      # Enable one-hand typing
+
+define HELIX_CUSTOMISE_MSG
+  $(info Helix customize)
+  $(info -  OLED_ENABLE=$(OLED_ENABLE))
+  $(info -  LED_BACK_ENABLE=$(LED_BACK_ENABLE))
+  $(info -  LED_UNDERGLOW_ENABLE=$(LED_UNDERGLOW_ENABLE))
+  $(info -  LED_ANIMATION=$(LED_ANIMATIONS))
+  $(info -  IOS_DEVICE_ENABLE=$(IOS_DEVICE_ENABLE))
+endef
+
+# Helix keyboard customize
+# you can edit follows 7 Variables
+#  jp: 以下の7つの変数を必要に応じて編集します。
+HELIX_ROWS = 5              # Helix Rows is 4 or 5
+OLED_ENABLE = no            # OLED_ENABLE
+LOCAL_GLCDFONT = no         # use each keymaps "helixfont.h" instead of "common/glcdfont.c"
+LED_BACK_ENABLE = no        # LED backlight (Enable WS2812 RGB underlight.)
+LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight.)
+LED_ANIMATIONS = yes        # LED animations
+IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
+
+####  LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE.
+####    Do not enable these with audio at the same time.
+
+### Helix keyboard 'edvorakjp' keymap: convenient command line option
+##    make HELIX=<options> helix:edvorakjp
+##    option= oled | back | under | na | ios
+##    ex.
+##      make HELIX=oled          helix:edvorakjp
+##      make HELIX=oled,back     helix:edvorakjp
+##      make HELIX=oled,under    helix:edvorakjp
+##      make HELIX=oled,back,na  helix:edvorakjp
+##      make HELIX=oled,back,ios helix:edvorakjp
+##
+ifneq ($(strip $(HELIX)),)
+  ifeq ($(findstring oled,$(HELIX)), oled)
+    OLED_ENABLE = yes
+  endif
+  ifeq ($(findstring back,$(HELIX)), back)
+    LED_BACK_ENABLE = yes
+  else ifeq ($(findstring under,$(HELIX)), under)
+    LED_UNDERGLOW_ENABLE = yes
+  endif
+  ifeq ($(findstring na,$(HELIX)), na)
+    LED_ANIMATIONS = no
+  endif
+  ifeq ($(findstring ios,$(HELIX)), ios)
+    IOS_DEVICE_ENABLE = yes
+  endif
+  $(eval $(call HELIX_CUSTOMISE_MSG))
+  $(info )
+endif
+
+# Uncomment these for checking
+#   jp: コンパイル時にカスタマイズの状態を表示したい時はコメントをはずします。
+# $(eval $(call HELIX_CUSTOMISE_MSG))
+# $(info )
+
+ifeq ($(strip $(HELIX_ROWS)), 4)
+  SRC += keymap_4rows.c
+else ifeq ($(strip $(HELIX_ROWS)), 5)
+  SRC += keymap_5rows.c
+else
+  $(error HELIX_ROWS = $(strip $(HELIX_ROWS)) is unexpected value)
+endif
+OPT_DEFS += -DHELIX_ROWS=$(strip $(HELIX_ROWS))
+
+ifeq ($(strip $(LED_BACK_ENABLE)), yes)
+  RGBLIGHT_ENABLE = yes
+  OPT_DEFS += -DRGBLED_BACK
+  ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
+    $(eval $(call HELIX_CUSTOMISE_MSG))
+    $(error LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE both 'yes')
+  endif
+else ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
+  RGBLIGHT_ENABLE = yes
+  OPT_DEFS += -DRGBLED_BACK
+else
+  RGBLIGHT_ENABLE = no
+endif
+
+ifeq ($(strip $(IOS_DEVICE_ENABLE)), yes)
+  OPT_DEFS += -DIOS_DEVICE_ENABLE
+endif
+
+ifeq ($(strip $(LED_ANIMATIONS)), yes)
+  OPT_DEFS += -DRGBLIGHT_ANIMATIONS
+endif
+
+ifeq ($(strip $(OLED_ENABLE)), yes)
+  OPT_DEFS += -DOLED_ENABLE
+  SRC += oled.c
+endif
+
+ifeq ($(strip $(LOCAL_GLCDFONT)), yes)
+  OPT_DEFS += -DLOCAL_GLCDFONT
+endif
+
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+ifndef QUANTUM_DIR
+  include ../../../../Makefile
+endif
+
+# Uncomment these for debugging
+# $(info -- RGBLIGHT_ENABLE=$(RGBLIGHT_ENABLE))
+# $(info -- OPT_DEFS=$(OPT_DEFS))
+# $(info )

keyboards/helix/rev2/keymaps/five_rows/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 // place overrides here
 
 #endif /* CONFIG_USER_H */

keyboards/helix/rev2/keymaps/five_rows_jis/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 /* Use I2C or Serial */
 
 #define USE_I2C
@@ -59,8 +57,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
   #error "expected HELIX_ROWS 4 or 5"
 #endif
 
-#define USE_SERIAL_PD2
-
 #define PREVENT_STUCK_MODIFIERS
 #define TAPPING_FORCE_HOLD
 #define TAPPING_TERM 100

keyboards/helix/rev2/keymaps/froggy/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 #undef TAPPING_TERM
 #define TAPPING_TERM 200
 #define ONESHOT_TAP_TOGGLE 5 /* Tapping this number of times holds the key until tapped this number of times again. */

keyboards/helix/rev2/keymaps/led_test/config.h

@@ -21,8 +21,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
 
-#include "../../config.h"
-
 // place overrides here
 
 #endif /* CONFIG_USER_H */

keyboards/helix/rev2/matrix.c

@@ -30,7 +30,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "matrix.h"
 #include "split_util.h"
 #include "pro_micro.h"
-#include "config.h"
 
 #ifdef USE_MATRIX_I2C
 #  include "i2c.h"

keyboards/helix/rev2/rev2.h

@@ -14,8 +14,8 @@
 #ifdef USE_I2C
 #include <stddef.h>
 #ifdef __AVR__
-	#include <avr/io.h>
+  #include <avr/io.h>
-	#include <avr/interrupt.h>
+  #include <avr/interrupt.h>
 #endif
 #endif
 
@@ -27,40 +27,40 @@
 // Standard Keymap
 // (TRRS jack on the left half is to the right, TRRS jack on the right half is to the left)
 #define LAYOUT( \
-	L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
+  L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
-	L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
+  L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
-	L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
+  L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
-	L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35  \
+  L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35  \
-	) \
+  ) \
-	{ \
+  { \
-		{ L00, L01, L02, L03, L04, L05, KC_NO }, \
+    { L00, L01, L02, L03, L04, L05, KC_NO }, \
-		{ L10, L11, L12, L13, L14, L15, KC_NO }, \
+    { L10, L11, L12, L13, L14, L15, KC_NO }, \
-		{ L20, L21, L22, L23, L24, L25, KC_NO }, \
+    { L20, L21, L22, L23, L24, L25, KC_NO }, \
-		{ L30, L31, L32, L33, L34, L35, L36 }, \
+    { L30, L31, L32, L33, L34, L35, L36 }, \
-		{ R05, R04, R03, R02, R01, R00, KC_NO }, \
+    { R05, R04, R03, R02, R01, R00, KC_NO }, \
-		{ R15, R14, R13, R12, R11, R10, KC_NO }, \
+    { R15, R14, R13, R12, R11, R10, KC_NO }, \
-		{ R25, R24, R23, R22, R21, R20, KC_NO }, \
+    { R25, R24, R23, R22, R21, R20, KC_NO }, \
-		{ R35, R34, R33, R32, R31, R30, R36 }, \
+    { R35, R34, R33, R32, R31, R30, R36 }, \
-	}
+  }
 #else
 // Keymap with right side flipped
 // (TRRS jack on both halves are to the right)
 #define LAYOUT( \
-	L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
+  L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
-	L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
+  L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
-	L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
+  L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
-	L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35  \
+  L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35  \
-	) \
+  ) \
-	{ \
+  { \
-		{ L00, L01, L02, L03, L04, L05, KC_NO }, \
+    { L00, L01, L02, L03, L04, L05, KC_NO }, \
-		{ L10, L11, L12, L13, L14, L15, KC_NO }, \
+    { L10, L11, L12, L13, L14, L15, KC_NO }, \
-		{ L20, L21, L22, L23, L24, L25, KC_NO }, \
+    { L20, L21, L22, L23, L24, L25, KC_NO }, \
-		{ L30, L31, L32, L33, L34, L35, L36 }, \
+    { L30, L31, L32, L33, L34, L35, L36 }, \
-		{ KC_NO, R00, R01, R02, R03, R04, R05 }, \
+    { KC_NO, R00, R01, R02, R03, R04, R05 }, \
-		{ KC_NO, R10, R11, R12, R13, R14, R15 }, \
+    { KC_NO, R10, R11, R12, R13, R14, R15 }, \
-		{ KC_NO, R20, R21, R22, R23, R24, R25 }, \
+    { KC_NO, R20, R21, R22, R23, R24, R25 }, \
-		{ R36, R30, R31, R32, R33, R34, R35 }, \
+    { R36, R30, R31, R32, R33, R34, R35 }, \
-	}
+  }
 #endif
 #else
   #ifndef FLIP_HALF
@@ -89,14 +89,14 @@
   // Keymap with right side flipped
   // (TRRS jack on both halves are to the right)
   #define LAYOUT( \
-		L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
+    L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
     L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
     L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
     L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35, \
     L40, L41, L42, L43, L44, L45, L46, R46, R40, R41, R42, R43, R44, R45  \
     ) \
     { \
-			{ L00, L01, L02, L03, L04, L05, KC_NO }, \
+      { L00, L01, L02, L03, L04, L05, KC_NO }, \
       { L10, L11, L12, L13, L14, L15, KC_NO }, \
       { L20, L21, L22, L23, L24, L25, KC_NO }, \
       { L30, L31, L32, L33, L34, L35, L36 }, \
@@ -110,4 +110,35 @@
   #endif
 #endif
 
+// Used to create a keymap using only KC_ prefixed keys
+#if HELIX_ROWS == 4
+  #define LAYOUT_kc( \
+    L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
+    L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
+    L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
+    L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35 \
+    ) \
+    LAYOUT( \
+      KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
+      KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
+      KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
+      KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##L36, KC_##R36, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35 \
+    )
+#else
+  #define LAYOUT_kc( \
+    L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, \
+    L10, L11, L12, L13, L14, L15,           R10, R11, R12, R13, R14, R15, \
+    L20, L21, L22, L23, L24, L25,           R20, R21, R22, R23, R24, R25, \
+    L30, L31, L32, L33, L34, L35, L36, R36, R30, R31, R32, R33, R34, R35, \
+    L40, L41, L42, L43, L44, L45, L46, R46, R40, R41, R42, R43, R44, R45 \
+    ) \
+    LAYOUT( \
+      KC_##L00, KC_##L01, KC_##L02, KC_##L03, KC_##L04, KC_##L05, KC_##R00, KC_##R01, KC_##R02, KC_##R03, KC_##R04, KC_##R05, \
+      KC_##L10, KC_##L11, KC_##L12, KC_##L13, KC_##L14, KC_##L15, KC_##R10, KC_##R11, KC_##R12, KC_##R13, KC_##R14, KC_##R15, \
+      KC_##L20, KC_##L21, KC_##L22, KC_##L23, KC_##L24, KC_##L25, KC_##R20, KC_##R21, KC_##R22, KC_##R23, KC_##R24, KC_##R25, \
+      KC_##L30, KC_##L31, KC_##L32, KC_##L33, KC_##L34, KC_##L35, KC_##L36, KC_##R36, KC_##R30, KC_##R31, KC_##R32, KC_##R33, KC_##R34, KC_##R35, \
+      KC_##L40, KC_##L41, KC_##L42, KC_##L43, KC_##L44, KC_##L45, KC_##L46, KC_##R46, KC_##R40, KC_##R41, KC_##R42, KC_##R43, KC_##R44, KC_##R45 \
+    )
+#endif
+
 #endif

keyboards/helix/rev2/serial_config.h

@@ -0,0 +1,16 @@
+#ifndef SOFT_SERIAL_CONFIG_H
+#define SOFT_SERIAL_CONFIG_H
+
+/* Soft Serial defines */
+#define SERIAL_PIN_DDR DDRD
+#define SERIAL_PIN_PORT PORTD
+#define SERIAL_PIN_INPUT PIND
+#define SERIAL_PIN_MASK _BV(PD2)
+#define SERIAL_PIN_INTERRUPT INT2_vect
+
+#define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
+#define SERIAL_MASTER_BUFFER_LENGTH MATRIX_ROWS/2
+
+//// #error rev2 serial config
+
+#endif /* SOFT_SERIAL_CONFIG_H */

keyboards/helix/rev2/split_util.c

@@ -7,7 +7,6 @@
 #include "split_util.h"
 #include "matrix.h"
 #include "keyboard.h"
-#include "config.h"
 
 #ifdef USE_MATRIX_I2C
 #  include "i2c.h"

keyboards/helix/serial.c

@@ -110,16 +110,18 @@ void serial_master_init(void) {
 void serial_slave_init(void) {
   serial_input_with_pullup();
 
-#ifndef USE_SERIAL_PD2
+#if SERIAL_PIN_MASK == _BV(PD0)
   // Enable INT0
   EIMSK |= _BV(INT0);
   // Trigger on falling edge of INT0
   EICRA &= ~(_BV(ISC00) | _BV(ISC01));
-#else
+#elif SERIAL_PIN_MASK == _BV(PD2)
   // Enable INT2
   EIMSK |= _BV(INT2);
   // Trigger on falling edge of INT2
   EICRA &= ~(_BV(ISC20) | _BV(ISC21));
+#else
+ #error unknown SERIAL_PIN_MASK value
 #endif
 }
 

keyboards/helix/serial.h

@@ -1,28 +1,19 @@
-#ifndef MY_SERIAL_H
+#ifndef SOFT_SERIAL_H
-#define MY_SERIAL_H
+#define SOFT_SERIAL_H
 
-#include "config.h"
 #include <stdbool.h>
 
-/* TODO:  some defines for interrupt setup */
+// ////////////////////////////////////////////
-#define SERIAL_PIN_DDR DDRD
+// Need Soft Serial defines in serial_config.h
-#define SERIAL_PIN_PORT PORTD
+// ////////////////////////////////////////////
-#define SERIAL_PIN_INPUT PIND
+// ex.
-
+//  #define SERIAL_PIN_DDR DDRD
-#ifndef USE_SERIAL_PD2
+//  #define SERIAL_PIN_PORT PORTD
-#define SERIAL_PIN_MASK _BV(PD0)
+//  #define SERIAL_PIN_INPUT PIND
-#define SERIAL_PIN_INTERRUPT INT0_vect
+//  #define SERIAL_PIN_MASK _BV(PD?)   ?=0,2
-#else
+//  #define SERIAL_PIN_INTERRUPT INT?_vect  ?=0,2
-#define SERIAL_PIN_MASK _BV(PD2)
+//  #define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
-#define SERIAL_PIN_INTERRUPT INT2_vect
+//  #define SERIAL_MASTER_BUFFER_LENGTH MATRIX_ROWS/2
-#endif
-
-#define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
-#ifdef KEYBOARD_helix_rev1
-#define SERIAL_MASTER_BUFFER_LENGTH 1
-#else
-#define SERIAL_MASTER_BUFFER_LENGTH MATRIX_ROWS/2
-#endif
 
 // Buffers for master - slave communication
 extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH];
@@ -33,4 +24,4 @@ void serial_slave_init(void);
 int serial_update_buffers(void);
 bool serial_slave_data_corrupt(void);
 
-#endif
+#endif /* SOFT_SERIAL_H */

keyboards/helix/ssd1306.h

@@ -4,7 +4,6 @@
 #include <stdbool.h>
 #include <stdio.h>
 #include "pincontrol.h"
-#include "config.h"
 
 enum ssd1306_cmds {
   DisplayOff = 0xAE,

keyboards/hhkb/config.h

@@ -54,6 +54,47 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 )
 
+#ifdef HHKB_RN42_ENABLE
+// rn42 support -- acquired from the tmk repo. This is almost certainly not
+// integrated with qmk in the correct way.
+
+#define SUART_OUT_PORT  PORTD
+#define SUART_OUT_BIT   0
+#define SUART_IN_PIN    PIND
+#define SUART_IN_BIT    1
+
+#ifdef __AVR_ATmega32U4__
+    /* iom32u4.h has no definition of UCSR1D. copy from iom32u2.h */
+    #define UCSR1D _SFR_MEM8(0xCB)
+    #define RTSEN 0
+    #define CTSEN 1
+
+    #define SERIAL_UART_BAUD        115200
+    #define SERIAL_UART_DATA        UDR1
+    #define SERIAL_UART_UBRR        ((F_CPU/(16.0*SERIAL_UART_BAUD)-1+0.5))
+    #define SERIAL_UART_RXD_VECT    USART1_RX_vect
+    #define SERIAL_UART_TXD_READY   (UCSR1A&(1<<UDRE1))
+    #define SERIAL_UART_INIT()      do { \
+        UBRR1L = (uint8_t) SERIAL_UART_UBRR;       /* baud rate */ \
+        UBRR1H = ((uint16_t)SERIAL_UART_UBRR>>8);  /* baud rate */ \
+        UCSR1B |= (1<<RXCIE1) | (1<<RXEN1); /* RX interrupt, RX: enable */ \
+        UCSR1B |= (0<<TXCIE1) | (1<<TXEN1); /* TX interrupt, TX: enable */ \
+        UCSR1C |= (0<<UPM11) | (0<<UPM10);  /* parity: none(00), even(01), odd(11) */ \
+        UCSR1D |= (0<<RTSEN) | (0<<CTSEN);  /* RTS, CTS(no flow control by hardware) */ \
+        DDRD |= (1<<5); PORTD &= ~(1<<5);   /* RTS for flow control by firmware */ \
+        sei(); \
+    } while(0)
+    #define SERIAL_UART_RTS_LO()    do { PORTD &= ~(1<<5); } while (0)
+    #define SERIAL_UART_RTS_HI()    do { PORTD |=  (1<<5); } while (0)
+#else
+    #error "USART configuration is needed."
+#endif
+
+/* power control of key switch board */
+#define HHKB_POWER_SAVING
+
+#endif
+
 /*
  * Feature disable options
  *  These options are also useful to firmware size reduction.

keyboards/hhkb/keymaps/eric/keymap.c

@@ -28,7 +28,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
         KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
         KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(HHKB),
-        KC_LGUI, KC_LALT, /*        */ KC_SPC, KC_RALT, KC_RGUI),
+        KC_LALT, KC_LGUI, /*        */ KC_SPC, KC_RGUI, KC_RALT),
 
     /* Layer HHKB: HHKB mode (HHKB Fn)
       |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|

keyboards/hhkb/rn42/MEMO.txt

@@ -0,0 +1,262 @@
+Memo of deveopment
+==================
+just memo, NOT WORTH READING
+
+2015/11/24
+JP Bluetooth:
+    RN-42 cannot send Japanese keys like; henkan, mu-henkan and kana, JPY and RO.
+    It seems HID usage more than 0x65 cannot be send with the module.
+        http://shiki.esrille.com/2014/07/bluetoothnisse.html
+
+
+Bug:
+- Factory Reset PIO4 doesn't work
+    - the reason is unclear - 12/08 NOT LOOK INTO ANY MORE
+    - WORKAROUND: use serial pins(3.3V, GND, RX and TX)
+        - SF,1 and R,1 to set factory defalult
+
+
+Todo:
+- LED cover and switch knob and new Slide Switch
+- RN42 auto configuration
+    - configure the module as HID device every time powering up
+    - this'll reduce work load of assembly
+
+- move rn42 to protocol directory when it becomes reusable stack
+
+- sendchar() in lufa.c no buffer
+    - no buffering. character lost can be caused.
+- LUFA sendchar should be buffered and serial_uart.c buffur size is too large(256).
+
+- BT operations
+    - disconnect
+    - new connection
+    - remove connection
+
+- sendchar() in lufa.c block loop   - DONE 11/29
+    - block loop when powered with AC adapter
+    - FrameNumber is not updated when adapter powered
+
+Improving:
+- ADC resolution
+    AVR120
+    AVR32138
+    - Enhancing ADC resolution by oversampling
+        AVR121  http://www.atmel.com/images/doc8003.pdf
+    - disable digital input buffer DIDR(7.8.6)
+
+Design:
+- suspend.h - DONE 11/26
+    - remove argument from suspend_power_down() for backward compatitibility
+- remove MCU dependent power saving code from core/keyboard - DONE 11/23
+    - it should be located in project matrix.c
+- HHKB matrix.c needs matrix_prev?
+    - is_modified() is obsolete now. really needs?
+- ADC: removing AREF capacitor C10
+    - seems to be better while usb powered
+    - still bad while battery powered
+    http://electronics.stackexchange.com/questions/105849/avcc-and-capacitor-using-adc
+- ADC: smaller resistors for voltage dividor
+    - 1K + 1K: not improved. - 11/27
+
+
+LUFA:
+USB connection check: state of USB deivce
+- USB_DeviceState:
+    USB_Deivce_State_t { Unattached, Powered, Default, Addressed, Configured*, Suspended* }
+    Unattached: unpluged
+    Powered:    pluged with power adapter
+    Default:    enumerate process bigin
+    Addressed:  addressed
+    Configured: enumerated
+    Suspended:  suspended
+
+- USB_IsInitialized: state of LUFA core setup
+    becomes true in USB_Init()  USBController_AVR8.c
+    becomes false in USB_Disable()  USBController_AVR8.c
+- USB_VBUS_GetStatus(): state of VBUS(power/connection)
+- USB_Disable() detaches, disables all interrupts, controller, PLL, regulater.
+
+- When connect to power adapter
+    - event happened: CW or CSW or C or DDC
+    - USB state: not configured
+
+- USB evnets
+    - USB connect: CSWRWRW
+    - USB connect but fail to enumeration: CWRWRWRWS
+    - USB disconnect: D
+    - Power adapter connect: CW, CSW, C
+    - Power adapter disconnect: D
+
+
+Power saving:
+- Pro2 current consumption
+    - active: 138.2mA(no device on Hub)
+    - suspended: 30.9mA(WakeUp enabled DIPSW6)
+    - suspended: 0mA->46.0mA(WakeUp disabled DIPSW6)
+- Pro current consumption
+    - active: 54.0mA
+    - suspended: 40.5mA(WakeUp enabled DIPSW6)
+    - suspended: 0.3mA(WakeUp disabled DIPSW6)
+
+- RN42 3.3V
+    - disconnected(Idle): 5mA (config mode)
+    - connected(Active):
+        SW,0000:  23-26mA
+        SW,0010:  27-29mA worse than 0000 for unknown reason
+        SW,0020:  17-19mA mouse NG
+        SW,0030:  13-16mA laggy mouse NG
+        SW,0050:  10-13mA laggy mouse NG
+
+- matrix power saving
+    - power saving while externally powered and not while unpluged
+- confirm suspend mode lufa.c: matrix_power_*, suspend_wakeup_condition
+- 8MHz clock
+- When not connected in a few minutes get into deep sleep to save battery life
+- CTS is needed for waking up from deep sleep? How deep sleep is activated?
+- firmware controlled 3.3V DC converter to switch on/off BT module
+- sleep MCU and BT module(keyboard is not used)
+- deep sleep MCU and BT module(keyboard is not used for long time)
+- deep sleep MCU and turn off BT module(keyboard is not used and not connected)
+- Battery ADC; switching, high resistance
+    - switching gnd end of divider with PF4
+    - high resistor 100K/1M?
+        capacitor   10nF
+        http://www.eevblog.com/forum/beginners/measuring-battery-voltage-without-consuming-current/
+- During USB suspend change clock source to internal RC from external Xtal(6.8)
+- FRZCLK: you can freeze clock for power saving. still WAKEUPI and VBUSTI interrupts are available while freezing.(21.7.3)
+- Suspend: Clear Suspend Bit, Freeze clock, disable PLL, MCU sleep(21.13)
+- Voltage reference(8.1.1)
+    - to reduce power consumption while power down mode
+- unset ADEN before sleep(24.7)
+
+
+
+
+
+
+
+Lipo
+----
+850mA lasts around 9 hours(07/28)
+
+Sparkfun Polymer Lithium Ion Battery 850mAh:
+https://www.sparkfun.com/products/341
+Lipo Cell spec:
+https://www.sparkfun.com/datasheets/Batteries/063048%20Li-polymer.pdf
+Protection spec:
+http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Prototyping/BatteryProtection.pdf
+                                min     typical max
+    over-charge                 4.255   4.280   4.305
+    over-charge discover?       4.030   4.080   4.130
+    over-discharge              2.827   2.900   2.973
+    over-discharge discover     3.022   3.100   3.178
+
+ADC voltage monitor:    voltage divider 10K+10K(0.5)
+                        ADC=V*0.5/2.56*1024
+
+    V       ADC
+    ------------------
+    4.20    0x347(839)
+    3.10    0x26b(619)
+
+
+
+
+TROUBLE SHOOT
+-------------
+07/16   After fix of voltage dividor on GPIO6, had a trouble that it could not send a char to BT module, though could receive.
+        Found R8 had wrong 1K resistor and changed to 10K, after that it can send to the module again. Not sure how it had sent with the wrong 1K before.
+
+07/18   On Linux, had an USB related trouble; keyboard or console didn't work for some reason. Changing PID cured this problem. Very annoying, took very long time before resolved it.
+
+12/07   rn42_rts() read 1 every time. R12 broke in open mode(no coductive), idk why, too much heat with soldering? and PF1 pin was not soldered.
+        It resolved with resoldering PF1 and new resistor on R12.
+
+
+
+
+Done:
+- low battery alert(solid light) 09/04
+- *** Rev.E BT test *** - DONE
+    - with MCP73832, new Schottky, tantalum caps - DONE 12/07
+        * MCP73832 doesn't leak from Vcc pin when unpluged and battery powered
+            34mV vs 2.07V(MCP73831) at Vcc pin
+            MCP73832 doesn't need revese protection diode D5
+        * PMEG2010ER is very low VF while reverse current/voltage is high
+            VF=0.96 vs 1.98(RB160M-30TR)with Fluke 175
+            Anode of D11 is 680mV vs 20mV(RB160M-30TR)
+            780mV is still low < 1.4V VBUS plugin detection(21.11)
+                this doesn't cause false VBUS detect
+                and 780mV on MCP73832 Vcc pin is also no problem.
+            D5 can be removed.
+    - ADC divider switching - DONE 12/07
+        * Drain and Source of Q4 Pch was reversed wrongly on Rev.E.
+
+    - reverse current from Lipo charger - DONE 12/07
+        * MCP73832 has no recverse current from Vcc pin unlike MCP73831
+
+
+- Rev.F design - DONE
+    - current measure point - DONE 12/08
+    - change value of cap 68->47    - DONE 12/08
+    - PPTC land pattern: no solder jumper, use 0Ohm resistor instead - CANCEL 12/08
+    - Q4 Pch FET: wrong Drain and Source - DONE 12/08
+    - D5 can be removed.    - DONE 12/08
+
+
+
+- BT_INDICATOR LED turns on wrongly when touching line or pin.  -- pull-up enabled on PF6/GPIO2 08/30
+- Lipo charger configuration: fast charge time:  USB charger spec? -- used 2kohm
+- use LED of charger to alarm low battery. LED should be powered directly from Lipo? - cancel; powered from VUSB
+- Use RTS in serial_uart.c to resolve missing chars from help message of RN-42 - done
+- CTS/RTS lines are needed? just connect in loop back if no flow control is needed. - done
+- add IO pin to charger status CHRG; LED control(low) and detect charge status(input HiZ) 07.24
+- LINKED: add trace on PIO2 to PF6   07.24
+- Lipo voltage ADC sensing
+- Lipo charger MCP73831: needs capacitor 4.7uF *2
+- USB connection check - 07.01
+- BT on/off check: whether RX line is pulled up? - checking RTS 07.01
+- USB/BT switching  BT is on -> BT, BT is off -> USB - 07.01
+- Under voltage lock out UVLO for protection of Lipo - Lipo has discharge protection at 3.100V    07.01
+- Power saving: HHKB scan, BT radio control - 9h with 850mAh, this is enough   07.01
+- Power selector doesn't work; Q4 MOSFET leaks from Lipo to USB power line. -- use Schottky instead 07/04
+
+- wrongly suspended when powered from adapter without USB connection - DONE
+    - suspend event may occur when plug into adapter
+    - and never wake until conected to real USB line
+    - without debug print via USB no problem; CSW(wake just after suspend as real USB line)
+    - seems like USB print causes this problem after suspended
+
+- lose USB connection during power-down mode - DONE
+    - USB initialize code in main() causes this - WRONG
+    - Do not power-down during USB connection is active - DONE 11/11
+        (USB_DeviceState == USB_DEVICE_Configured) is used to check USB connection
+        matrix_power_down() matrix.c - 11/23
+
+- with Nexus5 keyboard and mouse are very laggy.
+    Not confirmed. 01/15
+
+- switch BT host connections    - CANCEL 01/15
+    - switch next connection
+        cannot switch connection with version 6.15 at least
+
+- When given power only from wall wart adapter  - DONE? not confirmed 01/15
+    - it sleeps. it should not sleep
+    - Configured state without USB connection?
+
+- timer is slow while power down - DONE 11/26
+    - time out interrupt is lost while power down?
+    - interrupt of watchdog timer compensates timer counter(avr/suspend.c)
+
+- repeated CHARGING/FULL_CHARGED    - No longer problem 01/15
+    - In LTC sharp pulses are observed.
+    - MCP has no pulse but still has a problem.
+    - needs more wait before read pin state? - NO
+
+- USB plug-in fails while BT        - No longer problem 01/15
+    - it ends in suspend state
+    - maybe, not responsive to host enumeration process due to power-down.
+    - matrix_power_down() only when state is unattached - 11/26
+        - need to observe a while
+

keyboards/hhkb/rn42/PowerSave.txt

@@ -0,0 +1,88 @@
+Power Saving
+============
+
+
+MCU+HHKB Power Comsumption
+--------------------------
+Battery drive:
+    idle    18.9mA
+    active  35.8mA
+
+USB powered:
+    40.0mA
+    52mA    01/17
+
+Other keyboards:
+HHKB Pro    55mA
+HHKB Pro2   140mA
+HHKB Pro    42mA(Alt)
+HHKB Pro2   52mA(Alt BT controller USB mode)
+HHKB Pro2   88mA(Alt BT controller BT mode connected)
+HHKB Pro2   68mA(Alt BT controller BT mode config mode)
+Poker X     6mA
+Infinity    24mA(TMK)
+            65mA(kiibohd)
+
+
+HHKB key switch power control
+-----------------------------
+MOS FET Nch: BSS138 or IRLML6344T, either works and no apparent difference.
+Normally on(pull-up) or off(pull-down)? interms of power saving it prefers pull-down?
+
+Pull-down will be better for power saving, normally off.
+
+
+
+Used Timer
+----------
+
+8MHz clock
+----------
+1) 16MHz xtal with system prescaler div2: F_CPU=8MHz, F_USB=16MHz
+2) 8MHz xtal with div1: F_CPU=8MHz, F_USB=8MHz
+Hardware USART doesn't work at 115200bps with 8MHz(F_CPU).
+
+workaround:
+a) use Sotwre serial for communcation with RN-42
+b) reduce baud of RN-42 to lower rate;(factory default is 115200bps)
+10/03
+
+
+
+Slave mode
+----------
+Discovery/Inquire
+Connect/Page
+
+SI,0012
+SJ,0012
+InqWindw=0100
+PagWindw=0100
+
+
+Sniff mode
+----------
+0.625ms * <hex>
+SW,0320     Very sluggish. Type is not lost but very slow to register.
+SW,0160     Still sluggish. may transposed? can type but ...
+            Mouse point move intermittently
+SW,0020     feel a bit late like stumble(20ms)
+SW,0010     feel no latency(10ms)
+
+
+Deep sleep
+----------
+SW,8010
+
+
+TX power
+--------
+SY,fff4
+
+
+IO pins
+-------
+S%,1000         status led and connection control don't work
+                GPIO5: status LED
+                GPIO6: Connection control
+                GPIO2: linked status

keyboards/hhkb/rn42/RN42.txt

@@ -0,0 +1,408 @@
+RN-42 Bluetooth Module Support
+==============================
+Bluetooth controller board works with HHKB Pro2, JP, Type-S and Type-S JP and it supports both USB and Bluetooth as keyboard output protocol. Bluetooth module Roving Networks/Microchip RN-42 is installed on the board.
+
+
+RN-42:
+http://www.microchip.com/wwwproducts/Devices.aspx?product=RN42
+
+
+Capabitlities:
+- USB keyboard functions
+    completely equivarent to USB controller including mouse keys and NKRO.
+- Switching between USB and Bluetooth
+    You can switch the two connections with BT switch or key combination.
+- RN-42 config mode
+    You can change power/connection configuration of the module if needed.
+- Low battery alert
+    Red LED turns on when low voltage.
+- RN-42 status indicator
+    LED indicates status of Bluetooth connection.
+- Pairing
+    The module stores up to 8 connections.
+- Auto connect
+    The module connects the last connected device automatically.
+- iOS support
+    works as keyboard with iPhone5. No tested completely.
+- Android support
+    works as keyboard and mouse with Nexus5. No tested completely.
+- Mouse keys over BT
+    Note that iOS doesn't accept mouse device.
+
+
+Limitations:
+- Short battery life
+    Around 12hr with 1000mAh
+- No connection switching
+    RN-42 auto-connects to the last connected device.
+    Some of consumer products can switch between devices, for example Logitech K480.
+        http://www.logitech.com/en-us/product/multi-device-keyboard-k480?crid=26
+- HHKB JP requires case modification for BT switch and LEDs.
+    without switch power controlled by MCU? Probably using 3.3V regulator enable pin power of RN-42 can be controlled.
+
+NOTE:
+- LIPO BATTERY IS VERY DANGEROUS, TAKE EXTRA CARE OF YOUR SAFETY AND PROPERTY.
+- RN-42 version 6.15 is supported.
+- No NKRO over Bluetooth
+- Check you country's wiress regulation and certification of RN-42.
+
+Bugs:
+
+Todos:
+
+
+Lipo Battery
+------------
+You can use 3.7V Lithium Ion battery with JST PH 2pin connector and protection circuit.
+Battery space inside HHKB is around 54mm x 50mm and its height is 7mm.
+
+Sparkfun 850mAh
+https://www.sparkfun.com/products/341
+Sparkfun 1000mAh
+https://www.sparkfun.com/products/339
+
+Sparkfun 2000mAh battery won't fit due to its size.
+
+Learn about Lipo battery:
+https://learn.adafruit.com/li-ion-and-lipoly-batteries
+
+
+
+
+
+LED Status
+----------
+Configuring                     10 times per sec
+Startup/configuration timer     2 times per sec
+Discoverable/Inquiring/Idle     once per sec
+Connected                       solid on
+
+
+RN-42 Magic Command
+--------------------
+Magic key combination is 'LShift+RShift' by default in case of HHKB.
+
+Here is help.
+
+    ----- Bluetooth RN-42 Help -----
+    i:       RN-42 info
+    b:       battery voltage
+    Del:     enter/exit RN-42 config mode
+    Slck:    RN-42 initialize
+    p:       pairing
+    u:       toggle Force USB mode
+
+    RN-42 info:             displays information of the module on console.
+    battery voltage:        displays current voltage of battery and uptime.
+    RN-42 initialize:       does factory reset and configures RN-42
+    pairing:                enters Pairing mode.
+    toggle Force USB mode:  switch between USB and Bluetooth
+
+
+RN-42 Config mode
+-----------------
+You can tune/operate RN-42 yourself with config(command) mode.
+
+1. hook up USB cable
+2. run `hid_listen` command  in console
+3. turn on Bluetooth switch
+4. press LShift+RShift+Delete(Fn+~) you will see output like followings:
+
+    Entering config mode ...
+    CMD
+    v
+    Ver 6.15 04/26/2013
+    (c) Roving Networks
+
+5. do config with RN-42 commands. See documentations of RN-42.
+6. to exit also press LShift+RShift+Delete(Fn+~)
+
+    Exiting config mode ...
+    ---
+    END
+
+
+RN-42 Initial Configuration
+---------------------------
+RN-42 is configured as SPP device at factory reset, you need to configure it as HID device. This is needed just once first time.
+
+1. hook up USB cable
+2. run `hid_listen` command  in console
+3. turn on Bluetooth switch
+4. press LShift+RShift+ScrLk(Fn+O) you will see output like followings:
+
+    Entering config mode ...
+    CMD
+    Ver 6.15 04/26/2013
+    (c) Roving Networks
+    ECHO ON
+    SF,1
+    AOK
+    S-,TmkBT
+    AOK
+    SS,Keyboard/Mouse
+    AOK
+    SM,4
+    AOK
+    SW,8000
+    AOK
+    S~,6
+    AOK
+    SH,003C
+    AOK
+    SY,FFF4
+    AOK
+    R,1
+    Reboot!
+    Exiting config mode ...
+
+5. output of command 'X' after cofiguration
+
+    Ver 6.15 04/26/2013
+    (c) Roving Networks
+    ***Settings***
+    BTA=00066667BBE9
+    BTName=TmkBT-BBE9
+    Baudrt(SW4)=115K
+    Mode  =DTR
+    Authen=1
+    PinCod=1234
+    Bonded=0
+    Rem=NONE SET
+    ***ADVANCED Settings***
+    SrvName= Keyboard/Mouse
+    SrvClass=0000
+    DevClass=1F00
+    InqWindw=0100
+    PagWindw=0100
+    CfgTimer=255
+    StatuStr=NULL
+    HidFlags=3c
+    DTRtimer=8
+    KeySwapr=0
+    ***OTHER Settings***
+    Profile= HID
+    CfgChar= $
+    SniffEna=8000
+    LowPower=0
+    TX Power=fff4
+    IOPorts= 0
+    IOValues=0
+    Sleeptmr=0
+    DebugMod=0
+    RoleSwch=0
+
+
+Switch to USB mode
+------------------
+You can switch between USB and Bluetooth with pressing 'LShift+RShift+u'.
+
+
+Pairing mode
+------------
+This disconnects current connect and enter pairing mode.
+
+
+
+
+For deveropment
+===============
+
+RN-42 Serial Connection
+-----------------------
+UART:           115200bps, 8bit, 1-stopbit, non-parity, no flow control
+SSP:            115200bps, 8bit, 1-stopbit, non-parity, no flow control(via Bluetooth)
+
+To enter command mode disconnect the module from host and type '$$$'.(you will see 'CMD') and type '+' to get local echo. To exit type '---'(you will see 'END').
+
+
+RN-42 Commands
+--------------
+S-,tmkBT            // Device name
+SS,keyboard/mouse   // service name
+SM,4                // Auto Connect DTR mode
+SW,8010             // Sniff enable 0x10*0.625ms=10ms; 50ms is laggish and not much power save
+S~,6                // HID profile
+S~,0                // SPP profile
+SH,003C             // HID register
+SY,0004             // Transmit power
+SC,0000             // COD: 000005C0    (see HID spec/Bluegiga doc)
+SD,05C0             //     bit 12-8         7           6           5-0
+                    //         00101        1           1           0
+                    //         peripheral   pointing    keybaord    joystick, gamepad, ...
+SM,6                // Pairing mode: auto connect
+SM,4                // Master mode: Connection can be controled with GPIO6
+SF,1                // Factroy reset
+R,1                 // reboot
+SR,Z                // removes all remote addresses for reconnecting.
+                    // can be used to connect another host
+SR,I                // registers last inquiry address
+
+
+Operation Modes
+---------------
+SM,3        Auto Connect Master mode
+SM,4        Auto Connect DTR Mode uses GPIO6 to make and break connection(Mode =DTR)
+                confirm: auto connect works and control connection with GPIO6
+SM,5        Auto Connect ANY Mode (Mode =ANY)
+                each time GPIO is set, make inquiry and connect to the first found device
+SM,6        automatically reconnect(Mode =Pair)
+                confirm: auto connect works well but difficult to enter command mode.
+
+
+HID flag register
+-----------------
+SH,0200
+GH
+
+10 0000 0000(0200)  default
+00 0011 1000(0038)  Combo
+|| |  | |\_\____ number of paired devices to which the module can reconnect
+|| |  | \_______ send out reports over UART (0xFF <len> <data>)
+|| \__\_________ descriptor type
+|\______________ toggle virtual keyboard on iOS when first connected
+\_______________ Force HID mode if GPIO11 is high on power-up
+
+    Descriptor type:
+    0000:   keybaord
+    0001:   Game Pad
+    0010:   Mouse
+    0011:   Combo
+    0100:   Joystick
+    1xxx:   reserved
+
+
+Out report - Indicator
+----------------------
+0xFE 0x02 0x01 <LED_state>
+
+
+Apple iOS
+---------
+Keyboard can be used with iPhone, but mouse cannot.
+
+
+Android
+-------
+3.7.1.5 Note: To connect with Android phone the modules must wake up 11ms every 2.5seconds.
+
+
+Power Management
+----------------
+Inquiry and Page window     Idle or Active  (3.1.1)
+    Downside: delay in discovery or connection time
+    SI,         // set inquiry scan window(discovery) on/off duty?
+    SJ,         // set page scan window(connection)
+    This reduces averaege power >20mA to 5mA(3mA in Sniff mode)
+
+Sniff mode                  Transmit
+    Sniff mode is disabled by default and radio is active continuously when connected.(25-30mA)
+    In Sniff mode the radio wakes up intermittently and sleeps in very low power mode.(2mA)
+    SW,<val>    // set interval timer(*0.625ms) 0000-7FFF
+
+Deep sleep                  Idle            (3.1.2)
+    In this mode the module shuts down completly and only draws about 300uA. To enable this set the most signifant bit(0x8000) of Sniff interaval timer.
+    SW,8320     // deep sleep enable(interval=0x320*0.625=500ms)
+    In normal sleep the firmware is still running in idle mode, and wakes up about 20 times per second to check ports, update LEDs, etc. During deep sleep, the firmware actually stops runnig some tasks and the LEDs only update about once per second.
+    To wake from deep sleep there are three ways: (in worst case wake up takes 5ms)
+        *send a charactor to the UART(first charactor will be lost)
+        *toggle CTS low to high and wait 5ms
+        *wake automatically every slot time(<val>*0.625ms)
+    Once the radio is awake it stay active for exactly 1 second of inactivity and then sleeps again.
+    Downside: latency and data loss
+
+Disable Output driver       Idle or Active  (3.1.3)
+    S%,1000     // set all GPIO pins(0-11) to inputs.
+
+Lower Transmit Power        Idle or Active  (3.1.4)
+    SY,<hex>    // transmit power setting(takes effect after a power cycle and reboot)
+    Downside: reducing effective range
+
+
+Optimizig for Latency
+---------------------
+By default the firmware is optimized for throughput.
+SQ,16           // set latency bit
+SQ,0            // unset latency bit
+
+
+Configuration timer settings
+----------------------------
+Remote configuration is used for the module to be configured with various commands over Bluetooth(SPP profile only?).
+
+The module has remote configuration timer to allow remote configuration over Bluetooth after power up in Slave mode. In Master modes the remote configuration timer is set to 0(no remote configuration). (In Trigger Master mode the timer is used as an idle timer to break the connection after time expires with no charactors receive.)
+    ST,0        // no remote, no local when connected
+    ST,<1-252>  // local and remote with timeout in seconds from power up
+    ST,253      // local only       without timeout
+    ST,254      // remote only      without timeout
+    ST,255      // local and remote without timeout
+
+
+Commands
+--------
+S7,                     7bit mode
+SA,                     Authenticaiton
+SB,                     Send break
+SC,                     Service class
+SD,                     Device class
+SM,<val>                Operation mode
+SP,<string>             Pin code(alpahnumeric)
+SQ,<mask>               Special configuration(GPIO, discovery mode, low latency, reboot, UART)
+SR,<hex>                Store remote address
+SR,Z                    Erase all address
+SS,<string>             Set service name(1-20)**
+ST,<val>                Remote configuration timer(Master:0, Slave:0-255, Triger:as idle timer)
+SU,<val>                UART baud rate
+SW,<val>                low-power sniff mode** deep sleep and wake up every 625us * <val>
+SX,<0|1>                bonding enable  only acceps device that matches the stored address
+SY,<hex>                power setting**
+SZ,<val>                non-standard raw baud rate  <val>=baud*0.004096
+S~,<val>                Profile     0:SPP, 5:APL, 6:HID
+S-,<string>             Device name     -15 alphanumeric charactors
+S?,<0|1>                role switch enable
+S$,<char>               command mode char
+$|,<hex>                low-power connect mode  deep sleep/active(discoverable and connectable) cycle
+D                       display basic setting
+E                       display extended setting
+GB                      display the device's Bluetooth address
+GF                      display Bluetooth address of connected device
+GK                      show connection status
+GR                      show remote address for reconnecting
+G&                      show GPIO pin
+G<char>                 show stored setting
++                       toggle local echo on/off
+&                       show GPIO 3,4,6,7(DIP switch)
+C                       connect to stored remote address
+C,<address>             connect last address
+CFI                     connect and go into fast data mode
+CFR                     connect and go into fast data mode
+CT,<address>,<val>      connect to the address and disconnect after val?
+F,1                     fast data mod:
+H                       display help
+I,<time>,<cod>          inquiry scan with <cod>
+IN,<time>,<cod>         inquiry scan with <cod>, return without BT name
+IR                      inquiry scan with 0055AA
+IS                      inquiry scan with 001F00
+J                       hide pin code
+K,                      kill    disconnects current connection
+L                       link quality
+M                       show modem signlal status
+O                       display other settings
+P,<char>                pass through?
+Q                       quiet mode  make the module not discoverable
+Q,0                     discoverable and connectable
+Q,1                     not discoverable and not connectable
+Q,2                     not discoverable and connectable
+Q,?                     display current quiet mode
+R,1                     reboot
+T,<0|1>                 pass received data while in command mode
+U,<baud>,<parity>       change UART setting tentatively
+V                       display firmware version
+W                       wake from quiet mode    enable discovery and connection
+Z                       deep sleep mode(<2mA)
+
+
+Reset to Factory Default
+------------------------
+SF,1
+R,1

keyboards/hhkb/rn42/battery.c

@@ -0,0 +1,130 @@
+#include <avr/io.h>
+#include <util/delay.h>
+#include "battery.h"
+
+
+/*
+ * Battery
+ */
+void battery_init(void)
+{
+    // blink
+    battery_led(LED_ON);  _delay_ms(100);
+    battery_led(LED_OFF); _delay_ms(100);
+    battery_led(LED_ON);  _delay_ms(100);
+    battery_led(LED_OFF); _delay_ms(100);
+    // LED indicates charger status
+    battery_led(LED_CHARGER);
+
+    // ADC setting for voltage monitor
+    // Ref:2.56V band-gap, Input:ADC0(PF0), Prescale:128(16MHz/128=125KHz)
+    ADMUX = (1<<REFS1) | (1<<REFS0);
+    ADCSRA = (1<<ADPS2) | (1<<ADPS1) | (1<<ADPS0);
+    // digital input buffer disable(24.9.5)
+    DIDR0 = (1<<ADC0D) | (1<<ADC4D) | (1<<ADC7D);
+    DIDR1 = (1<<AIN0D);
+    DIDR2 = (1<<ADC8D) | (1<<ADC9D) | (1<<ADC11D) | (1<<ADC12D) | (1<<ADC13D);
+
+    // ADC disable voltate divider(PF4)
+    DDRF  |=  (1<<4);
+    PORTF &= ~(1<<4);
+}
+
+// Indicator for battery
+void battery_led(battery_led_t val)
+{
+    if (val == LED_TOGGLE) {
+        // Toggle LED
+        DDRF  |=  (1<<5);
+        PINF  |=  (1<<5);
+    } else if (val == LED_ON) {
+        // On overriding charger status
+        DDRF  |=  (1<<5);
+        PORTF &= ~(1<<5);
+    } else if (val == LED_OFF) {
+        // Off overriding charger status
+        DDRF  |=  (1<<5);
+        PORTF |=  (1<<5);
+    } else {
+        // Display charger status
+        DDRF  &= ~(1<<5);
+        PORTF &= ~(1<<5);
+    }
+}
+
+bool battery_charging(void)
+{
+    if (!(USBSTA&(1<<VBUS))) return false;
+
+    // Charger Status:
+    //   MCP73831   MCP73832   LTC4054  Status
+    //   Hi-Z       Hi-Z       Hi-Z     Shutdown/No Battery
+    //   Low        Low        Low      Charging
+    //   Hi         Hi-Z       Hi-Z     Charged
+
+    // preserve last register status
+    uint8_t ddrf_prev  = DDRF;
+    uint8_t portf_prev = PORTF;
+
+    // Input with pullup
+    DDRF  &= ~(1<<5);
+    PORTF |=  (1<<5);
+    _delay_ms(1);
+    bool charging = PINF&(1<<5) ? false : true;
+
+    // restore last register status
+    DDRF  = (DDRF&~(1<<5))  | (ddrf_prev&(1<<5));
+    PORTF = (PORTF&~(1<<5)) | (portf_prev&(1<<5));
+
+    // TODO: With MCP73831 this can not get stable status when charging.
+    // LED is powered from PSEL line(USB or Lipo)
+    // due to weak low output of STAT pin?
+    // due to pull-up'd via resitor and LED?
+    return charging;
+}
+
+// Returns voltage in mV
+uint16_t battery_voltage(void)
+{
+    // ADC disable voltate divider(PF4)
+    DDRF  |=  (1<<4);
+    PORTF |=  (1<<4);
+
+    volatile uint16_t bat;
+    ADCSRA |= (1<<ADEN);
+    _delay_ms(1);   // wait for charging S/H capacitance
+
+    ADCSRA |= (1<<ADSC);
+    while (ADCSRA & (1<<ADSC)) ;
+    bat = ADC;
+
+    ADCSRA &= ~(1<<ADEN);
+
+    // ADC disable voltate divider(PF4)
+    DDRF  |=  (1<<4);
+    PORTF &= ~(1<<4);
+
+    return (bat - BATTERY_ADC_OFFSET) * BATTERY_ADC_RESOLUTION;
+}
+
+static bool low_voltage(void) {
+    static bool low = false;
+    uint16_t v = battery_voltage();
+    if (v < BATTERY_VOLTAGE_LOW_LIMIT) {
+        low = true;
+    } else if (v > BATTERY_VOLTAGE_LOW_RECOVERY) {
+        low = false;
+    }
+    return low;
+}
+
+battery_status_t battery_status(void)
+{
+    if (USBSTA&(1<<VBUS)) {
+        /* powered */
+        return battery_charging() ? CHARGING : FULL_CHARGED;
+    } else {
+        /* not powered */
+        return low_voltage() ? LOW_VOLTAGE : DISCHARGING;
+    }
+}

keyboards/hhkb/rn42/battery.h

@@ -0,0 +1,35 @@
+#ifndef POWER_H
+#define POWER_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+typedef enum {
+    FULL_CHARGED,
+    CHARGING,
+    DISCHARGING,
+    LOW_VOLTAGE,
+    UNKNOWN,
+} battery_status_t;
+
+typedef enum {
+    LED_CHARGER = 0,
+    LED_ON,
+    LED_OFF,
+    LED_TOGGLE,
+} battery_led_t;
+
+/* Battery API */
+void battery_init(void);
+void battery_led(battery_led_t val);
+bool battery_charging(void);
+uint16_t battery_voltage(void);
+battery_status_t battery_status(void);
+
+#define BATTERY_VOLTAGE_LOW_LIMIT       3500
+#define BATTERY_VOLTAGE_LOW_RECOVERY    3700
+// ADC offset:16, resolution:5mV
+#define BATTERY_ADC_OFFSET              16
+#define BATTERY_ADC_RESOLUTION          5
+
+#endif

keyboards/hhkb/rn42/main.c

@@ -0,0 +1,106 @@
+#include <avr/io.h>
+#include <avr/power.h>
+#include <avr/wdt.h>
+#include "lufa.h"
+#include "print.h"
+#include "sendchar.h"
+#include "rn42.h"
+#include "rn42_task.h"
+#include "serial.h"
+#include "keyboard.h"
+#include "keycode.h"
+#include "action.h"
+#include "action_util.h"
+#include "wait.h"
+#include "suart.h"
+#include "suspend.h"
+#include "matrix.h"
+
+static int8_t sendchar_func(uint8_t c)
+{
+    xmit(c);        // SUART
+    sendchar(c);    // LUFA
+    return 0;
+}
+
+static void SetupHardware(void)
+{
+    /* Disable watchdog if enabled by bootloader/fuses */
+    MCUSR &= ~(1 << WDRF);
+    wdt_disable();
+
+    /* Disable clock division */
+    clock_prescale_set(clock_div_1);
+
+    // Leonardo needs. Without this USB device is not recognized.
+    USB_Disable();
+
+    USB_Init();
+
+    // for Console_Task
+    USB_Device_EnableSOFEvents();
+    print_set_sendchar(sendchar_func);
+
+    // SUART PD0:output, PD1:input
+    DDRD |= (1<<0);
+    PORTD |= (1<<0);
+    DDRD &= ~(1<<1);
+    PORTD |= (1<<1);
+}
+
+int main(void)  __attribute__ ((weak));
+int main(void)
+{
+    SetupHardware();
+    sei();
+
+    /* wait for USB startup to get ready for debug output */
+    uint8_t timeout = 255;  // timeout when USB is not available(Bluetooth)
+    while (timeout-- && USB_DeviceState != DEVICE_STATE_Configured) {
+        wait_ms(4);
+#if defined(INTERRUPT_CONTROL_ENDPOINT)
+        ;
+#else
+        USB_USBTask();
+#endif
+    }
+    print("\nUSB init\n");
+
+    rn42_init();
+    rn42_task_init();
+    print("RN-42 init\n");
+
+    /* init modules */
+    keyboard_init();
+
+#ifdef SLEEP_LED_ENABLE
+    sleep_led_init();
+#endif
+
+    print("Keyboard start\n");
+    while (1) {
+        while (rn42_rts() && // RN42 is off
+                USB_DeviceState == DEVICE_STATE_Suspended) {
+            print("[s]");
+            matrix_power_down();
+            suspend_power_down();
+            suspend_power_down();
+            suspend_power_down();
+            suspend_power_down();
+            suspend_power_down();
+            suspend_power_down();
+            suspend_power_down();
+            if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) {
+                    USB_Device_SendRemoteWakeup();
+            }
+        }
+
+        keyboard_task();
+
+#if !defined(INTERRUPT_CONTROL_ENDPOINT)
+        USB_USBTask();
+#endif
+
+        rn42_task();
+    }
+}

keyboards/hhkb/rn42/rn42.c

@@ -0,0 +1,265 @@
+#include <avr/io.h>
+#include "host.h"
+#include "host_driver.h"
+#include "serial.h"
+#include "rn42.h"
+#include "print.h"
+#include "timer.h"
+#include "wait.h"
+
+
+/* Host driver */
+static uint8_t keyboard_leds(void);
+static void send_keyboard(report_keyboard_t *report);
+static void send_mouse(report_mouse_t *report);
+static void send_system(uint16_t data);
+static void send_consumer(uint16_t data);
+
+host_driver_t rn42_driver = {
+    keyboard_leds,
+    send_keyboard,
+    send_mouse,
+    send_system,
+    send_consumer
+};
+
+
+void rn42_init(void)
+{
+    // JTAG disable for PORT F. write JTD bit twice within four cycles.
+    MCUCR |= (1<<JTD);
+    MCUCR |= (1<<JTD);
+
+    // PF7: BT connection control(high: connect, low: disconnect)
+    rn42_autoconnect();
+
+    // PF6: linked(input without pull-up)
+    DDRF  &= ~(1<<6);
+    PORTF |=  (1<<6);
+
+    // PF1: RTS(low: allowed to send, high: not allowed)
+    DDRF &= ~(1<<1);
+    PORTF &= ~(1<<1);
+
+    // PD5: CTS(low: allow to send, high:not allow)
+    DDRD |= (1<<5);
+    PORTD &= ~(1<<5);
+
+    serial_init();
+}
+
+int16_t rn42_getc(void)
+{
+    return serial_recv2();
+}
+
+const char *rn42_gets(uint16_t timeout)
+{
+    static char s[24];
+    uint16_t t = timer_read();
+    uint8_t i = 0;
+    int16_t c;
+    while (i < 23 && timer_elapsed(t) < timeout) {
+        if ((c = rn42_getc()) != -1) {
+            if ((char)c == '\r') continue;
+            if ((char)c == '\n') break;
+            s[i++] = c;
+        }
+    }
+    s[i] = '\0';
+    return s;
+}
+
+void rn42_putc(uint8_t c)
+{
+    serial_send(c);
+}
+
+void rn42_puts(char *s)
+{
+    while (*s)
+	serial_send(*s++);
+}
+
+bool rn42_autoconnecting(void)
+{
+    // GPIO6 for control connection(high: auto connect, low: disconnect)
+    // Note that this needs config: SM,4(Auto-Connect DTR Mode)
+    return (PORTF & (1<<7) ? true : false);
+}
+
+void rn42_autoconnect(void)
+{
+    // hi to auto connect
+    DDRF |= (1<<7);
+    PORTF |= (1<<7);
+}
+
+void rn42_disconnect(void)
+{
+    // low to disconnect
+    DDRF |= (1<<7);
+    PORTF &= ~(1<<7);
+}
+
+bool rn42_rts(void)
+{
+    // low when RN-42 is powered and ready to receive
+    return PINF&(1<<1);
+}
+
+void rn42_cts_hi(void)
+{
+    // not allow to send
+    PORTD |= (1<<5);
+}
+
+void rn42_cts_lo(void)
+{
+    // allow to send
+    PORTD &= ~(1<<5);
+}
+
+bool rn42_linked(void)
+{
+    // RN-42 GPIO2
+    //   Hi-Z:  Not powered
+    //   High:  Linked
+    //   Low:   Connecting
+    return PINF&(1<<6);
+}
+
+
+static uint8_t leds = 0;
+static uint8_t keyboard_leds(void) { return leds; }
+void rn42_set_leds(uint8_t l) { leds = l; }
+
+
+void rn42_send_str(const char *str)
+{
+    uint8_t c;
+    while ((c = pgm_read_byte(str++)))
+        rn42_putc(c);
+}
+
+const char *rn42_send_command(const char *cmd)
+{
+    static const char *s;
+    rn42_send_str(cmd);
+    wait_ms(500);
+    s = rn42_gets(100);
+    xprintf("%s\r\n", s);
+    rn42_print_response();
+    return s;
+}
+
+void rn42_print_response(void)
+{
+    int16_t c;
+    while ((c = rn42_getc()) != -1) {
+        xprintf("%c", c);
+    }
+}
+
+
+static void send_keyboard(report_keyboard_t *report)
+{
+    // wake from deep sleep
+/*
+    PORTD |= (1<<5);    // high
+    wait_ms(5);
+    PORTD &= ~(1<<5);   // low
+*/
+
+    serial_send(0xFD);  // Raw report mode
+    serial_send(9);     // length
+    serial_send(1);     // descriptor type
+    serial_send(report->mods);
+    serial_send(0x00);
+    serial_send(report->keys[0]);
+    serial_send(report->keys[1]);
+    serial_send(report->keys[2]);
+    serial_send(report->keys[3]);
+    serial_send(report->keys[4]);
+    serial_send(report->keys[5]);
+}
+
+static void send_mouse(report_mouse_t *report)
+{
+    // wake from deep sleep
+/*
+    PORTD |= (1<<5);    // high
+    wait_ms(5);
+    PORTD &= ~(1<<5);   // low
+*/
+
+    serial_send(0xFD);  // Raw report mode
+    serial_send(5);     // length
+    serial_send(2);     // descriptor type
+    serial_send(report->buttons);
+    serial_send(report->x);
+    serial_send(report->y);
+    serial_send(report->v);
+}
+
+static void send_system(uint16_t data)
+{
+    // Table 5-6 of RN-BT-DATA-UB
+    // 81,82,83 scan codes can be used?
+}
+
+
+static uint16_t usage2bits(uint16_t usage)
+{
+    switch (usage) {
+        case AC_HOME:                 return 0x01;
+        case AL_EMAIL:                return 0x02;
+        case AC_SEARCH:               return 0x04;
+        //case AL_KBD_LAYOUT:         return 0x08;  // Apple virtual keybaord toggle
+        case AUDIO_VOL_UP:            return 0x10;
+        case AUDIO_VOL_DOWN:          return 0x20;
+        case AUDIO_MUTE:              return 0x40;
+        case TRANSPORT_PLAY_PAUSE:    return 0x80;
+        case TRANSPORT_NEXT_TRACK:    return 0x100;
+        case TRANSPORT_PREV_TRACK:    return 0x200;
+        case TRANSPORT_STOP:          return 0x400;
+        case TRANSPORT_STOP_EJECT:    return 0x800;
+        case TRANSPORT_FAST_FORWARD:  return 0x1000;
+        case TRANSPORT_REWIND:        return 0x2000;
+        //case return 0x4000;   // Stop/eject
+        //case return 0x8000;   // Internet browser
+    };
+    return 0;
+}
+
+static void send_consumer(uint16_t data)
+{
+    uint16_t bits = usage2bits(data);
+    serial_send(0xFD);  // Raw report mode
+    serial_send(3);     // length
+    serial_send(3);     // descriptor type
+    serial_send(bits&0xFF);
+    serial_send((bits>>8)&0xFF);
+}
+
+
+/* Null driver for config_mode */
+static uint8_t config_keyboard_leds(void);
+static void config_send_keyboard(report_keyboard_t *report);
+static void config_send_mouse(report_mouse_t *report);
+static void config_send_system(uint16_t data);
+static void config_send_consumer(uint16_t data);
+
+host_driver_t rn42_config_driver = {
+    config_keyboard_leds,
+    config_send_keyboard,
+    config_send_mouse,
+    config_send_system,
+    config_send_consumer
+};
+
+static uint8_t config_keyboard_leds(void) { return leds; }
+static void config_send_keyboard(report_keyboard_t *report) {}
+static void config_send_mouse(report_mouse_t *report) {}
+static void config_send_system(uint16_t data) {}
+static void config_send_consumer(uint16_t data) {}