Add MIDI layer to magicmonty keymap (#1386)

* Add MIDI layer

* Respect brightness level on layer signalling

* Add hotkey in control layer for signalling state

* Update layout.png

* Remove image and replace it with imgur link

4 files changed, 105 insertions, 29 deletions

diff --git a/keyboards/clueboard/keymaps/magicmonty/Makefile b/keyboards/clueboard/keymaps/magicmonty/Makefile
index 1ae727708a..5b798b7fc7 100644
--- a/keyboards/clueboard/keymaps/magicmonty/Makefile
+++ b/keyboards/clueboard/keymaps/magicmonty/Makefile
@@ -1,2 +1,8 @@
+
 MOUSEKEY_ENABLE = yes
 EXTRAKEY_ENABLE = yes
+
+MIDI_ENABLE = yes
+
+# if MIDI_ENABLE is set to yes, then CONSOLE_ENABLE has to be disabled, because of the firmware size
+CONSOLE_ENABLE = false
diff --git a/keyboards/clueboard/keymaps/magicmonty/config.h b/keyboards/clueboard/keymaps/magicmonty/config.h
new file mode 100644
index 0000000000..4b2953499b
--- /dev/null
+++ b/keyboards/clueboard/keymaps/magicmonty/config.h
@@ -0,0 +1,29 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+/*
+ * 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 2
+
+#endif
diff --git a/keyboards/clueboard/keymaps/magicmonty/keymap.c b/keyboards/clueboard/keymaps/magicmonty/keymap.c
index 6ca843aabd..c7847dfb76 100644
--- a/keyboards/clueboard/keymaps/magicmonty/keymap.c
+++ b/keyboards/clueboard/keymaps/magicmonty/keymap.c
@@ -3,16 +3,23 @@
 // 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
+#define xxxxxxx KC_NO
 
 // 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
+#define _BL 0 // BASE Layer
+#define _FL 1 // Function Layer
+#define _ME 2 // Media Layer
+#define _CL 3 // Control Layer
+#define _ML 4 // Mouse Layer
+#if defined(MIDI_ENABLE)
+  #define _MI 5 // MIDI Layer
+  #define TO_MIDI TO(_MI)
+#else
+  #define TO_MIDI _______
+#endif
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   /* Keymap _BL: Base Layer (Default Layer)
@@ -24,17 +31,15 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     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
-   */
+  /* 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,_______, KC_PAUS,  _______,  _______,  _______,                   _______, \
     MO(_FL), _______, MO(_CL),_______,_______,_______,KC_LEFT,KC_DOWN,  KC_UP,KC_RGHT, _______,  _______,  _______,  _______,                            \
-    _______, _______, _______,_______,_______,_______,_______,_______,MO(_ME),_______, _______,  _______,  _______,  _______,          KC_PGUP,          \
+    _______, _______, _______,_______,_______,_______,_______,_______,MO(_ME),_______, _______,  TO_MIDI,  _______,  _______,          KC_PGUP,          \
     _______, _______, _______,_______,        _______,_______,                         _______,  _______,  _______,  MO(_FL), KC_HOME, KC_PGDN, KC_END),
 
-  /* Keymap _ME: Media layer
-    */
+  /* Keymap _ME: Media layer */
   [_ME] = KEYMAP(
     _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______, KC_MUTE,         KC_VOLU, \
     _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______,                  KC_VOLD, \
@@ -42,23 +47,39 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     MO(_FL), _______, _______,_______,_______,_______,_______,_______,MO(_ME),_______, _______,  _______,  _______,  MO(_FL),          _______,         \
     _______, _______, _______,_______,                _______,_______,                 _______,  _______,  _______,  _______, KC_MPRV, KC_MPLY,KC_MNXT),
 
-  /* Keymap _CL: Control layer
-    */
+  /* Keymap _CL: Control layer */
   [_CL] = KEYMAP(
-    _______, _______, _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______, RGB_TOG,          RGB_VAI, \
+    _______,    F(1), _______,_______,_______,_______,_______,_______,_______,_______, _______,  _______,  _______,  _______, 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
-    */
+  /* 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),
+
+#if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
+  /* Keymap _MI: MIDI layer (Advanced)*/
+  [_MI] = KEYMAP(
+    TO(_BL),MI_VEL_1,MI_VEL_2,MI_VEL_3,MI_VEL_4,MI_VEL_5,MI_VEL_6,MI_VEL_7,MI_VEL_8,MI_VEL_9,MI_VEL_10,  MI_CHD,   MI_CHU,  xxxxxxx, xxxxxxx,         xxxxxxx, \
+    xxxxxxx, xxxxxxx,   MI_Cs,   MI_Ds, xxxxxxx,   MI_Fs,   MI_Gs,   MI_As, xxxxxxx, MI_Cs_1,  MI_Ds_1, xxxxxxx,  MI_Fs_1,  xxxxxxx,                  xxxxxxx, \
+     MI_MOD,    MI_C,    MI_D,    MI_E,    MI_F,    MI_G,    MI_A,    MI_B,  MI_C_1,  MI_D_1,   MI_E_1,  MI_F_1,   MI_G_1,  xxxxxxx,                           \
+     MI_SUS, xxxxxxx, MI_OCTD, MI_OCTU,MI_MODSD,MI_MODSU, xxxxxxx, xxxxxxx, xxxxxxx, xxxxxxx, MI_TRNSD,MI_TRNSU,MI_TRNS_0,   MI_SUS,          xxxxxxx,         \
+    xxxxxxx, xxxxxxx, xxxxxxx,xxxxxxx,                 MI_ALLOFF,MI_ALLOFF,                    xxxxxxx, xxxxxxx,  xxxxxxx,  xxxxxxx, xxxxxxx, xxxxxxx,xxxxxxx),
+#elif defined(MIDI_ENABLE) && defined(MIDI_BASIC)
+  /* Keymap _MI: MIDI layer (Basic)*/
+  [_MI] = KEYMAP(
+    TO(_BL), xxxxxxx, xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx, xxxxxxx,  xxxxxxx,  xxxxxxx,  xxxxxxx, xxxxxxx,         xxxxxxx, \
+    xxxxxxx, xxxxxxx, xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx, xxxxxxx,  xxxxxxx,  xxxxxxx,  xxxxxxx,                  xxxxxxx, \
+    xxxxxxx, xxxxxxx, xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx, xxxxxxx,  xxxxxxx,  xxxxxxx,  xxxxxxx,                           \
+    xxxxxxx, xxxxxxx,   MI_ON, MI_OFF,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx,xxxxxxx, xxxxxxx,  xxxxxxx,  xxxxxxx,  xxxxxxx,          xxxxxxx,         \
+    xxxxxxx, xxxxxxx, xxxxxxx,xxxxxxx,                xxxxxxx,xxxxxxx,                 xxxxxxx,  xxxxxxx,  xxxxxxx,  xxxxxxx, xxxxxxx, xxxxxxx,xxxxxxx),
+#endif
 };
 
 /* This is a list of user defined functions. F(N) corresponds to item N
@@ -66,6 +87,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  */
 const uint16_t PROGMEM fn_actions[] = {
   [0] = ACTION_FUNCTION(0),  // Calls action_function()
+  [1] = ACTION_FUNCTION(1),  // Calls action_function()
 };
 
 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
@@ -102,6 +124,8 @@ void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
         }
       }
       break;
