keyboards/planck/keymaps/priyadi/keymap.c

   1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
   2 // this is the style you want to emulate.
   3
   4 #include "planck.h"
   5 #include "action_layer.h"
   6 #ifdef AUDIO_ENABLE
   7   #include "audio.h"
   8   #include "musical_notes.h"
   9 #endif
  10 #include "eeconfig.h"
  11 #include "process_unicode.h"
  12 #include "quantum.h"
  13
  14 extern keymap_config_t keymap_config;
  15
  16 enum layers {
  17   _QWERTY,
  18   _COLEMAK,
  19   _WORKMAN,
  20   _PUNC,
  21   _NUM,
  22   _FUNC,
  23   _EMOJI,
  24   _GUI,
  25 };
  26
  27 enum planck_keycodes {
  28   // layouts
  29   QWERTY = SAFE_RANGE,
  30   COLEMAK,
  31   WORKMAN,
  32
  33   // layer switchers
  34   PUNC,
  35   NUM,
  36   FUNC,
  37   EMOJI,
  38   GUI,
  39
  40   // os switchers
  41   LINUX,
  42   WIN,
  43   OSX,
  44 };
  45
  46 // Fillers to make layering clearer
  47
  48 #define _______ KC_TRNS
  49 #define XXXXXXX KC_NO
  50
  51 // unicode map
  52
  53 enum unicode_name {
  54   GRIN, // grinning face 😊
  55   TJOY, // tears of joy 😂
  56   SMILE, // grining face with smiling eyes 😁
  57   HEART, // heart ❤
  58   EYERT, // smiling face with heart shaped eyes 😍
  59   CRY, // crying face 😭
  60   SMEYE, // smiling face with smiling eyes 😊
  61   UNAMU, // unamused 😒
  62   KISS, // kiss 😘
  63   HART2, // two hearts 💕
  64   WEARY, // weary 😩
  65   OKHND, // ok hand sign 👌
  66   PENSV, // pensive 😔
  67   SMIRK, // smirk 😏
  68   RECYC, // recycle ♻
  69   WINK, // wink 😉
  70   THMUP, // thumb up 👍
  71   THMDN, // thumb down 👎
  72   PRAY, // pray 🙏
  73   PHEW, // relieved 😌
  74   MUSIC, // musical notes
  75   FLUSH, // flushed 😳
  76   CELEB, // celebration 🙌
  77   CRY2, // crying face 😢
  78   COOL, // smile with sunglasses 😎
  79   NOEVS, // see no evil
  80   NOEVH, // hear no evil
  81   NOEVK, // speak no evil
  82   POO, // pile of poo
  83   EYES, // eyes
  84   VIC, // victory hand
  85   BHART, // broken heart
  86   SLEEP, // sleeping face
  87   SMIL2, // smiling face with open mouth & sweat
  88   HUNRD, // 100
  89   CONFU, // confused
  90   TONGU, // face with tongue & winking eye
  91   DISAP, // disappointed
  92   YUMMY, // face savoring delicious food
  93   CLAP, // hand clapping
  94   FEAR, // face screaming in fear
  95   HORNS, // smiling face with horns
  96   HALO, // smiling face with halo
  97   BYE, // waving hand
  98   SUN, // sun
  99   MOON, // moon
 100   SKULL, // skull
 101 };
 102
 103 const uint32_t PROGMEM unicode_map[] = {
 104   [GRIN] = 0x1F600,
 105   [TJOY] = 0x1F602,
 106   [SMILE] = 0x1F601,
 107   [HEART] = 0x2764,
 108   [EYERT] = 0x1f60d,
 109   [CRY] = 0x1f62d,
 110   [SMEYE] = 0x1F60A,
 111   [UNAMU] = 0x1F612,
 112   [KISS] = 0x1F618,
 113   [HART2] = 0x1F495,
 114   [WEARY] = 0x1F629,
 115   [OKHND] = 0x1F44C,
 116   [PENSV] = 0x1F614,
 117   [SMIRK] = 0x1F60F,
 118   [RECYC] = 0x267B,
 119   [WINK] = 0x1F609,
 120   [THMUP] = 0x1F44D,
 121   [THMDN] = 0x1F44E,
 122   [PRAY] = 0x1F64F,
 123   [PHEW] = 0x1F60C,
 124   [MUSIC] = 0x1F3B6,
 125   [FLUSH] = 0x1F633,
 126   [CELEB] = 0x1F64C,
 127   [CRY2] = 0x1F622,
 128   [COOL] = 0x1F60E,
 129   [NOEVS] = 0x1F648,
 130   [NOEVH] = 0x1F649,
 131   [NOEVK] = 0x1F64A,
 132   [POO] = 0x1F4A9,
 133   [EYES] = 0x1F440,
 134   [VIC] = 0x270C,
 135   [BHART] = 0x1F494,
 136   [SLEEP] = 0x1F634,
 137   [SMIL2] = 0x1F605,
 138   [HUNRD] = 0x1F4AF,
 139   [CONFU] = 0x1F615,
 140   [TONGU] = 0x1F61C,
 141   [DISAP] = 0x1F61E,
 142   [YUMMY] = 0x1F60B,
 143   [CLAP] = 0x1F44F,
 144   [FEAR] = 0x1F631,
 145   [HORNS] = 0x1F608,
 146   [HALO] = 0x1F607,
 147   [BYE] = 0x1F44B,
 148   [SUN] = 0x2600,
 149   [MOON] = 0x1F314,
 150   [SKULL] = 0x1F480,
 151 };
 152
 153
 154 // hybrid shift - =
 155 // #undef KC_LSFT
 156 // #define KC_LSFT MT(MOD_LSFT, KC_MINS)
 157 // #undef KC_RSFT
 158 // #define KC_RSFT MT(MOD_LSFT, KC_EQL)
 159
 160
 161 // hybrid right-gui & scroll lock (mapped to Compose in OS)
 162 #undef KC_RCTL
 163 #define KC_RCTL MT(MOD_LCTL, KC_SLCK)
 164
 165 // keymaps
 166
 167 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 168
 169 /* Qwerty
 170  * ,-----------------------------------------------------------------------------------.
 171  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
 172  * |------+------+------+------+------+-------------+------+------+------+------+------|
 173  * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |Enter |
 174  * |------+------+------+------+------+------|------+------+------+------+------+------|
 175  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Shift |
 176  * |------+------+------+------+------+------+------+------+------+------+------+------|
 177  * | Ctrl | GUI  | Alt  | Punc | Num  |    Space    | Func |Emoji |AltGr | GUI  | Ctrl |
 178  * `-----------------------------------------------------------------------------------'
 179  */
 180 [_QWERTY] = {
 181   {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
 182   {KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_ENT },
 183   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
 184   {KC_LCTL, KC_LGUI, KC_LALT, PUNC,    NUM,     KC_SPC,  KC_SPC,  FUNC,    EMOJI,   KC_RALT, KC_RGUI, KC_RCTL}
 185 },
 186
 187 /* Colemak
 188  * ,-----------------------------------------------------------------------------------.
 189  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
 190  * |------+------+------+------+------+-------------+------+------+------+------+------|
 191  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |Enter |
 192  * |------+------+------+------+------+------|------+------+------+------+------+------|
 193  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Shift |
 194  * |------+------+------+------+------+------+------+------+------+------+------+------|
 195  * | Ctrl | GUI  | Alt  | Punc | Num  |    Space    | Func |Emoji |AltGr | GUI  | Ctrl |
 196  * `-----------------------------------------------------------------------------------'
 197  */
 198 [_COLEMAK] = {
 199   {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
 200   {KC_ESC,  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_ENT },
 201   {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
 202   {KC_LCTL, KC_LGUI, KC_LALT, PUNC,    NUM,     KC_SPC,  KC_SPC,  FUNC,    EMOJI,   KC_RALT, KC_RGUI, KC_RCTL}
 203 },
 204
 205 /* Workman
 206  * ,-----------------------------------------------------------------------------------.
 207  * | Tab  |   Q  |   D  |   R  |   W  |   B  |   J  |   F  |   U  |   P  |   ;  | Bksp |
 208  * |------+------+------+------+------+-------------+------+------+------+------+------|
 209  * | Esc  |   A  |   S  |   H  |   T  |   G  |   Y  |   N  |   E  |   O  |   I  |Enter |
 210  * |------+------+------+------+------+------|------+------+------+------+------+------|
 211  * | Shift|   Z  |   X  |   M  |   C  |   V  |   K  |   K  |   ,  |   .  |   /  |Shift |
 212  * |------+------+------+------+------+------+------+------+------+------+------+------|
 213  * | Ctrl | GUI  | Alt  | Punc | Num  |    Space    | Func |Emoji |AltGr | GUI  | Ctrl |
 214  * `-----------------------------------------------------------------------------------'
 215  */
 216 [_WORKMAN] = {
 217   {KC_TAB,  KC_Q,    KC_D,    KC_R,    KC_W,    KC_B,    KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN, KC_BSPC},
 218   {KC_ESC,  KC_A,    KC_S,    KC_H,    KC_T,    KC_G,    KC_Y,    KC_N,    KC_E,    KC_O,    KC_I,    KC_ENT },
 219   {KC_LSFT, KC_Z,    KC_X,    KC_M,    KC_C,    KC_V,    KC_K,    KC_L,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
 220   {KC_LCTL, KC_LGUI, KC_LALT, PUNC,    NUM,     KC_SPC,  KC_SPC,  FUNC,    EMOJI,   KC_RALT, KC_RGUI, KC_RCTL}
 221 },
 222
 223 /* Punc
 224  * ,-----------------------------------------------------------------------------------.
 225  * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |   `  |
 226  * |------+------+------+------+------+-------------+------+------+------+------+------|
 227  * |      |      |   \  |   -  |   =  |   <  |   >  |   (  |   )  |   '  |      |      |
 228  * |------+------+------+------+------+------|------+------+------+------+------+------|
 229  * |      |      |   |  |   _  |   +  |   {  |   }  |   [  |   ]  |   "  |      |      |
 230  * |------+------+------+------+------+------+------+------+------+------+------+------|
 231  * |      |      |      |      |      |             |      |      |      |      |      |
 232  * `-----------------------------------------------------------------------------------'
 233  */
 234 [_PUNC] = {
 235   {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_GRV },
 236   {XXXXXXX, XXXXXXX, KC_BSLS, KC_MINS,  KC_EQL, KC_LABK, KC_RABK, KC_LPRN, KC_RPRN, KC_QUOT, XXXXXXX, XXXXXXX},
 237   {XXXXXXX, XXXXXXX, KC_PIPE, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, KC_DQUO, XXXXXXX, XXXXXXX},
 238   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 239 },
 240
 241 /* Num
 242  * ,-----------------------------------------------------------------------------------.
 243  * |  ^   |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
 244  * |------+------+------+------+------+-------------+------+------+------+------+------|
 245  * | Esc  |  @   |  A   |  B   |  C   |  (   |  )   |   4  |   5  |   6  |   :  |Enter |
 246  * |------+------+------+------+------+------|------+------+------+------+------+------|
 247  * |  &   |  #   |  D   |  E   |  F   |  [   |  ]   |   1  |   2  |   3  |   /  |  *   |
 248  * |------+------+------+------+------+------+------+------+------+------+------+------|
 249  * |      |      |      |  x   |      |             |   0  |   ,  |   .  |   +  |  -   |
 250  * `-----------------------------------------------------------------------------------'
 251  */
 252 [_NUM] = {
 253   {KC_CIRC,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0, KC_BSPC},
 254   { KC_ESC,   KC_AT, S(KC_A), S(KC_B), S(KC_C), KC_LPRN, KC_RPRN,    KC_4,    KC_5,    KC_6, KC_COLN,  KC_ENT},
 255   {KC_AMPR, KC_HASH, S(KC_D), S(KC_E), S(KC_F), KC_LBRC, KC_RBRC,    KC_1,    KC_2,    KC_3, KC_SLSH, KC_ASTR},
 256   {_______, _______, _______,    KC_X, _______,  KC_SPC,  KC_SPC,    KC_0, KC_COMM,  KC_DOT, KC_PLUS, KC_MINS}
 257 },
 258
 259 /* Func
 260  * ,-----------------------------------------------------------------------------------.
 261  * |      |  F1  |  F2  |  F3  |  F4  |      |      | PgUp |  Up  | PgDn | PgUp | Del  |
 262  * |------+------+------+------+------+-------------+------+------+------+------+------|
 263  * |      |  F5  |  F6  |  F7  |  F8  |PrtSc |      | Left | Down | Right| PgDn | Ins  |
 264  * |------+------+------+------+------+------|------+------+------+------+------+------|
 265  * |      |  F9  |  F10 |  F11 |  F12 |      |      |      | Home |  End |      |      |
 266  * |------+------+------+------+------+------+------+------+------+------+------+------|
 267  * |      |      |      |      |      |             |      |      |      |      |      |
 268  * `-----------------------------------------------------------------------------------'
 269  */
 270 [_FUNC] = {
 271   {XXXXXXX,   KC_F1,   KC_F2,   KC_F3,   KC_F4, XXXXXXX, XXXXXXX, KC_PGUP,   KC_UP, KC_PGDN, KC_PGUP,  KC_DEL},
 272   {XXXXXXX,   KC_F5,   KC_F6,   KC_F7,  KC_F8,KC_PSCREEN,XXXXXXX, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN,  KC_INS},
 273   {_______,   KC_F9,  KC_F10,  KC_F11,  KC_F12, XXXXXXX, XXXXXXX, XXXXXXX, KC_HOME,  KC_END, XXXXXXX, _______},
 274   {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
 275 },
 276
 277 /* Emoji
 278  * ,-----------------------------------------------------------------------------------.
 279  * |      |      |      |      |      |      |      |      |      |      |      |      |
 280  * |------+------+------+------+------+-------------+------+------+------+------+------|
 281  * |      |      |      |      |      |      |      |      |      |      |      |      |
 282  * |------+------+------+------+------+------+------+------+------+------+------+------|
 283  * |      |      |      |      |      |      |      |      |      |      |      |      |
 284  * |------+------+------+------+------+------+------+------+------+------+------+------|
 285  * |      |      |      |      |      |      |      |      |      |      |      |      |
 286  * `-----------------------------------------------------------------------------------'
 287  */
 288 [_EMOJI] = {
 289   {X(HART2), X(CRY2),X(WEARY),X(EYERT),X(SMIRK), X(TJOY),X(RECYC),X(UNAMU),X(MUSIC),X(OKHND),X(PENSV), X(PHEW)},
 290   {X(THMUP), X(PRAY),X(SMILE),X(SMIL2),X(FLUSH), X(GRIN),X(HEART),  X(BYE), X(KISS),X(CELEB), X(COOL),X(NOEVS)},
 291   {X(THMDN),X(SLEEP), X(CLAP),  X(CRY),  X(VIC),X(BHART),  X(SUN),X(SMEYE), X(WINK), X(MOON),X(CONFU),X(NOEVH)},
 292   {  X(POO), X(EYES),X(HUNRD), _______,X(SKULL),X(HORNS), X(HALO), X(FEAR), _______,X(YUMMY),X(DISAP),X(NOEVK)}
 293 },
 294
 295 /* GUI
 296  * ,-----------------------------------------------------------------------------------.
 297  * |      |  D1  |  D2  |  D3  |  D4  |  D5  |  D6  |  D7  |  D8  |  D9  |  D10 |      |
 298  * |------+------+------+------+------+-------------+------+------+------+------+------|
 299  * |Linux |      | Vol- | Mute | Vol+ |      |      |  D-  |      |  D+  |      |Qwerty|
 300  * |------+------+------+------+------+------+------+------+------+------+------+------|
 301  * | Win  |      | Prev | Play | Next |      |      |      |      |      |      |Colmak|
 302  * |------+------+------+------+------+------+------+------+------+------+------+------|
 303  * | OSX  |      |      |      |      |  BL- |  BL+ |      |      |      |      |Workmn|
 304  * `-----------------------------------------------------------------------------------'
 305  */
 306 [_GUI] = {
 307   {_______, LGUI(KC_1),LGUI(KC_2),LGUI(KC_3),LGUI(KC_4),LGUI(KC_5),LGUI(KC_6),LGUI(KC_7),LGUI(KC_8),LGUI(KC_9),LGUI(KC_0), _______},
 308   {  LINUX, _______, KC_VOLD, KC_MUTE, KC_VOLU,_______,_______,KC_WWW_BACK,_______,KC_WWW_FORWARD,_______, QWERTY},
 309   {    WIN, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, _______, _______, _______, COLEMAK},
 310   {    OSX, _______, _______, _______, _______,  BL_DEC,  BL_INC, _______, _______, _______, _______, WORKMAN}
 311 },
 312
 313 };
 314
 315 #ifdef AUDIO_ENABLE
 316 float tone_startup[][2]    = SONG(STARTUP_SOUND);
 317 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 318 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 319 float tone_workman[][2]    = SONG(DVORAK_SOUND);
 320 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
 321 float tone_linux[][2] = SONG(CAPS_LOCK_ON_SOUND);
 322 float tone_windows[][2] = SONG(SCROLL_LOCK_ON_SOUND);
 323 float tone_osx[][2] = SONG(NUM_LOCK_ON_SOUND);
 324 float tone_click[][2] = SONG(MUSICAL_NOTE(_F3, 2));
 325 #endif
 326
 327 void persistant_default_layer_set(uint16_t default_layer) {
 328   eeconfig_update_default_layer(default_layer);
 329   default_layer_set(default_layer);
 330 }
 331
 332 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 333   // faux clicky
 334   if (record->event.pressed) PLAY_NOTE_ARRAY(tone_click, false, 0);
 335
 336   switch (keycode) {
 337     case QWERTY:
 338       if (record->event.pressed) {
 339         #ifdef AUDIO_ENABLE
 340           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
 341         #endif
 342         persistant_default_layer_set(1UL<<_QWERTY);
 343       }
 344       return false;
 345       break;
 346     case COLEMAK:
 347       if (record->event.pressed) {
 348         #ifdef AUDIO_ENABLE
 349           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
 350         #endif
 351         persistant_default_layer_set(1UL<<_COLEMAK);
 352       }
 353       return false;
 354       break;
 355     case WORKMAN:
 356       if (record->event.pressed) {
 357         #ifdef AUDIO_ENABLE
 358           PLAY_NOTE_ARRAY(tone_workman, false, 0);
 359         #endif
 360         persistant_default_layer_set(1UL<<_WORKMAN);
 361       }
 362       return false;
 363       break;
 364     case PUNC:
 365       if (record->event.pressed) {
 366         layer_on(_PUNC);
 367         update_tri_layer(_PUNC, _EMOJI, _GUI);
 368       } else {
 369         layer_off(_PUNC);
 370         update_tri_layer(_PUNC, _EMOJI, _GUI);
 371       }
 372       return false;
 373       break;
 374     case EMOJI:
 375       if (record->event.pressed) {
 376         layer_on(_EMOJI);
 377         update_tri_layer(_PUNC, _EMOJI, _GUI);
 378       } else {
 379         layer_off(_EMOJI);
 380         update_tri_layer(_PUNC, _EMOJI, _GUI);
 381       }
 382       return false;
 383       break;
 384     case NUM:
 385       if (record->event.pressed) {
 386         layer_on(_NUM);
 387       } else {
 388         layer_off(_NUM);
 389       }
 390       return false;
 391       break;
 392     case FUNC:
 393       if (record->event.pressed) {
 394         layer_on(_FUNC);
 395       } else {
 396         layer_off(_FUNC);
 397       }
 398       return false;
 399       break;
 400     case LINUX:
 401       set_unicode_input_mode(UC_LNX);
 402       #ifdef AUDIO_ENABLE
 403         PLAY_NOTE_ARRAY(tone_linux, false, 0);
 404       #endif
 405       return false;
 406       break;
 407     case WIN:
 408       set_unicode_input_mode(UC_WINC);
 409       #ifdef AUDIO_ENABLE
 410         PLAY_NOTE_ARRAY(tone_windows, false, 0);
 411       #endif
 412       return false;
 413       break;
 414     case OSX:
 415       set_unicode_input_mode(UC_OSX);
 416       #ifdef AUDIO_ENABLE
 417         PLAY_NOTE_ARRAY(tone_osx, false, 0);
 418       #endif
 419       return false;
 420       break;
 421   }
 422   return true;
 423 }
 424
 425 void matrix_init_user(void) {
 426   #ifdef AUDIO_ENABLE
 427       startup_user();
 428   #endif
 429   set_unicode_input_mode(UC_LNX);
 430 }
 431
 432 #ifdef AUDIO_ENABLE
 433
 434 void startup_user()
 435 {
 436     _delay_ms(20); // gets rid of tick
 437     PLAY_NOTE_ARRAY(tone_startup, false, 0);
 438 }
 439
 440 void shutdown_user()
 441 {
 442     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
 443     _delay_ms(150);
 444     stop_all_notes();
 445 }
 446
 447 #endif