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

New controller board 'kintwin' for Kinesis Contoured keyboards #21453

Closed
wants to merge 14 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
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
128 changes: 128 additions & 0 deletions keyboards/kinesis/keymaps/soft_dev/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/* Copyright 2023 Alex Stepanov
*
* 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_names {
_BASE, // default layer
_KEYPAD, // arrow keys, shifted symbols, HOME, END, PGUP, PGDN, FKeys, CTRL(TAB)
_NUMPAD // numpad keys
};

/* ,------------------------------------------------------------------------------------------------------------------------.
* | Esc | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | | F9 | F10 | F11 | F12 |PSCR|SLCK|PAUS|KPAD|BOOT|
* |--------+------+------+------+-------+------+--------------------------------+------+------+------+------+------+--------|
* | -_ | 1! | 2@ | 3# | 4$ | 5% | | 6^ | 7& | 8* | 9( | 0) | =+ |
* |--------+------+------+------+-------+------| +------+------+------+------+------+--------|
* | Tab | Q | W | E | R | T | | Y | U | I | O | P | \| |
* |--------+------+------+------+-------+------| |------+------+------+------+------+--------|
* | Del | A | S | D | F | G | | H | J | K | L | ;: | '" |
* |--------+------+------+------+-------+------| |------+------+------+------+------+--------|
* | Shift | Z | X | C | V | B | | N | M | ,. | .> | /? |Sht/Ent |
* `--------+------+------+------+-------+------- `------+------+------+------+------+--------'
* | `~ | Gui | Esc |MO(Num)| | [{ | ]} | | |
* `----------------------------' `---------------------------'
* ,---------------. ,---------------.
* |Alt+Tab| Alt | | Alt |TO(Num)|
* ,------|------ |-------| |-------+-------+------.
* | | | Shift | | Shift | | |
* | BkSp | KPAD |-------| |------ | KPAD | Space|
* | | | Ctrl | | Ctrl | | |
* `----------------------' `----------------------'
*/

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_BASE] = LAYOUT_pretty(
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_SCRL,KC_PAUS,TO(_KEYPAD),QK_BOOT,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nitpick, so feel free to ignore, but this bothers me.

Specifically, most/all keycodes have a 7 character name/alias, so you can have a 9 wide column (eg 1234567, ), so you can have consistent formatting/placement. So this scrunched together could be better spaced.

KC_MINS,KC_1,KC_2,KC_3,KC_4,KC_5, KC_6,KC_7,KC_8,KC_9,KC_0,KC_EQL,
KC_TAB,KC_Q,KC_W,KC_E,KC_R,KC_T, KC_Y,KC_U,KC_I,KC_O,KC_P,KC_BSLS,
KC_DEL,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,SC_SENT,
KC_GRV,KC_LGUI,KC_ESC,MO(_NUMPAD), KC_LBRC,KC_RBRC,KC_NO,KC_NO,
LALT(KC_TAB),KC_LALT, KC_RALT,TO(_NUMPAD),
KC_LSFT, KC_RSFT,
KC_BSPC,MO(_KEYPAD),KC_LCTL, KC_RCTL,MO(_KEYPAD),KC_SPC
),
/* ,------------------------------------------------------------------------------------------------------------------------.
* | | | | | | | | | | | | | | | | | TO(BASE) | |
* |--------+------+------+------+------+------+---------------------------------+------+------+------+------+------+--------|
* | _ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | + |
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
* | | F1 | F2 | F3 | F4 | F5 | | | Home | Up | End | | | |
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
* | | F6 | F7 | F8 | F9 | F10 | | Pgup | Lft | Dwn | Rgt | : | " |
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
* | CapsLk | | | | F11 | F12 | | Pgdn | | < | > | ? | |
* `--------+------+------+------+------+------' `------+------+------+------+------+--------'
* | ~ | INS | | | | { | } | | |
* `---------------------------' `---------------------------'
* ,--------------. ,--------------------.
* |Ctl+Tab| | | | | |
* ,------|------ |------| |------+------+------.
* | | |Shift | |Shift | | |
* | | |------| |------| | |
* | | | Ctrl | | Ctrl | | |
* `-------------- ------' `--------------------'
*/
[_KEYPAD] = LAYOUT_pretty(
KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO, KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,TO(_BASE),KC_NO,
KC_UNDS,KC_EXLM,KC_AT,KC_HASH,KC_DLR,KC_PERC, KC_CIRC,KC_AMPR,KC_ASTR,KC_LPRN,KC_RPRN,KC_PLUS,
KC_NO,KC_F1,KC_F2,KC_F3,KC_F4,KC_F5, KC_NO,KC_HOME,KC_UP,KC_END,KC_NO,KC_PIPE,
KC_CAPS,KC_F6,KC_F7,KC_F8,KC_F9,KC_F10, KC_PGUP,KC_LEFT,KC_DOWN,KC_RGHT,KC_COLN,KC_DQUO,
KC_NO,KC_NO,KC_NO,KC_NO,KC_F11,KC_F12, KC_PGDN,KC_NO,KC_LT,KC_GT,KC_QUES,KC_NO,
KC_TILD,KC_INS,KC_NO,KC_NO, KC_LCBR,KC_RCBR,KC_NO,KC_NO,
LCTL(KC_TAB),KC_NO, KC_NO,KC_NO,
KC_LSFT, KC_RSFT,
KC_NO,KC_NO,KC_LCTL, KC_RCTL,KC_NO,KC_NO
),
/*,--------+------+------+------+------+------+ +------+------+------+------+------+--------.
* | | | | | | | | | Base | = | / | * | |
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
* | | | | | | | | | 7 | 8 | 9 | - | |
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
* | Del | | | | | | | | 4 | 5 | 6 | + | |
* |--------+------+------+------+------+------| |------+------+------+------+------+--------|
* | BkSp | | | | | | | | 1 | 2 | 3 |Enter | Enter |
* `--------+------+------+------+------+------' `------+------+------+------+------+--------'
* | | | | | | . |Enter | | |
* `---------------------------' `---------------------------'
* ,-------------. ,-------------.
* | | | | | Base |
* ,------|------|------| |------+------+------.
* | | | | | | | |
* | BkSp | |------| |------| | 0 |
* | | | | | | | |
* `--------------------' `--------------------'
*/

