[Keyboard] Add Free Willy Keyboard (qmk#14394)

Co-authored-by: Ryan <fauxpark@gmail.com>
MetalBoards · Sep 29, 2021 · ce9d88f · ce9d88f
1 parent 1931f29
commit ce9d88f
Show file tree

Hide file tree

Showing 12 changed files with 368 additions and 0 deletions.
diff --git a/keyboards/free_willy/config.h b/keyboards/free_willy/config.h
@@ -0,0 +1,39 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x5351 // SQ
+#define PRODUCT_ID 0x4657 // FW
+#define DEVICE_VER 0x0001
+#define MANUFACTURER squashkb
+#define PRODUCT free willy
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 10
+
+#define MATRIX_ROW_PINS { F4, F5, F6, F7 }
+#define MATRIX_COL_PINS { D3, D2, D1, D0, D4, C6, D7, E6, B4, B5 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
diff --git a/keyboards/free_willy/free_willy.c b/keyboards/free_willy/free_willy.c
@@ -0,0 +1,16 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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 "free_willy.h"
diff --git a/keyboards/free_willy/free_willy.h b/keyboards/free_willy/free_willy.h
@@ -0,0 +1,33 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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
+
+#include "quantum.h"
+
+#define XXX 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, \
+            K32, K33, K34, K35, K36, K37           \
+) \
+{ \
+  { 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  }, \
+  { XXX, XXX, K32, K33, K34, K35, K36, K37, XXX, XXX  }  \
+}
diff --git a/keyboards/free_willy/info.json b/keyboards/free_willy/info.json
@@ -0,0 +1,47 @@
+{
+    "keyboard_name": "free willy",
+    "url": "https://www.squashkb.com/product/free-willy",
+    "maintainer": "tsquash",
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"x":0, "y":0},
+                {"x":1, "y":0},
+                {"x":2, "y":0},
+                {"x":3, "y":0},
+                {"x":4, "y":0},
+                {"x":5, "y":0},
+                {"x":6, "y":0},
+                {"x":7, "y":0},
+                {"x":8, "y":0},
+                {"x":9, "y":0},
+                {"x":0, "y":1},
+                {"x":1, "y":1},
+                {"x":2, "y":1},
+                {"x":3, "y":1},
+                {"x":4, "y":1},
+                {"x":5, "y":1},
+                {"x":6, "y":1},
+                {"x":7, "y":1},
+                {"x":8, "y":1},
+                {"x":9, "y":1},
+                {"x":0, "y":2},
+                {"x":1, "y":2},
+                {"x":2, "y":2},
+                {"x":3, "y":2},
+                {"x":4, "y":2},
+                {"x":5, "y":2},
+                {"x":6, "y":2},
+                {"x":7, "y":2},
+                {"x":8, "y":2},
+                {"x":9, "y":2},
+                {"x":2, "y":3},
+                {"x":3, "y":3},
+                {"x":4, "y":3},
+                {"x":5, "y":3},
+                {"x":6, "y":3},
+                {"x":7, "y":3}
+             ]
+        }
+    }
+}
diff --git a/keyboards/free_willy/keymaps/colemak/config.h b/keyboards/free_willy/keymaps/colemak/config.h
@@ -0,0 +1,20 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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
+
+/* Combos */
+#define COMBO_COUNT 5
+#define COMBO_TERM 50
diff --git a/keyboards/free_willy/keymaps/colemak/keymap.c b/keyboards/free_willy/keymaps/colemak/keymap.c
@@ -0,0 +1,75 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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
+
+enum layers{
+  _BASE,
+  _SYM,
+  _NAV
+};
+
+#define KC_SYM_SPC LT(_SYM, KC_SPC)
+
+enum combo_events {
+  COMBO_NUMBAK,
+  COMBO_TAB,
+  COMBO_ESC,
+  COMBO_DEL,
+  COMBO_RET,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT(
+    KC_Q,   KC_W,   KC_F,    KC_P,       KC_B,    KC_J,     KC_L,       KC_U,    KC_Y,    KC_BSPC,
+    KC_A,   KC_R,   KC_S,    KC_T,       KC_G,    KC_M,     KC_N,       KC_E,    KC_I,    KC_O,
+    KC_X,   KC_C,   KC_D,    KC_V,       KC_Z,    KC_K,     KC_H,       KC_COMM, KC_DOT,  KC_SLSH,
+                    KC_LCTL, KC_LSFT, KC_LALT, KC_LGUI , KC_SYM_SPC, MO(_NAV)
+  ),
+
+  [_SYM] = LAYOUT(
+    KC_1,       KC_2,     KC_3,      KC_4,     KC_5,     KC_6,     KC_7,     KC_8,     KC_9,     KC_0,
+    KC_EXLM,    KC_AT,    KC_HASH,   KC_DLR,   KC_PERC,  KC_CIRC,  KC_AMPR,  KC_ASTR,  KC_EQUAL, KC_MINS,
+    KC_BSLS,    KC_SCLN,   KC_LCBR,   KC_LBRC,  KC_LPRN,  KC_RPRN,  KC_RBRC,  KC_RCBR,  KC_QUOT,  KC_GRV,
+                          KC_TRNS,   KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS
+  ),
+
+  [_NAV] = LAYOUT(
+    RESET,    KC_NO,    KC_NO,    KC_NO,  KC_NO,   KC_NO,  KC_NO,    KC_NO,  KC_NO,  KC_NO,
+    KC_LEFT,  KC_DOWN,  KC_UP,  KC_RGHT,  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_TRNS,  KC_TRNS,  KC_TRNS, KC_TRNS,   KC_TRNS,   KC_TRNS
+  ),
+};
+
+
+#ifdef COMBO_ENABLE
+//const uint16_t PROGMEM combo_bspc[] = {KC_O, KC_P, COMBO_END};
+const uint16_t PROGMEM combo_numbak[] = {KC_0, KC_9, COMBO_END};
+const uint16_t PROGMEM combo_tab[] = {KC_F, KC_W, COMBO_END};
+const uint16_t PROGMEM combo_esc[] = {KC_N, KC_T, COMBO_END};
+const uint16_t PROGMEM combo_del[] = {KC_MINS, KC_EQL, COMBO_END};
+const uint16_t PROGMEM combo_ret[] = {KC_LGUI, KC_LALT, COMBO_END};
+
+combo_t key_combos[COMBO_COUNT] = {
+  //[COMBO_BSPC] = COMBO(combo_bspc,KC_BSPC),
+  [COMBO_NUMBAK] = COMBO(combo_numbak,KC_BSPC),
+  [COMBO_TAB] = COMBO(combo_tab,KC_TAB),
+  [COMBO_ESC] = COMBO(combo_esc,KC_ESC),
+  [COMBO_DEL] = COMBO(combo_del,KC_DEL),
+  [COMBO_RET] = COMBO(combo_ret,KC_ENTER),
+
+};
+#endif
diff --git a/keyboards/free_willy/keymaps/colemak/rules.mk b/keyboards/free_willy/keymaps/colemak/rules.mk
@@ -0,0 +1 @@
+COMBO_ENABLE = yes
diff --git a/keyboards/free_willy/keymaps/default/config.h b/keyboards/free_willy/keymaps/default/config.h
@@ -0,0 +1,20 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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
+
+/* Combos */
+#define COMBO_COUNT 5
+#define COMBO_TERM 50
diff --git a/keyboards/free_willy/keymaps/default/keymap.c b/keyboards/free_willy/keymaps/default/keymap.c
@@ -0,0 +1,74 @@
+/* Copyright 2021 Caleb Lightfoot
+ *
+ * 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
+
+enum layers{
+  _BASE,
+  _SYM,
+  _NAV
+};
+
+#define KC_SYM_SPC LT(_SYM, KC_SPC)
+#define KC_SFT_BCK LSFT_T(KC_BSPC)
+
+
+enum combo_events {
+  COMBO_NUMBAK,
+  COMBO_TAB,
+  COMBO_ESC,
+  COMBO_DEL,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT(
+    KC_Q,   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,    KC_ENT,
+    KC_Z,   KC_X,   KC_C,    KC_V,       KC_B,    KC_N,     KC_M,       KC_COMM, KC_DOT,  KC_SLSH,
+                    KC_LCTL, KC_SFT_BCK, KC_LALT, KC_LGUI , KC_SYM_SPC, MO(_NAV)
+  ),
+
+  [_SYM] = LAYOUT(
+    KC_1,       KC_2,     KC_3,      KC_4,     KC_5,     KC_6,     KC_7,     KC_8,     KC_9,     KC_0,
+    KC_EXLM,    KC_AT,    KC_HASH,   KC_DLR,   KC_PERC,  KC_CIRC,  KC_AMPR,  KC_ASTR,  KC_EQUAL, KC_MINS,
+    KC_BSLS,    KC_SCLN,   KC_LCBR,   KC_LBRC,  KC_LPRN,  KC_RPRN,  KC_RBRC,  KC_RCBR,  KC_QUOT,  KC_GRV,
+                          KC_TRNS,   KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS
+  ),
+
+  [_NAV] = LAYOUT(
+    RESET,    KC_NO,    KC_NO,    KC_NO,  KC_NO,   KC_NO,  KC_NO,    KC_NO,  KC_NO,  KC_NO,
+    KC_LEFT,  KC_DOWN,  KC_UP,  KC_RGHT,  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_TRNS,  KC_TRNS,  KC_TRNS, KC_TRNS,   KC_TRNS,   KC_TRNS
+  ),
+};
+
+
+#ifdef COMBO_ENABLE
+//const uint16_t PROGMEM combo_bspc[] = {KC_O, KC_P, COMBO_END};
+const uint16_t PROGMEM combo_numbak[] = {KC_0, KC_9, COMBO_END};
+const uint16_t PROGMEM combo_tab[] = {KC_Q, KC_W, COMBO_END};
+const uint16_t PROGMEM combo_esc[] = {KC_J, KC_F, COMBO_END};
+const uint16_t PROGMEM combo_del[] = {KC_MINS, KC_EQL, COMBO_END};
+
+combo_t key_combos[COMBO_COUNT] = {
+  //[COMBO_BSPC] = COMBO(combo_bspc,KC_BSPC),
+  [COMBO_NUMBAK] = COMBO(combo_numbak,KC_BSPC),
+  [COMBO_TAB] = COMBO(combo_tab,KC_TAB),
+  [COMBO_ESC] = COMBO(combo_esc,KC_ESC),
+  [COMBO_DEL] = COMBO(combo_del,KC_DEL),
+
+};
+#endif
diff --git a/keyboards/free_willy/keymaps/default/rules.mk b/keyboards/free_willy/keymaps/default/rules.mk
@@ -0,0 +1 @@
+COMBO_ENABLE = yes
diff --git a/keyboards/free_willy/readme.md b/keyboards/free_willy/readme.md
@@ -0,0 +1,21 @@
+# Free Willy
+
+![Free Willy](https://i.imgur.com/JBNV3Hk.png)
+
+Free willy is an ortholinear, 36 key keyboard featuring HHKB like corner blockers.
+
+* Keyboard Maintainer: [Caleb Lightfoot](https://github.com/Tsquash)
+* Hardware Supported: Free Willy PCB v1.0
+* Hardware Availability: [squashkb](https://www.squashkb.com/product/free-willy)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make free_willy:default
+
+To reset the keyboard, jump the reset and ground pins located on the pro micro.
+
+Flashing example for this keyboard:
+
+    make free_willy:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/free_willy/rules.mk b/keyboards/free_willy/rules.mk
@@ -0,0 +1,21 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+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 = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output