Add new keyboard layout for the ClueBoard (#1371)

4 files changed, 186 insertions, 0 deletions

diff --git a/keyboards/clueboard/keymaps/magicmonty/Makefile b/keyboards/clueboard/keymaps/magicmonty/Makefile
new file mode 100644
index 0000000000..1ae727708a
--- /dev/null
+++ b/keyboards/clueboard/keymaps/magicmonty/Makefile
@@ -0,0 +1,2 @@
+MOUSEKEY_ENABLE = yes
+EXTRAKEY_ENABLE = yes
diff --git a/keyboards/clueboard/keymaps/magicmonty/keymap.c b/keyboards/clueboard/keymaps/magicmonty/keymap.c
new file mode 100644
index 0000000000..fdfe2151db
--- /dev/null
+++ b/keyboards/clueboard/keymaps/magicmonty/keymap.c
@@ -0,0 +1,152 @@
+#include "clueboard.h"
+
+// Helpful defines
+#define GRAVE_MODS  (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)|MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)|MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT))
+#define _______ KC_TRNS
+
+// 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.
+#define _BL 0
+#define _FL 1
+#define _ME 2
+#define _CL 3
+#define _ML 4
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* Keymap _BL: Base Layer (Default Layer)
+   */
+  [_BL] = KEYMAP(
+    F(0),    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_INS, \
+    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_DEL, \
+    MO(_FL), KC_A,    KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,    KC_SCLN,  KC_QUOT,  KC_NUHS,  KC_ENT,                            \
+    KC_LSFT, KC_NUBS, KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT,   KC_SLSH,  _______,  KC_RSFT,          KC_UP,           \
+    KC_LCTL, KC_LGUI, KC_LALT, _______,          LT(_ML, KC_SPC),LT(_ML, KC_SPC),      _______,  KC_RALT,  MO(_ME),  MO(_FL), KC_LEFT, KC_DOWN, KC_RGHT),
+
+  /* Keymap _FL: Function Layer
+   */
+  [_FL] = KEYMAP(
+    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,   _______, _______,          BL_STEP, \
+    _______, _______, _______,_______,_______,_______,_______,_______,KC_PSCR,_______, _______,  _______,  _______,  _______,                   _______, \
+    MO(_FL), _______, MO(_CL),_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                            \
+    _______, _______, _______,_______,_______,_______,_______,_______,MO(_ME),_______, _______,  _______,  _______,  _______,          KC_PGUP,          \
+    _______, _______, _______,_______,        _______,_______,                         _______,  _______,  _______,  MO(_FL), KC_HOME, KC_PGDN, KC_END),
+
+  /* Keymap _ME: Media layer
+    */
+  [_ME] = KEYMAP(
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______, KC_MUTE,         KC_VOLU, \
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                  KC_VOLD, \
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                           \
+    MO(_FL), _______, _______,_______,_______,_______,_______,_______,MO(_ME),_______, _______,  _______,  _______,  MO(_FL),          _______,         \
+    _______, _______, _______,_______,                _______,_______,                 _______,  _______,  _______,  _______, KC_MPRV, KC_MPLY,KC_MNXT),
+
+  /* Keymap _CL: Control layer
+    */
+  [_CL] = KEYMAP(
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______, RGB_TOG,          RGB_VAI, \
+    _______, _______, _______,_______,RESET,  _______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                   RGB_VAD, \
+    _______, _______, MO(_CL),_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                            \
+    MO(_FL), _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  MO(_FL),          RGB_SAI,          \
+    _______, _______, _______,_______,        RGB_MOD,RGB_MOD,                         _______,  _______,  _______,  _______, RGB_HUD, RGB_SAD, RGB_HUI),
+
+  /* Keymap _ML: Mouse layer
+    */
+  [_ML] = KEYMAP(
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______, _______,         _______, \
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                  _______, \
+    _______, _______, KC_BTN3,KC_BTN2,KC_BTN1,_______,KC_MS_L,KC_MS_D,KC_MS_U,KC_MS_R, _______,  _______,  _______,  _______,                           \
+    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,          KC_MS_U,         \
+    _______, _______, _______,_______,        LT(_ML, KC_SPC),LT(_ML, KC_SPC),         _______,  KC_BTN1,  KC_BTN2,  KC_BTN3, KC_MS_L, KC_MS_D,KC_MS_R),
+};
+
+/* This is a list of user defined functions. F(N) corresponds to item N
+   of this list.
+ */
+const uint16_t PROGMEM fn_actions[] = {
+  [0] = ACTION_FUNCTION(0),  // Calls action_function()
+};
+
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
+  static uint8_t mods_pressed;
+  static bool mod_flag;
+
+  switch (id) {
+    case 0:
+      /* Handle the combined Grave/Esc key
+       */
+      mods_pressed = get_mods()&GRAVE_MODS; // Check to see what mods are pressed
+
+      if (record->event.pressed) {
+        /* The key is being pressed.
+         */
+        if (mods_pressed) {
+          mod_flag = true;
+          add_key(KC_GRV);
+          send_keyboard_report();
+        } else {
+          add_key(KC_ESC);
+          send_keyboard_report();
+        }
+      } else {
+        /* The key is being released.
+         */
+        if (mod_flag) {
+          mod_flag = false;
+          del_key(KC_GRV);
+          send_keyboard_report();
+        } else {
+          del_key(KC_ESC);
+          send_keyboard_report();
+        }
+      }
+      break;
+  }
+}
+
+enum layer_id {
+  LAYER_BASE,
+  LAYER_FUNCTION,
+  LAYER_MEDIA,
+  LAYER_CONTROL,
+  LAYER_MOUSE
+};
+
+void clueboard_set_led(uint8_t id) {
+  switch (id) {
+    case LAYER_BASE:
+      rgblight_sethsv(346, 0, 255);
+      break;
+    case LAYER_FUNCTION:
+      rgblight_sethsv(46, 255, 255);
+      break;
+    case LAYER_MEDIA:
+      rgblight_sethsv(86, 255, 255);
+      break;
+    case LAYER_CONTROL:
+      rgblight_sethsv(346, 255, 255);
+      break;
+    case LAYER_MOUSE:
+      rgblight_sethsv(206, 255, 255);
+      break;
+  }
+};
+
+void matrix_scan_user(void) {
+    uint32_t layer = layer_state;
+
+    if (layer & (1<<_FL)) {
+      if (layer & (1<<_ME)) {
+        clueboard_set_led(LAYER_MEDIA);
+      } else if (layer & (1<<_CL)) {
+        clueboard_set_led(LAYER_CONTROL);
+      } else {
+        clueboard_set_led(LAYER_FUNCTION);
+      }
+    } else if (layer & (1<<_ML)) {
+        clueboard_set_led(LAYER_MOUSE);
+    } else {
+        clueboard_set_led(LAYER_BASE);
+    }
+};
diff --git a/keyboards/clueboard/keymaps/magicmonty/layout.png b/keyboards/clueboard/keymaps/magicmonty/layout.png
new file mode 100644
index 0000000000..168eec2d61
--- /dev/null
+++ b/keyboards/clueboard/keymaps/magicmonty/layout.png
diff --git a/keyboards/clueboard/keymaps/magicmonty/readme.md b/keyboards/clueboard/keymaps/magicmonty/readme.md
new file mode 100644
index 0000000000..728c188225
--- /dev/null
+++ b/keyboards/clueboard/keymaps/magicmonty/readme.md
@@ -0,0 +1,32 @@
+```
+ ___     _____ _            _                         _     __    __ _   __
+|__ \   / ____| |          | |                       | |   / /   / /(_) / /
+ ||) | | |    | |_   _  ___| |__   ___   __ _ _ __ __| |  / /_  / /_   / /
+ |/ /  | |    | | | | |/ _ \ '_ \ / _ \ / _` | '__/ _` | | '_ \| '_ \ / /
+ |_|   | |____| | |_| |  __/ |_) | (_) | (_| | | | (_| | | (_) | (_) / / _
+ (_)    \_____|_|\__,_|\___|_.__/ \___/ \__,_|_|  \__,_|  \___/ \___/_/ (_)
+```
+
+![Clueboard Layout Image](layout.png)
+
+# MouseKeys Layout
+
+This layout is a combination of the `mouse_keys` and the `win_optimized` layouts.
+This layout is optimized for an ISO layout.
+
+It adds a mouse layer. When you hold down the spacebar the arrow keys
+will move your mouse cursor. You can click using the 3 mods to the left of the
+arrow keys, or the 3 keys under your primary fingers on the home row.
+The Left, Down, Up and Right for the mouse movement are also VIM-Like on the HJKL keys
+
+The CapsLock is disabled and works as Function key.
+
+There is also a separate media layer with Volume/Play controls
+
+The different layers are signalled throug setting of the underlight:
+
+- Base layer: White
+- Function layer: Yellow
+- Media layer: Green
+- Mouse layer: Blue
+- Control layer: Red