Add support for Encoders mapped into the keymap array

builddefs/generic_features.mk

@@ -23,7 +23,6 @@ GENERIC_FEATURES = \
     DIP_SWITCH \
     DYNAMIC_KEYMAP \
     DYNAMIC_MACRO \
-    ENCODER \
     GRAVE_ESC \
     HAPTIC \
     KEY_LOCK \

common_features.mk

@@ -411,6 +411,15 @@ ifeq ($(strip $(TERMINAL_ENABLE)), yes)
     OPT_DEFS += -DUSER_PRINT
 endif
 
+
+ifeq ($(strip $(ENCODER_ENABLE)), yes)
+    SRC += $(QUANTUM_DIR)/encoder.c
+    OPT_DEFS += -DENCODER_ENABLE
+    ifeq ($(strip $(ENCODER_KEYMAP_MAPPING_ENABLE)), yes)
+        OPT_DEFS += -DENCODER_KEYMAP_MAPPING_ENABLE
+    endif
+endif
+
 ifeq ($(strip $(VIA_ENABLE)), yes)
     DYNAMIC_KEYMAP_ENABLE := yes
     RAW_ENABLE := yes

docs/feature_encoders.md

@@ -54,6 +54,34 @@ If you are using different pinouts for the encoders on each half of a split keyb
 #define ENCODER_RESOLUTIONS_RIGHT { 2, 4 }
 ```
 
+?> Note: When using Encoders with split keyboards, it assumes that you have double the number of encoders. If not all encoders are populated, then you may need to skip indexes. 
+
+## Mapping Encoder Functions to the Keymap
+
+By enabling this config, you can place the keycodes for the encoders directly in the keymap itself.  If you have extra spots in your matrix (eg, not populated), you can use those locations.  To enable this you need to add a define that lists the row and column location to use. 
+
+Add this ton your `rules.mk`:
+
+```make
+ENCODER_KEYMAP_MAPPING_ENABLE = yes
+```
+
+And then add the configuration for the encoders in your `config.h`:
+
+```c
+#define ENCODER_KEYMAPPING { { 4, 0 }, { 4, 1 } }, { { 5, 0 }, { 5, 1 } }
+```
+
+This tells it to use row 4, column 0 for counter clockwise, row 4 column 1 for clockwise, and then row 5 column 0 and 1 for the second encoder.  
+
+This works with most keycodes.  Tap-Hold keys may not work well for this, nor will special keys, like tap dances.  However, this will work with quantum keycodes, as well as custom macros. 
+
+Additionally, this will explicitly disable callback functionality if defined, and solely handle the encoders through the keymap. Alternatievly, you can add `#define ENCODER_PROCESS_CALLBACKS` to allow the callbacks to continue working.  And returning false in the callbacks will prevent it from handling the encoder keymap configuration.
+
+?> Note: With Split Keyboards, you will want to define all of the possible positions. Meaning you should have double the number of encoder locations as you have "pads" defined for the encoder.
+
+?> Note: When adding support for this, you may want to consider adding an additional layout for those that don't wish to use this functionality.
+
 ## Callbacks
 
 The callback functions can be inserted into your `<keyboard>.c`:

keyboards/monarch/config.h

@@ -36,6 +36,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define ENCODERS_PAD_A { B4 }
 #define ENCODERS_PAD_B { B5 }
 #define ENCODER_RESOLUTION 1
+#define ENCODER_KEYMAPPING { { 5, 0 }, { 5, 1 } }
 
 //LEDS A6
 #define BACKLIGHT_PIN A6

keyboards/monarch/keymaps/via/keymap.c

@@ -51,40 +51,3 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
       _______, _______
   )
 };
-
-keyevent_t encoder_ccw = {
-    .key = (keypos_t){.row = 5, .col = 0},
-    .pressed = false
-};
-
-keyevent_t encoder_cw = {
-    .key = (keypos_t){.row = 5, .col = 1},
-    .pressed = false
-};
-
-void matrix_scan_user(void) {
-    if (IS_PRESSED(encoder_ccw)) {
-        encoder_ccw.pressed = false;
-        encoder_ccw.time = (timer_read() | 1);
-        action_exec(encoder_ccw);
-    }
-
-    if (IS_PRESSED(encoder_cw)) {
-        encoder_cw.pressed = false;
-        encoder_cw.time = (timer_read() | 1);
-        action_exec(encoder_cw);
-    }
-}
-
-bool encoder_update_user(uint8_t index, bool clockwise) {
-    if (clockwise) {
-        encoder_cw.pressed = true;
-        encoder_cw.time = (timer_read() | 1);
-        action_exec(encoder_cw);
-    } else {
-        encoder_ccw.pressed = true;
-        encoder_ccw.time = (timer_read() | 1);
-        action_exec(encoder_ccw);
-    }
-    return true;
-}

