''' Extension handles usage of Trackball Breakout by Pimoroni Product page: https://shop.pimoroni.com/products/trackball-breakout ''' from micropython import const import math import struct from kmk.keys import AX, KC, make_argumented_key, make_key from kmk.kmktime import PeriodicTimer from kmk.modules import Module I2C_ADDRESS = 0x0A I2C_ADDRESS_ALTERNATIVE = 0x0B CHIP_ID = 0xBA11 VERSION = 1 REG_LED_RED = 0x00 REG_LED_GRN = 0x01 REG_LED_BLU = 0x02 REG_LED_WHT = 0x03 REG_LEFT = 0x04 REG_RIGHT = 0x05 REG_UP = 0x06 REG_DOWN = 0x07 REG_SWITCH = 0x08 MSK_SWITCH_STATE = 0b10000000 REG_USER_FLASH = 0xD0 REG_FLASH_PAGE = 0xF0 REG_INT = 0xF9 MSK_INT_TRIGGERED = 0b00000001 MSK_INT_OUT_EN = 0b00000010 REG_CHIP_ID_L = 0xFA RED_CHIP_ID_H = 0xFB REG_VERSION = 0xFC REG_I2C_ADDR = 0xFD REG_CTRL = 0xFE MSK_CTRL_SLEEP = 0b00000001 MSK_CTRL_RESET = 0b00000010 MSK_CTRL_FREAD = 0b00000100 MSK_CTRL_FWRITE = 0b00001000 ANGLE_OFFSET = 0 class TrackballHandlerKeyMeta: def __init__(self, handler=0): self.handler = handler def layer_key_validator(handler): return TrackballHandlerKeyMeta(handler=handler) class TrackballMode: '''Behaviour mode of trackball: mouse movement or vertical scroll''' MOUSE_MODE = const(0) SCROLL_MODE = const(1) class ScrollDirection: '''Behaviour mode of scrolling: natural or reverse scrolling''' NATURAL = const(0) REVERSE = const(1) class TrackballHandler: def handle(self, keyboard, trackball, x, y, switch, state): raise NotImplementedError class PointingHandler(TrackballHandler): def handle(self, keyboard, trackball, x, y, switch, state): if x: AX.X.move(keyboard, x) if y: AX.Y.move(keyboard, y) if switch == 1: # Button pressed keyboard.pre_process_key(KC.MB_LMB, is_pressed=True) if not state and trackball.previous_state is True: # Button released keyboard.pre_process_key(KC.MB_LMB, is_pressed=False) trackball.previous_state = state class ScrollHandler(TrackballHandler): def __init__(self, scroll_direction=ScrollDirection.NATURAL): self.scroll_direction = scroll_direction def handle(self, keyboard, trackball, x, y, switch, state): if self.scroll_direction == ScrollDirection.REVERSE: y = -y if y != 0: AX.W.move(keyboard, y) if switch == 1: # Button pressed keyboard.pre_process_key(KC.MB_LMB, is_pressed=True) if not state and trackball.previous_state is True: # Button released keyboard.pre_process_key(KC.MB_LMB, is_pressed=False) trackball.previous_state = state class KeyHandler(TrackballHandler): x = 0 y = 0 def __init__(self, up, right, down, left, press, axis_snap=0.25, steps=8): self.up = up self.right = right self.down = down self.left = left self.press = press self.axis_snap = axis_snap self.steps = steps def handle(self, keyboard, trackball, x, y, switch, state): if y and abs(x / y) < self.axis_snap: x = 0 if x and abs(y / x) < self.axis_snap: y = 0 self.x += x self.y += y x_taps = self.x // self.steps y_taps = self.y // self.steps self.x %= self.steps self.y %= self.steps for i in range(x_taps, 0, 1): keyboard.tap_key(self.left) for i in range(x_taps, 0, -1): keyboard.tap_key(self.right) for i in range(y_taps, 0, 1): keyboard.tap_key(self.up) for i in range(y_taps, 0, -1): keyboard.tap_key(self.down) if switch and state: keyboard.tap_key(self.press) class Trackball(Module): '''Module handles usage of Trackball Breakout by Pimoroni''' def __init__( self, i2c, mode=TrackballMode.MOUSE_MODE, address=I2C_ADDRESS, angle_offset=ANGLE_OFFSET, handlers=None, ): self.angle_offset = angle_offset if not handlers: handlers = [PointingHandler(), ScrollHandler()] if mode == TrackballMode.SCROLL_MODE: handlers.reverse() self._i2c_address = address self._i2c_bus = i2c self.mode = mode self.previous_state = False # click state self.handlers = handlers self.current_handler = self.handlers[0] self.polling_interval = 20 chip_id = struct.unpack('= len(self.handlers): next_index = 0 self.activate_handler(next_index) def _read_raw_state(self): '''Read up, down, left, right and switch data from trackball.''' left, right, up, down, switch = self._i2c_rdwr([REG_LEFT], 5) switch, switch_state = ( switch & ~MSK_SWITCH_STATE, (switch & MSK_SWITCH_STATE) > 0, ) return up, down, left, right, switch, switch_state def _i2c_rdwr(self, data, length=0): '''Write and optionally read I2C data.''' while not self._i2c_bus.try_lock(): pass try: if length > 0: result = bytearray(length) self._i2c_bus.writeto_then_readfrom( self._i2c_address, bytes(data), result ) return list(result) else: self._i2c_bus.writeto(self._i2c_address, bytes(data)) return [] finally: self._i2c_bus.unlock() def _tb_handler_press(self, key, keyboard, *args, **kwargs): self.activate_handler(key.meta.handler) def _tb_handler_next_press(self, key, keyboard, *args, **kwargs): self.next_handler() def _calculate_movement(self, raw_x, raw_y): '''Calculate accelerated movement vector from raw data''' if raw_x == 0 and raw_y == 0: return 0, 0 var_accel = 1 power = 2.5 angle_rad = math.atan2(raw_y, raw_x) + self.angle_offset vector_length = math.sqrt(pow(raw_x, 2) + pow(raw_y, 2)) vector_length = pow(vector_length * var_accel, power) x = math.floor(vector_length * math.cos(angle_rad)) y = math.floor(vector_length * math.sin(angle_rad)) limit = 127 # hid size limit x_clamped = max(min(limit, x), -limit) y_clamped = max(min(limit, y), -limit) return x_clamped, y_clamped