From 7fe491bb54884fdc52160cb7b64f96083ee44d85 Mon Sep 17 00:00:00 2001
From: sotoba <sotoba.s+git@gmail.com>
Date: Sat, 25 Jul 2020 05:24:58 +0900
Subject: [PATCH] [Keyboard] Add "craftWalk" keyboard (#9689)

* Add craftWalk keyboard

* remove config.h

* Update keyboards/craftwalk/config.h

* Update keyboards/craftwalk/rules.mk

* Update keyboards/craftwalk/rules.mk

* Update keyboards/craftwalk/info.json

* Update keyboards/craftwalk/rules.mk

* Update keyboards/craftwalk/config.h

* fix bootloader

* Update keyboards/craftwalk/rules.mk

* Update keyboards/craftwalk/info.json

* Update keyboards/craftwalk/config.h

* Update keyboards/craftwalk/config.h

* Update keyboards/craftwalk/rules.mk

* Update keyboards/craftwalk/rules.mk
---
 keyboards/craftwalk/config.h                  | 198 ++++++++++++++++++
 keyboards/craftwalk/craftwalk.c               |  17 ++
 keyboards/craftwalk/craftwalk.h               |  38 ++++
 keyboards/craftwalk/info.json                 |  27 +++
 keyboards/craftwalk/keymaps/default/keymap.c  |  47 +++++
 keyboards/craftwalk/keymaps/default/readme.md |   1 +
 keyboards/craftwalk/readme.md                 |  15 ++
 keyboards/craftwalk/rules.mk                  |  22 ++
 8 files changed, 365 insertions(+)
 create mode 100644 keyboards/craftwalk/config.h
 create mode 100644 keyboards/craftwalk/craftwalk.c
 create mode 100644 keyboards/craftwalk/craftwalk.h
 create mode 100644 keyboards/craftwalk/info.json
 create mode 100644 keyboards/craftwalk/keymaps/default/keymap.c
 create mode 100644 keyboards/craftwalk/keymaps/default/readme.md
 create mode 100644 keyboards/craftwalk/readme.md
 create mode 100644 keyboards/craftwalk/rules.mk

diff --git a/keyboards/craftwalk/config.h b/keyboards/craftwalk/config.h
new file mode 100644
index 0000000000..d7f9f8a309
--- /dev/null
+++ b/keyboards/craftwalk/config.h
@@ -0,0 +1,198 @@
+/*
+Copyright 2020 sotoba
+
+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 0xFEED
+#define PRODUCT_ID 0x2E8F
+#define DEVICE_VER 0x0001
+#define MANUFACTURER sotoba
+#define PRODUCT craftwalk
+
+/* key matrix size */
+#define MATRIX_ROWS 3
+#define MATRIX_COLS 7
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+#define MATRIX_ROW_PINS { F6, B3, B5 }
+#define MATRIX_COL_PINS { B1, F7, F5, F4, B2, E6, B4 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6
+
+// #define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+// #define BACKLIGHT_LEVELS 3
+
+#define RGB_DI_PIN D3
+#ifdef RGB_DI_PIN
+  #define RGBLED_NUM 19
+  #define RGBLIGHT_HUE_STEP 8
+  #define RGBLIGHT_SAT_STEP 8
+  #define RGBLIGHT_VAL_STEP 8
+  #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+  #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+// /*== all animations enable ==*/
+//   #define RGBLIGHT_ANIMATIONS
+// /*== or choose animations ==*/
+  #define RGBLIGHT_EFFECT_BREATHING
+  #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+  #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+  #define RGBLIGHT_EFFECT_SNAKE
+//   #define RGBLIGHT_EFFECT_KNIGHT
+//   #define RGBLIGHT_EFFECT_CHRISTMAS
+  #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+  #define RGBLIGHT_EFFECT_RGB_TEST
+  #define RGBLIGHT_EFFECT_ALTERNATING
+// /*== customize breathing effect ==*/
+//   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+//   /*==== use exp() and sin() ====*/
+//   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* 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
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* key combination for magic key command */
+/* defined by default; to change, uncomment and set to the combination you want */
+// #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
+
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#define MAGIC_KEY_HELP           H
+//#define MAGIC_KEY_HELP_ALT       SLASH
+//#define MAGIC_KEY_DEBUG          D
+//#define MAGIC_KEY_DEBUG_MATRIX   X
+//#define MAGIC_KEY_DEBUG_KBD      K
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#define MAGIC_KEY_LAYER0         0
+//#define MAGIC_KEY_LAYER0_ALT     GRAVE
+//#define MAGIC_KEY_LAYER1         1
+//#define MAGIC_KEY_LAYER2         2
+//#define MAGIC_KEY_LAYER3         3
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#define MAGIC_KEY_BOOTLOADER     B
+//#define MAGIC_KEY_BOOTLOADER_ALT ESC
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
+//#define MAGIC_KEY_NKRO           N
+//#define MAGIC_KEY_SLEEP_LED      Z
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/craftwalk/craftwalk.c b/keyboards/craftwalk/craftwalk.c
new file mode 100644
index 0000000000..9b1ea8e2e4
--- /dev/null
+++ b/keyboards/craftwalk/craftwalk.c
@@ -0,0 +1,17 @@
+/* Copyright 2020 sotoba
+ *
+ * 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 "craftwalk.h"
diff --git a/keyboards/craftwalk/craftwalk.h b/keyboards/craftwalk/craftwalk.h
new file mode 100644
index 0000000000..80c32ef05e
--- /dev/null
+++ b/keyboards/craftwalk/craftwalk.h
@@ -0,0 +1,38 @@
+/* Copyright 2020 sotoba
+ *
+ * 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"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+       k00, k01, k02, \
+  k10, k11, k12, k13, \
+  k20, k21, k22, k23, k24, k25, k26 \
+) \
+{ \
+  { KC_NO, k00, k01, k02, KC_NO, KC_NO, KC_NO }, \
+  { k10, k11, k12, k13, KC_NO, KC_NO, KC_NO },  \
+  { k20, k21, k22, k23, k24, k25, k26 } \
+}
diff --git a/keyboards/craftwalk/info.json b/keyboards/craftwalk/info.json
new file mode 100644
index 0000000000..764af5b648
--- /dev/null
+++ b/keyboards/craftwalk/info.json
@@ -0,0 +1,27 @@
+{
+    "keyboard_name": "craftwalk",
+    "url": "https://github.com/sotoba/craftwalk",
+    "maintainer": "sotoba",
+    "width": 7.25,
+    "height": 4.5,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+              {"label":"Q", "x":1.25, "y":0.25},
+              {"label":"W", "x":2.25, "y":0},
+              {"label":"E", "x":3.25, "y":0.25},
+              {"label":"Ctrl", "x":0, "y":1},
+              {"label":"A", "x":1.25, "y":1.25},
+              {"label":"S", "x":2.25, "y":1},
+              {"label":"D", "x":3.25, "y":1.25},
+              {"label":"Shift", "x":0, "y":2},
+              {"label":"Adjust", "x":1.25, "y":2.25},
+              {"label":"Mouse", "x":2.25, "y":2},
+              {"label":"Mouse", "x":3.25, "y":2.25},
+              {"label":"F", "x":4.25, "y":2},
+              {"label":"Num", "x":5.25, "y":3, "h":1.5},
+              {"label":"Space", "x":6.25, "y":3, "h":1.5}
+            ]
+        }
+    }
+}
diff --git a/keyboards/craftwalk/keymaps/default/keymap.c b/keyboards/craftwalk/keymaps/default/keymap.c
new file mode 100644
index 0000000000..9acd46d9be
--- /dev/null
+++ b/keyboards/craftwalk/keymaps/default/keymap.c
@@ -0,0 +1,47 @@
+/* Copyright 2020 sotoba
+ *
+ * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _NUM,
+    _ADJUST
+};
+
+#define KC_NUM MO(_NUM)
+#define KC_ADJ MO(_ADJUST)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Base */
+    [_BASE] = LAYOUT(
+                 KC_Q,    KC_W,    KC_E,
+        KC_LCTL, KC_A,    KC_S,    KC_D,
+        KC_LSFT, KC_ADJ,  KC_WH_U, KC_WH_D, KC_F,    KC_NUM,  KC_SPC
+    ),
+    /* Number */
+    [_NUM] = LAYOUT(
+                 KC_1,    KC_2,    KC_3,
+        KC_TRNS, KC_4,    KC_5,    KC_6,
+        KC_TRNS, KC_7,    KC_8,    KC_9,    KC_F3,   KC_TRNS, KC_TRNS
+    ),
+    /* Adjust */
+    [_ADJUST] = LAYOUT(
+                 RGB_HUI, RGB_SAI, RGB_VAI,
+        RESET,   RGB_HUD, RGB_SAD, RGB_VAD,
+        RGB_M_T, KC_TRNS, RGB_MOD, RGB_RMOD,RGB_TOG, KC_TRNS, KC_TRNS
+    )
+};
diff --git a/keyboards/craftwalk/keymaps/default/readme.md b/keyboards/craftwalk/keymaps/default/readme.md
new file mode 100644
index 0000000000..7d51f51adf
--- /dev/null
+++ b/keyboards/craftwalk/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for craftwalk
diff --git a/keyboards/craftwalk/readme.md b/keyboards/craftwalk/readme.md
new file mode 100644
index 0000000000..183dc12d18
--- /dev/null
+++ b/keyboards/craftwalk/readme.md
@@ -0,0 +1,15 @@
+# craftWalk
+
+<img src="https://github.com/sotoba/craftwalk/blob/images/craftwalk_main.jpg" width="640">
+
+A macro pad for (mine)crafters.
+
+* Keyboard Maintainer: [sotoba](https://github.com/sotoba)
+* Hardware Supported: The craftWalk PCBs, Pro Micro supported
+* Hardware Availability: [BOOTH: stupa-devices](https://stupa-devices.booth.pm/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make craftwalk:default
+
+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/craftwalk/rules.mk b/keyboards/craftwalk/rules.mk
new file mode 100644
index 0000000000..f5b6bc72c0
--- /dev/null
+++ b/keyboards/craftwalk/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = no        # Audio control and System control
+CONSOLE_ENABLE = yes        # Console for debug
+COMMAND_ENABLE = yes        # 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 = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output