From 1f618c8302cc5053c382436a2d1fb11082c99057 Mon Sep 17 00:00:00 2001 From: Will Winder Date: Tue, 11 Jan 2022 15:17:37 -0500 Subject: keyhive sofle rgb: fix configuration. (#15339) * keyhive sofle rgb: fix configuration. * Add Colemak-DH and cycle layer keycode. * Fix indentation. * Add PLACEHOLDER for better readability. * Fix breaking changes. * Just one colemak. * PR Cleanup * Use NO_PIN definition instead of C7 * Define animations individually * Remove via json file and update documentation * Reduce LED brightness, one of the animations caused a crash * More PR feedback. * Better credit. * Disable NKRO. * Cleanup RGB configuration. * animations defined in keymap. * Update keyboards/sofle/keyhive/readme.md * PR Feedback. * Update phrasing from template. * Disable RGBLIGHT_ENABLE in keymap for better compatibility with default keymap. * Set a default animation. * Use default in keyboard readme. * Update keyboards/sofle/keyhive/info.json * Move via specific layout into via keymap. --- keyboards/sofle/keymaps/keyhive_via/config.h | 48 +++++++ keyboards/sofle/keymaps/keyhive_via/encoder.c | 49 +++++++ keyboards/sofle/keymaps/keyhive_via/keymap.c | 191 ++++++++++++++++++++++++++ keyboards/sofle/keymaps/keyhive_via/oled.c | 85 ++++++++++++ keyboards/sofle/keymaps/keyhive_via/readme.md | 49 +++++++ keyboards/sofle/keymaps/keyhive_via/rules.mk | 2 + keyboards/sofle/keymaps/via/keymap.c | 6 +- 7 files changed, 427 insertions(+), 3 deletions(-) create mode 100644 keyboards/sofle/keymaps/keyhive_via/config.h create mode 100644 keyboards/sofle/keymaps/keyhive_via/encoder.c create mode 100644 keyboards/sofle/keymaps/keyhive_via/keymap.c create mode 100644 keyboards/sofle/keymaps/keyhive_via/oled.c create mode 100644 keyboards/sofle/keymaps/keyhive_via/readme.md create mode 100644 keyboards/sofle/keymaps/keyhive_via/rules.mk (limited to 'keyboards/sofle/keymaps') diff --git a/keyboards/sofle/keymaps/keyhive_via/config.h b/keyboards/sofle/keymaps/keyhive_via/config.h new file mode 100644 index 0000000000..0e2cb6d2c4 --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/config.h @@ -0,0 +1,48 @@ + /* Copyright 2020 Josef Adamcik + * Modification for VIA support and RGB underglow by Jens Bonk-Wiltfang + * + * 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 . + */ + +#pragma once + +/* The way how "handedness" is decided (which half is which), +see https://docs.qmk.fm/#/feature_split_keyboard?id=setting-handedness +for more options. +*/ + +// More lighting options in quantum/rgblight/rgblight.h +#ifdef RGBLIGHT_ENABLE +# define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_SWIRL+2 + +// Disabling some of these is a good way to save flash space. +# define RGBLIGHT_EFFECT_ALTERNATING // 108 +# define RGBLIGHT_EFFECT_RGB_TEST // 158 +# define RGBLIGHT_EFFECT_RAINBOW_MOOD // 160 +# define RGBLIGHT_EFFECT_STATIC_GRADIENT // 168 +# define RGBLIGHT_EFFECT_RAINBOW_SWIRL // 192 +# define RGBLIGHT_EFFECT_BREATHING // 348 +# define RGBLIGHT_EFFECT_KNIGHT // 336 +# define RGBLIGHT_EFFECT_SNAKE // 406 +# define RGBLIGHT_EFFECT_CHRISTMAS // 508 +/* +#define RGBLIGHT_EFFECT_TWINKLE // 1156 +*/ +#endif + +// Disabled to save space +#define NO_ACTION_ONESHOT // 332 +#define NO_ACTION_MACRO // 0 +#define NO_ACTION_FUNCTION // 0 +#define DISABLE_LEADER // 0 diff --git a/keyboards/sofle/keymaps/keyhive_via/encoder.c b/keyboards/sofle/keymaps/keyhive_via/encoder.c new file mode 100644 index 0000000000..0883c4a48a --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/encoder.c @@ -0,0 +1,49 @@ + /* Copyright 2020 Josef Adamcik + * Modification for VIA support and RGB underglow by Jens Bonk-Wiltfang + * + * 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 . + */ + +//Setting up what encoder rotation does. If your encoder can be pressed as a button, that function can be set in Via. + +#ifdef ENCODER_ENABLE + static uint8_t encoder_state[2] = {0}; + //Use these keymap positions to specify the encoder functions on rotate. + static keypos_t encoder_ccw[2] = {{6, 3}, {6, 8}}; + static keypos_t encoder_cw[2] = {{6, 1}, {6, 6}}; + + void encoder_action_unregister(void) { + for (int index = 0; index < 2; ++index) { + if (encoder_state[index]) { + keyevent_t encoder_event = (keyevent_t){.key = encoder_state[index] >> 1 ? encoder_cw[index] : encoder_ccw[index], .pressed = false, .time = (timer_read() | 1)}; + encoder_state[index] = 0; + action_exec(encoder_event); + } + } + } + + void encoder_action_register(uint8_t index, bool clockwise) { + keyevent_t encoder_event = (keyevent_t){.key = clockwise ? encoder_cw[index] : encoder_ccw[index], .pressed = true, .time = (timer_read() | 1)}; + encoder_state[index] = (clockwise ^ 1) | (clockwise << 1); + action_exec(encoder_event); + } + + void matrix_scan_user(void) { encoder_action_unregister(); } + + bool encoder_update_user(uint8_t index, bool clockwise) { + encoder_action_register(index, clockwise); + return false; + }; +#endif + diff --git a/keyboards/sofle/keymaps/keyhive_via/keymap.c b/keyboards/sofle/keymaps/keyhive_via/keymap.c new file mode 100644 index 0000000000..878638e1a2 --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/keymap.c @@ -0,0 +1,191 @@ + /* Copyright 2020 Josef Adamcik + * Modification for VIA support and RGB underglow by Jens Bonk-Wiltfang + * + * 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 . + */ + +#include QMK_KEYBOARD_H + +#include "oled.c" +#include "encoder.c" + +// Base layer is the number of layers CYCLE selects from. +#define BASE_LAYERS 2 + +enum custom_keycodes { + PLACEHOLDER = SAFE_RANGE, // can always be here (4 bytes) + CYCLE // cycle through first BASE_LAYERS (62 bytes) +}; + +enum custom_layers { + _QWERTY, + _COLEMAK, + _LOWER, + _RAISE +}; + +// Extra keys are added for rotary encoder support in VIA +#define LAYOUT_via( \ + LA1, LA2, LA3, LA4, LA5, LA6, RA6, RA5, RA4, RA3, RA2, RA1, \ + LB1, LB2, LB3, LB4, LB5, LB6, LB7, RB7, RB6, RB5, RB4, RB3, RB2, RB1, \ + LC1, LC2, LC3, LC4, LC5, LC6, LE1, RE6, RC6, RC5, RC4, RC3, RC2, RC1, \ + LD1, LD2, LD3, LD4, LD5, LD6, LD7, RD7, RD6, RD5, RD4, RD3, RD2, RD1, \ + LE2, LE3, LE4, LE5, LE6, RE5, RE4, RE3, RE2, RE1 \ + ) \ + { \ + { LA1, LA2, LA3, LA4, LA5, LA6, KC_NO }, \ + { LB1, LB2, LB3, LB4, LB5, LB6, LB7 }, \ + { LC1, LC2, LC3, LC4, LC5, LC6, KC_NO }, \ + { LD1, LD2, LD3, LD4, LD5, LD6, LD7 }, \ + { LE1, LE2, LE3, LE4, LE5, LE6, KC_NO }, \ + { RA1, RA2, RA3, RA4, RA5, RA6, KC_NO }, \ + { RB1, RB2, RB3, RB4, RB5, RB6, RB7 }, \ + { RC1, RC2, RC3, RC4, RC5, RC6, KC_NO }, \ + { RD1, RD2, RD3, RD4, RD5, RD6, RD7 }, \ + { RE1, RE2, RE3, RE4, RE5, RE6, KC_NO } \ + } + +//Default keymap. This can be changed in Via. Use oled.c to change beavior that Via cannot change. +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { +/* + * QWERTY + * ,-----------------------------------------. ,-----------------------------------------. + * | ` | 1 | 2 | 3 | 4 | 5 |-------. E ,-------| 6 | 7 | 8 | 9 | 0 | ` | + * |------+------+------+------+------+------| VolUp |< N >| Pg Up |------+------+------+------+------+------| + * | ESC | Q | W | E | R | T |-------. C ,-------| Y | U | I | O | P | Bspc | + * |------+------+------+------+------+------| Mute |< O >| |------+------+------+------+------+------| + * | Tab | A | S | D | F | G |-------. D ,-------| H | J | K | L | ; | ' | + * |------+------+------+------+------+------| VolDn |< E >| Pg Dn |------+------+------+------+------+------| + * |LShift| Z | X | C | V | B |-------| R |-------| N | M | , | . | / |RShift| + * `-----------------------------------------/ / \ \-----------------------------------------' + * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | + * | | | | |/ / \ \ | | | | | + * `-----------------------------------' '------''---------------------------' + */ + +[_QWERTY] = LAYOUT_via( + KC_GRV, KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_GRV , + KC_ESC, KC_Q , KC_W , KC_E , KC_R , KC_T , KC_VOLU, KC_PGUP, KC_Y , KC_U , KC_I , KC_O , KC_P , KC_BSPC, + KC_TAB, KC_A , KC_S , KC_D , KC_F , KC_G , KC_MUTE, KC_NO , 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_VOLD, KC_PGDN, KC_N , KC_M , KC_COMM, KC_DOT , KC_SLSH, KC_RSFT, + KC_LGUI,KC_LALT ,KC_LCTRL,MO(_LOWER), KC_ENT , KC_SPC ,MO(_RAISE),KC_RCTRL, KC_RALT, KC_RGUI +), +/* + * COLEMAK - Vanilla + * ,-----------------------------------------. ,-----------------------------------------. + * | ` | 1 | 2 | 3 | 4 | 5 |-------. E ,-------| 6 | 7 | 8 | 9 | 0 | ` | + * |------+------+------+------+------+------| VolUp |< N >| Pg Up |------+------+------+------+------+------| + * | ESC | Q | W | F | P | G |-------. C ,-------| J | L | U | Y | ; | Bspc | + * |------+------+------+------+------+------| Mute |< O >| |------+------+------+------+------+------| + * | TAB | A | R | S | T | D |-------. D ,-------| H | N | E | I | O | ' | + * |------+------+------+------+------+------| VolDn |< E >| Pg Dn |------+------+------+------+------+------| + * |LShift| Z | X | C | V | B |-------| R |-------| K | M | , | . | / |RShift| + * `-----------------------------------------/ / \ \-----------------------------------------' + * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | + * | | | | |/ / \ \ | | | | | + * `-----------------------------------' '------''---------------------------' + */ +/* +[_COLEMAK] = LAYOUT_via( + KC_GRV , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_GRV , + KC_ESC , KC_Q , KC_W , KC_F , KC_P , KC_G , KC_VOLU, KC_PGUP, KC_J , KC_L , KC_U , KC_Y , KC_SCLN, KC_BSPC, + KC_TAB , KC_A , KC_R , KC_S , KC_T , KC_D , KC_MUTE, KC_NO , KC_H , KC_N , KC_E , KC_I , KC_O , KC_QUOT, + KC_LSFT, KC_Z , KC_X , KC_C , KC_V , KC_B , KC_VOLD, KC_PGDN, KC_N , KC_M , KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, + KC_LGUI, KC_LALT,KC_LCTRL,MO(_LOWER), KC_ENT , KC_SPC ,MO(_RAISE),KC_RCTRL, KC_RALT, KC_RGUI +), +*/ + +/* + * COLEMAK-DH + * ,-----------------------------------------. ,-----------------------------------------. + * | ` | 1 | 2 | 3 | 4 | 5 |-------. E ,-------| 6 | 7 | 8 | 9 | 0 | ` | + * |------+------+------+------+------+------| VolUp |< N >| Pg Up |------+------+------+------+------+------| + * | ESC | Q | W | F | P | B |-------. C ,-------| J | L | U | Y | ; | Bspc | + * |------+------+------+------+------+------| Mute |< O >| |------+------+------+------+------+------| + * | TAB | A | R | S | T | G |-------. D ,-------| M | N | E | I | O | ' | + * |------+------+------+------+------+------| VolDn |< E >| Pg Dn |------+------+------+------+------+------| + * |LShift| Z | X | C | D | V |-------| R |-------| K | H | , | . | / |RShift| + * `-----------------------------------------/ / \ \-----------------------------------------' + * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | + * | | | | |/ / \ \ | | | | | + * `-----------------------------------' '------''---------------------------' + */ +[_COLEMAK] = LAYOUT_via( + KC_GRV , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_GRV , + KC_ESC , KC_Q , KC_W , KC_F , KC_P , KC_B , KC_VOLU, KC_PGUP, KC_J , KC_L , KC_U , KC_Y , KC_SCLN, KC_BSPC, + KC_TAB , KC_A , KC_R , KC_S , KC_T , KC_G , KC_MUTE, KC_NO , KC_M , KC_N , KC_E , KC_I , KC_O , KC_QUOT, + KC_LSFT, KC_Z , KC_X , KC_C , KC_D , KC_V , KC_VOLD, KC_PGDN, KC_K , KC_H , KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, + KC_LGUI, KC_LALT,KC_LCTRL,MO(_LOWER), KC_ENT , KC_SPC ,MO(_RAISE),KC_RCTRL, KC_RALT, KC_RGUI +), + +/* LOWER + * ,-----------------------------------------. ,-----------------------------------------. + * | | F1 | F2 | F3 | F4 | F5 |-------. E ,-------| F6 | F7 | F8 | F9 | F10 | F11 | + * |------+------+------+------+------+------| |< N >| |------+------+------+------+------+------| + * | ` | 1 | 2 | 3 | 4 | 5 |-------. C ,-------| 6 | 7 | 8 | 9 | 0 | F12 | + * |------+------+------+------+------+------| |< O >| |------+------+------+------+------+------| + * | Tab | ! | @ | # | $ | % |-------. D ,-------| ^ | & | * | ( | ) | | | + * |------+------+------+------+------+------| |< E >| |------+------+------+------+------+------| + * | Shift| = | - | + | { | } |-------| R |-------| [ | ] | ; | : | \ | | + * `-----------------------------------------/ / \ \-----------------------------------------' + * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | + * | | | | |/ / \ \ | | | | | + * `-----------------------------------' '------''---------------------------' + */ +[_LOWER] = LAYOUT_via( + _______, KC_F1 , KC_F2 , KC_F3 , KC_F4 , KC_F5 , KC_F6 , KC_F7 , KC_F8 , KC_F9 , KC_F10 , KC_F11 , + KC_GRV , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , _______, _______, KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_F12 , + _______, KC_EXLM, KC_AT , KC_HASH, KC_DLR , KC_PERC, _______, _______, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PIPE, + _______, KC_EQL , KC_MINS, KC_PLUS, KC_LCBR, KC_RCBR, _______, _______, KC_LBRC, KC_RBRC, KC_SCLN, KC_COLN, KC_BSLS, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +), +/* RAISE + * ,----------------------------------------. ,-----------------------------------------. + * |Cycle | | | | | |-------. E ,-------| | | | | | | + * |------+------+------+------+------+------| |< N >| |------+------+------+------+------+------| + * | Esc | Ins | Pscr | Menu | | |-------. C ,-------| | | Up | | DLine| Bspc | + * |------+------+------+------+------+------| |< O >| |------+------+------+------+------+------| + * | Tab | LAt | LCtl |LShift| | Caps |-------. D ,-------| | Left | Down | Rigth| Del | Bspc | + * |------+------+------+------+------+------| |< E >| |------+------+------+------+------+------| + * |Shift | Undo | Cut | Copy | Paste| |-------| R |-------| | LStr | | LEnd | | Shift| + * `-----------------------------------------/ / \ \-----------------------------------------' + * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | + * | | | | |/ / \ \ | | | | | + * `----------------------------------' '------''---------------------------' + */ +[_RAISE] = LAYOUT_via( + CYCLE, _______, _______, _______, _______ , _______, _______, _______, _______, _______, _______, _______, + _______, KC_INS , KC_PSCR, KC_APP , XXXXXXX , XXXXXXX, _______, _______, KC_PGUP, _______, KC_UP , _______, _______, KC_BSPC, + _______, KC_LALT, KC_LCTL, KC_LSFT, XXXXXXX , KC_CAPS, _______, _______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_DEL , KC_BSPC, + _______, KC_UNDO, KC_CUT , KC_COPY, KC_PASTE, XXXXXXX, _______, _______, XXXXXXX, _______, XXXXXXX, _______, XXXXXXX, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ +) +}; + +// Custom keycode handling. +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + // handling this once instead of in each keycode uses less program memory. + if ((keycode >= SAFE_RANGE) && !(record->event.pressed)) { + return false; + } + + switch (keycode) { + case CYCLE: + set_single_persistent_default_layer((1+get_highest_layer(default_layer_state)) % BASE_LAYERS); + break; + } + + // this uses less memory than returning in each case. + return keycode < SAFE_RANGE; +}; diff --git a/keyboards/sofle/keymaps/keyhive_via/oled.c b/keyboards/sofle/keymaps/keyhive_via/oled.c new file mode 100644 index 0000000000..ef3a189f9d --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/oled.c @@ -0,0 +1,85 @@ + /* Copyright 2020 Josef Adamcik + * Modification for VIA support and RGB underglow by Jens Bonk-Wiltfang + * + * 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 . + */ + +//Sets up what the OLED screens display. + +#ifdef OLED_ENABLE + +static void render_logo(void) { + static const char PROGMEM qmk_logo[] = { + 0x80,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8a,0x8b,0x8c,0x8d,0x8e,0x8f,0x90,0x91,0x92,0x93,0x94, + 0xa0,0xa1,0xa2,0xa3,0xa4,0xa5,0xa6,0xa7,0xa8,0xa9,0xaa,0xab,0xac,0xad,0xae,0xaf,0xb0,0xb1,0xb2,0xb3,0xb4, + 0xc0,0xc1,0xc2,0xc3,0xc4,0xc5,0xc6,0xc7,0xc8,0xc9,0xca,0xcb,0xcc,0xcd,0xce,0xcf,0xd0,0xd1,0xd2,0xd3,0xd4,0 + }; + + oled_write_P(qmk_logo, false); +} + +static void print_status_narrow(void) { + // Print current mode + oled_write_P(PSTR("\n\n"), false); + + switch (get_highest_layer(default_layer_state)) { + case 0: // _QWERTY + oled_write_ln_P(PSTR("Qwrt\n"), false); + break; + case 1: // _COLEMAK + oled_write_ln_P(PSTR("Clmk\n"), false); + break; + default: + oled_write_P(PSTR("Mod"), false); + break; + } + oled_write_P(PSTR("\n\n"), false); + // Print current layer + oled_write_ln_P(PSTR("LAYER"), false); + switch (get_highest_layer(layer_state)) { + case 0: // _QWERTY + case 1: // _COLEMAK + oled_write_P(PSTR("Base\n"), false); + break; + case 2: + oled_write_P(PSTR("Lower"), false); + break; + case 3: + oled_write_P(PSTR("Raise"), false); + break; + default: + oled_write_ln_P(PSTR("Undef"), false); + } + oled_write_P(PSTR("\n\n"), false); + led_t led_usb_state = host_keyboard_led_state(); + oled_write_ln_P(PSTR("CPSLK"), led_usb_state.caps_lock); +} + +oled_rotation_t oled_init_user(oled_rotation_t rotation) { + if (is_keyboard_master()) { + return OLED_ROTATION_270; + } + return rotation; +} + +bool oled_task_user(void) { + if (is_keyboard_master()) { + print_status_narrow(); + } else { + render_logo(); + } + return false; +} + +#endif diff --git a/keyboards/sofle/keymaps/keyhive_via/readme.md b/keyboards/sofle/keymaps/keyhive_via/readme.md new file mode 100644 index 0000000000..e7a2beebcf --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/readme.md @@ -0,0 +1,49 @@ +# Only compatible with sofle/keyhive firmware which adds an extra column of keys for encoder mapping. + +![SofleKeyboard version 2.1 RGB Keyhive](https://i.imgur.com/Oa6spvZ.png) + +# Configuring VIA / Vial App + +This firmware will not auto-recognize until [PR #1060](https://github.com/the-via/keyboards/pull/1060) is accepted to the VIA keyboard database. For now you must install the new layout: + +1. Download [keyhive_sofle_rgb.json](https://raw.githubusercontent.com/the-via/keyboards/48372baae5ab451d752988121fa4f1dd47b2c1ce/src/sofle/keyhive_sofle_rgb.json). +2. In the VIA app, select `File > Import Keymap` from the menu. +3. Open the file you just downloaded. + +**You'll have to do this every time you use VIA or Vial until the PR is accepted.** + +# Using with VIA +* The default layouts should be loaded automatically. +* Layouts can be backed up in VIA in the SAVE+LOAD section. +* It is a good idea to Save Current Layout after you decide on your mapping. + +# Custom Features: + +### Rotary Encoder and VIA Features: +* Fully remappable. Left encoder controls volume up/down/mute. Right encoder PGUP/PGDOWN. +* Allows for live remapping of per-layer rotary encoder functions in VIA. +* VIA support with **keyhive_via** keymap. + +# Compiling + +Make example for this keyboard (after setting up your build environment): + + make sofle/keyhive:keyhive_via + +## Flashing + +Flash using the correct command below (or use QMK Toolbox). These commands can be mixed if, for example, you have an Elite C on the left and a pro micro on the right. + +Press reset button on the keyboard when asked. + +Disconnect the first half, connect the second one and repeat the process. + + # for Pro Micro-based builds + make sofle/keyhive:keyhive_via:avrdude-split-left + make sofle/keyhive:keyhive_via:avrdude-split-right + + # for Elite C or DFU bootloader builds + make sofle/keyhive:keyhive_via:dfu-split-left + make sofle/keyhive:keyhive_via:dfu-split-right + +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). diff --git a/keyboards/sofle/keymaps/keyhive_via/rules.mk b/keyboards/sofle/keymaps/keyhive_via/rules.mk new file mode 100644 index 0000000000..2875254096 --- /dev/null +++ b/keyboards/sofle/keymaps/keyhive_via/rules.mk @@ -0,0 +1,2 @@ +VIA_ENABLE = yes +RGBLIGHT_ENABLE = yes diff --git a/keyboards/sofle/keymaps/via/keymap.c b/keyboards/sofle/keymaps/via/keymap.c index 2f917f42dc..b8bbe195fe 100644 --- a/keyboards/sofle/keymaps/via/keymap.c +++ b/keyboards/sofle/keymaps/via/keymap.c @@ -58,7 +58,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { * `-----------------------------------------/ / \ \-----------------------------------------' * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | * | | | | |/ / \ \ | | | | | - * `----------------------------------' '------''---------------------------' + * `-----------------------------------' '------''---------------------------' */ [1] = LAYOUT( @@ -96,8 +96,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { * | Esc | Ins | Pscr | Menu | | | | | PWrd | Up | NWrd | DLine| Bspc | * |------+------+------+------+------+------| |------+------+------+------+------+------| * | Tab | LAt | LCtl |LShift| | Caps |-------. ,-------| | Left | Down | Rigth| Del | Bspc | - * |------+------+------+------+------+------| MUTE | | |------+------+------+------+------+------| - * |Shift | Undo | Cut | Copy | Paste| |-------| |-------| | LStr | | LEnd | | Shift| + * |------+------+------+------+------+------| MUTE | | |------+------+------+------+------+------| + * |Shift | Undo | Cut | Copy | Paste| |--------| |-------| | LStr | | LEnd | | Shift| * `-----------------------------------------/ / \ \-----------------------------------------' * | LGUI | LAlt | LCTR |LOWER | /Enter / \Space \ |RAISE | RCTR | RAlt | RGUI | * | | | | |/ / \ \ | | | | | -- cgit v1.2.3