From 6721825df5ddda0631faaf52292ce78db92f2c7f Mon Sep 17 00:00:00 2001
From: yfuku <30647434+yfuku@users.noreply.github.com>
Date: Sat, 7 Aug 2021 09:01:52 +0900
Subject: [PATCH] [Keyboard] Add owl8 keyboard (#13380)
* add owl8
* use DIRECT_PINS
* fix encoder
* Changed to use action_exec.
---
keyboards/owl8/config.h | 159 +++++++++++++++++++++++
keyboards/owl8/keymaps/default/keymap.c | 68 ++++++++++
keyboards/owl8/keymaps/default/readme.md | 1 +
keyboards/owl8/keymaps/via/keymap.c | 123 ++++++++++++++++++
keyboards/owl8/keymaps/via/readme.md | 1 +
keyboards/owl8/keymaps/via/rules.mk | 1 +
keyboards/owl8/owl8.c | 17 +++
keyboards/owl8/owl8.h | 41 ++++++
keyboards/owl8/readme.md | 19 +++
keyboards/owl8/rules.mk | 24 ++++
10 files changed, 454 insertions(+)
create mode 100644 keyboards/owl8/config.h
create mode 100644 keyboards/owl8/keymaps/default/keymap.c
create mode 100644 keyboards/owl8/keymaps/default/readme.md
create mode 100644 keyboards/owl8/keymaps/via/keymap.c
create mode 100644 keyboards/owl8/keymaps/via/readme.md
create mode 100644 keyboards/owl8/keymaps/via/rules.mk
create mode 100644 keyboards/owl8/owl8.c
create mode 100644 keyboards/owl8/owl8.h
create mode 100644 keyboards/owl8/readme.md
create mode 100644 keyboards/owl8/rules.mk
diff --git a/keyboards/owl8/config.h b/keyboards/owl8/config.h
new file mode 100644
index 00000000000..7bbaff39859
--- /dev/null
+++ b/keyboards/owl8/config.h
@@ -0,0 +1,159 @@
+/*
+Copyright 2021 yfuku
+
+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 .
+*/
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x5946 // YF
+#define PRODUCT_ID 0x0008
+#define DEVICE_VER 0x0001
+#define MANUFACTURER yfuku
+#define PRODUCT owl8
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 4
+
+/*
+ * 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 DIRECT_PINS { \
+ { F4, F7, B3, B6 }, \
+ { F5, F6, B1, B2 }, \
+ { D4, C6, D7, E6 }, \
+ { NO_PIN, NO_PIN, NO_PIN, NO_PIN } \
+}
+#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 LED_NUM_LOCK_PIN B0
+//#define LED_CAPS_LOCK_PIN B1
+//#define LED_SCROLL_LOCK_PIN B2
+//#define LED_COMPOSE_PIN B3
+//#define LED_KANA_PIN B4
+
+//#define BACKLIGHT_PIN B7
+//#define BACKLIGHT_LEVELS 3
+//#define BACKLIGHT_BREATHING
+
+//#define RGB_DI_PIN E2
+//#ifdef RGB_DI_PIN
+//# define RGBLED_NUM 16
+//# 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 useful 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
+
+/*
+ * 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
+
+#define ENCODERS_PAD_A { D4, D7 }
+#define ENCODERS_PAD_B { C6, E6 }
diff --git a/keyboards/owl8/keymaps/default/keymap.c b/keyboards/owl8/keymaps/default/keymap.c
new file mode 100644
index 00000000000..e840263639d
--- /dev/null
+++ b/keyboards/owl8/keymaps/default/keymap.c
@@ -0,0 +1,68 @@
+/* Copyright 2021 yfuku
+ *
+ * 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 .
+ */
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE,
+ _FN1,
+ _FN2,
+ _FN3
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_BASE] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO, // for encoders
+ KC_NO, KC_NO, KC_NO, KC_NO, // for ext keys
+ MO(1), KC_BSPC, KC_SPC, KC_ENT,
+ KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
+ ),
+ [_FN1] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_1, KC_2, KC_3, KC_4,
+ KC_5, KC_6, KC_7, KC_8
+ ),
+ [_FN2] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_1, KC_2, KC_3, KC_4,
+ KC_5, KC_6, KC_7, KC_8
+ ),
+ [_FN3] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_1, KC_2, KC_3, KC_4,
+ KC_5, KC_6, KC_7, KC_8
+ )
+};
+
+bool encoder_update_user(uint8_t index, bool clockwise) {
+ if (index == 0) { /* First encoder */
+ if (clockwise) {
+ tap_code(KC_PGDN);
+ } else {
+ tap_code(KC_PGUP);
+ }
+ } else if (index == 1) { /* Second encoder */
+ if (clockwise) {
+ tap_code(KC_DOWN);
+ } else {
+ tap_code(KC_UP);
+ }
+ }
+ return true;
+}
diff --git a/keyboards/owl8/keymaps/default/readme.md b/keyboards/owl8/keymaps/default/readme.md
new file mode 100644
index 00000000000..e0129daa2d3
--- /dev/null
+++ b/keyboards/owl8/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for owl8
diff --git a/keyboards/owl8/keymaps/via/keymap.c b/keyboards/owl8/keymaps/via/keymap.c
new file mode 100644
index 00000000000..dc981f47541
--- /dev/null
+++ b/keyboards/owl8/keymaps/via/keymap.c
@@ -0,0 +1,123 @@
+/* Copyright 2021 yfuku
+ *
+ * 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 .
+ */
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE,
+ _FN1,
+ _FN2,
+ _FN3
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_BASE] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO, // for encoders
+ KC_NO, KC_NO, KC_NO, KC_NO, // for ext keys
+ MO(1), KC_BSPC, KC_SPC, KC_ENT,
+ KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
+ ),
+ [_FN1] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_1, KC_2, KC_3, KC_4,
+ KC_5, KC_6, KC_7, KC_8
+ ),
+ [_FN2] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_1, KC_2, KC_3, KC_4,
+ KC_5, KC_6, KC_7, KC_8
+ ),
+ [_FN3] = LAYOUT(
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_NO, KC_NO, KC_NO, KC_NO,
+ KC_1, KC_2, KC_3, KC_4,
+ KC_5, KC_6, KC_7, KC_8
+ )
+};
+
+keyevent_t encoder1_ccw = {
+ .key = (keypos_t){.row = 3, .col = 1},
+ .pressed = false
+};
+
+keyevent_t encoder1_cw = {
+ .key = (keypos_t){.row = 3, .col = 0},
+ .pressed = false
+};
+
+keyevent_t encoder2_ccw = {
+ .key = (keypos_t){.row = 3, .col = 3},
+ .pressed = false
+};
+
+keyevent_t encoder2_cw = {
+ .key = (keypos_t){.row = 3, .col = 2},
+ .pressed = false
+};
+
+void matrix_scan_user(void) {
+ if (IS_PRESSED(encoder1_ccw)) {
+ encoder1_ccw.pressed = false;
+ encoder1_ccw.time = (timer_read() | 1);
+ action_exec(encoder1_ccw);
+ }
+
+ if (IS_PRESSED(encoder1_cw)) {
+ encoder1_cw.pressed = false;
+ encoder1_cw.time = (timer_read() | 1);
+ action_exec(encoder1_cw);
+ }
+
+ if (IS_PRESSED(encoder2_ccw)) {
+ encoder2_ccw.pressed = false;
+ encoder2_ccw.time = (timer_read() | 1);
+ action_exec(encoder2_ccw);
+ }
+
+ if (IS_PRESSED(encoder2_cw)) {
+ encoder2_cw.pressed = false;
+ encoder2_cw.time = (timer_read() | 1);
+ action_exec(encoder2_cw);
+ }
+}
+
+bool encoder_update_user(uint8_t index, bool clockwise) {
+ if (index == 0) { /* First encoder */
+ if (clockwise) {
+ encoder1_cw.pressed = true;
+ encoder1_cw.time = (timer_read() | 1);
+ action_exec(encoder1_cw);
+ } else {
+ encoder1_ccw.pressed = true;
+ encoder1_ccw.time = (timer_read() | 1);
+ action_exec(encoder1_ccw);
+ }
+ } else if (index == 1) {
+ if (clockwise) {
+ encoder2_cw.pressed = true;
+ encoder2_cw.time = (timer_read() | 1);
+ action_exec(encoder2_cw);
+ } else {
+ encoder2_ccw.pressed = true;
+ encoder2_ccw.time = (timer_read() | 1);
+ action_exec(encoder2_ccw);
+ }
+ }
+
+ return true;
+}
diff --git a/keyboards/owl8/keymaps/via/readme.md b/keyboards/owl8/keymaps/via/readme.md
new file mode 100644
index 00000000000..c4fa65987c0
--- /dev/null
+++ b/keyboards/owl8/keymaps/via/readme.md
@@ -0,0 +1 @@
+# The via keymap for owl8
diff --git a/keyboards/owl8/keymaps/via/rules.mk b/keyboards/owl8/keymaps/via/rules.mk
new file mode 100644
index 00000000000..1e5b99807cb
--- /dev/null
+++ b/keyboards/owl8/keymaps/via/rules.mk
@@ -0,0 +1 @@
+VIA_ENABLE = yes
diff --git a/keyboards/owl8/owl8.c b/keyboards/owl8/owl8.c
new file mode 100644
index 00000000000..a31289891aa
--- /dev/null
+++ b/keyboards/owl8/owl8.c
@@ -0,0 +1,17 @@
+/* Copyright 2021 yfuku
+ *
+ * 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 .
+ */
+
+#include "owl8.h"
diff --git a/keyboards/owl8/owl8.h b/keyboards/owl8/owl8.h
new file mode 100644
index 00000000000..656b3f17cd5
--- /dev/null
+++ b/keyboards/owl8/owl8.h
@@ -0,0 +1,41 @@
+/* Copyright 2021 yfuku
+ *
+ * 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 .
+ */
+
+#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( \
+ k30, k31, k32, k33, \
+ k20, k21, k22, k23, \
+ k00, k01, k02, k03, \
+ k10, k11, k12, k13 \
+) \
+{ \
+ {k00, k01, k02, k03 }, \
+ {k10, k11, k12, k13 }, \
+ {k20, k21, k22, k23 }, \
+ {k30, k31, k32, k33 } \
+}
diff --git a/keyboards/owl8/readme.md b/keyboards/owl8/readme.md
new file mode 100644
index 00000000000..b40a5f35cb3
--- /dev/null
+++ b/keyboards/owl8/readme.md
@@ -0,0 +1,19 @@
+# owl8
+
+
+
+macropad
+
+* Keyboard Maintainer: [yfuku](https://github.com/yfuku)
+* Hardware Supported: owl8 PCB, Pro Micro
+* Hardware Availability: https://yfuku.booth.pm/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make owl8:default
+
+Flashing example for this keyboard:
+
+ make owl8: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/owl8/rules.mk b/keyboards/owl8/rules.mk
new file mode 100644
index 00000000000..647c62c4525
--- /dev/null
+++ b/keyboards/owl8/rules.mk
@@ -0,0 +1,24 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes # 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
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
+
+ENCODER_ENABLE = yes