From fced377ac007d27f2650ccffbe0b18abcdcfe23d Mon Sep 17 00:00:00 2001
From: James Young <18669334+noroadsleft@users.noreply.github.com>
Date: Sat, 30 May 2020 13:14:59 -0700
Subject: 2020 May 30 Breaking Changes Update (#9215)
* Branch point for 2020 May 30 Breaking Change
* Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954)
* Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957)
* Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958)
* Migrate `ACTION_LAYER_MODS` to `LM()` (#8959)
* Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968)
* Convert V-USB usbdrv to a submodule (#8321)
* Unify Tap Hold functions and documentation (#8348)
* Changing board names to prevent confusion (#8412)
* Move the Keyboardio Model01 to a keyboardio/ subdir (#8499)
* Move spaceman keyboards (#8830)
* Migrate miscellaneous `fn_actions` entries (#8977)
* Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979)
* Organizing my keyboards (plaid, tartan, ergoinu) (#8537)
* Refactor Lily58 to use split_common (#6260)
* Refactor zinc to use split_common (#7114)
* Add a message if bin/qmk doesn't work (#9000)
* Fix conflicting types for 'tfp_printf' (#8269)
* Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480)
* Refactor and updates to TKC1800 code (#8472)
* Switch to qmk forks for everything (#9019)
* audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484)
* Audio enable corrections (2/3) (#8903)
* Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582)
* Audio enable corrections (Part 4) (#8974)
* Fix typo from PR7114 (#9171)
* Augment future branch Changelogs (#8978)
* Revert "Branch point for 2020 May 30 Breaking Change"
---
keyboards/zinc/keymaps/default/config.h | 2 -
keyboards/zinc/keymaps/default/keymap.c | 26 ++++--
keyboards/zinc/keymaps/default/readme_en.md | 131 ++++++++++++++++++++++++++++
keyboards/zinc/keymaps/default/readme_jp.md | 48 ++++++++--
keyboards/zinc/keymaps/default/rules.mk | 57 ++++++++++--
5 files changed, 241 insertions(+), 23 deletions(-)
create mode 100644 keyboards/zinc/keymaps/default/readme_en.md
(limited to 'keyboards/zinc/keymaps/default')
diff --git a/keyboards/zinc/keymaps/default/config.h b/keyboards/zinc/keymaps/default/config.h
index 4dcb0724ff..2185dc9ebe 100644
--- a/keyboards/zinc/keymaps/default/config.h
+++ b/keyboards/zinc/keymaps/default/config.h
@@ -20,8 +20,6 @@ along with this program. If not, see .
*/
#pragma once
-// if you need more program area, try uncomment follow line
-#include "serial_config_simpleapi.h"
// place overrides here
// Selection of RGBLIGHT MODE to use.
diff --git a/keyboards/zinc/keymaps/default/keymap.c b/keyboards/zinc/keymaps/default/keymap.c
index 0f08d21ee7..cd1bf0328b 100644
--- a/keyboards/zinc/keymaps/default/keymap.c
+++ b/keyboards/zinc/keymaps/default/keymap.c
@@ -139,7 +139,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { \
* |------+------+------+------+------+------| |------+------+------+------+------+------|
* | |RGB ON| HUE+ | SAT+ | VAL+ | Mac | | Win | - | = |Print |ScLock|Pause |
* |------+------+------+------+------+------| |------+------+------+------+------+------|
- * | | MODE | HUE- | SAT- | VAL- | | | | | | | | |
+ * |MODE R| MODE | HUE- | SAT- | VAL- | | | | | | |PageUp| |
* |------+------+------+------+------+------| |------+------+------+------+------+------|
* | | | | EISU | EISU | EISU | | KANA | KANA | Home |PageDn|PageUp| End |
* `-----------------------------------------' `-----------------------------------------'
@@ -147,13 +147,13 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { \
[_ADJUST] = LAYOUT_ortho_4x12( \
_______, RESET, RGBRST, _______, _______, _______, _______, QWERTY, COLEMAK, DVORAK, _______, KC_INS, \
_______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, AG_NORM, AG_SWAP, KC_MINS, KC_EQL, KC_PSCR, KC_SLCK, KC_PAUS,\
- _______, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______, _______, _______, _______,\
- _______, _______, _______, EISU, EISU, EISU, KANA, KANA, KC_HOME, KC_PGDN, KC_PGUP, KC_END\
+ RGB_RMOD,RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______, _______, KC_PGUP, _______,\
+ _______, _______, _______, EISU, EISU, EISU, KANA, KANA, KANA, KC_HOME, KC_PGDN, KC_END\
)
};
// define variables for reactive RGB
-bool TOG_STATUS = false;
+bool TOG_STATUS = false;
// Setting ADJUST layer RGB back to default
void update_tri_layer_RGB(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
@@ -211,7 +211,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
}
return false;
break;
-
+
case RAISE:
if (record->event.pressed) {
//not sure how to have keyboard check mode and set it to a variable, so my work around
@@ -244,16 +244,28 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
}
return false;
break;
+
//led operations - RGB mode change now updates the RGB_current_mode to allow the right RGB mode to be set after reactive keys are released
+ case RGB_RMOD:
+ #if defined(RGBLIGHT_ENABLE)
+ if (record->event.pressed) {
+ rgblight_mode_noeeprom(RGB_current_config.mode);
+ rgblight_step_reverse();
+ RGB_current_config.mode = rgblight_config.mode;
+ }
+ return false;
+ #endif
+ break;
+
case RGB_MOD:
- #ifdef RGBLIGHT_ENABLE
+ #if defined(RGBLIGHT_ENABLE)
if (record->event.pressed) {
rgblight_mode_noeeprom(RGB_current_config.mode);
rgblight_step();
RGB_current_config.mode = rgblight_config.mode;
}
- #endif
return false;
+ #endif
break;
case EISU:
diff --git a/keyboards/zinc/keymaps/default/readme_en.md b/keyboards/zinc/keymaps/default/readme_en.md
new file mode 100644
index 0000000000..6447e96ed4
--- /dev/null
+++ b/keyboards/zinc/keymaps/default/readme_en.md
@@ -0,0 +1,131 @@
+# The Default Zinc Layout
+## layout
+
+### Qwerty
+
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Shift| Z | X | C | V | B | | N | M | , | . | / |Enter |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Esc | Fn | Alt | Win |Lower |Space | | Space| Raise| Left | Down | Up | Right|
+ `------------------------------------------ ------------------------------------------'
+```
+
+### Colemak
+
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | Tab | Q | W | F | P | G | | J | L | U | Y | ; | Bksp |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Ctrl | A | R | S | T | D | | H | N | E | I | O | ' |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Shift| Z | X | C | V | B | | K | M | , | . | / |Enter |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
+ `------------------------------------------ ------------------------------------------'
+```
+
+### Dvorak
+
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | Tab | ' | , | . | P | Y | | F | G | C | R | L | Del |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Ctrl | A | O | E | U | I | | D | H | T | N | S | / |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Shift| ; | Q | J | K | X | | B | M | W | V | Z |Enter |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
+ `-----------------------------------------' `-----------------------------------------'
+```
+
+### Lower
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | - | _ | + | { | } | | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | | | | Home | End | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | | | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------' `-----------------------------------------'
+```
+
+### RAISE
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | F7 | F8 | F9 | F10 | F11 | | F12 | | | | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | | | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------' `-----------------------------------------'
+```
+
+### Adjust (Lower + Raise)
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | | Reset|RGBRST|Aud on|Audoff| | | |Qwerty|Colemk|Dvorak| | Ins |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | |RGB ON| HUE+ | SAT+ | VAL+ | Mac | | Win | - | = |Print |ScLock|Pause |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ |MODE R|RGBMOD| HUE- | SAT- | VAL- | | | | | | |PageUp| |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | EISU | EISU | EISU | | KANA | KANA | KANA | Home |PageDn| End |
+ `-----------------------------------------' `-----------------------------------------'
+```
+
+## Compile
+
+go to qmk top directory.
+
+```
+$ cd qmk_firmware
+```
+make with `zinc:`
+
+```
+$ make zinc:default
+```
+
+To make and flash with `:flash`
+
+```
+$ make zinc:default:flash
+```
+
+
+## Customize
+
+You can customize from the command line.
+
+```
+# Zinc keyboard 'default' keymap: convenient command line option
+make ZINC= zinc:defualt
+# option= back | under | both | cont | na | ios
+# ex.
+# make ZINC=under zinc:defualt
+# make ZINC=under,ios zinc:defualt
+# make ZINC=back zinc:default
+# make ZINC=back,na zinc:default
+# make ZINC=back,ios zinc:default
+```
+
+Or edit `qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` directly.
+
+```
+# Zinc keyboard customize
+LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
+LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
+LED_BOTH_ENABLE = no # LED backlight and underglow
+LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
+LED_ANIMATIONS = yes # LED animations
+IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
+```
diff --git a/keyboards/zinc/keymaps/default/readme_jp.md b/keyboards/zinc/keymaps/default/readme_jp.md
index dfedb37c15..8132f5036e 100644
--- a/keyboards/zinc/keymaps/default/readme_jp.md
+++ b/keyboards/zinc/keymaps/default/readme_jp.md
@@ -43,6 +43,44 @@
`-----------------------------------------' `-----------------------------------------'
```
+ ### Lower
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | - | _ | + | { | } | | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | | | | Home | End | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | | | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------' `-----------------------------------------'
+```
+
+### RAISE
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | F7 | F8 | F9 | F10 | F11 | | F12 | | | | |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | | | | | | | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------' `-----------------------------------------'
+```
+
+### Adjust (Lower + Raise)
+```
+ ,-----------------------------------------. ,-----------------------------------------.
+ | | Reset|RGBRST|Aud on|Audoff| | | |Qwerty|Colemk|Dvorak| | Ins |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | |RGB ON| HUE+ | SAT+ | VAL+ | Mac | | Win | - | = |Print |ScLock|Pause |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ |MODE R|RGBMOD| HUE- | SAT- | VAL- | | | | | | |PageUp| |
+ |------+------+------+------+------+------| |------+------+------+------+------+------|
+ | | | | EISU | EISU | EISU | | KANA | KANA | KANA | Home |PageDn| End |
+ `-----------------------------------------' `-----------------------------------------'
+```
## コンパイルの仕方
@@ -76,7 +114,7 @@ $ make zinc:default:clean
```
# Zinc keyboard 'default' keymap: convenient command line option
make ZINC= zinc:defualt
-# option= back | under | na | ios
+# option= back | under | both | cont | na | ios
# ex.
# make ZINC=under zinc:defualt
# make ZINC=under,ios zinc:defualt
@@ -85,16 +123,16 @@ make ZINC= zinc:defualt
# make ZINC=back,ios zinc:default
```
-あるいは`qmk_firmware/keyboards/zinc/rev1/keymaps/default/rules.mk` の以下の部分を直接編集して機能を有効化してください。
+あるいは`qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` の以下の部分を直接編集して機能を有効化してください。
```
# Zinc keyboard customize
LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
+LED_BOTH_ENABLE = no # LED backlight and underglow
+LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
LED_ANIMATIONS = yes # LED animations
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
-
-
```
## RGB backlight を有効にする
@@ -120,4 +158,4 @@ RBG Underglow や RGBバックライトの輝度を抑えて、iPad, iPhone に
```
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
-```
\ No newline at end of file
+```
diff --git a/keyboards/zinc/keymaps/default/rules.mk b/keyboards/zinc/keymaps/default/rules.mk
index c980f7d00b..32e0f21610 100644
--- a/keyboards/zinc/keymaps/default/rules.mk
+++ b/keyboards/zinc/keymaps/default/rules.mk
@@ -20,6 +20,9 @@ define ZINC_CUSTOMISE_MSG
$(info Zinc customize)
$(info - LED_BACK_ENABLE=$(LED_BACK_ENABLE))
$(info - LED_UNDERGLOW_ENABLE=$(LED_UNDERGLOW_ENABLE))
+ $(info - LED_BOTH_ENABLE=$(LED_BOTH_ENABLE))
+ $(info - LED_RGB_CONT=$(LED_RGB_CONT))
+ $(info - RGB_MATRIX=$(RGB_MATRIX))
$(info - LED_ANIMATION=$(LED_ANIMATIONS))
$(info - IOS_DEVICE_ENABLE=$(IOS_DEVICE_ENABLE))
endef
@@ -27,6 +30,10 @@ endef
# Zinc keyboard customize
LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
+LED_BOTH_ENABLE = no # LED backlight and underglow
+LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
+RGB_MATRIX = no # RGB LED Matrix
+RGB_MATRIX_SPLIT_RIGHT = no # RGB Matrix for RIGHT Hand
LED_ANIMATIONS = yes # LED animations
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
Link_Time_Optimization = no # if firmware size over limit, try this option
@@ -36,7 +43,7 @@ Link_Time_Optimization = no # if firmware size over limit, try this option
### Zinc keyboard 'default' keymap: convenient command line option
## make ZINC= zinc:defualt
-## option= back | under | na | ios
+## option= back | under | both | cont | matrix | na | ios
## ex.
## make ZINC=under zinc:defualt
## make ZINC=under,ios zinc:defualt
@@ -47,9 +54,22 @@ Link_Time_Optimization = no # if firmware size over limit, try this option
ifneq ($(strip $(ZINC)),)
ifeq ($(findstring back,$(ZINC)), back)
LED_BACK_ENABLE = yes
- else ifeq ($(findstring under,$(ZINC)), under)
+ endif
+ ifeq ($(findstring under,$(ZINC)), under)
LED_UNDERGLOW_ENABLE = yes
endif
+ ifeq ($(findstring both,$(ZINC)), both)
+ LED_BOTH_ENABLE = yes
+ endif
+ ifeq ($(findstring cont,$(ZINC)), cont)
+ LED_RGB_CONT = yes
+ endif
+ ifeq ($(findstring matrix,$(ZINC)), matrix)
+ RGB_MATRIX = yes
+ endif
+ ifeq ($(findstring right,$(ZINC)), right)
+ RGB_MATRIX_SPLIT_RIGHT = yes
+ endif
ifeq ($(findstring na,$(ZINC)), na)
LED_ANIMATIONS = no
endif
@@ -62,10 +82,11 @@ endif
ifeq ($(strip $(LED_BACK_ENABLE)), yes)
RGBLIGHT_ENABLE = yes
- OPT_DEFS += -DRGBLED_BACK
ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
- $(eval $(call ZINC_CUSTOMISE_MSG))
- $(error LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE both 'yes')
+ OPT_DEFS += -DRGBLED_BOTH
+ $(info LED_BOTH_ENABLE option is enabled instead of LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE)
+ else
+ OPT_DEFS += -DRGBLED_BACK
endif
else ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
RGBLIGHT_ENABLE = yes
@@ -73,18 +94,36 @@ else
RGBLIGHT_ENABLE = no
endif
+ifeq ($(strip $(LED_BOTH_ENABLE)), yes)
+ RGBLIGHT_ENABLE = yes
+ OPT_DEFS += -DRGBLED_BOTH
+endif
+
+ifeq ($(strip $(LED_RGB_CONT)), yes)
+ OPT_DEFS += -DRGBLED_CONT
+endif
+
+ifeq ($(strip $(RGB_MATRIX)), yes)
+ RGBLIGHT_ENABLE = no
+ RGB_MATRIX_ENABLE = WS2812
+endif
+
ifeq ($(strip $(IOS_DEVICE_ENABLE)), yes)
- OPT_DEFS += -DIOS_DEVICE_ENABLE
+ OPT_DEFS += -DIOS_DEVICE_ENABLE
endif
ifeq ($(strip $(LED_ANIMATIONS)), yes)
-# OPT_DEFS += -DRGBLIGHT_ANIMATIONS
- OPT_DEFS += -DLED_ANIMATIONS
+# OPT_DEFS += -DRGBLIGHT_ANIMATIONS
+ OPT_DEFS += -DLED_ANIMATIONS
+
+endif
+ifeq ($(strip $(RGB_MATRIX_SPLIT_RIGHT)), yes)
+ OPT_DEFS += -DRGB_MATRIX_SPLIT_RIGHT
endif
ifeq ($(strip $(Link_Time_Optimization)),yes)
- EXTRAFLAGS += -flto -DUSE_Link_Time_Optimization
+ EXTRAFLAGS += -flto -DUSE_Link_Time_Optimization
endif
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
--
cgit v1.2.3