keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Keyboard] Jiran keyboard (#9628)

Browse Source 
* Add jirand folder from local catalog

* Add controller into readme

* Replace image of PCB

* Create rev2 folder for RGB version

* Rename keymap folder

* Add new rev for RGB light version

* Change some keycodes for RGB light

* Remove some unnecessary code

* Add via keymap

* Activate RBG light support

* Update some info

* Update layout image link

* Update keyboards/jiran/config.h

* Update keyboards/jiran/keymaps/via/config.h

* Update keyboards/jiran/keymaps/default/rules.mk

* Update keyboards/jiran/keymaps/default/readme.md

* Update keyboards/jiran/keymaps/default/keymap.c

* Update keyboards/jiran/rev1/config.h

* Update keyboards/jiran/rev1/config.h

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rev2/config.h

* Update keyboards/jiran/rev2/config.h

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rev2/rev1.c

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rules.mk

* Some fix

* Update keyboards/jiran/keymaps/default/keymap.c

* Update keyboards/jiran/rev1/config.h

* Update keyboards/jiran/rev1/config.h

* Update keyboards/jiran/rev2/config.h

* Fix default keymap error

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rev2/rules.mk

* Update keyboards/jiran/rev1/rules.mk

* Update keyboards/jiran/config.h

* Update keyboards/jiran/rev1/config.h

* Update keyboards/jiran/rev2/config.h

* Delete by request

* Update keyboards/jiran/config.h

* Update keyboards/jiran/keymaps/via/keymap.c

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rules.mk

* Update keyboards/jiran/rules.mk

* Change some info by request

* Update keyboards/jiran/rev1/rev1.h

* Remove by request
This commit is contained in:
Ladniy 2020-07-28 08:48:48 +08:00 committed by GitHub
parent 6104609afa
commit 84cd07b0d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 338 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
keyboards/jiran/config.h Normal file
View File

@ -0,0 +1,47 @@
/*
Copyright 2020 Vladislav Morozov <ladniy1@ya.ru>
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 0x1209
#define PRODUCT_ID 0x3735
#define DEVICE_VER 0x0300
#define MANUFACTURER Ladniy
#define PRODUCT Jiran
/* key matrix size */
// Rows are doubled-up
#define MATRIX_ROWS 10
#define MATRIX_COLS 6
// wiring of each half
#define MATRIX_ROW_PINS { B4, B5, F4, F5, F6 }
#define MATRIX_COL_PINS { D3, D2, D4, C6, D7, E6 }
/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION COL2ROW
/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5
/* serial.c configuration for split keyboard */
#define SOFT_SERIAL_PIN D1
#define MASTER_LEFT

1
keyboards/jiran/jiran.c Normal file
View File

@ -0,0 +1 @@
#include "jiran.h"

11
keyboards/jiran/jiran.h Normal file
View File

@ -0,0 +1,11 @@
#pragma once
#include "quantum.h"
#ifdef KEYBOARD_jiran_rev1
#include "rev1.h"
#endif
#ifdef KEYBOARD_jiran_rev2
#include "rev2.h"
#endif

21
keyboards/jiran/keymaps/default/config.h Normal file
View File

@ -0,0 +1,21 @@
/*
Copyright 2017 Danny Nguyen <danny@keeb.io>
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
// #define USE_I2C
#define EE_HANDS

47
keyboards/jiran/keymaps/default/keymap.c Normal file
View File

@ -0,0 +1,47 @@
#include QMK_KEYBOARD_H
// Defines names for use in layer keycodes and the keymap
enum jiran_layers {
_QWERTY,
_LOWER
};
#define KC_RBGI RGUI_T(KC_RBRC)
#define KC_BSCT RCTL_T(KC_BSLS)
#define KC_QTSH RSFT_T(KC_QUOT)
#define KC_SLSF RSFT_T(KC_LSCR)
#define KC_NLCT RCTL_T(KC_LNUM)
#define KC_ETAL RALT_T(KC_ENT)
#define LOWER MO(_LOWER)
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_QWERTY] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
// ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐
KC_LGUI, 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_RBGI,
// └────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┘
KC_LSFT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QTSH,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_LCTL, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_BSCT,
// └────────┴────────┴────────┴────────┼────────┼────────┤ ├────────┼────────┼────────┴────────┴────────┴────────┘
LOWER, KC_SPC, KC_LALT, KC_ETAL, KC_BSPC, LOWER
// └────────┴────────┴────────┘ └────────┴────────┴────────┘
),
[_LOWER] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_EQL,
// ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐
KC_F11, KC_TAB, RGB_HUI, KC_HOME, RESET, RGB_SAI, RGB_VAI, KC_VOLU, KC_PGUP, RESET, KC_HOME, KC_INS, KC_DEL, KC_F12,
// └────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┘
KC_LSFT, RGB_HUD, KC_LEFT, KC_UP, KC_RGHT, RGB_VAD, KC_MUTE, KC_LEFT, KC_UP, KC_RGHT, KC_PSCR, KC_SLSF,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_LCTL, RGB_M_B, KC_END, KC_DOWN, RGB_SAD, RGB_TOG, KC_VOLD, KC_PGDN, KC_DOWN, KC_END, KC_PAUS, KC_NLCT,
// └────────┴────────┴────────┴────────┼────────┼────────┤ ├────────┼────────┴────────┴────────┴────────┴────────┘
KC_TRNS, KC_SPC, KC_LALT, KC_ETAL, KC_BSPC, KC_TRNS
// └────────┴────────┴────────┘ └────────┴────────┴────────┘
),
};

6
keyboards/jiran/keymaps/default/readme.md Normal file
View File

@ -0,0 +1,6 @@
# Default Jiran Layout
![Jiran layout Image](https://i.imgur.com/xxmekHU.png)
This is the default layout that comes with every Jiran from the buy groups.
Layout contains all the keys with a standard 104 keys keyboard.

61
keyboards/jiran/keymaps/via/keymap.c Normal file
View File

@ -0,0 +1,61 @@
#include QMK_KEYBOARD_H
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
// ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐
KC_LGUI, KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, RGUI_T(KC_RBRC),
// └────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┘
KC_LSFT, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, RSFT_T(KC_QUOT),
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_LCTL, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, RCTL_T(KC_BSLS),
// └────────┴────────┴────────┴────────┼────────┼────────┤ ├────────┼────────┼────────┴────────┴────────┴────────┘
MO(1), KC_SPC, KC_LALT, RALT_T(KC_ENT), KC_BSPC, MO(1)
// └────────┴────────┴────────┘ └────────┴────────┴────────┘
),
[1] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_EQL,
// ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐
KC_F11, KC_TAB, RGB_HUI, KC_HOME, RESET, RGB_SAI, RGB_VAI, KC_VOLU, KC_PGUP, RESET, KC_HOME, KC_INS, KC_DEL, KC_F12,
// └────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┘
KC_LSFT, RGB_HUD, KC_LEFT, KC_UP, KC_RGHT, RGB_VAD, KC_MUTE, KC_LEFT, KC_UP, KC_RGHT, KC_PSCR, RSFT_T(KC_LSCR),
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_LCTL, RGB_M_B, KC_END, KC_DOWN, RGB_SAD, RGB_TOG, KC_VOLD, KC_PGDN, KC_DOWN, KC_END, KC_PAUS, RCTL_T(KC_LNUM),
// └────────┴────────┴────────┴────────┼────────┼────────┤ ├────────┼────────┴────────┴────────┴────────┴────────┘
KC_TRNS, KC_SPC, KC_LALT, RALT_T(KC_ENT), KC_BSPC, KC_TRNS
// └────────┴────────┴────────┘ └────────┴────────┴────────┘
),
[2] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// └────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┘
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// └────────┴────────┴────────┴────────┼────────┼────────┤ ├────────┼────────┴────────┴────────┴────────┴────────┘
_______, _______, _______, _______, _______, _______
// └────────┴────────┴────────┘ └────────┴────────┴────────┘
),
[3] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// └────────┼────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┼────────┘
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// └────────┴────────┴────────┴────────┼────────┼────────┤ ├────────┼────────┴────────┴────────┴────────┴────────┘
_______, _______, _______, _______, _______, _______
// └────────┴────────┴────────┘ └────────┴────────┴────────┘
),
};

2
keyboards/jiran/keymaps/via/rules.mk Normal file
View File

@ -0,0 +1,2 @@
VIA_ENABLE = yes
EXTRAKEY_ENABLE = yes

15
keyboards/jiran/readme.md Normal file
View File

@ -0,0 +1,15 @@
# Jiran
![Jiran](https://i.imgur.com/HnA2Onc.png)
A 6x4 matrix ergo keyboard with additional 3 thumb and 1 pinky keys for full cyrillic layout. [More info on GitHub](https://github.com/Ladniy/jiran-breakoff)
* Keyboard Maintainer: [Ladniy](https://github.com/Ladniy)
* Hardware Supported: Jiran PCB rev1, rev2, Pro Micro
* Hardware Availability: [Open Source](https://github.com/Ladniy/jiran-breakoff)
Make example for this keyboard (after setting up your build environment):
make jiran: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).

20
keyboards/jiran/rev1/config.h Normal file
View File

@ -0,0 +1,20 @@
/*
Copyright 2017 Danny Nguyen <danny@keeb.io>
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
#define BACKLIGHT_PIN B6
#define BACKLIGHT_LEVELS 5

1
keyboards/jiran/rev1/rev1.c Normal file
View File

@ -0,0 +1 @@
#include "rev1.h"

26
keyboards/jiran/rev1/rev1.h Normal file
View File

@ -0,0 +1,26 @@
#pragma once
#include "jiran.h"
#include "quantum.h"
#define LAYOUT( \
L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
L40, L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, R45, \
L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35, \
L43, L44, L45, R40, R41, R42 \
) \
{ \
{ L00, L01, L02, L03, L04, L05 }, \
{ L10, L11, L12, L13, L14, L15 }, \
{ L20, L21, L22, L23, L24, L25 }, \
{ L30, L31, L32, L33, L34, L35 }, \
{ L40, KC_NO, KC_NO, L43, L44, L45, }, \
{ R05, R04, R03, R02, R01, R00 }, \
{ R15, R14, R13, R12, R11, R10 }, \
{ R25, R24, R23, R22, R21, R20 }, \
{ R35, R34, R33, R32, R31, R30 }, \
{ R45, KC_NO, KC_NO, R42, R41, R40 } \
}

1
keyboards/jiran/rev1/rules.mk Normal file
View File

@ -0,0 +1 @@
BACKLIGHT_ENABLE = yes

28
keyboards/jiran/rev2/config.h Normal file
View File

@ -0,0 +1,28 @@
/*
Copyright 2017 Danny Nguyen <danny@keeb.io>
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
#define RGB_DI_PIN B6
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 56
#define RGBLIGHT_SPLIT
#define RGBLED_SPLIT { 28, 28 }
#define RGBLIGHT_HUE_STEP 10
#define RGBLIGHT_SAT_STEP 17
#define RGBLIGHT_VAL_STEP 17
#define RGBLIGHT_LIMIT_VAL 255

1
keyboards/jiran/rev2/rev2.c Normal file
View File

@ -0,0 +1 @@
#include "rev2.h"

24
keyboards/jiran/rev2/rev2.h Normal file
View File

@ -0,0 +1,24 @@
#pragma once
#include "jiran.h"
#include "quantum.h"
#define LAYOUT( \
L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \
L40, L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, R45, \
L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \
L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35, \
L43, L44, L45, R40, R41, R42 \
) \
{ \
{ L00, L01, L02, L03, L04, L05 }, \
{ L10, L11, L12, L13, L14, L15 }, \
{ L20, L21, L22, L23, L24, L25 }, \
{ L30, L31, L32, L33, L34, L35 }, \
{ L40, KC_NO, KC_NO, L43, L44, L45, }, \
{ R05, R04, R03, R02, R01, R00 }, \
{ R15, R14, R13, R12, R11, R10 }, \
{ R25, R24, R23, R22, R21, R20 }, \
{ R35, R34, R33, R32, R31, R30 }, \
{ R45, KC_NO, KC_NO, R42, R41, R40 } \
}

1
keyboards/jiran/rev2/rules.mk Normal file
View File

@ -0,0 +1 @@
RGBLIGHT_ENABLE = yes

25
keyboards/jiran/rules.mk Normal file
View File

@ -0,0 +1,25 @@
# 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 = no # Mouse keys
EXTRAKEY_ENABLE = no # 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
SPLIT_KEYBOARD = yes
DEFAULT_FOLDER = jiran/rev1