Co-authored-by: Drashna Jaelre <drashna@live.com>pull/15511/head
@ -0,0 +1,18 @@ | |||
// Copyright 2021 KiwiKey (@KiwiKey) | |||
// SPDX-License-Identifier: GPL-2.0-or-later | |||
#include "borderland.h" | |||
#ifdef ENCODER_ENABLE | |||
bool encoder_update_kb(uint8_t index, bool clockwise) { | |||
if (!encoder_update_user(index, clockwise)) { return false; } | |||
if (index == 0) { | |||
if (clockwise) { | |||
tap_code_delay(KC_VOLU, 10); | |||
} else { | |||
tap_code_delay(KC_VOLD, 10); | |||
} | |||
} | |||
return true; | |||
} | |||
#endif |
@ -0,0 +1,29 @@ | |||
// Copyright 2021 KiwiKey (@KiwiKey) | |||
// SPDX-License-Identifier: GPL-2.0-or-later | |||
#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, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k0E, k1E, \ | |||
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k2E, \ | |||
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k3E, \ | |||
k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3D, \ | |||
k40, k42, k44, k45, k47, k49, k4C, k4D, k4E \ | |||
) \ | |||
{ \ | |||
{ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k0E }, \ | |||
{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k1E }, \ | |||
{ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, KC_NO, k2E }, \ | |||
{ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, KC_NO, k3D, k3E }, \ | |||
{ k40, KC_NO, k42, KC_NO, k44, k45, KC_NO, k47, KC_NO, k49, KC_NO, KC_NO, k4C, k4D, k4E } \ | |||
} |
@ -0,0 +1,126 @@ | |||
// Copyright 2021 KiwiKey (@KiwiKey) | |||
// SPDX-License-Identifier: GPL-2.0-or-later | |||
#pragma once | |||
#include "config_common.h" | |||
/* USB Device descriptor parameter */ | |||
#define VENDOR_ID 0x4B57 // KW - KiwiKey | |||
#define PRODUCT_ID 0x424C // BL - Borderland | |||
#define DEVICE_VER 0x0001 | |||
#define MANUFACTURER KiwiKey | |||
#define PRODUCT Borderland | |||
/* key matrix size */ | |||
#define MATRIX_ROWS 5 | |||
#define MATRIX_COLS 15 | |||
/* | |||
* 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 { D0, D1, D2, D3, D5 } | |||
#define MATRIX_COL_PINS { F0, F1, E6, C7, C6, B6, D4, B1, B0, B7, B5, B4, D7, D6, B3 } | |||
#define UNUSED_PINS | |||
/* COL2ROW, ROW2COL */ | |||
#define DIODE_DIRECTION COL2ROW | |||
#define ENCODERS_PAD_A { F5 } | |||
#define ENCODERS_PAD_B { F6 } | |||
#define ENCODER_RESOLUTION 4 | |||
#define TAP_CODE_DELAY 10 | |||
#define RGB_DI_PIN B2 | |||
#ifdef RGB_DI_PIN | |||
#define RGBLED_NUM 18 | |||
#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 */ | |||
#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 | |||
#define RGBLIGHT_EFFECT_TWINKLE | |||
/*== 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 |
@ -0,0 +1,82 @@ | |||
{ | |||
"keyboard_name": "Borderland", | |||
"url": "https://kiwikey.vn/borderland/", | |||
"maintainer": "KiwiKey", | |||
"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":9, "y":0}, | |||
{"x":10, "y":0}, | |||
{"x":11, "y":0}, | |||
{"x":12, "y":0}, | |||
{"x":13, "y":0}, | |||
{"x":14, "y":0}, | |||
{"x":15, "y":0}, | |||
{"x":16, "y":0}, | |||
{"x":17.3, "y":0}, | |||
{"x":0, "y":1, "w":1.5}, | |||
{"x":1.5, "y":1}, | |||
{"x":2.5, "y":1}, | |||
{"x":3.5, "y":1}, | |||
{"x":4.5, "y":1}, | |||
{"x":5.5, "y":1}, | |||
{"x":8.5, "y":1}, | |||
{"x":9.5, "y":1}, | |||
{"x":10.5, "y":1}, | |||
{"x":11.5, "y":1}, | |||
{"x":12.5, "y":1}, | |||
{"x":13.5, "y":1}, | |||
{"x":14.5, "y":1}, | |||
{"x":15.5, "y":1, "w":1.5}, | |||
{"x":17.3, "y":1}, | |||
{"x":0, "y":2, "w":1.75}, | |||
{"x":1.75, "y":2}, | |||
{"x":2.75, "y":2}, | |||
{"x":3.75, "y":2}, | |||
{"x":4.75, "y":2}, | |||
{"x":5.75, "y":2}, | |||
{"x":8.75, "y":2}, | |||
{"x":9.75, "y":2}, | |||
{"x":10.75, "y":2}, | |||
{"x":11.75, "y":2}, | |||
{"x":12.75, "y":2}, | |||
{"x":13.75, "y":2}, | |||
{"x":14.75, "y":2, "w":2.25}, | |||
{"x":17.3, "y":2}, | |||
{"x":0, "y":3, "w":2.25}, | |||
{"x":2.25, "y":3}, | |||
{"x":3.25, "y":3}, | |||
{"x":4.25, "y":3}, | |||
{"x":5.25, "y":3}, | |||
{"x":6.25, "y":3}, | |||
{"x":9.25, "y":3}, | |||
{"x":10.25, "y":3}, | |||
{"x":11.25, "y":3}, | |||
{"x":12.25, "y":3}, | |||
{"x":13.25, "y":3}, | |||
{"x":14.25, "y":3, "w":1.75}, | |||
{"x":16.3, "y":3.25}, | |||
{"x":0, "y":4, "w":1.5}, | |||
{"x":3.25, "y":4, "w":1.5}, | |||
{"x":4.75, "y":4, "w":2}, | |||
{"x":6.75, "y":4, "w":1.25}, | |||
{"x":8.75, "y":4, "w":2.75}, | |||
{"x":11.5, "y":4, "w":1.5}, | |||
{"x":15.3, "y":4.25}, | |||
{"x":16.3, "y":4.25}, | |||
{"x":17.3, "y":4.25} | |||
] | |||
} | |||
} | |||
} |
@ -0,0 +1,22 @@ | |||
// Copyright 2021 KiwiKey (@KiwiKey) | |||
// SPDX-License-Identifier: GPL-2.0-or-later | |||
#include QMK_KEYBOARD_H | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
[0] = LAYOUT( | |||
KC_GESC, 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_DEL, 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_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, MO(1), | |||
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_LALT, KC_SPC, KC_LGUI, KC_SPC, KC_RALT, KC_LEFT, KC_DOWN, KC_RGHT | |||
), | |||
[1] = LAYOUT( | |||
_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, | |||
_______, _______, _______, _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______ | |||
) | |||
}; |
@ -0,0 +1 @@ | |||
# The default keymap for Borderland |
@ -0,0 +1,37 @@ | |||
// Copyright 2021 KiwiKey (@KiwiKey) | |||
// SPDX-License-Identifier: GPL-2.0-or-later | |||
#include QMK_KEYBOARD_H | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
[0] = LAYOUT( | |||
KC_GESC, 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_DEL, 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_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, MO(1), | |||
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_LALT, KC_SPC, KC_LGUI, KC_SPC, KC_RALT, KC_LEFT, KC_DOWN, KC_RGHT | |||
), | |||
[1] = LAYOUT( | |||
_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, _______, _______, | |||
_______, _______, _______, _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______ | |||
), | |||
[2] = LAYOUT( | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______ | |||
), | |||
[3] = LAYOUT( | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______ | |||
) | |||
}; |
@ -0,0 +1 @@ | |||
# VIA keymap for Borderland |
@ -0,0 +1 @@ | |||
VIA_ENABLE = yes |
@ -0,0 +1,27 @@ | |||
# Borderland | |||
![Borderland](https://i.imgur.com/3aMyUJb.jpg) | |||
Another keyboard with well-known Arisu layout, comes with USB Type-C connection and Rotary Encoder. More information can be found at https://kiwikey.vn/borderland/ | |||
* Keyboard Maintainer: [KiwiKey](https://github.com/kiwikey) | |||
* Hardware Supported: Borderland PCB rev1 | |||
* Hardware Availability: [KiwiKey Website](https://kiwikey.vn/) | |||
Make example for this keyboard (after setting up your build environment): | |||
make kiwikey/borderland:default | |||
Flashing example for this keyboard: | |||
make kiwikey/borderland: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). | |||
## Bootloader | |||
Enter the bootloader in 3 ways: | |||
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard | |||
* **Physical reset button**: Briefly press the button on the back of the PCB | |||
* **Keycode in layout**: Press the key mapped to `RESET`, in default keymap it is `Fn+R` |
@ -0,0 +1,20 @@ | |||
# MCU name | |||
MCU = atmega32u4 | |||
# Bootloader selection | |||
BOOTLOADER = atmel-dfu | |||
# Build Options | |||
# change yes to no to disable | |||
# | |||
BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite | |||
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 | |||
NKRO_ENABLE = no # Enable N-Key Rollover | |||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality | |||
RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow | |||
AUDIO_ENABLE = no # Audio output | |||
ENCODER_ENABLE = yes | |||
NO_USB_STARTUP_CHECK = yes |