Moved BLE to HID

kmk/extensions/led.py

@@ -0,0 +1,197 @@
+import pulseio
+from math import e, exp, pi, sin
+
+from kmk.extensions import Extension, InvalidExtensionEnvironment
+from kmk.keys import make_key
+
+
+class AnimationModes:
+    OFF = 0
+    STATIC = 1
+    STATIC_STANDBY = 2
+    BREATHING = 3
+    USER = 4
+
+
+class LED(Extension):
+    def __init__(
+        self,
+        led_pin,
+        brightness_step=5,
+        brightness_limit=100,
+        breathe_center=1.5,
+        animation_mode=AnimationModes.STATIC,
+        animation_speed=1,
+        user_animation=None,
+        val=100,
+    ):
+        try:
+            self._led = pulseio.PWMOut(led_pin)
+        except Exception as e:
+            print(e)
+            raise InvalidExtensionEnvironment(
+                'Unable to create pulseio.PWMOut() instance with provided led_pin'
+            )
+
+        self._brightness = 0
+        self._pos = 0
+        self._effect_init = False
+
+        self.brightness_step = brightness_step
+        self.brightness_limit = brightness_limit
+        self.animation_mode = animation_mode
+        self.animation_speed = animation_speed
+        self.breathe_center = breathe_center
+        self.val = val
+
+        if user_animation is not None:
+            self.user_animation = user_animation
+
+        make_key(names=('LED_TOG',), on_press=self._key_led_tog)
+        make_key(names=('LED_INC',), on_press=self._key_led_inc)
+        make_key(names=('LED_DEC',), on_press=self._key_led_dec)
+        make_key(names=('LED_ANI',), on_press=self._key_led_ani)
+        make_key(names=('LED_AND',), on_press=self._key_led_and)
+        make_key(
+            names=('LED_MODE_PLAIN', 'LED_M_P'), on_press=self._key_led_mode_static
+        )
+        make_key(
+            names=('LED_MODE_BREATHE', 'LED_M_B'), on_press=self._key_led_mode_breathe
+        )
+
+    def __repr__(self):
+        return 'LED({})'.format(self._to_dict())
+
+    def _to_dict(self):
+        # TODO FIXME remove
+        pass
+
+    def _init_effect(self):
+        self._pos = 0
+        self._effect_init = False
+        return self
+
+    def after_hid_send(self, keyboard):
+        if self._enabled and self.animation_mode:
+            self.animate()
+
+        return keyboard
+
+    def set_brightness(self, percent):
+        self._led.duty_cycle = int(percent / 100 * 65535)
+
+    def increase_brightness(self, step=None):
+        if not step:
+            self._brightness += self.brightness_step
+        else:
+            self._brightness += step
+
+        if self._brightness > 100:
+            self._brightness = 100
+
+        self.set_brightness(self._brightness)
+
+    def decrease_brightness(self, step=None):
+        if not step:
+            self._brightness -= self.brightness_step
+        else:
+            self._brightness -= step
+
+        if self._brightness < 0:
+            self._brightness = 0
+
+        self.set_brightness(self._brightness)
+
+    def off(self):
+        self.set_brightness(0)
+
+    def increase_ani(self):
+        '''
+        Increases animation speed by 1 amount stopping at 10
+        :param step:
+        '''
+        if (self.animation_speed + 1) >= 10:
+            self.animation_speed = 10
+        else:
+            self.val += 1
+
+    def decrease_ani(self):
+        '''
+        Decreases animation speed by 1 amount stopping at 0
+        :param step:
+        '''
+        if (self.val - 1) <= 0:
+            self.val = 0
+        else:
+            self.val -= 1
+
+    def effect_breathing(self):
+        # http://sean.voisen.org/blog/2011/10/breathing-led-with-arduino/
+        # https://github.com/qmk/qmk_firmware/blob/9f1d781fcb7129a07e671a46461e501e3f1ae59d/quantum/rgblight.c#L806
+        sined = sin((self._pos / 255.0) * pi)
+        multip_1 = exp(sined) - self.breathe_center / e
+        multip_2 = self.brightness_limit / (e - 1 / e)
+
+        self._brightness = int(multip_1 * multip_2)
+        self._pos = (self._pos + self.animation_speed) % 256
+        self.set_brightness(self._brightness)
+
+        return self
+
+    def effect_static(self):
+        self.set_brightness(self._brightness)
+        # Set animation mode to none to prevent cycles from being wasted
+        self.animation_mode = None
+        return self
+
+    def animate(self):
+        '''
+        Activates a "step" in the animation based on the active mode
+        :return: Returns the new state in animation
+        '''
+        if self._effect_init:
+            self._init_effect()
+        if self._enabled:
+            if self.animation_mode == AnimationModes.BREATHING:
+                return self.effect_breathing()
+            elif self.animation_mode == AnimationModes.STATIC:
+                return self.effect_static()
+            elif self.animation_mode == AnimationModes.USER:
+                return self.user_animation(self)
+        else:
+            self.off()
+
+        return self
+
+    def _key_led_tog(self, key, state, *args, **kwargs):
+        if self.animation_mode == AnimationModes.STATIC_STANDBY:
+            self.animation_mode = AnimationModes.STATIC
+
+        self._enabled = not self._enabled
+        return state
+
+    def _key_led_inc(self, key, state, *args, **kwargs):
+        self.increase_brightness()
+        return state
+
+    def _key_led_dec(self, key, state, *args, **kwargs):
+        self.decrease_brightness()
+        return state
+
+    def _key_led_ani(self, key, state, *args, **kwargs):
+        self.increase_ani()
+        return state
+
+    def _key_led_and(self, key, state, *args, **kwargs):
+        self.decrease_ani()
+        return state
+
+    def _key_led_mode_static(self, key, state, *args, **kwargs):
+        self._effect_init = True
+        self.animation_mode = AnimationModes.STATIC
+        return state
+
+    def _key_led_mode_breathe(self, key, state, *args, **kwargs):
+        self._effect_init = True
+        self.animation_mode = AnimationModes.BREATHING
+        return state