[Keyboard] Add splitkb.com's Aurora Helix (#21871)
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
This commit is contained in:
harveysch
GitHub
parent
49f1cbd40e
commit
e7ae5ec07c
17 changed files with 1209 additions and 0 deletions
19
keyboards/splitkb/aurora/helix/keymaps/debug/config.h
Normal file
19
keyboards/splitkb/aurora/helix/keymaps/debug/config.h
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
/* Copyright 2023 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
|
||||
|
||||
#define RGBLIGHT_EFFECT_BREATHING
|
||||
68
keyboards/splitkb/aurora/helix/keymaps/debug/keymap.c
Normal file
68
keyboards/splitkb/aurora/helix/keymaps/debug/keymap.c
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
/* Copyright 2023 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, S(KC_R), S(KC_Q), S(KC_P), S(KC_O), S(KC_N), S(KC_M),
|
||||
KC_S, KC_T, 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), S(KC_T), S(KC_S),
|
||||
KC_Z, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, S(KC_6), S(KC_5), S(KC_4), S(KC_3), S(KC_2), S(KC_1), S(KC_Z)
|
||||
)
|
||||
};
|
||||
|
||||
#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 128x32 OLED rotated 90 degrees is 5 characters wide and 16 characters tall
|
||||
// This example string should fill that neatly
|
||||
oled_write_P(PSTR("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789!@#$%^&*()[]{}-=_+?"), false);
|
||||
return false;
|
||||
}
|
||||
#endif
|
||||
24
keyboards/splitkb/aurora/helix/keymaps/debug/readme.md
Normal file
24
keyboards/splitkb/aurora/helix/keymaps/debug/readme.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Aurora Helix'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
|
||||
|
||||
|
||||
|
||||
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 left half uses index 0, the right half uses index 1.
|
||||
|
||||
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
keyboards/splitkb/aurora/helix/keymaps/debug/rules.mk
Normal file
8
keyboards/splitkb/aurora/helix/keymaps/debug/rules.mk
Normal file
|
|
@ -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
|
||||
24
keyboards/splitkb/aurora/helix/keymaps/default/config.h
Normal file
24
keyboards/splitkb/aurora/helix/keymaps/default/config.h
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
/* Copyright 2023 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
|
||||
|
||||
#define RGB_DISABLE_WHEN_USB_SUSPENDED
|
||||
#define RGB_MATRIX_KEYPRESSES
|
||||
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
|
||||
#define ENABLE_RGB_MATRIX_SOLID_SPLASH
|
||||
#define ENABLE_RGB_MATRIX_RAINBOW_BEACON
|
||||
#define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
|
||||
52
keyboards/splitkb/aurora/helix/keymaps/default/keymap.json
Normal file
52
keyboards/splitkb/aurora/helix/keymaps/default/keymap.json
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
{
|
||||
"config": {
|
||||
"features": {
|
||||
"oled": true,
|
||||
"rgb_matrix": true,
|
||||
"rgblight": false
|
||||
},
|
||||
"encoder": {
|
||||
"enabled": true
|
||||
},
|
||||
"rgblight": {
|
||||
"hue_steps": 8,
|
||||
"saturation_steps": 8,
|
||||
"brightness_steps": 8,
|
||||
"sleep": true
|
||||
}
|
||||
},
|
||||
"keyboard": "splitkb/aurora/helix",
|
||||
"keymap": "default",
|
||||
"layers": [
|
||||
[
|
||||
"KC_GRV", "KC_1", "KC_2", "KC_3", "KC_4", "KC_5", "KC_6", "KC_7", "KC_8", "KC_9", "KC_0", "KC_DEL",
|
||||
"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_LBRC", "KC_RBRC", "KC_N", "KC_M", "KC_COMM", "KC_DOT", "KC_SLSH", "KC_ENT" ,
|
||||
"MO(3)", "KC_ESC", "KC_LALT", "KC_LGUI", "LALT(KC_GRV)", "MO(1)", "KC_SPC", "KC_SPC", "MO(2)", "LALT(KC_GRV)", "KC_LEFT", "KC_DOWN", "KC_UP", "KC_RGHT"
|
||||
],
|
||||
[
|
||||
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______",
|
||||
"KC_TILD", "KC_EXLM", "KC_AT", "KC_HASH", "KC_DLR", "KC_PERC", "KC_CIRC", "KC_AMPR", "KC_ASTR", "KC_LPRN", "KC_RPRN", "_______",
|
||||
"_______", "KC_F1", "KC_F2", "KC_F3", "KC_F4", "KC_F5", "KC_F6", "KC_UNDS", "KC_PLUS", "KC_LCBR", "KC_RCBR", "KC_PIPE",
|
||||
"KC_CAPS", "KC_F7", "KC_F8", "KC_F9", "KC_F10", "KC_F11", "KC_LPRN", "KC_RPRN", "KC_F12", "_______", "_______", "KC_HOME", "KC_END", "_______",
|
||||
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "MO(3)", "_______", "KC_MNXT", "KC_VOLD", "KC_VOLU", "KC_MPLY"
|
||||
],
|
||||
[
|
||||
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "KC_BSPC",
|
||||
"KC_GRV", "KC_1", "KC_2", "KC_3", "KC_4", "KC_5", "KC_6", "KC_7", "KC_8", "KC_9", "KC_0", "KC_DEL",
|
||||
"_______", "KC_F1", "KC_F2", "KC_F3", "KC_F4", "KC_F5", "KC_F6", "KC_MINS", "KC_EQL", "KC_LBRC", "KC_RBRC", "KC_BSLS",
|
||||
"KC_CAPS", "KC_F7", "KC_F8", "KC_F9", "KC_F10", "KC_F11", "_______", "_______", "KC_F12", "_______", "_______", "KC_PGDN", "KC_PGUP", "_______",
|
||||
"_______", "_______", "_______", "_______", "_______", "MO(3)", "_______", "_______", "_______", "_______", "KC_MNXT", "KC_VOLD", "KC_VOLU", "KC_MPLY"
|
||||
],
|
||||
[
|
||||
"KC_F1", "KC_F2", "KC_F3", "KC_F4", "KC_F5", "KC_F6", "KC_F7", "KC_F8", "KC_F9", "KC_F10", "KC_F11", "KC_F12",
|
||||
"_______", "QK_BOOT", "_______", "EE_CLR", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "KC_DEL",
|
||||
"_______", "_______", "_______", "_______", "_______", "AG_NORM", "AG_SWAP", "_______", "_______", "_______", "_______", "_______",
|
||||
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "RGB_TOG", "RGB_HUI", "RGB_SAI", "RGB_VAI",
|
||||
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "RGB_MOD", "RGB_HUD", "RGB_SAD", "RGB_VAD"
|
||||
]
|
||||
],
|
||||
"layout": "LAYOUT",
|
||||
"version": 1
|
||||
}
|
||||
88
keyboards/splitkb/aurora/helix/keymaps/default/readme.md
Normal file
88
keyboards/splitkb/aurora/helix/keymaps/default/readme.md
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
# Aurora Helix's Default Keymap
|
||||
_This keymap is a copy of the [Helix default keymap](https://github.com/qmk/qmk_firmware/tree/master/keyboards/helix/rev3_5rows/keymaps/default), with slight modifications._
|
||||
|
||||
A simple default keymap for the Aurora Helix
|
||||
=============================================
|
||||
|
||||
Keymaps in general are quite personal, so it is difficult to come up with a default that will suit every user. We hope this keymap serves as a good starting point for your own - although it should be fairly usable out-of-the-box.
|
||||
|
||||
What do all these layers do?
|
||||
----------------------------
|
||||
|
||||
### Layer 0: Base layer
|
||||
|
||||
|
||||
|
||||
This is where your basic letters live.
|
||||
|
||||
The homing thumb fingers are used to access the different layers.
|
||||
|
||||
* The homing second to left thumb finger gives access to the Symbols (or lower) layer
|
||||
* The homing second to right thumb finger gives access to the Navigation (or raise) layer
|
||||
* Pressing both homing thumb fingers gives access to the Adjust layer
|
||||
|
||||
### Layer 1: Lower
|
||||
|
||||
|
||||
|
||||
The Lower layer gives access to the F keys, symbols and media control.
|
||||
|
||||
### Layer 2: Raise
|
||||
|
||||
|
||||
|
||||
The Raise layer gives access to additional numbers keys, F keys.
|
||||
|
||||
### Layer 3: Adjust
|
||||
|
||||
|
||||
|
||||
The Adjust layer exposes RGB adjustment keys on the right hand and additional configuration keys.
|
||||
|
||||
Where is the keymap.c?
|
||||
----------------------
|
||||
|
||||
The keymap.c file is not published to the repository. It is generated from `keymap.json` by the build system.
|
||||
|
||||
This avoids duplicating information and allow users to edit their keymap from the QMK Configurator web interface.
|
||||
|
||||
How do I edit and update the keymap?
|
||||
------------------------------------
|
||||
|
||||
The `keymap.json` file is generated from the QMK Configurator interface and formatted for better readability in the context of the Ferris keyboard.
|
||||
|
||||
To edit it, you may:
|
||||
* Edit it directly from a text editor.
|
||||
* Edit it from the QMK Configurator.
|
||||
|
||||
If you decide to use the latter workflow, here are the steps to follow:
|
||||
|
||||
* From the [QMK Configurator](https://config.qmk.fm/#/splitkb/aurora/helix/rev1/LAYOUT), hit the "import QMK keymap json file" button (it has a drawing with an up arrow on it).
|
||||
* Browse to the location of your keymap (for example, `<your qmk repo>/keyboards/splitkb/aurora/helix/keymaps/default/keymap.json`)
|
||||
* Perform any modification to the keymap in the web UI
|
||||
* Export the keymap to your downloads folder, by hitting the "Export QMK keymap json file" button (it has a drawing with a down arrow on it)
|
||||
* Replace your original keymap with the one you just downloaded
|
||||
|
||||
_**Note:** At the time of writing (the 24th of October 2022), not every feature used in the default keymap is supported by the QMK Configurator. You cannot yet upload the default `keymap.json` due to a file format mismatch - use the "Load Default" button to load the default keymap instead. Additionally, custom configuration options are still being worked on: if your keymap depends on them, please compile your firmware offline for now._
|
||||
|
||||
I want to do more than the JSON format supports!
|
||||
-------------------------------------------------
|
||||
|
||||
While the `json` format is easy to use, it does lack certain functionality - most notably custom OLED or encoder behaviour.
|
||||
|
||||
To add this, you need to convert it to the `c` format. Do keep in mind that this is generally a one-way operation.
|
||||
|
||||
First, from the root of your qmk repo, move to your keymap folder
|
||||
|
||||
```bash
|
||||
cd ./keyboards/splitkb/aurora/helix/keymaps/my_personal_keymap
|
||||
```
|
||||
|
||||
Next, convert your `keymap.json` to a `keymap.c`
|
||||
|
||||
```bash
|
||||
qmk json2c -o keymap.c keymap.json
|
||||
```
|
||||
|
||||
You can add custom C code to the newly generated `keymap.c` file. Do note that you have to use **either** a C file **or** a JSON file - you cannot do both!
|
||||
**If a JSON file is present, the C file is ignored.**
|
||||
Loading…
Add table
Add a link
Reference in a new issue