+    case 1:
+      rgblight_mode(1);
   }
 }
 
@@ -110,26 +134,34 @@ enum layer_id {
   LAYER_FUNCTION,
   LAYER_MEDIA,
   LAYER_CONTROL,
-  LAYER_MOUSE
+  LAYER_MOUSE,
+#if defined(MIDI_ENABLE)
+  LAYER_MIDI
+#endif
 };
 
-void clueboard_set_led(uint8_t id) {
+void clueboard_set_led(uint8_t id, uint8_t val) {
   switch (id) {
     case LAYER_BASE:
-      rgblight_sethsv_noeeprom(346, 0, 255);
+      rgblight_sethsv_noeeprom(346, 0, val);
       break;
     case LAYER_FUNCTION:
-      rgblight_sethsv_noeeprom(46, 255, 255);
+      rgblight_sethsv_noeeprom(46, 255, val);
       break;
     case LAYER_MEDIA:
-      rgblight_sethsv_noeeprom(86, 255, 255);
+      rgblight_sethsv_noeeprom(86, 255, val);
       break;
     case LAYER_CONTROL:
-      rgblight_sethsv_noeeprom(346, 255, 255);
+      rgblight_sethsv_noeeprom(346, 255, val);
       break;
     case LAYER_MOUSE:
-      rgblight_sethsv_noeeprom(206, 255, 255);
+      rgblight_sethsv_noeeprom(206, 255, val);
+      break;
+#if defined(MIDI_ENABLE)
+    case LAYER_MIDI:
+      rgblight_sethsv_noeeprom(316, 255, val);
       break;
+#endif
   }
 };
 
@@ -140,18 +172,23 @@ void matrix_scan_user(void) {
     if (!rgblight_config.enable || rgblight_config.mode != 1) { return; }
 
     uint32_t layer = layer_state;
+    uint8_t val = rgblight_config.val;
 
     if (layer & (1<<_FL)) {
       if (layer & (1<<_ME)) {
-        clueboard_set_led(LAYER_MEDIA);
+        clueboard_set_led(LAYER_MEDIA, val);
       } else if (layer & (1<<_CL)) {
-        clueboard_set_led(LAYER_CONTROL);
+        clueboard_set_led(LAYER_CONTROL, val);
       } else {
-        clueboard_set_led(LAYER_FUNCTION);
+        clueboard_set_led(LAYER_FUNCTION, val);
       }
     } else if (layer & (1<<_ML)) {
-        clueboard_set_led(LAYER_MOUSE);
+        clueboard_set_led(LAYER_MOUSE, val);
+#if defined(MIDI_ENABLE)
+    } else if (layer & (1<<_MI)) {
+        clueboard_set_led(LAYER_MIDI, val);
+#endif
     } else {
-        clueboard_set_led(LAYER_BASE);
+        clueboard_set_led(LAYER_BASE, val);
     }
 };
diff --git a/keyboards/clueboard/keymaps/magicmonty/readme.md b/keyboards/clueboard/keymaps/magicmonty/readme.md
index 2959172df1..04930311f4 100644
--- a/keyboards/clueboard/keymaps/magicmonty/readme.md
+++ b/keyboards/clueboard/keymaps/magicmonty/readme.md
@@ -1,6 +1,8 @@
-![Clueboard Layout Image](http://i.imgur.com/ngg4EAY.png)
+# Layout of @magicmonty
 
-# MouseKeys Layout
+[Keyboard Layout Editor File](http://www.keyboard-layout-editor.com/#/gists/f869b8789242a712e0f46eabbd550056)
+
+![Clueboard Layout Image](http://imgur.com/fXJFlrp.png)
 
 This layout is a combination of the `mouse_keys` and the `win_optimized` layouts.
 This layout is optimized for an ISO layout.
@@ -10,6 +12,8 @@ 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
 
+There is also a MIDI layer included.
+
 The CapsLock is disabled and works as Function key.
 
 There is also a separate media layer with Volume/Play controls