Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Keyboard] Add Kyria rev3 #19423

Merged
merged 1 commit into from
Jan 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions keyboards/splitkb/kyria/config.h
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
/*
Copyright 2019 Thomas Baart <thomas@splitkb.com>
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/>.
*/
/* Copyright 2022 splitkb.com <support@splitkb.com>
*
* 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"

69 changes: 10 additions & 59 deletions keyboards/splitkb/kyria/info.json
Original file line number Diff line number Diff line change
@@ -1,65 +1,16 @@
{
"manufacturer": "splitkb",
"url": "https://splitkb.com",
"maintainer": "splitkb.com",
"manufacturer": "splitkb.com",
"url": "https://splitkb.com/products/kyria-pcb-kit",
"maintainer": "splitkb",
"usb": {
"vid": "0x8D1D",
"pid": "0x9D9D"
"device_version": "1.0.0"
},
"layouts": {
"LAYOUT": {
"layout": [
{"x":0, "y":0.75},
{"x":1, "y":0.75},
{"x":2, "y":0.25},
{"x":3, "y":0},
{"x":4, "y":0.25},
{"x":5, "y":0.5},
{"x":10.5, "y":0.5},
{"x":11.5, "y":0.25},
{"x":12.5, "y":0},
{"x":13.5, "y":0.25},
{"x":14.5, "y":0.75},
{"x":15.5, "y":0.75},
{"x":0, "y":1.75},
{"x":1, "y":1.75},
{"x":2, "y":1.25},
{"x":3, "y":1},
{"x":4, "y":1.25},
{"x":5, "y":1.5},
{"x":10.5, "y":1.5},
{"x":11.5, "y":1.25},
{"x":12.5, "y":1},
{"x":13.5, "y":1.25},
{"x":14.5, "y":1.75},
{"x":15.5, "y":1.75},
{"x":0, "y":2.75},
{"x":1, "y":2.75},
{"x":2, "y":2.25},
{"x":3, "y":2},
{"x":4, "y":2.25},
{"x":5, "y":2.5},
{"x":6, "y":3},
{"x":7, "y":3.25},
{"x":8.5, "y":3.25},
{"x":9.5, "y":3},
{"x":10.5, "y":2.5},
{"x":11.5, "y":2.25},
{"x":12.5, "y":2},
{"x":13.5, "y":2.25},
{"x":14.5, "y":2.75},
{"x":15.5, "y":2.75},
{"x":2.5, "y":3.25},
{"x":3.5, "y":3.25},
{"x":4.5, "y":3.5},
{"x":5.5, "y":4},
{"x":6.5, "y":4.25},
{"x":9, "y":4.25},
{"x":10, "y":4},
{"x":11, "y":3.5},
{"x":12, "y":3.25},
{"x":13, "y":3.25}
]
}
"development_board": "elite_c",
"split": {
"enabled": true
},
"build": {
"lto": true
}
}
21 changes: 21 additions & 0 deletions keyboards/splitkb/kyria/keymaps/debug/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/* Copyright 2022 splitkb.com <support@splitkb.com>
*
* 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

#ifdef RGBLIGHT_ENABLE
# define RGBLIGHT_EFFECT_BREATHING
#endif
73 changes: 73 additions & 0 deletions keyboards/splitkb/kyria/keymaps/debug/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/* Copyright 2022 splitkb.com <support@splitkb.com>
*
* 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 layers {
_DEFAULT = 0,
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_DEFAULT] = LAYOUT(
KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, S(KC_F), S(KC_E), S(KC_D), S(KC_C), S(KC_B), S(KC_A),
KC_G, KC_H, KC_I, KC_J, KC_K, KC_L, S(KC_L), S(KC_K), S(KC_J), S(KC_I), S(KC_H), S(KC_G),
KC_M, KC_N, KC_O, KC_P, KC_Q, KC_R, KC_S, KC_T, S(KC_T), S(KC_S), S(KC_R), S(KC_Q), S(KC_P), S(KC_O), S(KC_N), S(KC_M),
KC_U, KC_V, KC_W, KC_X, KC_Y, S(KC_Y), S(KC_X), S(KC_W), S(KC_V), S(KC_U)
)
};

#ifdef RGBLIGHT_ENABLE
void keyboard_post_init_user(void) {
rgblight_enable_noeeprom(); // enables RGB, without saving settings
rgblight_sethsv_noeeprom(HSV_RED); // sets the color to red without saving
rgblight_mode_noeeprom(RGBLIGHT_MODE_BREATHING + 3); // sets mode to Fast breathing without saving
}
#endif

#ifdef ENCODER_ENABLE
bool encoder_update_user(uint8_t index, bool clockwise) {
// 0 is left-half encoder,
// 1 is right-half encoder
if (index == 0) {
tap_code(KC_0);
} else if (index == 1) {
tap_code(KC_1);
}

if (clockwise) {
tap_code16(KC_PLUS);
} else {
tap_code(KC_MINUS);
}

return false;
}
#endif

#ifdef OLED_ENABLE
bool oled_task_user(void) {
// A 128x64 OLED rotated 180 degrees is 21 characters wide and 8 characters tall
// This example string should fill that neatly
const char *text = PSTR("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789!@#$%^&*()[]{}-=_+?/,.|abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789!@#$%^&*()[]{}-=_+?/,.|");

if (is_keyboard_master()) {
oled_write_P(text, false);
} else {
oled_write_P(text, false);
}
return false;
}
#endif
24 changes: 24 additions & 0 deletions keyboards/splitkb/kyria/keymaps/debug/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Kyria's Debug Keymap

To make debugging your build as easy as possible, we have provided a special debugging keymap. It is not intended to actually type on, it is just here to make sure that your hardware is working correctly.

## Keys

![Keys](https://i.imgur.com/pmPBYlkh.png)

The left side uses lowercase letters, the right side uses uppercase ones.

## Encoders

Encoders output a number of 0 or 1, depending on the installed position.
These correspond to the index used for custom encoder code.

The number is followed by either a `+` or a `-`, depending on the direction turned.

## LEDs

Both underglow and per-key RGB should be fading between red and off.

## OLEDs

Both the primary and secondary side should be filled with characters.
8 changes: 8 additions & 0 deletions keyboards/splitkb/kyria/keymaps/debug/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# NOTE: These are already enabled by default at the revision level
#ENCODER_ENABLE = yes
#OLED_ENABLE = yes

# RGB Matrix is enabled at the revision level,
# while we use the regular RGB underglow for testing
RGB_MATRIX_ENABLE = no
RGBLIGHT_ENABLE = yes
4 changes: 3 additions & 1 deletion keyboards/splitkb/kyria/keymaps/default/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@
# define RGBLIGHT_HUE_STEP 8
# define RGBLIGHT_SAT_STEP 8
# define RGBLIGHT_VAL_STEP 8
# define RGBLIGHT_LIMIT_VAL 150
# ifndef RGBLIGHT_LIMIT_VAL
# define RGBLIGHT_LIMIT_VAL 150
# endif
#endif

// Lets you roll mod-tap keys
Expand Down
3 changes: 2 additions & 1 deletion keyboards/splitkb/kyria/keymaps/default/rules.mk
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
OLED_ENABLE = yes
OLED_DRIVER = SSD1306 # Enables the use of OLED displays
OLED_DRIVER = SSD1306 # Enables the use of OLED displays
ENCODER_ENABLE = yes # Enables the use of one or more encoders
RGB_MATRIX_ENABLE = no # Disable keyboard RGB matrix, as it is enabled by default on rev3
RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
7 changes: 5 additions & 2 deletions keyboards/splitkb/kyria/kyria.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright 2019 Thomas Baart <thomas@splitkb.com>
/* Copyright 2022 splitkb.com <support@splitkb.com>
*
* 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
Expand All @@ -13,7 +13,8 @@
* 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 "kyria.h"

#include "quantum.h"

#ifdef OLED_ENABLE
oled_rotation_t oled_init_kb(oled_rotation_t rotation) {
Expand All @@ -39,6 +40,8 @@ bool oled_task_kb(void) {
oled_write_P(PSTR("rev1\n\n"), false);
#elif defined(KEYBOARD_splitkb_kyria_rev2)
oled_write_P(PSTR("rev2\n\n"), false);
#elif defined(KEYBOARD_splitkb_kyria_rev3)
oled_write_P(PSTR("rev3\n\n"), false);
#endif
// Host Keyboard Layer Status
oled_write_P(PSTR("Layer: "), false);
Expand Down
9 changes: 0 additions & 9 deletions keyboards/splitkb/kyria/kyria.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,3 @@
#if defined(KEYBOARD_splitkb_kyria_rev2)
# include "rev2.h"
#endif

/* This 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.
*/
15 changes: 7 additions & 8 deletions keyboards/splitkb/kyria/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,25 @@

