wanleg's gherkin layout

my layout for the Gherkin

keyboards/gherkin/keymaps/wanleg/config.h

@@ -0,0 +1,61 @@
+#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    40 Percent Club
+#define PRODUCT         Gherkin
+#define DESCRIPTION     A 30 key ortholinear keyboard
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 6
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { F7, B1, B3, B2, B6 }
+#define MATRIX_COL_PINS { B4, E6, D7, C6, D4, D0 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* number of backlight levels */
+#define BACKLIGHT_PIN B5
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_LEVELS 3
+#endif
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCING_DELAY 5
+
+/* 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 command */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+/* prevent stuck modifiers */
+#define PREVENT_STUCK_MODIFIERS
+
+/*tap dance definition */
+#define TAPPING_TERM 200
+
+
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 0
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#endif
+
+#endif

keyboards/gherkin/keymaps/wanleg/keymap.c

@@ -0,0 +1,221 @@
+/* Copyright 2017 Brian Fong
+ *
+ * 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 "gherkin.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.
+#define _QW 0
+#define DIR 1
+#define NUM 2
+#define ETC 3
+
+
+/////////////// TAP DANCE SECTION START ///////////////
+//Tap Dance Declarations (list of my tap dance configurations)
+enum {
+  TD_SFT_CAPS = 0
+  ,TD_Q_ESC
+  ,ENT_TAP_DANCE
+  ,DEL_TAP_DANCE
+};
+
+///// QUAD FUNCTION TAP DANCE GENERAL SETUP SECTION START /////
+///// (no need to edit this section) /////
+//Enums used to clearly convey the state of the tap dance
+enum {
+  SINGLE_TAP = 1,
+  SINGLE_HOLD = 2,
+  DOUBLE_TAP = 3,
+  DOUBLE_HOLD = 4,
+  DOUBLE_SINGLE_TAP = 5 //send SINGLE_TAP twice - NOT DOUBLE_TAP
+  // Add more enums here if you want for triple, quadruple, etc.
+};
+
+typedef struct {
+  bool is_press_action;
+  int state;
+} tap;
+
+int cur_dance (qk_tap_dance_state_t *state) {
+  if (state->count == 1) {
+    //If count = 1, and it has been interrupted - it doesn't matter if it is pressed or not: Send SINGLE_TAP
+    if (state->interrupted || !state->pressed) return SINGLE_TAP;
+    if (state->interrupted) return SINGLE_TAP;
+    else return SINGLE_HOLD;
+  }
+  //If count = 2, and it has been interrupted - assume that user is trying to type the letter associated
+  //with single tap.
+  else if (state->count == 2) {
+    if (state->interrupted) return DOUBLE_SINGLE_TAP;
+    else if (state->pressed) return DOUBLE_HOLD;
+    else return DOUBLE_TAP;
+  }
+  else return 6; //magic number. At some point this method will expand to work for more presses
+}
+///// QUAD FUNCTION TAP DANCE GENERAL SETUP SECTION END /////
+///// QUAD FUNCTION TAP DANCE PERSONALIZATION SECTION START /////
+//instantialize an instance of 'tap' for the 'ENT' tap dance.
+static tap ENTtap_state = {
+  .is_press_action = true,
+  .state = 0
+};
+
+void ENT_finished (qk_tap_dance_state_t *state, void *user_data) {
+  ENTtap_state.state = cur_dance(state);
+  switch (ENTtap_state.state) {
+    case SINGLE_TAP: register_code(KC_SPC); break;
+    case SINGLE_HOLD: register_code(KC_LSFT); break;
+    case DOUBLE_TAP: register_code(KC_ENT); break;
+    case DOUBLE_HOLD: register_code(KC_NO); break; // setting double hold to do nothing (change this if you want)
+    case DOUBLE_SINGLE_TAP: register_code(KC_SPC); unregister_code(KC_SPC); register_code(KC_SPC);
+    //Last case is for fast typing. Assuming your key is `f`:
+    //For example, when typing the word `buffer`, and you want to make sure that you send `ff` and not `Esc`.
+    //In order to type `ff` when typing fast, the next character will have to be hit within the `TAPPING_TERM`, which by default is 200ms.
+  }
+}
+
+void ENT_reset (qk_tap_dance_state_t *state, void *user_data) {
+  switch (ENTtap_state.state) {
+    case SINGLE_TAP: unregister_code(KC_SPC); break;
+    case SINGLE_HOLD: unregister_code(KC_LSFT); break;
+    case DOUBLE_TAP: unregister_code(KC_ENT); break;
+    case DOUBLE_HOLD: unregister_code(KC_NO);
+    case DOUBLE_SINGLE_TAP: unregister_code(KC_SPC);
+  }
+  ENTtap_state.state = 0;
+}
+
+//instanalize an instance of 'tap' for the 'DEL' tap dance.
+static tap DELtap_state = {
+  .is_press_action = true,
+  .state = 0
+};
+
+void DEL_finished (qk_tap_dance_state_t *state, void *user_data) {
+  DELtap_state.state = cur_dance(state);
+  switch (DELtap_state.state) {
+    case SINGLE_TAP: register_code(KC_BSPC); break;
+    case SINGLE_HOLD: register_code(KC_LCTL); break;
+    case DOUBLE_TAP: register_code(KC_DEL); break;
+    case DOUBLE_HOLD: register_code(KC_NO); break;
+    case DOUBLE_SINGLE_TAP: register_code(KC_BSPC); unregister_code(KC_BSPC); register_code(KC_BSPC);
+  }
+}
+
+void DEL_reset (qk_tap_dance_state_t *state, void *user_data) {
+  switch (DELtap_state.state) {
+    case SINGLE_TAP: unregister_code(KC_BSPC); break;
+    case SINGLE_HOLD: unregister_code(KC_LCTL); break;
+    case DOUBLE_TAP: unregister_code(KC_DEL); break;
+    case DOUBLE_HOLD: unregister_code(KC_NO);
+    case DOUBLE_SINGLE_TAP: unregister_code(KC_BSPC);
+  }
+  DELtap_state.state = 0;
+}
+///// QUAD FUNCTION TAP DANCE PERSONALIZATION SECTION END /////
+
+//Tap Dance Definitions
+//THIS SECTION HAS TO BE AT THE END OF THE TAP DANCE SECTION
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [TD_SFT_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_LSFT, KC_CAPS)
+// Other declarations would go here, separated by commas, if you have them
+ ,[TD_Q_ESC]  = ACTION_TAP_DANCE_DOUBLE(KC_Q, KC_ESC)
+ ,[ENT_TAP_DANCE] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, ENT_finished, ENT_reset)
+ ,[DEL_TAP_DANCE] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, DEL_finished, DEL_reset)
+};
+
+//In Layer declaration, add tap dance item in place of a key code
+//TD(TD_SFT_CAPS)
+
+///////////// TAP DANCE SECTION END ///////////////
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+ /* Qwerty
+ * .-----------------------------------------------------------------------------------------.
+ * | Q//ESC | W      | E      | R      | T      | Y      | U      | I      | O      | P      |
+ * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ * | A      | S      | D      | F      | G      | H      | J      | K      | L      | ENTER  |
+ * |        |        |        |        |        |        |        |        |        |SFThold |
+ * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+ * | Z      | X      | C      | V/NUM  | B/ETC  | N      | M/DIR  | ,/GUI  | ./ALT  | BKSC   |
+ * | SFThold|        |        |        |        |        |        |        |        |CTRLhold|
+ * '-----------------------------------------------------------------------------------------'
+ */
+
+ [_QW] = KEYMAP( /* Qwerty*/
+   TD(TD_Q_ESC), KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,
+   KC_A,    KC_S,    KC_D,    KC_F,    KC_G, KC_H,    KC_J,    KC_K,    KC_L,   SFT_T(KC_SPC),
+   SFT_T(KC_Z),    KC_X,    KC_C,    LT(NUM, KC_V), LT(ETC, KC_B), KC_N, LT(DIR, KC_M), GUI_T(KC_COMM), ALT_T(KC_DOT), CTL_T(KC_BSPC)
+  ),
+
+
+//
+///*
+// *  Directional Modifiers
+// * .-----------------------------------------------------------------------------------------.
+// * | TAB    |   up   |        | INS    |  CTRL  | SHIFT  | PgUp   | HOME   |  -     |  =     |
+// * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+// * | left   |  down  | right  | PrScr  | SHIFT  |  CTRL  | PgDn   | END    |  [     |  ]     |
+// * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+// * |        |        |        |        |        |        |        |        | ALT    |  /     |
+// * '-----------------------------------------------------------------------------------------'
+// */
+//
+[DIR] = KEYMAP( /* Directional Modifiers */
+  KC_TAB,  KC_UP,   KC_TRNS, KC_INS,  KC_LCTL, KC_RSFT, KC_PGUP, KC_HOME, KC_MINS, KC_EQL  ,
+  KC_LEFT, KC_DOWN, KC_RGHT, KC_PSCR, KC_LSFT, KC_RCTL, KC_PGDN, KC_END,  KC_LBRC, KC_RBRC ,
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_RALT, KC_SLSH
+),
+//
+// /*
+//  *  Numbers
+//  * .-----------------------------------------------------------------------------------------.
+//  * | F1     | F2     | F3     | F4     | F5     | F6     | F7     | F8     | F9     | F10    |
+//  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+//  * | 1      | 2      | 3      | 4      | 5      | 6      | 7      | 8      | 9      | 0      |
+//  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+//  * | F11    | F12    |        |        |        | ENTER  | SHIFT  | GUI    | ./ALT  | BKSC   |
+//  * |        |        |        |        |        |        |        |        |        |CTRLhold|
+//  * '-----------------------------------------------------------------------------------------'
+//  */
+//
+[NUM] = KEYMAP ( /* Numbers */
+  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10  ,
+  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0    ,
+  KC_F11,  KC_F12,  KC_TRNS, KC_TRNS, KC_TRNS, KC_ENT,  KC_RSFT, KC_RGUI, ALT_T(KC_DOT), CTL_T(KC_BSPC)
+),
+//
+//
+//  /*
+//   *  ETC
+//   * .-----------------------------------------------------------------------------------------.
+//   * |  `     |        |        |        |        |        |        |        |        |  \     |
+//   * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+//   * | CAPS   | P-Brk  |        |        |        |        |        |        |  ;     |  '     |
+//   * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
+//   * | SHIFT  |        |        |        |        | C-A-D  |        | GUI    |        |  DEL   |
+//   * '-----------------------------------------------------------------------------------------'
+//   */
+//
+[ETC] = KEYMAP( /* ETC */
+  KC_GRV,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_BSLS ,
+  KC_CAPS, KC_PAUS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_SCLN, KC_QUOT ,
+  KC_LSFT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, LALT(LCTL(KC_DEL)), KC_TRNS, KC_RGUI, KC_TRNS, KC_DEL
+ ),
+};