keyboards/monarch/keymaps/via/rules.mk

@@ -1 +1,2 @@
 VIA_ENABLE = yes
+ENCODER_KEYMAP_MAPPING_ENABLE = yes

keyboards/nightly_boards/adellein/adellein.c

@@ -15,14 +15,3 @@
  */
 
 #include "adellein.h"
-
-void matrix_scan_kb(void) {
-    encoder_action_unregister();
-    matrix_scan_user();
-}
-
-bool encoder_update_kb(uint8_t index, bool clockwise) {
-//    if (!encoder_update_user(index, clockwise)) return false;
-    encoder_action_register(index, clockwise);
-    return true;
-};

keyboards/nightly_boards/adellein/adellein.h

@@ -17,7 +17,6 @@
 #pragma once
 
 #include "quantum.h"
-#include "encoder_action.h"
 
 /* This is a shortcut to help you visually see your layout.
  *
@@ -52,4 +51,3 @@
     { K20,   K21,   K22,   K23,   K24,   K25,   K26,   K27,   K28,   K29,   K2A,   K2B,   K2C   }, \
     { K30,   E00A,  K32,  E00B,   K34,   K35,   KC_NO, K37,   KC_NO, K39,   KC_NO, KC_NO, K3C   }, \
 }
-

keyboards/nightly_boards/adellein/config.h

@@ -55,14 +55,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #endif
 
 /* Encoders */
-
-#define ENCODERS 1
-
 #define ENCODERS_PAD_A { C7 }
 #define ENCODERS_PAD_B { C6 }
 
-#define ENCODERS_CW_KEY  { { 3, 3 } }
-#define ENCODERS_CCW_KEY { { 1, 3 } }
+#define ENCODER_KEYMAPPING { { 3, 3 }, { 3, 1} }
 
 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 #define DEBOUNCE 5
@@ -74,5 +70,3 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define LOCKING_SUPPORT_ENABLE
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
-
-

keyboards/nightly_boards/adellein/rules.mk

@@ -22,4 +22,4 @@ ENCODER_ENABLE = yes          # Enable Rotary Encoders
 LTO_ENABLE = yes
 
 # Added encoder Action
-SRC += encoder_action.c
+ENCODER_KEYMAP_MAPPING_ENABLE = yes

keyboards/nightly_boards/n40_o/config.h

@@ -56,13 +56,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 /* Encoders */
 
-#define ENCODERS 3
-
 #define ENCODERS_PAD_A { F6, F4 , B6 }
 #define ENCODERS_PAD_B { F7, F5 , C6 }
 
-#define ENCODERS_CW_KEY  { { 2, 4 },{ 4, 4 },{ 6, 4 } }
-#define ENCODERS_CCW_KEY { { 1, 4 },{ 3, 4 },{ 5, 4 } }
+#define ENCODER_KEYMAPPING { { 4, 1 }, { 4, 2 } }, { { 4, 3 }, { 4, 4 } }, { { 4, 5 }, { 4, 6 } }
 
 /* Audio */
 

keyboards/nightly_boards/n40_o/n40_o.c

@@ -15,14 +15,3 @@
  */
 
 #include "n40_o.h"
-
-void matrix_scan_kb(void) {
-    encoder_action_unregister();
-    matrix_scan_user();
-}
-
-bool encoder_update_kb(uint8_t index, bool clockwise) {
-//    if (!encoder_update_user(index, clockwise)) return false;
-    encoder_action_register(index, clockwise);
-    return true;
-};

keyboards/nightly_boards/n40_o/n40_o.h

@@ -17,7 +17,6 @@
 #pragma once
 
 #include "quantum.h"
-#include "encoder_action.h"
 
 /* This is a shortcut to help you visually see your layout.
  *

keyboards/nightly_boards/n40_o/rules.mk

@@ -23,4 +23,4 @@ ENCODER_ENABLE = yes          # Enable Rotary Encoders
 LTO_ENABLE = yes
 
 # Added encoder Action
-SRC += encoder_action.c
+ENCODER_KEYMAP_MAPPING_ENABLE = yes

keyboards/nightly_boards/n60_s/config.h

@@ -49,13 +49,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 /* Encoders */
 
-#define ENCODERS 1
-
 #define ENCODERS_PAD_A { D3 }
 #define ENCODERS_PAD_B { D5 }
 
-#define ENCODERS_CW_KEY  { { 1, 5 } }
-#define ENCODERS_CCW_KEY { { 0, 5 } }
+#define ENCODER_KEYMAPPING { { 5, 0 }, { 5, 1 } }
 
 /* Audio */