keybrd library is an open source library for creating custom-keyboard firmware.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

keybrd_3d_sublayerNestedKeys.ino 3.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /* keybrd_3d_sublayerNested.ino
  2. This sketch:
  3. is firmware for layout with 2 layers plus 1 sublayer.
  4. runs on the first three columns of a breadboard keyboard
  5. | Layout | **0** | **1** | **2** |
  6. |:------:|:-----:|:-----:|:-----:|
  7. | **0** | a - 1 | b = | c Num |
  8. | **1** | Alpha | Sym | Enter |
  9. */
  10. // ################## GLOBAL ###################
  11. // ================= INCLUDES ==================
  12. //Keys
  13. #include <Code_Sc.h>
  14. #include <LayerState.h>
  15. #include <Code_LayerLock.h>
  16. #include <Code_LayerHold.h>
  17. #include <Key_LayeredKeys.h>
  18. #include <Key_LayeredKeys1.h>
  19. //Matrix
  20. #include <Row.h>
  21. #include <Scanner_uC.h>
  22. #include <ScanDelay.h>
  23. // ============ SPEED CONFIGURATION ============
  24. ScanDelay scanDelay(9000);
  25. // ================== SCANNER ==================
  26. uint8_t readPins[] = {14, 15, 16};
  27. uint8_t readPinCount = sizeof(readPins)/sizeof(*readPins);
  28. Scanner_uC scanner(LOW, readPins, readPinCount);
  29. // =================== CODES ===================
  30. // ----------------- LAYER CODE ----------------
  31. enum layers { ALPHA, SYM };
  32. LayerState layerState;
  33. Code_LayerLock l_normal(ALPHA, layerState);
  34. Code_LayerLock l_sym(SYM, layerState);
  35. /*
  36. Key_LayeredKeys are associated with layerState.
  37. */
  38. LayerStateInterface& Key_LayeredKeys::refLayerState = layerState;
  39. /* ---------------- SUBLAYER CODE --------------
  40. Sublayers are implemented just like primary layers.
  41. */
  42. enum subLayers { SUBSYM, SUBNUM };
  43. LayerState sublayerState;
  44. Code_LayerHold l_num(SUBNUM, sublayerState);
  45. /*
  46. Key_LayeredKeys1 are associated with sublayerState.
  47. Key_LayeredKeys (in layer) and Key_LayeredKeys1 (in sublayer) classes are nearly identical,
  48. only the static refLayerState are different.
  49. */
  50. LayerStateInterface& Key_LayeredKeys1::refLayerState = sublayerState;
  51. // ---------------- SCAN CODES -----------------
  52. Code_Sc s_a(KEY_A);
  53. Code_Sc s_b(KEY_B);
  54. Code_Sc s_c(KEY_C);
  55. Code_Sc s_minus(KEY_MINUS);
  56. Code_Sc s_equal(KEY_EQUAL);
  57. Code_Sc s_enter(KEY_ENTER);
  58. Code_Sc s_1(KEY_1);
  59. /* =================== KEYS ====================
  60. The key k_sub00 contains codes for layerIds SUBSYM and SUBNUM.
  61. (The Num sublayer only has one key because small example. Usually sublayers have multiple keys.)
  62. */
  63. Key* const ptrsKeys_sub00[] = { &s_minus, &s_1 };
  64. Key_LayeredKeys1 k_sub00(ptrsKeys_sub00);
  65. /*
  66. k_sub00 is nested in k_00.
  67. The key k_00 contains code and key for layerIds ALPHA and SYM.
  68. Notice that k_sub00 is of type Key_LayeredKeys1, while k_00 is of type Key_LayeredKeys.
  69. k_sub00 and k_00 are associated with distinct LayerStates.
  70. */
  71. Key* const ptrsKeys_00[] = { &s_a, &k_sub00 };
  72. Key_LayeredKeys k_00(ptrsKeys_00);
  73. Key* const ptrsKeys_01[] = { &s_b, &s_equal };
  74. Key_LayeredKeys k_01(ptrsKeys_01);
  75. Key* const ptrsKeys_02[] = { &s_c, &l_num };
  76. Key_LayeredKeys k_02(ptrsKeys_02);
  77. // =================== ROWS ====================
  78. Key* const ptrsKeys_0[] = { &k_00, &k_01, &k_02 };
  79. uint8_t keyCount_0 = sizeof(ptrsKeys_0)/sizeof(*ptrsKeys_0);
  80. Row row_0(scanner, 0, ptrsKeys_0, keyCount_0);
  81. Key* const ptrsKeys_1[] = { &l_normal, &l_sym, &s_enter };
  82. uint8_t keyCount_1 = sizeof(ptrsKeys_1)/sizeof(*ptrsKeys_1);
  83. Row row_1(scanner, 1, ptrsKeys_1, keyCount_1);
  84. // ################### MAIN ####################
  85. void setup()
  86. {
  87. Keyboard.begin();
  88. }
  89. void loop()
  90. {
  91. row_0.process();
  92. row_1.process();
  93. scanDelay.delay();
  94. }