Keymap: I got my intern a KBParadise V60 Type R... (#3813)

* new mode for v60

xtonhasvim. still working on it:

- need to get indicator lights going
- and fun layer properly fleshed out.

* status lighting, proper fun layer

copied fun layout from keycaps to maximize accessibility

* enable power return

* support brightness adjustment for indicators

* refined brightness setting.

is saved in eeprom now

* readme. and fixed tilde

* more modifiers fall through fun layer

* i mean, this kinda works..

* much more reliable way of restoring lights

* responded to feedback

keyboards/v60_type_r/keymaps/xtonhasvim/config.h

@@ -0,0 +1,24 @@
+/* Copyright 2018 Christon DeWan (Xton)
+ *
+ * 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/>.
+ */
+
+
+#pragma once
+
+#define V60_POLESTAR
+
+#define PERMISSIVE_HOLD
+
+

keyboards/v60_type_r/keymaps/xtonhasvim/keymap.c

@@ -0,0 +1,196 @@
+/* Copyright 2018 Christon DeWan (Xton)
+ *
+ * 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
+
+#include "xtonhasvim.h"
+#include "fancylighting.h"
+
+#define _______ KC_TRNS
+#define X_____X KC_NO
+
+enum layers {
+  _QWERTY,
+  _FUN,
+  _MOVE,
+  _CMD
+};
+
+enum layout_key_codes {
+  IND_BRI = VIM_SAFE_RANGE,
+  IND_DIM
+};
+
+extern uint8_t vim_cmd_layer(void) { return _CMD; }
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_QWERTY] = LAYOUT_all(
+        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,  X_____X, KC_BSPC, \
+        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, \
+        LT(_MOVE, 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_ENT,  \
+        KC_LSFT, X_____X,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, X_____X,  \
+        KC_LCTL, KC_LALT, KC_LGUI,               KC_SPC,                          KC_RGUI, KC_RALT,  VIM_START, MO(_FUN)),
+
+
+    [_MOVE] = LAYOUT_all(
+        X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X,
+        X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, KC_HOME, KC_PGDN, KC_PGUP, KC_END, X_____X, X_____X, X_____X, X_____X,
+        _______, X_____X, LGUI(KC_LBRC), LGUI(LSFT(KC_LBRC)), LGUI(LSFT(KC_RBRC)), LGUI(KC_RBRC), KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, X_____X, X_____X, VIM_START,
+        _______, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, _______,
+        _______,   _______,   _______,               _______,                                                      _______,   _______,  _______,  _______),
+
+
+    [_FUN] = LAYOUT_all(
+	       KC_GRV,    KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,     KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,   KC_F12,  X_____X, KC_DEL, \
+	       X_____X,   X_____X,  KC_UP,    RGB_TOG,  IND_BRI,  X_____X,  X_____X,   X_____X, KC_PSCR, KC_SLCK, KC_PAUS, KC_UP,    X_____X,          KC_INS, \
+	       X_____X,   KC_LEFT,  KC_DOWN,  KC_RIGHT, IND_DIM,  X_____X,  X_____X,   X_____X, KC_HOME, KC_PGUP, KC_LEFT, KC_RIGHT,          FIREY_RETURN,          \
+	       _______,   X_____X,  BL_INC,   BL_STEP,  BL_DEC,   X_____X,  KC_VOLD,   KC_VOLU, KC_MUTE, KC_END,  KC_PGDN,  KC_DOWN, _______, X_____X,  \
+	       _______,   _______,  _______,            X_____X,                                                           _______,  _______, X_____X, _______
+    ),
+
+    [_CMD] = LAYOUT_all(
+        VIM_ESC, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X, X_____X,
+        X_____X, X_____X, VIM_W, VIM_E, X_____X, X_____X, VIM_Y, VIM_U, VIM_I, VIM_O, VIM_P, X_____X, X_____X, X_____X,
+        _______,   VIM_A, VIM_S, VIM_D, X_____X, VIM_G, VIM_H, VIM_J, VIM_K, VIM_L, X_____X, X_____X, X_____X,
+        VIM_SHIFT,     X_____X, X_____X, VIM_X, VIM_C, VIM_V, VIM_B, X_____X, X_____X, VIM_COMMA, VIM_PERIOD, X_____X, VIM_SHIFT,X_____X,
+        _______, _______, _______,               _______,                          _______, _______,  _______, TO(_QWERTY)
+    )
+};
+
+
+void led_set_user(uint8_t usb_led) {
+    if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
+        // output low
+        DDRE  |=  (1<<PE6);
+        PORTE &= ~(1<<PE6);
+    }
+    else {
+        // Hi-Z
+        DDRE  &= ~(1<<PE6);
+        PORTE &= ~(1<<PE6);
+    }
+}
+
+#define C_RED 0xFF, 0x00, 0x00
+#define C_GRN 0x00, 0xFF, 0x00
+#define C_BLU 0x00, 0x00, 0xFF
+
+#define C_YAN 0x00, 0xFF, 0xFF
+#define C_PRP 0x7A, 0x00, 0xFF
+#define C_ORG 0xFF, 0x93, 0x00
+
+float rgb_brightness = 1.0;
+
+/** the underglow LEDs aren't individually addressable, sadly */
+void rgbflag(uint8_t r, uint8_t g, uint8_t b) {
+  float rgb_brightness = ((float)rgblight_get_val())/256;
+  if(rgb_brightness == 0) rgb_brightness = 0.05;
+  LED_TYPE *target_led = user_rgb_mode ? shadowed_led : led;
+  target_led[0].r = (uint8_t)(r*rgb_brightness);
+  target_led[0].g = (uint8_t)(g*rgb_brightness);
+  target_led[0].b = (uint8_t)(b*rgb_brightness);
+  rgblight_set(); // just to handle turning off if that's required
+}
+
+void set_state_leds(void) {
+  switch (biton32(layer_state)) {
+  case _MOVE:
+    rgbflag(C_BLU);
+    break;
+  case _FUN:
+    rgbflag(C_PRP);
+    break;
+  case _CMD:
+    switch(vstate) {
+      case VIM_V:
+      case VIM_VI:
+      case VIM_VS:
+      case VIM_C:
+      case VIM_CI:
+      case VIM_D:
+      case VIM_DI:
+        rgbflag(C_RED);
+        break;
+      case VIM_G:
+        rgbflag(C_PRP);
+        break;
+      case VIM_Y:
+        rgbflag(C_ORG);
+        break;
+      case VIM_START:
+      default:
+        rgbflag(C_GRN);
+        break;
+    }
+    break;
+  default: //  for any other layers, or the default layer
+    rgbflag(C_YAN);
+    break;
+  }
+}
+
+#define RGBLIGHT_LIMIT_VAL 255
+#define RGBLIGHT_BASE_VAL 3
+extern rgblight_config_t rgblight_config;
+extern backlight_config_t backlight_config;
+
+bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
+  if (record->event.pressed) {
+    switch(keycode) {
+      case IND_BRI:
+        if (rgblight_config.val + RGBLIGHT_VAL_STEP > RGBLIGHT_LIMIT_VAL) {
+          rgblight_config.val = RGBLIGHT_LIMIT_VAL;
+        } else {
+          rgblight_config.val = rgblight_config.val + RGBLIGHT_VAL_STEP;
+        }
+        eeconfig_update_rgblight(rgblight_config.raw);
+        set_state_leds();
+      break;
+      case IND_DIM:
+        if (rgblight_config.val - RGBLIGHT_VAL_STEP < RGBLIGHT_BASE_VAL) {
+          rgblight_config.val = RGBLIGHT_BASE_VAL;
+        } else {
+          rgblight_config.val = rgblight_config.val - RGBLIGHT_VAL_STEP;
+        }
+        eeconfig_update_rgblight(rgblight_config.raw);
+        set_state_leds();
+      break;
+    }
+  }
+  return true;
+}
+
+void suspend_power_down_user(void)
+{
+  // rgb
+  rgblight_config.enable = false;
+  rgblight_set();
+
+  // backlight
+  /** I don't know why, but 3 means "off" and down is up */
+  backlight_config.level = 3;
+  backlight_config.enable = false;
+  backlight_set(3);
+}
+
+void suspend_wakeup_init_user(void)
+{
+  rgblight_config.raw = eeconfig_read_rgblight();
+  backlight_config.raw = eeconfig_read_backlight();
+
+  backlight_set(backlight_config.level);
+  rgblight_set();
+}
+

