Skip to content

Commit

Permalink
Efreet refactor (qmk#10806)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fauxpark
fauxpark authored and Owen Winkler committed Nov 5, 2020
1 parent ede3fda commit eee8a24
Show file tree
Hide file tree
Showing 10 changed files with 246 additions and 285 deletions.
157 changes: 43 additions & 114 deletions keyboards/efreet/config.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID 0x534F // "SO"
#define PRODUCT_ID 0x0001
#define DEVICE_VER 0x0001
#define MANUFACTURER Soran
#define PRODUCT Efreet
#define DESCRIPTION A 40% ortholinear keyboard.
#define VENDOR_ID 0x534F // "SO"
#define PRODUCT_ID 0x0001
#define DEVICE_VER 0x0001
#define MANUFACTURER Soran
#define PRODUCT Efreet

/* key matrix size */
#define MATRIX_ROWS 8
Expand All @@ -40,50 +39,50 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
* DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
* ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
*
*/
*/
#define MATRIX_ROW_PINS { B0, D6, D5, D4, D3, D2, D1, C2 }
#define MATRIX_COL_PINS { B3, B4, B5, B6, B7, C7 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL*/
/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

/*
* Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
*/
#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6

#define BACKLIGHT_PIN D0
#define BACKLIGHT_BREATHING
#define BACKLIGHT_LEVELS 3
#define BACKLIGHT_BREATHING

// #define RGB_DI_PIN E2
// #ifdef RGB_DI_PIN
// #define RGBLED_NUM 16
// #define RGBLIGHT_HUE_STEP 8
// #define RGBLIGHT_SAT_STEP 8
// #define RGBLIGHT_VAL_STEP 8
// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
// /*== all animations enable ==*/
// #define RGBLIGHT_ANIMATIONS
// /*== or choose animations ==*/
// #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
// /*== customize breathing effect ==*/
// /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
// #define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
// /*==== use exp() and sin() ====*/
// #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
// #define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
// #endif
//#define RGB_DI_PIN E2
//#ifdef RGB_DI_PIN
//# define RGBLED_NUM 16
//# define RGBLIGHT_HUE_STEP 8
//# define RGBLIGHT_SAT_STEP 8
//# define RGBLIGHT_VAL_STEP 8
//# define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
//# define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
/*== all animations enable ==*/
//# define RGBLIGHT_ANIMATIONS
/*== or choose animations ==*/
//# 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
/*== customize breathing effect ==*/
/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
//# define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
/*==== use exp() and sin() ====*/
//# define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
//# define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
//#endif

/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5
Expand All @@ -97,9 +96,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define LOCKING_RESYNC_ENABLE

/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
* This is userful for the Windows task manager shortcut (ctrl+shift+esc).
* This is useful for the Windows task manager shortcut (ctrl+shift+esc).
*/
// #define GRAVE_ESC_CTRL_OVERRIDE
//#define GRAVE_ESC_CTRL_OVERRIDE

/*
* Force NKRO
Expand All @@ -122,55 +121,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
//#define FORCE_NKRO

/*
* Magic Key Options
*
* Magic keys are hotkey commands that allow control over firmware functions of
* the keyboard. They are best used in combination with the HID Listen program,
* found here: https://www.pjrc.com/teensy/hid_listen.html
*
* The options below allow the magic key functionality to be changed. This is
* useful if your keyboard/keypad is missing keys and you want magic key support.
*
*/

/* control how magic key switches layers */
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false

/* override magic key keymap */
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
//#define MAGIC_KEY_HELP H
//#define MAGIC_KEY_HELP_ALT SLASH
//#define MAGIC_KEY_DEBUG D
//#define MAGIC_KEY_DEBUG_MATRIX X
//#define MAGIC_KEY_DEBUG_KBD K
//#define MAGIC_KEY_DEBUG_MOUSE M
//#define MAGIC_KEY_VERSION V
//#define MAGIC_KEY_STATUS S
//#define MAGIC_KEY_CONSOLE C
//#define MAGIC_KEY_LAYER0 0
//#define MAGIC_KEY_LAYER0_ALT GRAVE
//#define MAGIC_KEY_LAYER1 1
//#define MAGIC_KEY_LAYER2 2
//#define MAGIC_KEY_LAYER3 3
//#define MAGIC_KEY_LAYER4 4
//#define MAGIC_KEY_LAYER5 5
//#define MAGIC_KEY_LAYER6 6
//#define MAGIC_KEY_LAYER7 7
//#define MAGIC_KEY_LAYER8 8
//#define MAGIC_KEY_LAYER9 9
//#define MAGIC_KEY_BOOTLOADER B
//#define MAGIC_KEY_BOOTLOADER_ALT ESC
//#define MAGIC_KEY_LOCK CAPS
//#define MAGIC_KEY_EEPROM E
//#define MAGIC_KEY_EEPROM_CLEAR BSPACE
//#define MAGIC_KEY_NKRO N
//#define MAGIC_KEY_SLEEP_LED Z

/*
* Feature disable options
* These options are also useful to firmware size reduction.
Expand All @@ -186,32 +136,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
//#define NO_ACTION_MACRO
//#define NO_ACTION_FUNCTION

/*
* MIDI options
*/

/* Prevent use of disabled MIDI features in the keymap */
//#define MIDI_ENABLE_STRICT 1

/* enable basic MIDI features:
- MIDI notes can be sent when in Music mode is on
*/
//#define MIDI_BASIC

/* enable advanced MIDI features:
- MIDI notes can be added to the keymap
- Octave shift and transpose
- Virtual sustain, portamento, and modulation wheel
- etc.
*/
//#define MIDI_ADVANCED

/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
//#define MIDI_TONE_KEYCODE_OCTAVES 1
/* disable these deprecated features by default */
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

/* Bootmagic Lite key configuration */
// #define BOOTMAGIC_LITE_ROW 0
// #define BOOTMAGIC_LITE_COLUMN 0
//#define BOOTMAGIC_LITE_ROW 0
//#define BOOTMAGIC_LITE_COLUMN 0
36 changes: 1 addition & 35 deletions keyboards/efreet/efreet.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,39 +13,5 @@
* 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 "efreet.h"

// Optional override functions below.
// You can leave any or all of these undefined.
// These are only required if you want to perform custom actions.

/*
void matrix_init_kb(void) {
// put your keyboard start-up code here
// runs once when the firmware starts up
matrix_init_user();
}
void matrix_scan_kb(void) {
// put your looping keyboard code here
// runs every cycle (a lot)

matrix_scan_user();
}
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
// put your per-action keyboard code here
// runs for every action, just before processing by the firmware
return process_record_user(keycode, record);
}
void led_set_kb(uint8_t usb_led) {
// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
led_set_user(usb_led);
}
*/
#include "efreet.h"
65 changes: 33 additions & 32 deletions keyboards/efreet/efreet.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,44 @@

#include "quantum.h"

/* This a shortcut to help you visually see your layout.
#define XXX KC_NO

/* This is 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.
*/
#define LAYOUT_ortho_4x12( \
k00, k10, k01, k11, k02, k12, k03, k13, k04, k14, k05, k15, \
k20, k30, k21, k31, k22, k32, k23, k33, k24, k34, k25, k35, \
k40, k50, k41, k51, k42, k52, k43, k53, k44, k54, k45, k55, \
k60, k70, k61, k71, k62, k72, k63, k73, k64, k74, k65, k75 \
) { \
{ k10, k11, k12, k13, k14, k15 }, \
{ k00, k01, k02, k03, k04, k05 }, \
{ k30, k31, k32, k33, k34, k35 }, \
{ k20, k21, k22, k23, k24, k25 }, \
{ k50, k51, k52, k53, k54, k55 }, \
{ k40, k41, k42, k43, k44, k45 }, \
{ k70, k71, k72, k73, k74, k75 }, \
{ k60, k61, k62, k63, k64, k65 } \
}

