[Keymap] update dz60:mrsendyyk (#10160)

Update DZ60 Personal readme.md and keymap.c * Update readme.md * Update keymap.c * Update keymap.c * Update readme.md * Update readme.md * Update readme.md * Update keymap.c * Update readme.md * Update * Update readme.md * Update keymap.c * Update readme.md
2020-09-01 12:26:52 +07:00 · 2020-09-01 12:26:52 +07:00 · 854a94f383
parent 4a6cfb06c5
commit 854a94f383
2 changed files with 83 additions and 88 deletions
--- a/keyboards/dz60/keymaps/mrsendyyk/keymap.c
+++ b/keyboards/dz60/keymaps/mrsendyyk/keymap.c
@ -1,63 +1,29 @@
+/* 
+ * Based on Sendy YK's 60% ANSI Arrow Layout and Keymap
+ * https://github.com/qmk/qmk_firmware/blob/master/layouts/default/60_ansi_arrow/info.json
+ * https://github.com/qmk/qmk_firmware/blob/master/layouts/community/60_ansi_arrow/mrsendyyk/keymap.c
+ * 
+ * https://github.com/mrsendyyk
+ */
+
 #include QMK_KEYBOARD_H

-const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-  
-  /*
-   * Default Layer [0]
-   * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-   * │Esc│1  │2  │3  │4  │5  │6  │7  │8  │9  │0  │-  │=  │Bspc   │
-   * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-   * │Tab  │Q  │W  │E  │R  │T  │Y  │U  │I  │O  │P  │[  │]  │\    │
-   * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-   * │Caps L│A  │S  │D  │F  │G  │H  │J  │K  │L  │;  │'  │Enter   │
-   * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-   * │Shift   │Z  │X  │C  │V  │B  │N  │M  │,  │.  │Shift │↑  │/  │
-   * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-   * │Ctl │OS  │Alt │          Space         │Alt│Ctl│←  │↓  │→  │
-   * └────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-   */
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {  
+  /* Default Layer [0] */
     [0] = LAYOUT_60_ansi_arrow(KC_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC,
                                KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS,
                                KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
                                KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_RSFT, KC_UP, KC_SLSH,
                                KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, LT(2, KC_RALT), LT(1, KC_RCTL), KC_LEFT, KC_DOWN, KC_RGHT
     ),
-
-  /*
-   * Fn Layer [1]
-   * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-   * │`  │F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│Delete │
-   * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-   * │Bri+ │   │   │End│Rst│   │   │   │Ins│   │P S│   │   │Eject│
-   * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-   * │Bri-  │   │S L│   │   │   │Hm │   │   │   │   │   │Mute    │
-   * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-   * │Vol+    │   │   │Cal│   │   │N L│Ml │   │   │Pause │P U│   │
-   * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-   * │Vol-│Rwd │F FD│           Play         │Stp│   │Prv│P D│Nxt│
-   * └────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-   */
+  /* Fn Layer [1] */
 	 [1] = LAYOUT_60_ansi_arrow(KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_DEL,
                                KC_BRIU, KC_TRNS, KC_TRNS, KC_END, RESET, KC_TRNS, KC_TRNS, KC_TRNS, KC_INS, KC_TRNS, KC_PSCR, KC_TRNS, KC_TRNS, KC_EJCT,
                                KC_BRID, KC_TRNS, KC_SLCK, KC_TRNS, KC_TRNS, KC_TRNS, KC_HOME, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MUTE,
                                KC_VOLU, KC_TRNS, KC_TRNS, KC_CALC, KC_TRNS, KC_TRNS, KC_NLCK, KC_MAIL, KC_TRNS, KC_TRNS, KC_PAUS, KC_PGUP, KC_TRNS,
                                KC_VOLD, KC_MRWD, KC_MFFD, KC_MPLY, KC_MSTP, KC_TRNS, KC_MPRV, KC_PGDN, KC_MNXT
     ),
-
-  /*
-   * Fn Layer [2]
-   * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-   * │   │   │   │   │   │   │   │   │   │   │   │   │   │       │
-   * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-   * │     │R T│R M│Hu+│Hu-│Sa+│Sa-│Br+│Br-│   │   │   │   │     │
-   * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-   * │      │   │   │   │   │   │   │   │   │   │   │   │        │
-   * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-   * │        │   │   │   │BL-│B T│BL+│B C│   │   │      │   │   │
-   * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-   * │    │    │    │                        │   │   │   │   │   │
-   * └────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-   */
+  /* Fn Layer [2] */
 	 [2] = LAYOUT_60_ansi_arrow(KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
                                KC_TRNS, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
                                KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
@ -71,7 +37,7 @@ void keyboard_post_init_user(void) {
  rgblight_sethsv_noeeprom(0, 0, 0);
 }

-/* RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer indicator */
+/* RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer Indicator */
   void update_led(void) {
     /* Num Lock Indicator */
        if (host_keyboard_led_state().num_lock) {
@ -79,7 +45,7 @@ void keyboard_post_init_user(void) {
        }
     /* Scroll Lock Indicator */
        if (host_keyboard_led_state().scroll_lock) {
-          rgblight_setrgb(0, 100, 255);
+          rgblight_setrgb(241, 190, 72);
        }
   }

--- a/keyboards/dz60/keymaps/mrsendyyk/readme.md
+++ b/keyboards/dz60/keymaps/mrsendyyk/readme.md
@ -1,56 +1,85 @@
-# [Sendy YK](https://mr.sendyyk.com)'s Keymap
-`LAYOUT_60_ansi_arrow` with RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer indicator.
+# Sendy YK's 60% ANSI Arrow Layout and Keymap
+
+This is Sendy YK's [60% ANSI Arrow Layout](https://github.com/qmk/qmk_firmware/blob/master/layouts/default/60_ansi_arrow/info.json) and [Keymap (with RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer Indicator)](https://github.com/qmk/qmk_firmware/blob/master/layouts/community/60_ansi_arrow/mrsendyyk/keymap.c).
+
+## 60% ANSI Arrow Layout
+
+![LAYOUT_60_ansi_arrow](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/kbdfans_tofu_60_keyboard/assets/dz60_layout_60_ansi_arrow.png)
+
+## Keymap

 ### Default Layer [0]

-```
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-│Esc│1  │2  │3  │4  │5  │6  │7  │8  │9  │0  │-  │=  │Bspc   │
-├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-│Tab  │Q  │W  │E  │R  │T  │Y  │U  │I  │O  │P  │[  │]  │\    │
-├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-│Caps L│A  │S  │D  │F  │G  │H  │J  │K  │L  │;  │'  │Enter   │
-├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-│Shift   │Z  │X  │C  │V  │B  │N  │M  │,  │.  │Shift │↑  │/  │
-├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-│Ctl │OS  │Alt │          Space         │Alt│Ctl│←  │↓  │→  │
-└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-```
+![Default Layer [0]](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/kbdfans_tofu_60_keyboard/assets/dz60_mrsendyyk_0.png)

 ### Fn Layer [1]
-Press and hold *right* **Ctl** key.
-```
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-│`  │F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│Delete │
-├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-│Bri+ │   │   │End│Rst│   │   │   │Ins│   │P S│   │   │Eject│
-├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-│Bri-  │   │S L│   │   │   │Hm │   │   │   │   │   │Mute    │
-├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-│Vol+    │   │   │Cal│   │   │N L│Ml │   │   │Pause │P U│   │
-├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-│Vol-│Rwd │F FD│           Play         │Stp│   │Prv│P D│Nxt│
-└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-```
+
+Press and hold *right* **Ctrl** key.
+
+![Fn Layer [1]](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/kbdfans_tofu_60_keyboard/assets/dz60_mrsendyyk_1.png)

 ### Fn Layer [2]
+
 Press and hold *right* **Alt** key.
+
+![Fn Layer [2]](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/kbdfans_tofu_60_keyboard/assets/dz60_mrsendyyk_2.png)
+
+### RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer Indicator
+
+#### Caps Lock Indicator
+
+```c
+/* Caps Lock Indicator */
+   if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {
+     writePinLow(B2);
+     rgblight_setrgb(100, 255, 100);
+   }
 ```
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-│   │   │   │   │   │   │   │   │   │   │   │   │   │       │
-├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-│     │R T│R M│Hu+│Hu-│Sa+│Sa-│Br+│Br-│   │   │   │   │     │
-├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-│      │   │   │   │   │   │   │   │   │   │   │   │        │
-├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-│        │   │   │   │BL-│B T│BL+│B C│   │   │      │   │   │
-├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-│    │    │    │                        │   │   │   │   │   │
-└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
+
+#### Num Lock Indicator
+
+```c
+/* Num Lock Indicator */
+   if (host_keyboard_led_state().num_lock) {
+     rgblight_setrgb(225, 8, 0);
+   }
+```
+
+#### Scroll Lock Indicator
+```c
+/* Scroll Lock Indicator */
+   if (host_keyboard_led_state().scroll_lock) {
+     rgblight_setrgb(241, 190, 72);
+   }
+```
+
+#### Layer Indicator
+
+```c
+/* Layer Indicator */
+   else {          
+     switch (get_highest_layer(layer_state)) {
+     /* Fn Layer [1] Indicator */
+        case 1:
+          rgblight_setrgb(255, 110, 0);
+          break;
+     /* Fn Layer [2] Indicator */
+        case 2:
+          rgblight_setrgb(255, 110, 0);
+          break;
+     /* Default Layer [0] Indicator */
+        default:
+          rgblight_setrgb(0, 0, 0);
+          break;
+     }
+     update_led();
+   }
 ```

 ## Build The Firmware
+
 You will need to build the firmware. To do so go to your terminal window and run the compile command:

    qmk compile -kb dz60 -km mrsendyyk
+
 See [The Complete Newbs Guide To QMK](https://docs.qmk.fm/#/newbs).