[_NUMPAD] = LAYOUT_pretty(
KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO, KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,
KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO, KC_NO,TO(_BASE),KC_EQL,KC_SLSH,KC_ASTR,KC_NO,
KC_NO,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO, KC_NO,KC_7,KC_8,KC_9,KC_MINS,KC_NO,
KC_DEL,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO, KC_NO,KC_4,KC_5,KC_6,KC_PLUS,KC_NO,
KC_BSPC,KC_NO,KC_NO,KC_NO,KC_NO,KC_NO, KC_NO,KC_1,KC_2,KC_3,KC_ENT,KC_ENT,
KC_NO,KC_NO,KC_NO,KC_NO, KC_DOT,KC_ENT,KC_NO,KC_NO,
KC_NO,KC_NO, KC_NO,TO(_BASE),
KC_NO, KC_NO,
KC_BSPC,KC_NO,KC_NO, KC_NO,KC_NO,KC_0
)
};

layer_state_t layer_state_set_user(layer_state_t state) {
writePin(LED_KPD_PIN, !layer_state_cmp(state, _KEYPAD));
writePin(LED_NUM_PIN, !layer_state_cmp(state, _NUMPAD));
return state;
};
105 changes: 105 additions & 0 deletions keyboards/kinesis/keymaps/soft_dev/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
## Custom Layout
Kinesis Contoured family of keyboards belong to a relatively small group of keyboards that utilize thumb clusters. The keycap profiles of thumb cluster keys make it easy to press multiple keys simultaneously by a thumb finger. Co-locating CTRL, SHIFT and KEYPAD modifiers in the thumb cluster gives truly unique capabilities to these keyboards.

### Software Developer Layout
The **soft_dev** layout is optimized for software development on a Windows machine. It is a result of many years of daily usage. It is a great starting point for your own design.

#### Layout Features
- 3 layers: default layer, keypad layer, numpad layer
- keypad layer allows for 2 finger operation using **arrow** keys together with
- **CTRL** and/or **SHIFT** modifiers OR
- **HOME/END** keys OR
- **PAGEUP/PAGEDOWN** keys.
- two finger operations can be achieved by holding up to 3 modifier keys (KEYPAD/SHIFT/CTRL) with a thumb finger and using index/middle/ring finger by pressing keywell keys. For example, you can fully control caret position and text selection of:
- each letter
- each word
- from a current caret position to the beginning of the line
- from a current caret position to the end of the line
- multiple lines
- multiple pages
- with little practice you will be able to string together different key combinations. For example, executing `KEYPAD + O` and then `KEYPAD + SHIFT + U` selects the whole line of text with barely any finger movement. The best part is that it works in any text editor!
- keypad layer allows accessing **F1-F12** and **ESC** keys by moving only a single finger away from the home row, making it very fast and convenient
- **KEYPAD** key can be used to access US ANSI Shifted Symbols instead of pressing a SHIFT key. This gives you two advantages: it makes KEYPAD key a "go to" key which is used in almost all operations unrelated to typing of letters. To understand the second advantage, compare pressing `SHIFT + 0` and `KEYPAD + 0` using the right hand
- **NUMPAD** "momentary" modifier key can be used to quickly switch to a numeric pad while typing alphanumeric strings. In a stock Kinesis firmware you would have to switch to KEYPAD layer and then press NUMLOCK key which makes it unusable for this task
- **NUMPAD** key in the right thumb cluster can be used to switch to a numeric pad for long numeric sequences

