Merge pull request #7 from fsargent/EncoderDocs

Added docs around encoder pins
nullbitsco · Jul 14, 2021 · e891938 · e891938
2 parents c381ff8 + 2fcf567
commit e891938
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 2 deletions.
diff --git a/config.h b/config.h
@@ -30,5 +30,21 @@
 #define RGBLIGHT_ANIMATIONS
 
 /* Additional optional encoder pins */
-// #define ENCODERS_PAD_A { D1, D0 } //Can only be used if I2C is not used
-// #define ENCODERS_PAD_B { D3, D2 } //Can only be used if serial (exp) is not used
+
+// You can mix/match pins within the ENCODERS_PAD_A and ENCODERS_PAD_B defines.
+
+// Encoder 1 Pins:
+// #define ENCODERS_PAD_A { B2 }
+// #define ENCODERS_PAD_B { B3 }
+
+// Encoder 2 Pins:
+// #define ENCODERS_PAD_A { B4 }
+// #define ENCODERS_PAD_B { B5 }
+
+// Encoder 3 Pins: ⚠️ Compatibility note: encoder 3 shares the drive signals with the I2C bus. It can not be used at the same time as the OLED, alphanumeric display, or LED matrix options.
+// #define ENCODERS_PAD_A { D0 }
+// #define ENCODERS_PAD_B { D1 }
+
+// Encoder 4 Pins: ⚠️ Compatibility note: encoder 4 shares the drive signals with the UART bus. It can not be used at the same time as the expansion port.
+// #define ENCODERS_PAD_A { D2 }
+// #define ENCODERS_PAD_B { D3 }
diff --git a/keymaps/14seg/config.h b/keymaps/14seg/config.h
@@ -15,5 +15,6 @@
  */
 
 
+// Encoders are defined in order. 1: B2 & B3, 2: B4 & B5, 3: D0 & D1, 4: D2 & D3
 #define ENCODERS_PAD_A { B2 }
 #define ENCODERS_PAD_B { B3 }
diff --git a/keymaps/19keypad/config.h b/keymaps/19keypad/config.h
@@ -16,5 +16,6 @@
 
 #define TAPPING_TERM 200
 
+// Encoders are defined in order. 1: B2 & B3, 2: B4 & B5, 3: D0 & D1, 4: D2 & D3
 #define ENCODERS_PAD_A { D3 }
 #define ENCODERS_PAD_B { D2 }
diff --git a/keymaps/4rotary/config.h b/keymaps/4rotary/config.h
@@ -16,5 +16,6 @@
 
 #define TAPPING_TERM 200
 
+// Encoders are defined in order. 1: B2 & B3, 2: B4 & B5, 3: D0 & D1, 4: D2 & D3
 #define ENCODERS_PAD_A { B2, B4, D0, D2 }
 #define ENCODERS_PAD_B { B3, B5, D1, D3 }
diff --git a/keymaps/oled/config.h b/keymaps/oled/config.h
@@ -16,5 +16,6 @@
 
 #define TAPPING_TERM 200
 
+// Encoders are defined in order. 1: B2 & B3, 2: B4 & B5, 3: D0 & D1, 4: D2 & D3
 #define ENCODERS_PAD_A { B2 }
 #define ENCODERS_PAD_B { B3 }
diff --git a/keymaps/via/config.h b/keymaps/via/config.h
@@ -15,5 +15,6 @@
  */
 
 
+// Encoders are defined in order. 1: B2 & B3, 2: B4 & B5, 3: D0 & D1, 4: D2 & D3
 #define ENCODERS_PAD_A { B2 }
 #define ENCODERS_PAD_B { B3 }