#define LAYOUT_ortho_4x12( \
K00, K10, K01, K11, K02, K12, K03, K13, K04, K14, K05, K15,\
K20, K30, K21, K31, K22, K32, K23, K33, K24, K34, K25, K35,\
K40, K50, K41, K51, K42, K52, K43, K53, K44, K54, K45, K55,\
K60, K70, K61, K71, K62, K72, K63, K73, K64, K74, K65, K75\
) { \
{ K10, K11, K12, K13, K14, K15 }, \
{ K00, K01, K02, K03, K04, K05 }, \
{ K30, K31, K32, K33, K34, K35 }, \
{ K20, K21, K22, K23, K24, K25 }, \
{ K50, K51, K52, K53, K54, K55 }, \
{ K40, K41, K42, K43, K44, K45 }, \
{ K70, K71, K72, K73, K74, K75 }, \
{ K60, K61, K62, K63, K64, K65 } \
}

#define LAYOUT_planck_mit( \
K00, K10, K01, K11, K02, K12, K03, K13, K04, K14, K05, K15,\
K20, K30, K21, K31, K22, K32, K23, K33, K24, K34, K25, K35,\
K40, K50, K41, K51, K42, K52, K43, K53, K44, K54, K45, K55,\
K60, K70, K61, K71, K62, K72, K73, K64, K74, K65, K75\
) { \
{ K10, K11, K12, K13, K14, K15 }, \
{ K00, K01, K02, K03, K04, K05 }, \
{ K30, K31, K32, K33, K34, K35 }, \
{ K20, K21, K22, K23, K24, K25 }, \
{ K50, K51, K52, K53, K54, K55 }, \
{ K40, K41, K42, K43, K44, K45 }, \
{ K70, K71, K72, K73, K74, K75 }, \
{ K60, K61, K62, KC_NO, K64, K65 } \
}
#define LAYOUT_planck_mit( \
k00, k10, k01, k11, k02, k12, k03, k13, k04, k14, k05, k15, \
k20, k30, k21, k31, k22, k32, k23, k33, k24, k34, k25, k35, \
k40, k50, k41, k51, k42, k52, k43, k53, k44, k54, k45, k55, \
k60, k70, k61, k71, k62, k72, k73, k64, k74, k65, k75 \
) { \
{ k10, k11, k12, k13, k14, k15 }, \
{ k00, k01, k02, k03, k04, k05 }, \
{ k30, k31, k32, k33, k34, k35 }, \
{ k20, k21, k22, k23, k24, k25 }, \
{ k50, k51, k52, k53, k54, k55 }, \
{ k40, k41, k42, k43, k44, k45 }, \
{ k70, k71, k72, k73, k74, k75 }, \
{ k60, k61, k62, XXX, k64, k65 } \
}
Loading

0 comments on commit eee8a24

Please sign in to comment.