#### Layout Layers

<img src="https://i.imgur.com/86LCI3zh.jpg">
<img src="https://i.imgur.com/Gv4WBw7h.jpg"/>
<img src="https://i.imgur.com/gKXMUI2h.jpg"/>
alvicstep marked this conversation as resolved.
Show resolved Hide resolved

#### Notes
- MO(1) - switch to **KEYPAD** layer while key is being pressed
- MO(2) - switch to **NUMPAD** layer while key is being pressed
- TO(0) - switch to **BASE** layer
- TO(2) - switch to **NUMPAD** layer
- Rsft(Enter) - acts as an ENTER key when pressed and released. Acts as a SHIFT modifier in combination with other keys
- Bt - enter bootloader mode
- Alt(Tab) - toggle between last two active applications
- Ctrl(Tab) - toggle between last two active tabs


### Differences From Stock
- **{}[]** keys are moved to the left side of the keywell to be easily accessible
- **-** and **+** keys are switched
- **CAPS LOCK** key is moved to **KEYPAD** layer and is mapped to **DELETE** on **BASE** layer

### Shortcuts


|Shortcut | Control Caret |
|---------------------|---------------------------------------|
|`KEYPAD + J` | move caret one character left |
|`KEYPAD + L` | move caret one character right |
|`KEYPAD + I` | move caret one line up |
|`KEYPAD + K` | move caret one line down |
|`KEYPAD + CTRL + J` | move caret one word to the left |
|`KEYPAD + CTRL + L` | move caret one word to the right |
|`KEYPAD + U` | move caret to the start of the line |
|`KEYPAD + O` | move caret to the end of the line |
|`KEYPAD + H` | move caret one page up |
|`KEYPAD + N` | move caret one page down |


|Shortcut | Scroll Lock |
|---------------------|---------------------------------------|
|`KEYPAD + CTRL + I` | scroll page up |
|`KEYPAD + CTRL + K` | scroll page down |


|Shortcut | Select Text |
|-----------------------------|-------------------------------|
|`KEYPAD + CTRL + SHIFT + J` | select one word to the left |
|`KEYPAD + CTRL + SHIFT + L` | select one word to the right |
|`KEYPAD + CTRL + SHIFT + I` | select one line up |
|`KEYPAD + CTRL + SHIFT + K` | select one line down |
|`KEYPAD + SHIFT + H` | select one page up |
|`KEYPAD + SHIFT + N` | select one page down |
|`KEYPAD + CTRL + SHIFT + U` | select from beginning of the file up to the caret position |
|`KEYPAD + CTRL + SHIFT + O` | select from caret position to the end of the file |


|Shortcut | US ANSI Shifted Symbols |
|---------------------|---------------------------------------|
|`KEYPAD + -` | _ |
|`KEYPAD + 1` | ! |
|`KEYPAD + 2` | @ |
|`KEYPAD + 3` | # |
|`KEYPAD + 4` | $ |
|`KEYPAD + 5` | % |
|`KEYPAD + 6` | ^ |
|`KEYPAD + 7` | & |
|`KEYPAD + 8` | * |
|`KEYPAD + 9` | ( |
|`KEYPAD + 0` | ) |
|`KEYPAD + =` | + |
|`KEYPAD + \` | \| |
|`KEYPAD + '` | " |
|`KEYPAD + ;` | : |
|`KEYPAD + /` | ? |
|`KEYPAD + [` | { |
|`KEYPAD + ]` | } |
|`KEYPAD + ,` | < |
|`KEYPAD + .` | > |
|`KEYPAD + BACKTICK` | ~ |
22 changes: 22 additions & 0 deletions keyboards/kinesis/kintwin/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* Copyright 2023 Alex Stepanov

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 LED_KPD_PIN C13
#define LED_CAPS_PIN A15
#define LED_NUM_PIN B4
#define LED_SCRL_PIN B3
28 changes: 28 additions & 0 deletions keyboards/kinesis/kintwin/halconf.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* Copyright 2020 QMK
*
* 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/>.
*/

/*
* This file was auto-generated by:
* `qmk chibios-confmigrate -i keyboards/handwired/onekey/blackpill_f401/halconf.h -r platforms/chibios/common/configs/halconf.h`
*/

#pragma once

#define HAL_USE_I2C TRUE

#define HAL_USE_PWM TRUE

#include_next <halconf.h>
Loading