Remove Sofle rgb_default keymap & tidy readme's (#25010)

This commit is contained in:
jack
2025-04-14 09:58:14 -07:00
committed by GitHub
parent 9208fb5adb
commit 32b9d33bbb
8 changed files with 19 additions and 801 deletions
-23
View File
@@ -1,23 +0,0 @@
/* Copyright
* 2021 solartempest
* 2021 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/>.
*/
#pragma once
// OLED settings
#define OLED_TIMEOUT 80000
#define OLED_BRIGHTNESS 90
-1
View File
@@ -1,5 +1,4 @@
{
"keyboard_name": "Sofle",
"manufacturer": "Keyhive",
"development_board": "elite_c",
"usb": {
-54
View File
@@ -1,54 +0,0 @@
# Keyhive Sofle Keyboard
![SofleKeyboard version 2.1 RGB Keyhive](https://i.imgur.com/WH9OoWuh.jpg)
Sofle is 6×4+5 keys column-staggered split keyboard. Based on Lily58, Corne and Helix keyboards.
For details about the keyboard design, refer to Josef's blog: [Sofle Keyboard - a split keyboard based on Lily58 and Crkbd](https://josef-adamcik.cz/electronics/let-me-introduce-you-sofle-keyboard-split-keyboard-based-on-lily58.html)
Build guide: [Keyhive Sofle RGB build guide](https://github.com/keyhive/build_guides/blob/master/docs/keyboards/sofle-rgb.md)
* Keyboard Maintainer: [Winder](https://github.com/winder)
* Hardware Supported: Keyhive Sofle RGB, ProMicro / Elite-C
* Hardware Availability: [Keyhive](https://keyhive.xyz/shop/sofle)
### Acknowledgements
* Solartempest - the image on this page and most of the code is either copied directly or inspired by their fork. [Solartempest's fork.](https://github.com/solartempest/qmk_firmware/tree/master/keyboards/solartempest/sofle).
* [Keyhive fork](https://github.com/keyhive/qmk_firmware) defined all of the board settings.
# Supported Keymaps
The keyhive schematic has been slightly modified compared to the open source sofle and not all keymaps are compatible.
* **default**: Basic functionality, no rgb, no VIA.
* [keyhive_via](../keymaps/keyhive_via/readme.md) - Includes rgblighting and special support for remapping encoders with VIA.
* **Other**: may work but backwards compatibility is not guaranteed or tested.
# VIA Support
As of 1.3.1, the VIA tool does not support Keyhive/Sofle V2 out of the box.
See [keyhive_via](../keymaps/keyhive_via/readme.md) for details about configuring and using VIA.
# Compiling
Make example for this keyboard (after setting up your build environment):
make sofle/keyhive:default
## 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:default:avrdude-split-left
make sofle/keyhive:default:avrdude-split-right
# for Elite C or DFU bootloader builds
make sofle/keyhive:default:dfu-split-left
make sofle/keyhive:default: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).
@@ -1,124 +0,0 @@
/* Copyright 2021 Dane Evans
*
* 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_MATRIX_I2C
/* Select hand configuration */
///https://thomasbaart.nl/2018/12/01/reducing-firmware-size-in-qmk/
#define CUSTOM_FONT
#define CUSTOM_LAYER_READ //if you remove this it causes issues - needs better guarding
#define QUICK_TAP_TERM 0
#ifdef TAPPING_TERM
#undef TAPPING_TERM
#define TAPPING_TERM 200
#endif
#define ENCODER_DIRECTION_FLIP
#define RGBLIGHT_SLEEP
//
#define RGBLIGHT_LAYERS
/* ws2812 RGB LED */
#define WS2812_DI_PIN D3
#ifdef RGB_MATRIX_ENABLE
#define RGBLIGHT_LED_COUNT 35 // Number of LEDs
#define RGBLIGHT_LED_COUNT 35 // Number of LEDs
#define RGB_MATRIX_LED_COUNT RGBLIGHT_LED_COUNT
#endif
#ifdef RGBLIGHT_ENABLE
#undef RGBLIGHT_LED_COUNT
//#define RGBLIGHT_EFFECT_BREATHING
#define RGBLIGHT_EFFECT_RAINBOW_MOOD
//#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
//#define RGBLIGHT_EFFECT_SNAKE
//#define RGBLIGHT_EFFECT_KNIGHT
//#define RGBLIGHT_EFFECT_CHRISTMAS
//#define RGBLIGHT_EFFECT_STATIC_GRADIENT
//#define RGBLIGHT_EFFECT_RGB_TEST
//#define RGBLIGHT_EFFECT_ALTERNATING
//#define RGBLIGHT_EFFECT_TWINKLE
#define RGBLIGHT_LED_COUNT 70
#undef RGBLED_SPLIT
#define RGBLED_SPLIT { 35, 35 } // haven't figured out how to use this yet
//#define RGBLIGHT_LED_COUNT 30
#undef RGBLIGHT_LIMIT_VAL
#define RGBLIGHT_LIMIT_VAL 120
#define RGBLIGHT_HUE_STEP 10
#define RGBLIGHT_SAT_STEP 17
#define RGBLIGHT_VAL_STEP 17
#endif
#ifdef RGB_MATRIX_ENABLE
# define RGB_MATRIX_KEYPRESSES // reacts to keypresses
// # define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
# define RGB_MATRIX_SLEEP // turn off effects when suspended
# define RGB_MATRIX_FRAMEBUFFER_EFFECTS
// # define RGB_MATRIX_LED_PROCESS_LIMIT (RGB_MATRIX_LED_COUNT + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
// # define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
# define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
#define RGB_MATRIX_DEFAULT_MODE RGB_MATRIX_GRADIENT_LEFT_RIGHT
# define RGB_MATRIX_HUE_STEP 8
# define RGB_MATRIX_SAT_STEP 8
# define RGB_MATRIX_VAL_STEP 8
# define RGB_MATRIX_SPD_STEP 10
/* Disable the animations you don't want/need. You will need to disable a good number of these *
* because they take up a lot of space. Disable until you can successfully compile your firmware. */
// # undef ENABLE_RGB_MATRIX_ALPHAS_MODS
// # undef ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
// # undef ENABLE_RGB_MATRIX_BREATHING
// # undef ENABLE_RGB_MATRIX_CYCLE_ALL
// # undef ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
// # undef ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
// # undef ENABLE_RGB_MATRIX_CYCLE_OUT_IN
// # undef ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
// # undef ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
// # undef ENABLE_RGB_MATRIX_DUAL_BEACON
// # undef ENABLE_RGB_MATRIX_RAINBOW_BEACON
// # undef ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
// # undef ENABLE_RGB_MATRIX_RAINDROPS
// # undef ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
// # undef ENABLE_RGB_MATRIX_TYPING_HEATMAP
// # undef ENABLE_RGB_MATRIX_DIGITAL_RAIN
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
// # undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
// # undef ENABLE_RGB_MATRIX_SPLASH
// # undef ENABLE_RGB_MATRIX_MULTISPLASH
// # undef ENABLE_RGB_MATRIX_SOLID_SPLASH
// # undef ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
#endif
File diff suppressed because it is too large Load Diff
@@ -1,7 +0,0 @@
MOUSEKEY_ENABLE = yes
EXTRAKEY_ENABLE = yes
CONSOLE_ENABLE = no
RGBLIGHT_ENABLE = yes
ENCODER_ENABLE = yes
LTO_ENABLE = yes
OLED_ENABLE = yes
+19 -6
View File
@@ -4,24 +4,37 @@
Sofle is 6×4+5 keys column-staggered split keyboard. Based on Lily58, Corne and Helix keyboards.
More details about the keyboard on my blog: [Let me introduce you SofleKeyboard - a split keyboard based on Lily58 and Crkbd](https://josef-adamcik.cz/electronics/let-me-introduce-you-sofle-keyboard-split-keyboard-based-on-lily58.html)
The current (temporary) build guide and a build log is available here: [SofleKeyboard build log/guide](https://josef-adamcik.cz/electronics/soflekeyboard-build-log-and-build-guide.html)
More details about the keyboard and build guides can be found here: [Sofle Keyboard Build Log and Guide](https://josefadamcik.github.io/SofleKeyboard)
* Keyboard Maintainer: [Josef Adamcik](https://josef-adamcik.cz) [Twitter:@josefadamcik](https://twitter.com/josefadamcik)
* Hardware Supported: SofleKeyboard PCB, ProMicro
* Hardware Availability: [PCB & Case Data](https://github.com/josefadamcik/SofleKeyboard)
## Firmware Revisions
- `sofle/rev1` is used for v1, v2, and RGB PCBs (**NOT** RGB PCBs purchased from [Keyhive](https://keyhive.xyz))
- `sofle/keyhive` is used for PCBs purchased from [Keyhive](https://keyhive.xyz/shop/sofle)
- [`keyboards/sofle_choc`](../sofle_choc/) is used for Choc PCBs
Make example for this keyboard (after setting up your build environment):
make sofle:default
make sofle/rev1:default
make sofle/keyhive:default
Flash the default keymap:
Flashing example for this keyboard:
make sofle:default:avrdude
make sofle/rev1:default:flash
make sofle/keyhive:default:flash
Press reset button on he keyboard when asked.
Disconnect the first half, connect the second one and repeat the process.
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).
## Bootloader
Enter the bootloader in 3 ways:
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix
* **Physical reset button**: Briefly press the button near the TRRS connector. Quickly double-tap if you are using Pro Micro.
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
-27
View File
@@ -1,27 +0,0 @@
# Sofle Keyboard
![SofleKeyboard version 1](https://i.imgur.com/S5GTKth.jpeg)
Sofle is 6×4+5 keys column-staggered split keyboard. Based on Lily58, Corne and Helix keyboards.
More details about the keyboard on my blog: [Let me introduce you SofleKeyboard - a split keyboard based on Lily58 and Crkbd](https://josef-adamcik.cz/electronics/let-me-introduce-you-sofle-keyboard-split-keyboard-based-on-lily58.html)
The current (temporary) build guide and a build log is available here: [SofleKeyboard build log/guide](https://josef-adamcik.cz/electronics/soflekeyboard-build-log-and-build-guide.html)
* Keyboard Maintainer: [Josef Adamcik](https://josef-adamcik.cz) [Twitter:@josefadamcik](https://twitter.com/josefadamcik)
* Hardware Supported: SofleKeyboard PCB, ProMicro
* Hardware Availability: [PCB & Case Data](https://github.com/josefadamcik/SofleKeyboard)
Make example for this keyboard (after setting up your build environment):
make sofle:default
Flashing example for this keyboard:
make sofle:default:flash
Press reset button on he keyboard when asked.
Disconnect the first half, connect the second one and repeat the process.
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).