keyboards/gherkin/keymaps/wanleg/readme.md

@@ -0,0 +1,12 @@
+![Gherkin Wanleg Layout Image](https://i.imgur.com/RpN5N42.png)
+
+# Gherkin Wanleg Layout
+
+Here is the layout I came up with to preserve a standard QWERTY layout as much as possible, in as few layers as possible for a 30 key board.
+I originally set up a few Tap Dance keys, but eventually dropped most of them in favor of chorded versions, since in actual use, they tended to impede typing speed more than their (current) two-key versions.
+I've left them in my layout ready for use if anyone wants to try them out:
+Single tap - Double tap - Hold
+space - enter - shift
+backspace - delete - control
+shift - caps lock - XXXX
+KC_Q - escape - XXXX

keyboards/gherkin/keymaps/wanleg/rules.mk

@@ -0,0 +1,63 @@
+# MCU name
+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*
+OPT_DEFS += -DBOOTLOADER_SIZE=4096
+
+# 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
+
+
+# Build Options
+#   comment out to disable the options.
+#
+BOOTMAGIC_ENABLE = yes	# 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
+SLEEP_LED_ENABLE = no  # Breathing sleep LED during USB suspend
+NKRO_ENABLE = yes		# USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = yes  # Enable keyboard backlight functionality
+AUDIO_ENABLE = no
+RGBLIGHT_ENABLE = no
+TAP_DANCE_ENABLE = yes		# Enable Tap Dance (comment if not being implemented)