sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add encoder resolution setting

Browse Source
This commit is contained in:
Gleb Sabirzyanov 2022-06-21 22:12:33 +10:00 committed by xs5871
parent ed378c960f
commit aafa0d9c6a
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
kmk/modules/encoder.py
View File

@ -58,17 +58,19 @@ class BaseEncoder:
self._direction = -1 self._direction = -1
# when the encoder settles on a position (every 2 steps) # when the encoder settles on a position (every 2 steps)
if new_state == (True, True): if new_state[0] == new_state[1]:
if self._movement > 2: # when the encoder made a full loop according to its resolution
# 1 full step is 4 movements, however, when rotated quickly, if self._movement >= self.resolution - 1:
# some steps may be missed. This makes it behaves more # 1 full step is 4 movements (2 for high-resolution encoder),
# naturally # however, when rotated quickly, some steps may be missed.
real_movement = round(self._movement / 4) # This makes it behave more naturally
real_movement = round(self._movement / self.resolution)
self._pos += self._direction * real_movement self._pos += self._direction * real_movement
if self.on_move_do is not None: if self.on_move_do is not None:
for i in range(real_movement): for i in range(real_movement):
self.on_move_do(self.get_state()) self.on_move_do(self.get_state())
# Reinit to properly identify new movement
# Rotation finished, reset to identify new movement
self._movement = 0 self._movement = 0
self._direction = 0 self._direction = 0
@ -97,9 +99,13 @@ class BaseEncoder:
class GPIOEncoder(BaseEncoder): class GPIOEncoder(BaseEncoder):
def __init__(self, pin_a, pin_b, pin_button=None, is_inverted=False): def __init__(self, pin_a, pin_b, pin_button=None, is_inverted=False, resolution=None):
super().__init__(is_inverted) super().__init__(is_inverted)
# Resolution can be 4 or 2 depending on whether the detent
# on the encoder is defined by 2 or 4 pulses
self.resolution = resolution
self.pin_a = EncoderPin(pin_a) self.pin_a = EncoderPin(pin_a)
self.pin_b = EncoderPin(pin_b) self.pin_b = EncoderPin(pin_b)
self.pin_button = ( self.pin_button = (
@ -210,6 +216,7 @@ class EncoderHandler(Module):
self.encoders = [] self.encoders = []
self.pins = None self.pins = None
self.map = None self.map = None
self.resolution = 4
def on_runtime_enable(self, keyboard): def on_runtime_enable(self, keyboard):
return return
@ -228,6 +235,9 @@ class EncoderHandler(Module):
# Else fall back to GPIO # Else fall back to GPIO
else: else:
new_encoder = GPIOEncoder(*pins) new_encoder = GPIOEncoder(*pins)
# Set default resolution if unset
if new_encoder.resolution is None:
new_encoder.resolution = self.resolution
# In our case, we need to define keybord and encoder_id for callbacks # In our case, we need to define keybord and encoder_id for callbacks
new_encoder.on_move_do = lambda x, bound_idx=idx: self.on_move_do( new_encoder.on_move_do = lambda x, bound_idx=idx: self.on_move_do(