From 0831a3181a51cf190aabcea504c1be2752bbc2be Mon Sep 17 00:00:00 2001 From: MakotoKurauchi Date: Tue, 15 Dec 2020 20:14:14 +0900 Subject: [PATCH] [Keymap] Helix default keymap oled update (#11152) * update keyboards/helix/rev2/local_features.mk - Improved parsing of the `HELIX =` option * add 'is_mac_mode()' into keyboards/helix/rev2/rev2.c * update helix/rev2/keymaps/default/keymap.c: use rgblight query functions * Makes the OLED driver used by the helix:default keymap switchable. * use TOP/drivers/oled/oled_driver.c `make helix:default` or `make OLED_SELECT=core helix:default` * use helix/local_drivers/ssd1306.c `make OLED_SELECT=local helix:default` * Separated the OLED related code from keymap.c and moved it to oled_display.c. * Change the 'led_test' keymap to follow the changes in the 'default' keymap. * update helix/rev2/keymaps/default/oled_display.c * add '#define OLED_UPDATE_INTERVAL 50' into keyboards/helix/rev2/config.h * Support for OLED_UPDATE_INTERVAL, even for older types of OLED tasks * add readme.md for helix/rev2 * Apply drashna's suggestions to rev2.c. * Apply drashna's suggestions to rev3_4rows.c, rev3_5rows.c. Co-authored-by: mtei <2170248+mtei@users.noreply.github.com> --- keyboards/helix/rev2/config.h | 2 + keyboards/helix/rev2/keymaps/default/keymap.c | 174 +++---------- .../helix/rev2/keymaps/default/oled_display.c | 228 ++++++++++++++++++ keyboards/helix/rev2/keymaps/default/rules.mk | 12 + .../rev2/keymaps/led_test/oled_display.c | 1 + .../helix/rev2/keymaps/led_test/rules.mk | 4 + keyboards/helix/rev2/local_features.mk | 156 +++++++----- keyboards/helix/rev2/readme.md | 13 + keyboards/helix/rev2/rev2.c | 17 +- keyboards/helix/rev2/rev2.h | 3 + keyboards/helix/rev2/rules.mk | 5 + keyboards/helix/rev3_4rows/rev3_4rows.c | 16 +- keyboards/helix/rev3_5rows/rev3_5rows.c | 16 +- 13 files changed, 414 insertions(+), 233 deletions(-) create mode 100644 keyboards/helix/rev2/keymaps/default/oled_display.c create mode 100644 keyboards/helix/rev2/keymaps/led_test/oled_display.c create mode 100644 keyboards/helix/rev2/readme.md diff --git a/keyboards/helix/rev2/config.h b/keyboards/helix/rev2/config.h index f85896fbea..e4ddf94988 100644 --- a/keyboards/helix/rev2/config.h +++ b/keyboards/helix/rev2/config.h @@ -48,6 +48,8 @@ along with this program. If not, see . #define SSD1306OLED #endif +#define OLED_UPDATE_INTERVAL 50 + /* Select rows configuration */ // Rows are 4 or 5 // #define HELIX_ROWS 5 see ./rules.mk diff --git a/keyboards/helix/rev2/keymaps/default/keymap.c b/keyboards/helix/rev2/keymaps/default/keymap.c index c575287ee6..d5209d8537 100644 --- a/keyboards/helix/rev2/keymaps/default/keymap.c +++ b/keyboards/helix/rev2/keymaps/default/keymap.c @@ -1,3 +1,19 @@ +/* Copyright 2020 yushakobo + * + * 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 "bootloader.h" #ifdef PROTOCOL_LUFA @@ -7,17 +23,6 @@ #ifdef AUDIO_ENABLE #include "audio.h" #endif -#ifdef SSD1306OLED - #include "ssd1306.h" -#endif - - -#ifdef RGBLIGHT_ENABLE -//Following line allows macro to read current RGB settings -extern rgblight_config_t rgblight_config; -#endif - -extern uint8_t is_master; // Each layer gets a name for readability, which is then used in the keymap matrix below. // The underscores don't mean anything - you can have a layer called STUFF or any other name. @@ -420,16 +425,16 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { if (record->event.pressed) { rgblight_mode(RGB_current_mode); rgblight_step(); - RGB_current_mode = rgblight_config.mode; + RGB_current_mode = rgblight_get_mode(); } #endif return false; break; case EISU: if (record->event.pressed) { - if(keymap_config.swap_lalt_lgui==false){ + if (is_mac_mode()) { register_code(KC_LANG2); - }else{ + } else { SEND_STRING(SS_LALT("`")); } } else { @@ -439,9 +444,9 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { break; case KANA: if (record->event.pressed) { - if(keymap_config.swap_lalt_lgui==false){ + if (is_mac_mode()) { register_code(KC_LANG1); - }else{ + } else { SEND_STRING(SS_LALT("`")); } } else { @@ -454,7 +459,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { if (record->event.pressed) { eeconfig_update_rgblight_default(); rgblight_enable(); - RGB_current_mode = rgblight_config.mode; + RGB_current_mode = rgblight_get_mode(); } #endif break; @@ -462,12 +467,16 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { return true; } +#ifdef SSD1306OLED + #include "ssd1306.h" +#endif + void matrix_init_user(void) { #ifdef AUDIO_ENABLE startup_user(); #endif #ifdef RGBLIGHT_ENABLE - RGB_current_mode = rgblight_config.mode; + RGB_current_mode = rgblight_get_mode(); #endif //SSD1306 OLED init, make sure to add #define SSD1306OLED in config.h #ifdef SSD1306OLED @@ -500,132 +509,3 @@ void music_scale_user(void) } #endif - - -//SSD1306 OLED update loop, make sure to add #define SSD1306OLED in config.h -#ifdef SSD1306OLED - -void matrix_scan_user(void) { - iota_gfx_task(); // this is what updates the display continuously -} - -void matrix_update(struct CharacterMatrix *dest, - const struct CharacterMatrix *source) { - if (memcmp(dest->display, source->display, sizeof(dest->display))) { - memcpy(dest->display, source->display, sizeof(dest->display)); - dest->dirty = true; - } -} - -//assign the right code to your layers for OLED display -#define L_BASE 0 -#define L_LOWER (1<<_LOWER) -#define L_RAISE (1<<_RAISE) -#define L_ADJUST (1<<_ADJUST) -#define L_ADJUST_TRI (L_ADJUST|L_RAISE|L_LOWER) - -static void render_logo(struct CharacterMatrix *matrix) { - - static const char helix_logo[] PROGMEM ={ - 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}; - matrix_write_P(matrix, helix_logo); - //matrix_write_P(&matrix, PSTR(" Split keyboard kit")); -} - -static void render_rgbled_status(bool full, struct CharacterMatrix *matrix) { -#ifdef RGBLIGHT_ENABLE - char buf[30]; - if (RGBLIGHT_MODES > 1 && rgblight_config.enable) { - if (full) { - snprintf(buf, sizeof(buf), " LED %2d: %d,%d,%d ", - rgblight_config.mode, - rgblight_config.hue/RGBLIGHT_HUE_STEP, - rgblight_config.sat/RGBLIGHT_SAT_STEP, - rgblight_config.val/RGBLIGHT_VAL_STEP); - } else { - snprintf(buf, sizeof(buf), "[%2d] ",rgblight_config.mode); - } - matrix_write(matrix, buf); - } -#endif -} - -static void render_layer_status(struct CharacterMatrix *matrix) { - // Define layers here, Have not worked out how to have text displayed for each layer. Copy down the number you see and add a case for it below - char buf[10]; - matrix_write_P(matrix, PSTR("Layer: ")); - switch (layer_state) { - case L_BASE: - matrix_write_P(matrix, PSTR("Default")); - break; - case L_RAISE: - matrix_write_P(matrix, PSTR("Raise")); - break; - case L_LOWER: - matrix_write_P(matrix, PSTR("Lower")); - break; - case L_ADJUST: - case L_ADJUST_TRI: - matrix_write_P(matrix, PSTR("Adjust")); - break; - default: - matrix_write_P(matrix, PSTR("Undef-")); - snprintf(buf,sizeof(buf), "%ld", layer_state); - matrix_write(matrix, buf); - } -} - -void render_status(struct CharacterMatrix *matrix) { - - // Render to mode icon - static const char os_logo[][2][3] PROGMEM ={{{0x95,0x96,0},{0xb5,0xb6,0}},{{0x97,0x98,0},{0xb7,0xb8,0}}}; - if(keymap_config.swap_lalt_lgui==false){ - matrix_write_P(matrix, os_logo[0][0]); - matrix_write_P(matrix, PSTR("\n")); - matrix_write_P(matrix, os_logo[0][1]); - }else{ - matrix_write_P(matrix, os_logo[1][0]); - matrix_write_P(matrix, PSTR("\n")); - matrix_write_P(matrix, os_logo[1][1]); - } - - matrix_write_P(matrix, PSTR(" ")); - render_layer_status(matrix); - matrix_write_P(matrix, PSTR("\n")); - - // Host Keyboard LED Status - matrix_write_P(matrix, (host_keyboard_leds() & (1<. + */ + +#include +#include +#include QMK_KEYBOARD_H + +#ifdef SSD1306OLED + #include "ssd1306.h" +#endif + +// Each layer gets a name for readability, which is then used in the keymap matrix below. +// The underscores don't mean anything - you can have a layer called STUFF or any other name. +// Layer names don't all need to be of the same length, obviously, and you can also skip them +// entirely and just use numbers. +enum layer_number { + _QWERTY = 0, + _COLEMAK, + _DVORAK, + _LOWER, + _RAISE, + _ADJUST +}; + +//SSD1306 OLED update loop, make sure to add #define SSD1306OLED in config.h +#if defined(SSD1306OLED) || defined(OLED_DRIVER_ENABLE) + +# if defined(OLED_DRIVER_ENABLE) +oled_rotation_t oled_init_user(oled_rotation_t rotation) { + if (is_keyboard_master()) { + return OLED_ROTATION_0; + } else { + return OLED_ROTATION_180; + } +} +# else +# define oled_write(data,flag) matrix_write(matrix, data) +# define oled_write_P(data,flag) matrix_write_P(matrix, data) +# endif + +# ifdef SSD1306OLED +void matrix_scan_user(void) { + iota_gfx_task(); // this is what updates the display continuously +} + +void matrix_update(struct CharacterMatrix *dest, + const struct CharacterMatrix *source) { + if (memcmp(dest->display, source->display, sizeof(dest->display))) { + memcpy(dest->display, source->display, sizeof(dest->display)); + dest->dirty = true; + } +} +# endif + +//assign the right code to your layers for OLED display +#define L_BASE 0 +#define L_LOWER (1<<_LOWER) +#define L_RAISE (1<<_RAISE) +#define L_ADJUST (1<<_ADJUST) +#define L_ADJUST_TRI (L_ADJUST|L_RAISE|L_LOWER) + +# ifdef SSD1306OLED +static void render_logo(struct CharacterMatrix *matrix) { +# else +static void render_logo(void) { +# endif + + static const char helix_logo[] PROGMEM ={ + 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(helix_logo, false); +} + +# ifdef SSD1306OLED +static void render_rgbled_status(bool full, struct CharacterMatrix *matrix) { +# else +static void render_rgbled_status(bool full) { +# endif +# ifdef RGBLIGHT_ENABLE + char buf[30]; + if (RGBLIGHT_MODES > 1 && rgblight_is_enabled()) { + if (full) { + snprintf(buf, sizeof(buf), " LED %2d: %d,%d,%d ", + rgblight_get_mode(), + rgblight_get_hue()/RGBLIGHT_HUE_STEP, + rgblight_get_sat()/RGBLIGHT_SAT_STEP, + rgblight_get_val()/RGBLIGHT_VAL_STEP); + } else { + snprintf(buf, sizeof(buf), "[%2d] ", rgblight_get_mode()); + } + oled_write(buf, false); + } +# endif +} + +# ifdef SSD1306OLED +static void render_layer_status(struct CharacterMatrix *matrix) { +# else +static void render_layer_status(void) { +# endif + // Define layers here, Have not worked out how to have text displayed for each layer. Copy down the number you see and add a case for it below + char buf[10]; + oled_write_P(PSTR("Layer: "), false); + switch (layer_state) { + case L_BASE: + oled_write_P(PSTR("Default"), false); + break; + case L_RAISE: + oled_write_P(PSTR("Raise"), false); + break; + case L_LOWER: + oled_write_P(PSTR("Lower"), false); + break; + case L_ADJUST: + case L_ADJUST_TRI: + oled_write_P(PSTR("Adjust"), false); + break; + default: + oled_write_P(PSTR("Undef-"), false); + snprintf(buf,sizeof(buf), "%ld", layer_state); + oled_write(buf, false); + } +} + +# ifdef SSD1306OLED +void render_status(struct CharacterMatrix *matrix) { +# else +void render_status(void) { +# endif + // Render to mode icon + static const char os_logo[][2][3] PROGMEM = {{{0x95,0x96,0},{0xb5,0xb6,0}},{{0x97,0x98,0},{0xb7,0xb8,0}}}; + if (is_mac_mode()) { + oled_write_P(os_logo[0][0], false); + oled_write_P(PSTR("\n"), false); + oled_write_P(os_logo[0][1], false); + } else { + oled_write_P(os_logo[1][0], false); + oled_write_P(PSTR("\n"), false); + oled_write_P(os_logo[1][1], false); + } + + oled_write_P(PSTR(" "), false); +# ifdef SSD1306OLED + render_layer_status(matrix); +# else + render_layer_status(); +# endif + oled_write_P(PSTR("\n"), false); + + // Host Keyboard LED Status + led_t led_state = host_keyboard_led_state(); + oled_write_P(led_state.num_lock ? PSTR("NUMLOCK") : PSTR(" "), false); + oled_write_P(led_state.caps_lock ? PSTR("CAPS") : PSTR(" "), false); + oled_write_P(led_state.scroll_lock ? PSTR("SCLK") : PSTR(" "), false); + oled_write_P(PSTR("\n"), false); +# ifdef SSD1306OLED + render_rgbled_status(true, matrix); +# else + render_rgbled_status(true); + oled_write_P(PSTR("\n"), false); +# endif +} + + +# ifdef SSD1306OLED +# if OLED_UPDATE_INTERVAL > 0 +uint16_t oled_update_timeout; +# endif + +void iota_gfx_task_user(void) { + struct CharacterMatrix matrix; + +# if DEBUG_TO_SCREEN + if (debug_enable) { + return; + } +# endif + +#if OLED_UPDATE_INTERVAL > 0 + if (timer_elapsed(oled_update_timeout) < OLED_UPDATE_INTERVAL) { + return; + } + oled_update_timeout = timer_read(); +#endif + matrix_clear(&matrix); + if (is_keyboard_master()) { + render_status(&matrix); + } else { + render_logo(&matrix); + render_rgbled_status(false, &matrix); + render_layer_status(&matrix); + } + matrix_update(&display, &matrix); +} +# else +void oled_task_user(void) { + +# if DEBUG_TO_SCREEN + if (debug_enable) { + return; + } +# endif + + if (is_keyboard_master()) { + render_status(); + } else { + render_logo(); + render_rgbled_status(false); + render_layer_status(); + } +} +# endif +#endif diff --git a/keyboards/helix/rev2/keymaps/default/rules.mk b/keyboards/helix/rev2/keymaps/default/rules.mk index 9801648dec..206e836ec0 100644 --- a/keyboards/helix/rev2/keymaps/default/rules.mk +++ b/keyboards/helix/rev2/keymaps/default/rules.mk @@ -18,6 +18,18 @@ LTO_ENABLE = no # if firmware size over limit, try this option # LED_ANIMATIONS = yes # LED animations # IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone) +# OLED_ENABLE が yes のとき +# OLED_SELECT が core ならば QMK 標準の oled_dirver.c を使用します。 +# OLED_SELECT が core 以外ならば従来どおり helix/local_drivers/ssd1306.c を使用します。 +# If OLED_ENABLE is 'yes' +# If OLED_SELECT is 'core', use QMK standard oled_dirver.c. +# If OLED_SELECT is other than 'core', use helix/local_drivers/ssd1306.c. +OLED_SELECT = core + +ifeq ($(strip $(OLED_ENABLE)), yes) + SRC += oled_display.c +endif + # convert Helix-specific options (that represent combinations of standard options) # into QMK standard options. include $(strip $(KEYBOARD_LOCAL_FEATURES_MK)) diff --git a/keyboards/helix/rev2/keymaps/led_test/oled_display.c b/keyboards/helix/rev2/keymaps/led_test/oled_display.c new file mode 100644 index 0000000000..3261b6c581 --- /dev/null +++ b/keyboards/helix/rev2/keymaps/led_test/oled_display.c @@ -0,0 +1 @@ +#include "../default/oled_display.c" diff --git a/keyboards/helix/rev2/keymaps/led_test/rules.mk b/keyboards/helix/rev2/keymaps/led_test/rules.mk index cc6d568111..8b590eee86 100644 --- a/keyboards/helix/rev2/keymaps/led_test/rules.mk +++ b/keyboards/helix/rev2/keymaps/led_test/rules.mk @@ -18,6 +18,10 @@ LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight.) LED_ANIMATIONS = yes # LED animations # IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone) +OLED_SELECT = core +ifeq ($(strip $(OLED_ENABLE)), yes) + SRC += oled_display.c +endif SRC += led_test_init.c # convert Helix-specific options (that represent combinations of standard options) diff --git a/keyboards/helix/rev2/local_features.mk b/keyboards/helix/rev2/local_features.mk index 1d0b55cbf1..ce3853a02c 100644 --- a/keyboards/helix/rev2/local_features.mk +++ b/keyboards/helix/rev2/local_features.mk @@ -10,6 +10,7 @@ KEYBOARD_LOCAL_FEATURES_MK := define HELIX_CUSTOMISE_MSG $(info Helix Spacific Build Options) $(info - OLED_ENABLE = $(OLED_ENABLE)) + $(info - OLED_SELECT = $(OLED_SELECT)) $(info - LED_BACK_ENABLE = $(LED_BACK_ENABLE)) $(info - LED_UNDERGLOW_ENABLE = $(LED_UNDERGLOW_ENABLE)) $(info - LED_ANIMATIONS = $(LED_ANIMATIONS)) @@ -20,9 +21,10 @@ endef define HELIX_HELP_MSG $(info Helix keyboard convenient command line option) $(info - make HELIX= helix:) - $(info - option= oled | no-oled | back | no-back | under | na | no-ani) - $(info - ios | sc | split-common | scan | verbose) - $(info - ex.) + $(info - option= oled | core-oled | local-oled | no-oled ) + $(info - back | no-back | under | na | no-ani ) + $(info - ios | sc | split-common | scan | verbose) + $(info - eg.) $(info - make HELIX=no-oled helix:) $(info - make HELIX=oled,no-back helix:) $(info - make HELIX=oled,under helix:) @@ -32,65 +34,76 @@ define HELIX_HELP_MSG endef ifneq ($(strip $(HELIX)),) + define HELIX_OPTION_PARSE + # parce 'oled' 'back' 'under' 'ios' etc. + $(if $(SHOW_PARCE),$(info parse .$1.)) #debug + + ifeq ($(strip $1),help) + HELP=on + endif + ifneq ($(filter nooled no-oled,$(strip $1)),) + OLED_ENABLE = no + endif + ifeq ($(strip $1),oled) + OLED_ENABLE = yes + endif + ifneq ($(filter core-oled core_oled newoled new-oled olednew oled-new,$(strip $1)),) + OLED_ENABLE = yes + OLED_SELECT = core + endif + ifneq ($(filter local-oled local_oled oldoled old-oled oledold oled-old,$(strip $1)),) + OLED_ENABLE = yes + OLED_SELECT = local + endif + ifneq ($(filter noback no-back nounder no-under,$(strip $1)),) + LED_BACK_ENABLE = no + LED_UNDERGLOW_ENABLE = no + endif + ifeq ($(strip $1),back) + LED_BACK_ENABLE = yes + LED_UNDERGLOW_ENABLE = no + endif + ifeq ($(strip $1),under) + LED_BACK_ENABLE = no + LED_UNDERGLOW_ENABLE = yes + endif + ifneq ($(filter na no_ani no-ani,$(strip $1)),) + LED_ANIMATIONS = no + endif + ifeq ($(strip $1),ios) + IOS_DEVICE_ENABLE = yes + endif + ifneq ($(filter sc split-common split_common,$(strip $1)),) + SPLIT_KEYBOARD = yes + endif + ifneq ($(filter nosc no-sc no-split-common no-split_common,$(strip $1)),) + SPLIT_KEYBOARD = no + endif + ifeq ($(strip $1),scan) + # use DEBUG_MATRIX_SCAN_RATE + # see docs/newbs_testing_debugging.md + OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE + CONSOLE_ENABLE = yes + SHOW_VERBOSE_INFO = yes + endif + ifeq ($(strip $1),verbose) + SHOW_VERBOSE_INFO = yes + endif + ifeq ($(strip $1),lto) + LTO_ENABLE = yes + endif + ifneq ($(filter nolto no-lto no_lto,$(strip $1)),) + LTO_ENABLE = no + endif + endef # end of HELIX_OPTION_PARSE + COMMA=, - helix_option := $(subst $(COMMA), , $(HELIX)) - ifneq ($(filter help,$(helix_option)),) - $(eval $(call HELIX_HELP_MSG)) - $(error ) - endif - ifneq ($(filter nooled,$(helix_option)),) - OLED_ENABLE = no - else ifneq ($(filter no-oled,$(helix_option)),) - OLED_ENABLE = no - else ifneq ($(filter oled,$(helix_option)),) - OLED_ENABLE = yes - endif - ifneq ($(filter noback,$(helix_option)),) - LED_BACK_ENABLE = no - LED_UNDERGLOW_ENABLE = no - else ifneq ($(filter no-back,$(helix_option)),) - LED_BACK_ENABLE = no - LED_UNDERGLOW_ENABLE = no - else ifneq ($(filter nounder,$(helix_option)),) - LED_BACK_ENABLE = no - LED_UNDERGLOW_ENABLE = no - else ifneq ($(filter no-under,$(helix_option)),) - LED_BACK_ENABLE = no - LED_UNDERGLOW_ENABLE = no - else ifneq ($(filter back,$(helix_option)),) - LED_BACK_ENABLE = yes - LED_UNDERGLOW_ENABLE = no - else ifneq ($(filter under,$(helix_option)),) - LED_BACK_ENABLE = no - LED_UNDERGLOW_ENABLE = yes - endif - ifneq ($(filter na,$(helix_option)),) - LED_ANIMATIONS = no - endif - ifneq ($(filter no_ani,$(helix_option)),) - LED_ANIMATIONS = no - endif - ifneq ($(filter no-ani,$(helix_option)),) - LED_ANIMATIONS = no - endif - ifneq ($(filter ios,$(helix_option)),) - IOS_DEVICE_ENABLE = yes - endif - ifneq ($(filter sc,$(helix_option)),) - SPLIT_KEYBOARD = yes - endif - ifneq ($(filter split-common,$(helix_option)),) - SPLIT_KEYBOARD = yes - endif - ifneq ($(filter scan,$(helix_option)),) - # use DEBUG_MATRIX_SCAN_RATE - # see docs/newbs_testing_debugging.md - OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE - CONSOLE_ENABLE = yes - SHOW_VERBOSE_INFO = yes - endif - ifeq ($(filter verbose,$(helix_option)), verbose) - SHOW_VERBOSE_INFO = yes + $(eval $(foreach A_OPTION_NAME,$(subst $(COMMA), ,$(HELIX)), \ + $(call HELIX_OPTION_PARSE,$(A_OPTION_NAME)))) + + ifeq ($(strip $(HELP)),on) + $(eval $(call HELIX_HELP_MSG)) + $(error ) endif SHOW_HELIX_OPTIONS = yes endif @@ -142,12 +155,21 @@ ifeq ($(strip $(LED_ANIMATIONS)), yes) endif ifeq ($(strip $(OLED_ENABLE)), yes) - SRC += local_drivers/i2c.c - SRC += local_drivers/ssd1306.c - KEYBOARD_PATHS += $(HELIX_TOP_DIR)/local_drivers - OPT_DEFS += -DOLED_ENABLE - ifeq ($(strip $(LOCAL_GLCDFONT)), yes) - OPT_DEFS += -DLOCAL_GLCDFONT + ifeq ($(strip $(OLED_SELECT)),core) + OLED_DRIVER_ENABLE = yes + ifeq ($(strip $(LOCAL_GLCDFONT)), yes) + OPT_DEFS += -DOLED_FONT_H=\ + else + OPT_DEFS += -DOLED_FONT_H=\"common/glcdfont.c\" + endif + else + SRC += local_drivers/i2c.c + SRC += local_drivers/ssd1306.c + KEYBOARD_PATHS += $(HELIX_TOP_DIR)/local_drivers + OPT_DEFS += -DOLED_ENABLE + ifeq ($(strip $(LOCAL_GLCDFONT)), yes) + OPT_DEFS += -DLOCAL_GLCDFONT + endif endif endif diff --git a/keyboards/helix/rev2/readme.md b/keyboards/helix/rev2/readme.md new file mode 100644 index 0000000000..e6a6f2e952 --- /dev/null +++ b/keyboards/helix/rev2/readme.md @@ -0,0 +1,13 @@ +# Helix rev2 + +A compact split ortholinear keyboard. + +* Keyboard Maintainer: [yushakobo](https://github.com/yushakobo) +* Hardware Supported: Helix rev2 PCBs, Pro Micro +* Hardware Availability: [PCB & Case Data](https://github.com/MakotoKurauchi/helix) + +Make example for this keyboard (after setting up your build environment): + + make helix/rev2:default:flash + +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/helix/rev2/rev2.c b/keyboards/helix/rev2/rev2.c index 12b8ae9efa..d2b3143d89 100644 --- a/keyboards/helix/rev2/rev2.c +++ b/keyboards/helix/rev2/rev2.c @@ -18,13 +18,28 @@ void led_set_kb(uint8_t usb_led) { } #endif +bool is_mac_mode(void) { + // This is the opposite of the QMK standard, but we'll leave it for backwards compatibility. + return keymap_config.swap_lalt_lgui == false; +} + +void set_mac_mode_kb(bool macmode) { + /* The result is the same as pressing the AG_NORM(=MAGIC_UNSWAP_ALT_GUI)/AG_SWAP(=MAGIC_SWAP_ALT_GUI) keys. + * see + * https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L123-L124 + * https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L80-L81 + */ + keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = !macmode; + eeconfig_update_keymap(keymap_config.raw); +} + void matrix_init_kb(void) { // Each keymap.c should use is_keyboard_master() instead of is_master. // But keep is_master for a while for backwards compatibility // for the old keymap.c. is_master = is_keyboard_master(); - matrix_init_user(); + matrix_init_user(); }; void keyboard_post_init_kb(void) { diff --git a/keyboards/helix/rev2/rev2.h b/keyboards/helix/rev2/rev2.h index 42f215fdf4..bab841fe39 100644 --- a/keyboards/helix/rev2/rev2.h +++ b/keyboards/helix/rev2/rev2.h @@ -2,6 +2,9 @@ #include "helix.h" +bool is_mac_mode(void); +void set_mac_mode_kb(bool macmode); + #ifndef SPLIT_KEYBOARD extern bool is_helix_master(void); #define is_keyboard_master() is_helix_master() diff --git a/keyboards/helix/rev2/rules.mk b/keyboards/helix/rev2/rules.mk index d5d69c979c..a31e9d9b22 100644 --- a/keyboards/helix/rev2/rules.mk +++ b/keyboards/helix/rev2/rules.mk @@ -8,3 +8,8 @@ LED_BACK_ENABLE = no # LED backlight (Enable WS2812 RGB underlight.) LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight.) LED_ANIMATIONS = yes # LED animations IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone) + +# If OLED_ENABLE is 'yes' +# If OLED_SELECT is 'core', use QMK standard oled_dirver.c. +# If OLED_SELECT is other than 'core', use helix/local_drivers/ssd1306.c. +OLED_SELECT = local diff --git a/keyboards/helix/rev3_4rows/rev3_4rows.c b/keyboards/helix/rev3_4rows/rev3_4rows.c index cf183366d6..c034c83381 100644 --- a/keyboards/helix/rev3_4rows/rev3_4rows.c +++ b/keyboards/helix/rev3_4rows/rev3_4rows.c @@ -21,15 +21,13 @@ bool is_mac_mode(void) { } void set_mac_mode(bool macmode) { - if (macmode) { - /* The result is the same as pressing the AG_NORM(=MAGIC_UNSWAP_ALT_GUI) key. */ - /* https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L123-L124 */ - keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = false; - } else { - /* The result is the same as pressing the AG_SWAP(=MAGIC_SWAP_ALT_GUI) key. */ - /* https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L80-L81 */ - keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = true; - } + /* The result is the same as pressing the AG_NORM(=MAGIC_UNSWAP_ALT_GUI)/AG_SWAP(=MAGIC_SWAP_ALT_GUI) keys. + * see + * https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L123-L124 + * https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L80-L81 + */ + keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = !macmode; + eeconfig_update_keymap(keymap_config.raw); } void dip_switch_update_kb(uint8_t index, bool active) { diff --git a/keyboards/helix/rev3_5rows/rev3_5rows.c b/keyboards/helix/rev3_5rows/rev3_5rows.c index cf183366d6..c034c83381 100644 --- a/keyboards/helix/rev3_5rows/rev3_5rows.c +++ b/keyboards/helix/rev3_5rows/rev3_5rows.c @@ -21,15 +21,13 @@ bool is_mac_mode(void) { } void set_mac_mode(bool macmode) { - if (macmode) { - /* The result is the same as pressing the AG_NORM(=MAGIC_UNSWAP_ALT_GUI) key. */ - /* https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L123-L124 */ - keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = false; - } else { - /* The result is the same as pressing the AG_SWAP(=MAGIC_SWAP_ALT_GUI) key. */ - /* https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L80-L81 */ - keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = true; - } + /* The result is the same as pressing the AG_NORM(=MAGIC_UNSWAP_ALT_GUI)/AG_SWAP(=MAGIC_SWAP_ALT_GUI) keys. + * see + * https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L123-L124 + * https://github.com/qmk/qmk_firmware/blob/fb4a6ad30ea7a648acd59793ed4a30c3a8d8dc32/quantum/process_keycode/process_magic.c#L80-L81 + */ + keymap_config.swap_lalt_lgui = keymap_config.swap_ralt_rgui = !macmode; + eeconfig_update_keymap(keymap_config.raw); } void dip_switch_update_kb(uint8_t index, bool active) {