summaryrefslogtreecommitdiff
path: root/keyboards/nyquist/keymaps/hexwire
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/nyquist/keymaps/hexwire')
-rw-r--r--keyboards/nyquist/keymaps/hexwire/Makefile5
-rw-r--r--keyboards/nyquist/keymaps/hexwire/README.md116
-rw-r--r--keyboards/nyquist/keymaps/hexwire/Underglow Pinouts.md20
-rw-r--r--keyboards/nyquist/keymaps/hexwire/config.h43
-rw-r--r--keyboards/nyquist/keymaps/hexwire/keymap.c218
-rwxr-xr-xkeyboards/nyquist/keymaps/hexwire/keymap_converter.py39
-rwxr-xr-xkeyboards/nyquist/keymaps/hexwire/keymap_to_readme.rb40
7 files changed, 481 insertions, 0 deletions
diff --git a/keyboards/nyquist/keymaps/hexwire/Makefile b/keyboards/nyquist/keymaps/hexwire/Makefile
new file mode 100644
index 0000000000..1e57612788
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/Makefile
@@ -0,0 +1,5 @@
+RGBLIGHT_ENABLE = yes
+
+ifndef QUANTUM_DIR
+ include ../../../../Makefile
+endif
diff --git a/keyboards/nyquist/keymaps/hexwire/README.md b/keyboards/nyquist/keymaps/hexwire/README.md
new file mode 100644
index 0000000000..3ce3f6af33
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/README.md
@@ -0,0 +1,116 @@
+Hexwire's Nyquist Layout
+============================
+
+### Changes from default layout
+
+- Main layer
+ - The right space bar key has been changed to backspace, as I only hit space with my left thumb
+ - Backtick is at the lower right and also serves goes to the 3rd function layer when held
+ - Enter key acts as shift when held
+ - Escape key acts as control when held
+ - Minus key at upper right
+- Lower layer
+ - Numbers are on the lower layer, to make it easier to use a numpad on the right hand
+ - Arrow keys
+ - Straight and curly brackets in the middle two columns
+ - Screenshot keys for MacOS
+- Upper layer
+ - Symbols are on the upper layer
+ - Media keys
+ - Page Up/Down, Home/End
+- 3rd function layer
+ - Function keys
+
+## Layouts
+
+### QWERTY
+
+```
+,----+----+----+----+----+----. ,----+----+----+----+----+----.
+|ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|TAB , Q , W , E , R , T , Y , U , I , O , P ,MINS|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| X0 , A , S , D , F , G , H , J , K , L ,SCLN,QUOT|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|LSFT, Z , X , C , V , B , N , M ,COMM,DOT ,SLSH, X4 |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT|
+`----+----+----+----+----+----' `----+----+----+----+----+----'
+```
+
+### Colemak
+```
+,----+----+----+----+----+----. ,----+----+----+----+----+----.
+|ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|TAB , Q , W , F , P , G , J , L , U , Y ,SCLN,MINS|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| X0 , A , R , S , T , D , H , N , E , I , O ,QUOT|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|LSFT, Z , X , C , V , B , K , M ,COMM,DOT ,SLSH, X4 |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT|
+`----+----+----+----+----+----' `----+----+----+----+----+----'
+```
+
+### Dvorak
+```
+,----+----+----+----+----+----. ,----+----+----+----+----+----.
+|ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|TAB ,QUOT,COMM,DOT , P , Y , F , G , C , R , L ,MINS|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| X0 , A , O , E , U , I , D , H , T , N , S ,SLSH|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|LSFT,SCLN, Q , J , K , X , B , M , W , V , Z , X4 |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT|
+`----+----+----+----+----+----' `----+----+----+----+----+----'
+```
+
+### Lower
+```
+,----+----+----+----+----+----. ,----+----+----+----+----+----.
+|TILD,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN,BSPC|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 , |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|DEL ,CAPP,LEFT,RGHT, UP ,LBRC, RBRC, P4 , P5 , P6 ,PLUS,PIPE|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| ,CPYP, , ,DOWN,LCBR, RCBR, P1 , P2 , P3 ,MINS, |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , , , , , , DEL , , P0 ,PDOT, , |
+`----+----+----+----+----+----' `----+----+----+----+----+----'
+```
+
+### Raise
+```
+,----+----+----+----+----+----. ,----+----+----+----+----+----.
+|TILD,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN,BSPC|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| ,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN, |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|DEL ,MPRV,MNXT,VOLU,PGUP,UNDS, EQL ,HOME, , , ,BSLS|
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+|MUTE,MSTP,MPLY,VOLD,PGDN,MINS, PLUS,END , , , , |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , , , , , , , , , , , |
+`----+----+----+----+----+----' `----+----+----+----+----+----'
+```
+
+### 3rd function layer
+
+```
+,----+----+----+----+----+----. ,----+----+----+----+----+----.
+|F12 , F1 , F2 , F3 , F4 , F5 , F6 , F7 , F8 , F9 ,F10 ,F11 |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , , , , , , , , , , , |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , , , , , , , , , , , |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , , , , , , , , , , , |
+|----+----+----+----+----+----| |----+----+----+----+----+----|
+| , , , , , , , , , , , |
+`----+----+----+----+----+----' `----+----+----+----+----+----'
+```
diff --git a/keyboards/nyquist/keymaps/hexwire/Underglow Pinouts.md b/keyboards/nyquist/keymaps/hexwire/Underglow Pinouts.md
new file mode 100644
index 0000000000..9a7633a52f
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/Underglow Pinouts.md
@@ -0,0 +1,20 @@
+# Let's Split RGB Underglow
+
+## Master
+
+### Pro Micro
+- Red: LED +5V -> Pro Micro VCC
+- Green: LED Din -> Pro Micro TX0
+- Black: LED GND -> Pro Micro GND
+
+### TRRS
+- Red: LED +5V -> PCB VCC
+- Green: LED Do -> PCB Extra Data
+- Black: LED GND -> PCB GND
+
+## Slave
+
+### TRRS
+- Red: LED +5V -> PCB VCC
+- Green: LED Din -> PCB Extra Data
+- Black: LED GND -> PCB GND
diff --git a/keyboards/nyquist/keymaps/hexwire/config.h b/keyboards/nyquist/keymaps/hexwire/config.h
new file mode 100644
index 0000000000..23abba0aa4
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/config.h
@@ -0,0 +1,43 @@
+/*
+Copyright 2017 Danny Nguyen <danny@hexwire.com>
+
+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.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 TAPPING_TERM 150
+
+#undef RGBLED_NUM
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 8
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+
+#endif \ No newline at end of file
diff --git a/keyboards/nyquist/keymaps/hexwire/keymap.c b/keyboards/nyquist/keymaps/hexwire/keymap.c
new file mode 100644
index 0000000000..803d257a91
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/keymap.c
@@ -0,0 +1,218 @@
+#include "nyquist.h"
+#include "action_layer.h"
+#include "eeconfig.h"
+
+extern keymap_config_t keymap_config;
+
+#define _QWERTY 0
+#define _COLEMAK 1
+#define _DVORAK 2
+#define _LOWER 3
+#define _RAISE 4
+#define _FN3 5
+#define _FN4 6
+#define _ADJUST 16
+
+enum custom_keycodes {
+ QWERTY = SAFE_RANGE,
+ COLEMAK,
+ DVORAK,
+ LOWER,
+ RAISE,
+ FN3,
+ FN4,
+ ADJUST,
+};
+
+#define KC_ KC_TRNS
+#define _______ KC_TRNS
+
+#define KC_CAPW LGUI(LSFT(KC_3)) // Capture whole screen
+#define KC_CPYW LGUI(LSFT(LCTL(KC_3))) // Copy whole screen
+#define KC_CAPP LGUI(LSFT(KC_4)) // Capture portion of screen
+#define KC_CPYP LGUI(LSFT(LCTL(KC_4))) // Copy portion of screen
+#define KC_X0 MT(MOD_LCTL, KC_ESC)
+#define KC_X1 LOWER
+#define KC_X2 RAISE
+#define KC_X3 LT(_FN3, KC_GRV)
+#define KC_X4 MT(MOD_LSFT, KC_ENT)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+ [_QWERTY] = KC_KEYMAP(
+ //,----+----+----+----+----+----. ,----+----+----+----+----+----.
+ ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ TAB , Q , W , E , R , T , Y , U , I , O , P ,MINS,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ X0 , A , S , D , F , G , H , J , K , L ,SCLN,QUOT,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ LSFT, Z , X , C , V , B , N , M ,COMM,DOT ,SLSH, X4 ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT
+ //`----+----+----+----+----+----' `----+----+----+----+----+----'
+ ),
+
+ [_COLEMAK] = KC_KEYMAP(
+ //,----+----+----+----+----+----. ,----+----+----+----+----+----.
+ ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ TAB , Q , W , F , P , G , J , L , U , Y ,SCLN,MINS,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ X0 , A , R , S , T , D , H , N , E , I , O ,QUOT,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ LSFT, Z , X , C , V , B , K , M ,COMM,DOT ,SLSH, X4 ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT
+ //`----+----+----+----+----+----' `----+----+----+----+----+----'
+ ),
+
+ [_DVORAK] = KC_KEYMAP(
+ //,----+----+----+----+----+----. ,----+----+----+----+----+----.
+ ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ TAB ,QUOT,COMM,DOT , P , Y , F , G , C , R , L ,MINS,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ X0 , A , O , E , U , I , D , H , T , N , S ,SLSH,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ LSFT,SCLN, Q , J , K , X , B , M , W , V , Z , X4 ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT
+ //`----+----+----+----+----+----' `----+----+----+----+----+----'
+ ),
+
+ [_LOWER] = KC_KEYMAP(
+ //,----+----+----+----+----+----. ,----+----+----+----+----+----.
+ TILD,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN,BSPC,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 , ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ DEL ,CAPP,LEFT,RGHT, UP ,LBRC, RBRC, P4 , P5 , P6 ,PLUS,PIPE,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ ,CPYP, , ,DOWN,LCBR, RCBR, P1 , P2 , P3 ,MINS, ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , , , , , , DEL , , P0 ,PDOT, ,
+ //`----+----+----+----+----+----' `----+----+----+----+----+----'
+ ),
+
+ [_RAISE] = KC_KEYMAP(
+ //,----+----+----+----+----+----. ,----+----+----+----+----+----.
+ TILD,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN,BSPC,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ ,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN, ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ DEL ,MPRV,MNXT,VOLU,PGUP,UNDS, EQL ,HOME, , , ,BSLS,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ MUTE,MSTP,MPLY,VOLD,PGDN,MINS, PLUS,END , , , , ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , , , , , , , , , , ,
+ //`----+----+----+----+----+----' `----+----+----+----+----+----'
+ ),
+
+ [_FN3] = KC_KEYMAP(
+ //,----+----+----+----+----+----. ,----+----+----+----+----+----.
+ F12 , F1 , F2 , F3 , F4 , F5 , F6 , F7 , F8 , F9 ,F10 ,F11 ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , , , , , , , , , , , ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , , , , , , , , , , , ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , , , , , , , , , , , ,
+ //|----+----+----+----+----+----| |----+----+----+----+----+----|
+ , , , , , , , , , , ,
+ //`----+----+----+----+----+----' `----+----+----+----+----+----'
+ ),
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * | | Reset|RGB Tg|RGB Md|Hue Up|Hue Dn|Sat Up|Sat Dn|Val Up|Val Dn| | |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak| | |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | | | | | | | | | | | | |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------------------'
+ */
+ [_ADJUST] = KEYMAP( \
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+ _______, RESET , RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI, _______, _______, \
+ _______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, _______, _______, \
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
+ )
+
+
+};
+
+#ifdef AUDIO_ENABLE
+float tone_qwerty[][2] = SONG(QWERTY_SOUND);
+float tone_dvorak[][2] = SONG(DVORAK_SOUND);
+float tone_colemak[][2] = SONG(COLEMAK_SOUND);
+#endif
+
+void persistent_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) {
+ switch (keycode) {
+ case QWERTY:
+ if (record->event.pressed) {
+ #ifdef AUDIO_ENABLE
+ PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
+ #endif
+ persistent_default_layer_set(1UL<<_QWERTY);
+ }
+ return false;
+ break;
+ case COLEMAK:
+ if (record->event.pressed) {
+ #ifdef AUDIO_ENABLE
+ PLAY_NOTE_ARRAY(tone_colemak, false, 0);
+ #endif
+ persistent_default_layer_set(1UL<<_COLEMAK);
+ }
+ return false;
+ break;
+ case DVORAK:
+ if (record->event.pressed) {
+ #ifdef AUDIO_ENABLE
+ PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
+ #endif
+ persistent_default_layer_set(1UL<<_DVORAK);
+ }
+ return false;
+ break;
+ 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;
+ break;
+ 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;
+ break;
+ case ADJUST:
+ if (record->event.pressed) {
+ layer_on(_ADJUST);
+ } else {
+ layer_off(_ADJUST);
+ }
+ return false;
+ break;
+ }
+ return true;
+}
diff --git a/keyboards/nyquist/keymaps/hexwire/keymap_converter.py b/keyboards/nyquist/keymaps/hexwire/keymap_converter.py
new file mode 100755
index 0000000000..683f64da45
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/keymap_converter.py
@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+import re
+
+class KeymapConverter:
+
+ def __init__(self, filename):
+ self.filename = filename
+
+ def read_keymaps(self):
+ with open(self.filename) as f:
+ lines = f.readlines()
+
+ mode = 0
+ for line in lines:
+ line = line[:-1]
+ if mode == 0:
+ if "KC_KEYMAP" in line:
+ matches = re.match(r'.*\[(.*)\] = .*', line)
+ if matches:
+ layer_name = matches.group(1)
+ layer_name = layer_name[1:].capitalize()
+ print '###', layer_name
+ print '```'
+ mode = 1
+ elif mode == 1:
+ if "//" in line:
+ print line[4:]
+ elif ")" in line:
+ mode = 0
+ print '```'
+ print
+ elif line[-1] == ',':
+ print "|" + line[5:-1] + "|"
+ else:
+ print "|" + line[5:] + "|"
+
+converter = KeymapConverter('keymap.c')
+converter.read_keymaps()
diff --git a/keyboards/nyquist/keymaps/hexwire/keymap_to_readme.rb b/keyboards/nyquist/keymaps/hexwire/keymap_to_readme.rb
new file mode 100755
index 0000000000..7285b008a4
--- /dev/null
+++ b/keyboards/nyquist/keymaps/hexwire/keymap_to_readme.rb
@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+class KeymapConverter
+
+ def initialize(filename)
+ @filename = filename
+ @mode = :search
+ end
+
+ def read_keymaps
+ lines = IO.readlines(@filename)
+ lines.each { |line| parse_line line[0..-2] }
+ end
+
+ def parse_line(line)
+ case @mode
+ when :search
+ if line =~ /KC_KEYMAP/
+ puts "### #{line}"
+ puts "```"
+ @mode = :parse
+ end
+ when :parse
+ if line =~ /\)/
+ @mode = :search
+ puts "```\n\n"
+ else
+ line = line[4..-1]
+ line.sub!(/(,)^-/m, "|")
+ line.sub!(/( {4})/, " |")
+
+ puts line
+ end
+ end
+ end
+
+end
+
+converter = KeymapConverter.new('keymap.c')
+converter.read_keymaps