From c58f7857bdeb5b0c4edbf03abefb9d659c2f3cbd Mon Sep 17 00:00:00 2001
From: Koichi Katano <36572567+kkatano@users.noreply.github.com>
Date: Tue, 14 Jan 2020 19:31:21 +0900
Subject: [PATCH] [Keyboard] Add Yurei PCB (#7880)
* Add yurei
* Implement keyboard
* Update readme.md
* Update config.h
* Update info.json
* Update info.json
* Update keyboards/yurei/config.h
* Delete config.h
* Update rules.mk
* Update yurei.c
* Update keymap.c
* Update keyboards/yurei/yurei.h
* Update keyboards/yurei/keymaps/default/keymap.c
* Update keyboards/yurei/info.json
* Update keyboards/yurei/rules.mk
---
keyboards/yurei/config.h | 252 ++++++++++++++++++++++
keyboards/yurei/info.json | 101 +++++++++
keyboards/yurei/keymaps/default/keymap.c | 27 +++
keyboards/yurei/keymaps/default/readme.md | 1 +
keyboards/yurei/readme.md | 13 ++
keyboards/yurei/rules.mk | 34 +++
keyboards/yurei/yurei.c | 25 +++
keyboards/yurei/yurei.h | 44 ++++
8 files changed, 497 insertions(+)
create mode 100644 keyboards/yurei/config.h
create mode 100644 keyboards/yurei/info.json
create mode 100644 keyboards/yurei/keymaps/default/keymap.c
create mode 100644 keyboards/yurei/keymaps/default/readme.md
create mode 100644 keyboards/yurei/readme.md
create mode 100644 keyboards/yurei/rules.mk
create mode 100644 keyboards/yurei/yurei.c
create mode 100644 keyboards/yurei/yurei.h
diff --git a/keyboards/yurei/config.h b/keyboards/yurei/config.h
new file mode 100644
index 000000000..da37d3ce8
--- /dev/null
+++ b/keyboards/yurei/config.h
@@ -0,0 +1,252 @@
+/*
+Copyright 2019 Koichi Katano
+
+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 0xFEED
+#define PRODUCT_ID 0x5D5E
+#define DEVICE_VER 0x0001
+#define MANUFACTURER Koichi Katano
+#define PRODUCT Yurei
+#define DESCRIPTION A Tenkeyless PCB
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 17
+
+/*
+ * 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 { B5, B4, B3, B2, B1, B0 }
+#define MATRIX_COL_PINS { D5, C7, C6, D4, D0, E6, F0, F1, F4, F5, F6, F7, D7, D6, D1, D2, D3 }
+#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 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 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 */
+#ifndef LINK_TIME_OPTIMIZATION_ENABLE
+ #define NO_ACTION_MACRO
+ #define NO_ACTION_FUNCTION
+#endif
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+ - MIDI notes can be sent when in Music mode is on
+*/
+//#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+ - MIDI notes can be added to the keymap
+ - Octave shift and transpose
+ - Virtual sustain, portamento, and modulation wheel
+ - etc.
+*/
+//#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 1
+
+/*
+ * HD44780 LCD Display Configuration
+ */
+/*
+#define LCD_LINES 2 //< number of visible lines of the display
+#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
+
+#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
+
+#if LCD_IO_MODE
+#define LCD_PORT PORTB //< port for the LCD lines
+#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
+#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
+#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
+#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
+#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
+#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
+#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
+#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
+#define LCD_RS_PORT LCD_PORT //< port for RS line
+#define LCD_RS_PIN 3 //< pin for RS line
+#define LCD_RW_PORT LCD_PORT //< port for RW line
+#define LCD_RW_PIN 2 //< pin for RW line
+#define LCD_E_PORT LCD_PORT //< port for Enable line
+#define LCD_E_PIN 1 //< pin for Enable line
+#endif
+*/
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/yurei/info.json b/keyboards/yurei/info.json
new file mode 100644
index 000000000..ff6fec7a5
--- /dev/null
+++ b/keyboards/yurei/info.json
@@ -0,0 +1,101 @@
+{
+ "keyboard_name": "Yurei",
+ "url": "https://github.com/kkatano/yurei",
+ "maintainer": "Koichi Katano",
+ "width": 18.26,
+ "height": 6.47,
+ "layouts": {
+ "LAYOUT_tkl_ansi": {
+ "key_count": 87,
+ "layout": [
+ {"label":"1", "x":0, "y":0},
+ {"label":"2", "x":2, "y":0},
+ {"label":"3", "x":3, "y":0},
+ {"label":"4", "x":4, "y":0},
+ {"label":"5", "x":5, "y":0},
+ {"label":"6", "x":6.5, "y":0},
+ {"label":"7", "x":7.5, "y":0},
+ {"label":"8", "x":8.5, "y":0},
+ {"label":"9", "x":9.5, "y":0},
+ {"label":"10", "x":11, "y":0},
+ {"label":"11", "x":12, "y":0},
+ {"label":"12", "x":13, "y":0},
+ {"label":"13", "x":14, "y":0},
+ {"label":"14", "x":15.26, "y":0},
+ {"label":"15", "x":16.26, "y":0},
+ {"label":"16", "x":17.26, "y":0},
+ {"label":"17", "x":0, "y":1.47},
+ {"label":"18", "x":1, "y":1.47},
+ {"label":"19", "x":2, "y":1.47},
+ {"label":"20", "x":3, "y":1.47},
+ {"label":"21", "x":4, "y":1.47},
+ {"label":"22", "x":5, "y":1.47},
+ {"label":"23", "x":6, "y":1.47},
+ {"label":"24", "x":7, "y":1.47},
+ {"label":"25", "x":8, "y":1.47},
+ {"label":"26", "x":9, "y":1.47},
+ {"label":"27", "x":10, "y":1.47},
+ {"label":"28", "x":11, "y":1.47},
+ {"label":"29", "x":12, "y":1.47},
+ {"label":"30", "x":13, "y":1.47, "w":2},
+ {"label":"31", "x":15.26, "y":1.47},
+ {"label":"32", "x":16.26, "y":1.47},
+ {"label":"33", "x":17.26, "y":1.47},
+ {"label":"34", "x":0, "y":2.47, "w":1.5},
+ {"label":"35", "x":1.5, "y":2.47},
+ {"label":"36", "x":2.5, "y":2.47},
+ {"label":"37", "x":3.5, "y":2.47},
+ {"label":"38", "x":4.5, "y":2.47},
+ {"label":"39", "x":5.5, "y":2.47},
+ {"label":"40", "x":6.5, "y":2.47},
+ {"label":"41", "x":7.5, "y":2.47},
+ {"label":"42", "x":8.5, "y":2.47},
+ {"label":"43", "x":9.5, "y":2.47},
+ {"label":"44", "x":10.5, "y":2.47},
+ {"label":"45", "x":11.5, "y":2.47},
+ {"label":"46", "x":12.5, "y":2.47},
+ {"label":"47", "x":13.5, "y":2.47, "w":1.5},
+ {"label":"48", "x":15.26, "y":2.47},
+ {"label":"49", "x":16.26, "y":2.47},
+ {"label":"50", "x":17.26, "y":2.47},
+ {"label":"51", "x":0, "y":3.47, "w":1.75},
+ {"label":"52", "x":1.75, "y":3.47},
+ {"label":"53", "x":2.75, "y":3.47},
+ {"label":"54", "x":3.75, "y":3.47},
+ {"label":"55", "x":4.75, "y":3.47},
+ {"label":"56", "x":5.75, "y":3.47},
+ {"label":"57", "x":6.75, "y":3.47},
+ {"label":"58", "x":7.75, "y":3.47},
+ {"label":"59", "x":8.75, "y":3.47},
+ {"label":"60", "x":9.75, "y":3.47},
+ {"label":"61", "x":10.75, "y":3.47},
+ {"label":"62", "x":11.75, "y":3.47},
+ {"label":"63", "x":12.75, "y":3.47, "w":2.25},
+ {"label":"64", "x":0, "y":4.47, "w":2.25},
+ {"label":"65", "x":2.25, "y":4.47},
+ {"label":"66", "x":3.25, "y":4.47},
+ {"label":"67", "x":4.25, "y":4.47},
+ {"label":"68", "x":5.25, "y":4.47},
+ {"label":"69", "x":6.25, "y":4.47},
+ {"label":"70", "x":7.25, "y":4.47},
+ {"label":"71", "x":8.25, "y":4.47},
+ {"label":"72", "x":9.25, "y":4.47},
+ {"label":"73", "x":10.25, "y":4.47},
+ {"label":"74", "x":11.25, "y":4.47},
+ {"label":"75", "x":12.25, "y":4.47, "w":2.75},
+ {"label":"76", "x":16.26, "y":4.47},
+ {"label":"77", "x":0, "y":5.47, "w":1.25},
+ {"label":"78", "x":1.25, "y":5.47, "w":1.25},
+ {"label":"79", "x":2.5, "y":5.47, "w":1.25},
+ {"label":"80", "x":3.75, "y":5.47, "w":6.25},
+ {"label":"81", "x":10, "y":5.47, "w":1.25},
+ {"label":"82", "x":11.25, "y":5.47, "w":1.25},
+ {"label":"83", "x":12.5, "y":5.47, "w":1.25},
+ {"label":"84", "x":13.75, "y":5.47, "w":1.25},
+ {"label":"85", "x":15.26, "y":5.47},
+ {"label":"86", "x":16.26, "y":5.47},
+ {"label":"87", "x":17.26, "y":5.47}
+ ]
+ }
+ }
+}
diff --git a/keyboards/yurei/keymaps/default/keymap.c b/keyboards/yurei/keymaps/default/keymap.c
new file mode 100644
index 000000000..45f955fb0
--- /dev/null
+++ b/keyboards/yurei/keymaps/default/keymap.c
@@ -0,0 +1,27 @@
+/* Copyright 2019 Koichi Katano
+ *
+ * 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
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ LAYOUT_tkl_ansi(
+ KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_SLCK, KC_PAUS,
+ KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_HOME, KC_PGUP,
+ 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, KC_DEL, KC_END, KC_PGDN,
+ 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, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
+ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+ )
+};
diff --git a/keyboards/yurei/keymaps/default/readme.md b/keyboards/yurei/keymaps/default/readme.md
new file mode 100644
index 000000000..4134a11e4
--- /dev/null
+++ b/keyboards/yurei/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for yurei
diff --git a/keyboards/yurei/readme.md b/keyboards/yurei/readme.md
new file mode 100644
index 000000000..fc5b3eb5c
--- /dev/null
+++ b/keyboards/yurei/readme.md
@@ -0,0 +1,13 @@
+# Yurei
+
+A Tenkeyless PCB inspired by Phantom, for customizing Filco Majestouch 2.
+
+* Keyboard Maintainer: [Koichi Katano](https://github.com/kkatano)
+* Hardware Supported: Yurei PCB
+* Hardware Availability: https://github.com/kkatano/yurei
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yurei: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/yurei/rules.mk b/keyboards/yurei/rules.mk
new file mode 100644
index 000000000..37d7d6d4b
--- /dev/null
+++ b/keyboards/yurei/rules.mk
@@ -0,0 +1,34 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+# Teensy halfkay
+# Pro Micro caterina
+# Atmel DFU atmel-dfu
+# LUFA DFU lufa-dfu
+# QMK DFU qmk-dfu
+# ATmega32A bootloadHID
+# ATmega328P USBasp
+BOOTLOADER = halfkay
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes # Mouse keys
+EXTRAKEY_ENABLE = yes # 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 = no # Enable keyboard RGB underglow
+MIDI_ENABLE = no # MIDI support
+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
+HD44780_ENABLE = no # Enable support for HD44780 based LCDs
+
+LAYOUTS = tkl_ansi
diff --git a/keyboards/yurei/yurei.c b/keyboards/yurei/yurei.c
new file mode 100644
index 000000000..3ac0d32be
--- /dev/null
+++ b/keyboards/yurei/yurei.c
@@ -0,0 +1,25 @@
+/* Copyright 2019 Koichi Katano
+ *
+ * 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 "yurei.h"
+
+bool led_update_kb(led_t led_state) {
+ if (led_update_user(led_state)) {
+ writePin(B6, led_state.caps_lock);
+ writePin(B7, led_state.scroll_lock);
+ }
+ return true;
+}
diff --git a/keyboards/yurei/yurei.h b/keyboards/yurei/yurei.h
new file mode 100644
index 000000000..d117d2a02
--- /dev/null
+++ b/keyboards/yurei/yurei.h
@@ -0,0 +1,44 @@
+/* Copyright 2019 Koichi Katano
+ *
+ * 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_tkl_ansi( \
+ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0E, k0F, k0G, \
+ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k1E, k1F, k1G, \
+ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E, k2F, k2G, \
+ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3D, \
+ k40, k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, k4F, \
+ k50, k51, k52, k56, k5A, k5B, k5C, k5D, k5E, k5F, k5G \
+) \
+{ \
+ { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, KC_NO, k0E, k0F, k0G }, \
+ { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k1E, k1F, k1G }, \
+ { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E, k2F, k2G }, \
+ { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, KC_NO, k3D, KC_NO, KC_NO, KC_NO }, \
+ { k40, KC_NO, k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, KC_NO, KC_NO, k4F, KC_NO }, \
+ { k50, k51, k52, KC_NO, KC_NO, KC_NO, k56, KC_NO, KC_NO, KC_NO, k5A, k5B, k5C, k5D, k5E, k5F, k5G } \
+}