An ergonomical 40% split keyboard

Keyboard Maintainer: [splitkb.com](https://github.com/splitkb)
Hardware Supported: Pro Micro 5V/16MHz and compatible.
Hardware Availability: [splitkb.com](https://splitkb.com) and partners.
* Keyboard Maintainer: [splitkb.com](https://github.com/splitkb)
* Hardware Supported: Pro Micro 5V/16MHz and compatible.
* Hardware Availability: [splitkb.com](https://splitkb.com/products/kyria-pcb-kit)

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

make splitkb/kyria/rev2:default
make splitkb/kyria/rev2/proton_c:default
make splitkb/kyria/rev3:default

Example of flashing this keyboard:

make splitkb/kyria/rev2:default:flash
make splitkb/kyria/rev3:default:flash

Replace "rev2" with "rev1" if you have a Kyria of revision 1.4 or below.
Replace "rev3" with "rev2" if you have a Kyria of revision 2.x, or "rev1" if you have a Kyria of revision 1.4 or below.
Not sure what revision yours is? It is printed on the outer lower edge of the PCB!
As a rule of thumb, all Kyrias sold after January 1st 2022 are revision 2.x.

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).

A build guide for the Kyria can be found at [docs.splitkb.com](https://docs.splitkb.com/hc/en-us/articles/360010552059-Kyria-Build-Guide-Introduction).
A build guide for the Kyria can be found at [docs.splitkb.com](https://docs.splitkb.com/hc/en-us/categories/360002241559-Build-Guides). For revision 3.x you want to use the [Aurora build guide](https://docs.splitkb.com/hc/en-us/articles/6269789921564-Aurora-Build-Guide-1-Introduction), for revision 2.x and below you want to use the [Kyria-specific guide](https://docs.splitkb.com/hc/en-us/articles/360010552059-Kyria-Build-Guide-Introduction).

## Proton C Conversion Guide

Expand Down
57 changes: 57 additions & 0 deletions keyboards/splitkb/kyria/rev1/info.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,63 @@
{
"keyboard_name": "Kyria rev1",
"usb": {
"pid": "0x9D9D",
"device_version": "0.0.1"
},
"layouts": {
"LAYOUT": {
"layout": [
{"x":0, "y":0.75},
{"x":1, "y":0.75},
{"x":2, "y":0.25},
{"x":3, "y":0},
{"x":4, "y":0.25},
{"x":5, "y":0.5},
{"x":10.5, "y":0.5},
{"x":11.5, "y":0.25},
{"x":12.5, "y":0},
{"x":13.5, "y":0.25},
{"x":14.5, "y":0.75},
{"x":15.5, "y":0.75},
{"x":0, "y":1.75},
{"x":1, "y":1.75},
{"x":2, "y":1.25},
{"x":3, "y":1},
{"x":4, "y":1.25},
{"x":5, "y":1.5},
{"x":10.5, "y":1.5},
{"x":11.5, "y":1.25},
{"x":12.5, "y":1},
{"x":13.5, "y":1.25},
{"x":14.5, "y":1.75},
{"x":15.5, "y":1.75},
{"x":0, "y":2.75},
{"x":1, "y":2.75},
{"x":2, "y":2.25},
{"x":3, "y":2},
{"x":4, "y":2.25},
{"x":5, "y":2.5},
{"x":6, "y":3},
{"x":7, "y":3.25},
{"x":8.5, "y":3.25},
{"x":9.5, "y":3},
{"x":10.5, "y":2.5},
{"x":11.5, "y":2.25},
{"x":12.5, "y":2},
{"x":13.5, "y":2.25},
{"x":14.5, "y":2.75},
{"x":15.5, "y":2.75},
{"x":2.5, "y":3.25},
{"x":3.5, "y":3.25},
{"x":4.5, "y":3.5},
{"x":5.5, "y":4},
{"x":6.5, "y":4.25},
{"x":9, "y":4.25},
{"x":10, "y":4},
{"x":11, "y":3.5},
{"x":12, "y":3.25},
{"x":13, "y":3.25}
]
}
}
}
Loading