darkkirb/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Per-encoder resolutions (#10259)

Browse source 
* Per-encoder resolutions

* Resolutions for right hand
This commit is contained in:
Ryan 2020-10-04 06:00:21 +11:00 committed by James Young
parent f728c249ce
commit 310662fce9
No known key found for this signature in database
GPG key ID: 8E1085BF6FCFBD74
2 changed files with 28 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/feature_encoders.md
View file

@ -32,13 +32,20 @@ Additionally, the resolution, which defines how many pulses the encoder register
#define ENCODER_RESOLUTION 4 #define ENCODER_RESOLUTION 4
``` ```
It can also be defined per-encoder, by instead defining:
```c
#define ENCODER_RESOLUTIONS { 4, 2 }
```
## Split Keyboards ## Split Keyboards
If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout for the right half like this: If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout (and optionally, resolutions) for the right half like this:
```c ```c
#define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a } #define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a }
#define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b } #define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b }
#define ENCODER_RESOLUTIONS_RIGHT { 2, 4 }
``` ```
## Callbacks ## Callbacks

24
quantum/encoder.c
View file

@ -23,7 +23,7 @@
// for memcpy // for memcpy
#include <string.h> #include <string.h>
#ifndef ENCODER_RESOLUTION #if !defined(ENCODER_RESOLUTIONS) && !defined(ENCODER_RESOLUTION)
# define ENCODER_RESOLUTION 4 # define ENCODER_RESOLUTION 4
#endif #endif
@ -34,6 +34,9 @@
#define NUMBER_OF_ENCODERS (sizeof(encoders_pad_a) / sizeof(pin_t)) #define NUMBER_OF_ENCODERS (sizeof(encoders_pad_a) / sizeof(pin_t))
static pin_t encoders_pad_a[] = ENCODERS_PAD_A; static pin_t encoders_pad_a[] = ENCODERS_PAD_A;
static pin_t encoders_pad_b[] = ENCODERS_PAD_B; static pin_t encoders_pad_b[] = ENCODERS_PAD_B;
#ifdef ENCODER_RESOLUTIONS
static uint8_t encoder_resolutions[] = ENCODER_RESOLUTIONS;
#endif
#ifndef ENCODER_DIRECTION_FLIP #ifndef ENCODER_DIRECTION_FLIP
# define ENCODER_CLOCKWISE true # define ENCODER_CLOCKWISE true
@ -65,9 +68,15 @@ void encoder_init(void) {
if (!isLeftHand) { if (!isLeftHand) {
const pin_t encoders_pad_a_right[] = ENCODERS_PAD_A_RIGHT; const pin_t encoders_pad_a_right[] = ENCODERS_PAD_A_RIGHT;
const pin_t encoders_pad_b_right[] = ENCODERS_PAD_B_RIGHT; const pin_t encoders_pad_b_right[] = ENCODERS_PAD_B_RIGHT;
# if defined(ENCODER_RESOLUTIONS_RIGHT)
const uint8_t encoder_resolutions_right[] = ENCODER_RESOLUTIONS_RIGHT;
# endif
for (uint8_t i = 0; i < NUMBER_OF_ENCODERS; i++) { for (uint8_t i = 0; i < NUMBER_OF_ENCODERS; i++) {
encoders_pad_a[i] = encoders_pad_a_right[i]; encoders_pad_a[i] = encoders_pad_a_right[i];
encoders_pad_b[i] = encoders_pad_b_right[i]; encoders_pad_b[i] = encoders_pad_b_right[i];
# if defined(ENCODER_RESOLUTIONS_RIGHT)
encoder_resolutions[i] = encoder_resolutions_right[i];
# endif
} }
} }
#endif #endif
@ -87,19 +96,26 @@ void encoder_init(void) {
static void encoder_update(int8_t index, uint8_t state) { static void encoder_update(int8_t index, uint8_t state) {
uint8_t i = index; uint8_t i = index;
#ifdef ENCODER_RESOLUTIONS
int8_t resolution = encoder_resolutions[i];
#else
int8_t resolution = ENCODER_RESOLUTION;
#endif
#ifdef SPLIT_KEYBOARD #ifdef SPLIT_KEYBOARD
index += thisHand; index += thisHand;
#endif #endif
encoder_pulses[i] += encoder_LUT[state & 0xF]; encoder_pulses[i] += encoder_LUT[state & 0xF];
if (encoder_pulses[i] >= ENCODER_RESOLUTION) { if (encoder_pulses[i] >= resolution) {
encoder_value[index]++; encoder_value[index]++;
encoder_update_kb(index, ENCODER_COUNTER_CLOCKWISE); encoder_update_kb(index, ENCODER_COUNTER_CLOCKWISE);
} }
if (encoder_pulses[i] <= -ENCODER_RESOLUTION) { // direction is arbitrary here, but this clockwise if (encoder_pulses[i] <= -resolution) { // direction is arbitrary here, but this clockwise
encoder_value[index]--; encoder_value[index]--;
encoder_update_kb(index, ENCODER_CLOCKWISE); encoder_update_kb(index, ENCODER_CLOCKWISE);
} }
encoder_pulses[i] %= ENCODER_RESOLUTION; encoder_pulses[i] %= resolution;
} }
void encoder_read(void) { void encoder_read(void) {