Skip to content

Commit

Permalink
Add a new keyboard: yoichiro/lunakey_mini (qmk#10958)
Browse files Browse the repository at this point in the history
* Add a new keyboard: yoichiro/lunakey_mini

* Modify the VENDOR and PRODUCT IDs.

* Remove unnecessary EOL characters.

* Remove unnecessary modified characters.

* Update the layer definition more simple.

* Change the product name.

* Change the LAYOUT name (append `_split_3x6_4`) and change keys order in info.json file.
  • Loading branch information
yoichiro authored Nov 22, 2020
1 parent 30afa1c commit c84650a
Show file tree
Hide file tree
Showing 8 changed files with 396 additions and 0 deletions.
153 changes: 153 additions & 0 deletions keyboards/yoichiro/lunakey_mini/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/*
Copyright 2020 Yoichiro Tanaka
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 0x5954 // "YT" - Yoichiro Tanaka
#define PRODUCT_ID 0x0001
#define DEVICE_VER 0x0001
#define MANUFACTURER yoichiro
#define PRODUCT Lunakey Mini

/* key matrix size */
#define MATRIX_ROWS 8
#define MATRIX_COLS 6

/*
* 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 { D4, D7, E6, B4 }
#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3 }
#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 D2 // or D1, D2, D3, E6

//#define BACKLIGHT_PIN B7
//#define BACKLIGHT_LEVELS 3
//#define BACKLIGHT_BREATHING

#define RGB_DI_PIN D3
#ifdef RGB_DI_PIN
#define RGBLED_NUM 12
#define RGBLIGHT_SPLIT
#define RGBLED_SPLIT { 6, 6 }
#define RGBLIGHT_LED_MAP { 0, 1, 2, 3, 4, 5, \
11, 10, 9, 8, 7, 6 }
#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

/* Audio Support */
#define C6_AUDIO

/* 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
56 changes: 56 additions & 0 deletions keyboards/yoichiro/lunakey_mini/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"keyboard_name": "Lunakey Mini",
"url": "",
"maintainer": "qmk",
"width": 14.75,
"height": 5,
"layouts": {
"LAYOUT_split_3x6_4": {
"layout": [
{"label":"L00", "x":0, "y":1.5},
{"label":"L01", "x":1, "y":1.25},
{"label":"L02", "x":2, "y":0.5},
{"label":"L03", "x":3, "y":0},
{"label":"L04", "x":4, "y":0.25},
{"label":"L05", "x":5, "y":0.5},
{"label":"R00", "x":8.75, "y":0.5},
{"label":"R01", "x":9.75, "y":0.25},
{"label":"R02", "x":10.75, "y":0},
{"label":"R03", "x":11.75, "y":0.5},
{"label":"R04", "x":12.75, "y":1.25},
{"label":"R05", "x":13.75, "y":1.5},
{"label":"L10", "x":0, "y":2.5},
{"label":"L11", "x":1, "y":2.25},
{"label":"L12", "x":2, "y":1.5},
{"label":"L13", "x":3, "y":1},
{"label":"L14", "x":4, "y":1.25},
{"label":"L15", "x":5, "y":1.5},
{"label":"R10", "x":8.75, "y":1.5},
{"label":"R11", "x":9.75, "y":1.25},
{"label":"R12", "x":10.75, "y":1},
{"label":"R13", "x":11.75, "y":1.5},
{"label":"R14", "x":12.75, "y":2.25},
{"label":"R15", "x":13.75, "y":2.5},
{"label":"L20", "x":0, "y":3.5},
{"label":"L21", "x":1, "y":3.25},
{"label":"L22", "x":2, "y":2.5},
{"label":"L23", "x":3, "y":2},
{"label":"L24", "x":4, "y":2.25},
{"label":"L25", "x":5, "y":2.5},
{"label":"R20", "x":8.75, "y":2.5},
{"label":"R21", "x":9.75, "y":2.25},
{"label":"R22", "x":10.75, "y":2},
{"label":"R23", "x":11.75, "y":2.5},
{"label":"R24", "x":12.75, "y":3.25},
{"label":"R25", "x":13.75, "y":3.5},
{"label":"L30", "x":3, "y":4},
{"label":"L31", "x":4, "y":3.75},
{"label":"L32", "x":5, "y":3.75},
{"label":"L33", "x":6, "y":4},
{"label":"R30", "x":7.75, "y":4},
{"label":"R31", "x":8.75, "y":3.75},
{"label":"R32", "x":9.75, "y":3.75},
{"label":"R33", "x":10.75, "y":4}]
}
}
}
81 changes: 81 additions & 0 deletions keyboards/yoichiro/lunakey_mini/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/* Copyright 2020 Yoichiro Tanaka
*
* 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 layer_number {
_QWERTY = 0,
_LOWER,
_RAISE,
_ADJUST,
};

#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[_QWERTY] = LAYOUT_split_3x6_4(
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
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_LGUI, KC_LALT, LOWER, KC_SPC, KC_ENT, RAISE, KC_RALT, KC_RGUI
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
),

[_LOWER] = LAYOUT_split_3x6_4(
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_LCTL, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT,_______, _______,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_ENT, RAISE, KC_RALT, KC_RGUI
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
),

[_RAISE] = LAYOUT_split_3x6_4(
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_ESC, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_LCTL, _______, _______, _______, _______, _______, KC_MINS, KC_EQL, KC_LCBR, KC_RCBR, KC_PIPE, KC_GRV,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
KC_LSFT, KC_TILD, _______, _______, _______, _______, KC_UNDS, KC_PLUS, KC_LBRC, KC_RBRC, KC_BSLS, KC_TILD,
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_ENT, RAISE, KC_RALT, KC_RGUI
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
),

[_ADJUST] = LAYOUT_split_3x6_4(
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
RESET, _______, _______, _______, _______, _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
//+--------+--------+--------+--------+--------+--------+ +--------+--------+--------+--------+--------+--------+
RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______, _______, _______, _______, _______,
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
KC_LGUI, KC_LALT, LOWER, KC_SPC, KC_ENT, RAISE, KC_RALT, KC_RGUI
//+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+
)
};

layer_state_t layer_state_set_user(layer_state_t state) {
return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
}
3 changes: 3 additions & 0 deletions keyboards/yoichiro/lunakey_mini/keymaps/default/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
RGBLIGHT_ENABLE = no # Enable keyboard RGB Underglow
AUDIO_ENABLE = no # Enable Audio output
OLED_DRIVER_ENABLE = no # Enable OLED Display
17 changes: 17 additions & 0 deletions keyboards/yoichiro/lunakey_mini/lunakey_mini.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/* Copyright 2020 Yoichiro Tanaka
*
* 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 "lunakey_mini.h"
44 changes: 44 additions & 0 deletions keyboards/yoichiro/lunakey_mini/lunakey_mini.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/* Copyright 2020 Yoichiro Tanaka
*
* 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_split_3x6_4( \
L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \
L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
L30, L31, L32, L33, R30, R31, R32, R33 \
) \
{ \
{ L00, L01, L02, L03, L04, L05 }, \
{ L10, L11, L12, L13, L14, L15 }, \
{ L20, L21, L22, L23, L24, L25 }, \
{ KC_NO, KC_NO, L30, L31, L32, L33 }, \
{ R05, R04, R03, R02, R01, R00 }, \
{ R15, R14, R13, R12, R11, R10 }, \
{ R25, R24, R23, R22, R21, R20 }, \
{ KC_NO, KC_NO, R33, R32, R31, R30 } \
}
19 changes: 19 additions & 0 deletions keyboards/yoichiro/lunakey_mini/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Lunakey Mini

![lunakey_mini](https://i.imgur.com/b1oUINil.jpg)

This is a 40% split keyboard which has 3x6 vertically staggered keys and 4 thumbnail keys.

* Keyboard Maintainer: [Yoichiro Tanaka](https://github.com/yoichiro)
* Hardware Supported: Lunakey Mini PCB, Pro Micro MCU.
* Hardware Availability: https://yoichiro.booth.pm/

Make example for this keyboard (after setting up your build environment):

make yoichiro/lunakey_mini:default

Flashing example for this keyboard:

make yoichiro/lunakey_mini: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).
Loading

0 comments on commit c84650a

Please sign in to comment.