keyboards/v60_type_r/keymaps/xtonhasvim/readme.md

@@ -0,0 +1,20 @@
+KB Paradise V60 Type R Xton Has Vim! Layout
+======================
+
+If you don't look closely, this layout mimics the default layout fairly well. Care
+is taken to match the FN layer to the keycaps that the TypeR comes with. I wrote this layout 
+for a keyboard that I'm giving my intern as a parting gift and wanted it to be as easy to learn
+as possible.
+
+The key differences:
+
+- Holding capslock down activates the movement layer, much like the vimouse layout except that I'm using the xtonhasvim movement layer.
+- Capslock+return (or right-control) activates vim mode!
+
+## Keymap Notes
+
+- Alternate underglow modes are not supported. Instead the underglow is used to indicate state. It can be turned off and dimmed. Polestar underglow LEDs are not individually addressable, sadly.
+
+### Build
+
+To build this keymap, simply run `make v60_type_r:xtonhasvim` from the root project directory. Flash using QMK Toolbox

keyboards/v60_type_r/keymaps/xtonhasvim/rules.mk

@@ -0,0 +1,5 @@
+BACKLIGHT_ENABLE = yes
+RGBLIGHT_ENABLE = yes
+MOUSEKEY_ENABLE = no
+CONSOLE_ENABLE = no        # Console for debug(+400)
+DEBUG_ENABLE = no

