summaryrefslogtreecommitdiffstats
path: root/keyboards/planck
diff options
context:
space:
mode:
authoryellowmoneybank <16255242+yellowmoneybank@users.noreply.github.com>2017-11-20 18:22:16 +0100
committerJack Humbert <jack.humb@gmail.com>2017-11-20 18:22:16 +0100
commitc6cdd5422fb64e8854db9cbd3ba2ca2f3b7418e8 (patch)
tree07e81461bee1a45545dc85b22726f2e632ee2d81 /keyboards/planck
parentd6ca4e555ac52a446b1657ac3f3027655fe5ab5b (diff)
downloadqmk_firmware-c6cdd5422fb64e8854db9cbd3ba2ca2f3b7418e8.tar.gz
qmk_firmware-c6cdd5422fb64e8854db9cbd3ba2ca2f3b7418e8.tar.xz
Neo2Planck (#2032)
* Documentation * Enabled Mouse-Keys in Makefile * Layer 1 finished * Small Bugfixes * Updated documentation
Diffstat (limited to 'keyboards/planck')
-rw-r--r--keyboards/planck/keymaps/neo2planck/config.h8
-rw-r--r--keyboards/planck/keymaps/neo2planck/keymap.c120
-rw-r--r--keyboards/planck/keymaps/neo2planck/readme.md64
-rw-r--r--keyboards/planck/keymaps/neo2planck/rules.mk23
4 files changed, 215 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/neo2planck/config.h b/keyboards/planck/keymaps/neo2planck/config.h
new file mode 100644
index 000000000..3e9e692d3
--- /dev/null
+++ b/keyboards/planck/keymaps/neo2planck/config.h
@@ -0,0 +1,8 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+#define PREVENT_STUCK_MODIFIERS
+
+#endif \ No newline at end of file
diff --git a/keyboards/planck/keymaps/neo2planck/keymap.c b/keyboards/planck/keymaps/neo2planck/keymap.c
new file mode 100644
index 000000000..d51b123ff
--- /dev/null
+++ b/keyboards/planck/keymaps/neo2planck/keymap.c
@@ -0,0 +1,120 @@
+#include "planck.h"
+#ifdef BACKLIGHT_ENABLE
+#include "backlight.h"
+#endif
+#include "keymap_german.h"
+
+// for intellisense, has to be commented for building
+/*
+#include "..\..\..\..\quantum\keymap_extras\keymap_german.h"
+#include "..\..\..\..\tmk_core\common\keycode.h"
+*/
+
+
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+
+/*
+This layout tries to emulate Neo2, and is intended to be used with a German QWERTZ softwarelayout.
+It has "üäöß" as it is optimized for a mix of German & English.
+The special character layer and the navigation & number block layer are designed to keep the fingers near the home row.
+*/
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/*
+,-----------------------------------------------------------------------------------.
+| Esc | X | V | L | C | W | K | H | G | F | Q | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Ent | U | I | A | E | O | S | N | R | T | D | Y |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift| Ü | Ö | Ä | P | Z | B | M | , | . | J |Shift |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt |MRight| Ctrl |
+`-----------------------------------------------------------------------------------'
+*/
+
+[0] = {
+ { KC_ESC, DE_X, DE_V, DE_L, DE_C, DE_W, DE_K, DE_H, DE_G, DE_F, DE_Q, KC_BSPC },
+ { KC_ENT, DE_U, DE_I, DE_A, DE_E, DE_O, DE_S, DE_N, DE_R, DE_T, DE_D, DE_Y },
+ { KC_LSFT, DE_UE, DE_OE, DE_AE, DE_P, DE_Z, DE_B, DE_M, DE_COMM, DE_DOT, DE_J, KC_LSFT },
+ { KC_LCTL , KC_RGUI, KC_LALT, MO(2), MO(1), KC_SPC, KC_SPC, MO(1), MO(2), KC_RALT, KC_BTN2, KC_RCTL }
+},
+
+/* M1
+ ,-----------------------------------------------------------------------------------.
+ | Esc | | _ | [ | ] | ^ | ! | < | > | = | & | ß |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | \ | / | { | } | * | ? | ( | ) | - | : | @ |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| # | $ | | | ~ | ` | + | % | " | ' | ; |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+*/
+[1] = {
+ { _______, _______, DE_UNDS, DE_LBRC, DE_RBRC, DE_CIRC, DE_EXLM, DE_LESS, DE_MORE, DE_EQL, DE_AMPR, DE_SS },
+ { KC_TAB, DE_BSLS, DE_SLSH, DE_LCBR, DE_RCBR, DE_ASTR, DE_QST, DE_LPRN, DE_RPRN, DE_MINS, DE_COLN, DE_AT },
+ { _______, DE_HASH, DE_DLR, DE_PIPE, DE_TILD, DE_ACUT, DE_PLUS, DE_PERC, DE_DQOT, DE_QUOT, DE_SCLN, _______ },
+ { _______, _______, _______, MO(3), _______, _______, _______, _______, MO(3), _______, _______, _______ }
+},
+
+/* M2 Navigation & Number Blocks
+* very easy to get used to & intuituve placement
+* ,-----------------------------------------------------------------------------------.
+* | | PgUp | Bksp | Up | DEL | PgDn | | 7 | 8 | 9 | | Ins |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* | Tab | Home | Lft | Down | Right| End | | 4 | 5 | 6 | . | Enter|
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift| | Tab | | Enter| | 0 | 1 | 2 | 3 | , |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+* `-----------------------------------------------------------------------------------'
+*/
+[2] = {
+ { XXXXXXX, KC_PGUP, KC_BSPC, KC_UP, KC_DEL, KC_PGDN, XXXXXXX, DE_7, DE_8, DE_9, XXXXXXX, KC_INS },
+ { KC_TAB, KC_HOME, KC_LEFT, KC_DOWN, KC_RGHT, KC_END, XXXXXXX, DE_4, DE_5, DE_6, DE_DOT, KC_ENT },
+ { _______, XXXXXXX, KC_TAB, XXXXXXX, KC_ENT, XXXXXXX, DE_0, DE_1, DE_2, DE_3, DE_COMM, _______ },
+ { _______, _______, _______, _______, MO(3), _______, _______, MO(3), _______, _______, _______, _______ }
+},
+
+/* M3 Function & Media Keys
+* ,-----------------------------------------------------------------------------------.
+* | | | Print|Scroll|Pause | | | F7 | F8 | F9 | F12 | |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* | Tab | | Mute | Vol- | Vol+ | | ³ | F4 | F5 | F6 | F11 | Enter|
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift| | Prev | Play | Next | | ² | F1 | F2 | F3 | F10 |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+* `-----------------------------------------------------------------------------------'
+*/
+[3] = {
+ { XXXXXXX, XXXXXXX, KC_PSCR, KC_SLCK, KC_PAUS, XXXXXXX, XXXXXXX, KC_F7, KC_F8, KC_F9, KC_F12, XXXXXXX },
+ { KC_TAB, XXXXXXX, KC_MUTE, KC_VOLD, KC_VOLU, XXXXXXX, DE_SQ3, KC_F4, KC_F5, KC_F6, KC_F11, KC_ENT },
+ { _______, XXXXXXX, KC_MPRV, KC_MPLY, KC_MNXT, XXXXXXX, DE_SQ2, KC_F1, KC_F2, KC_F3, KC_F10, _______ },
+ { _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ }
+},
+};
+
+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);
+#ifdef BACKLIGHT_ENABLE
+ backlight_step();
+#endif
+ }
+ else {
+ unregister_code(KC_RSFT);
+ }
+ break;
+ }
+ return MACRO_NONE;
+};
diff --git a/keyboards/planck/keymaps/neo2planck/readme.md b/keyboards/planck/keymaps/neo2planck/readme.md
new file mode 100644
index 000000000..2f1c32057
--- /dev/null
+++ b/keyboards/planck/keymaps/neo2planck/readme.md
@@ -0,0 +1,64 @@
+Neo2Planck
+=====================================
+
+This layout tries to emulate Neo2, and is intended to be used with a German QWERTZ softwarelayout.
+It has "üäöß" as it is optimized for a mix of German & English.
+The special character layer and the navigation & number block layer are designed to keep the fingers near the home row.
+
+This layout has some adaptations, due to the limited keys available:
+* function-keys moved to the bottom row
+* press M1 + M2 to get to layer 3
+
+Neo2 wiki page: http://wiki.neo-layout.org/
+
+## Neo2 Base Layer
+```
+ ,-----------------------------------------------------------------------------------.
+ | Esc | X | V | L | C | W | K | H | G | F | Q | Bksp |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Ent | U | I | A | E | O | S | N | R | T | D | Y |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| Ü | Ö | Ä | P | Z | B | M | , | . | J |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt |MRight| Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
+
+# M1 Special Characters
+```
+ ,-----------------------------------------------------------------------------------.
+ | Esc | | _ | [ | ] | ^ | ! | < | > | = | & | ß |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | \ | / | { | } | * | ? | ( | ) | - | : | @ |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| # | $ | | | ~ | ` | + | % | " | ' | ; |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
+
+## M2 Navigation & Number Blocks
+```
+ ,-----------------------------------------------------------------------------------.
+ | | PgUp | Bksp | Up | DEL | PgDn | | 7 | 8 | 9 | | Ins |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | Home | Lft | Down | Right| End | | 4 | 5 | 6 | . | Enter|
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| | Tab | | Enter| | 0 | 1 | 2 | 3 | , |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
+
+## M3 F-Keys and Media-Keys
+```
+ ,-----------------------------------------------------------------------------------.
+ | | | Print|Scroll|Pause | | | F7 | F8 | F9 | F12 | |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | | Mute | Vol- | Vol+ | | ³ | F4 | F5 | F6 | F11 | Enter|
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| | Prev | Play | Next | | ² | F1 | F2 | F3 | F10 |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
diff --git a/keyboards/planck/keymaps/neo2planck/rules.mk b/keyboards/planck/keymaps/neo2planck/rules.mk
new file mode 100644
index 000000000..2122dd349
--- /dev/null
+++ b/keyboards/planck/keymaps/neo2planck/rules.mk
@@ -0,0 +1,23 @@
+# 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 = 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
+NKRO_ENABLE = yes # 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.
+
+# 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