keyboards/v60_type_r/rules.mk

@@ -68,4 +68,4 @@ 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
 
-LAYOUTS = 60_ansi
+LAYOUTS = 60_ansi

users/xtonhasvim/fancylighting.c

@@ -34,9 +34,14 @@ void matrix_scan_keymap(void) {
 #define FADE_BACK_TIME 500
 #define BREATH_FIRE_TIME 1000
 #define ANIMATION_STEP_INTERVAL 20
+
+#if RGBLED_NUM >= 2
 #define POWER_KEY_OFFSET (RGBLED_NUM / 2)
 #define SPACE_OFFSET_MAX (RGBLED_NUM / 2)
-
+#else
+#define POWER_KEY_OFFSET 1
+#define SPACE_OFFSET_MAX 1
+#endif
 
 uint16_t effect_start_timer = 0;
 uint8_t user_rgb_mode = 0;

users/xtonhasvim/fancylighting.h

@@ -1,4 +1,4 @@
-p /* Copyright 2015-2017 Christon DeWan
+/* Copyright 2015-2017 Christon DeWan
  *
  * 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
@@ -20,16 +20,17 @@ p /* Copyright 2015-2017 Christon DeWan
 
 #include "xtonhasvim.h"
 
+
 extern uint8_t user_rgb_mode;
 extern LED_TYPE shadowed_led[];
 
-void start_firey_return(void);
 
-#endif //_fancy_lighting_h
+#endif //RGBLIGHT_ENABLE
+void start_firey_return(void);
 
 enum xtonhasvim_rgbmodes {
   BREATH_FIRE = 1,
   FADE_BACK
 };
 
-#endif //RGBLIGHT_ENABLE
+#endif //_fancy_lighting_h

users/xtonhasvim/xtonhasvim.h

@@ -22,11 +22,9 @@
 
 #define X_____X KC_NO
 
-bool process_record_xtonhasvim(uint16_t keycode, keyrecord_t *record);
-
 enum xtonhasvim_keycodes {
-  DUMMY = SAFE_RANGE,
+  // 20: give keyboard-specific codes some room
-  FIREY_RETURN, // kick off special effects
+  FIREY_RETURN = SAFE_RANGE + 20,  // kick off special effects
   VIM_START, // bookend for vim states
   VIM_A,
   VIM_B,