Fluxpad V2

.gitattributes

@@ -20,3 +20,4 @@
 *.SLDASM filter=lfs diff=lfs merge=lfs -text
 *.STEP filter=lfs diff=lfs merge=lfs -text
 *.STP filter=lfs diff=lfs merge=lfs -text
+APP/images/** -filter=lfs -diff=lfs -merge=lfs -text

.github/workflows/main.yml

@@ -2,6 +2,7 @@ on:
   pull_request:
     branches:
     - main
+    - fluxpad-2
 
 jobs:
   build-arduino:
@@ -41,7 +42,7 @@ jobs:
     - name: Checkout with submodules
       uses: actions/checkout@v3
       with:
-        lfs: true
+        lfs: false
         submodules: 'recursive'
 
     - name: Create Executable

APP/fluxpad_interface.py

@@ -26,6 +26,19 @@ class CommandType(enum.Enum):
     READ = "r"
 
 
+class LightingMode(enum.IntEnum):
+    Off = 0
+    Static = 1
+    Fade = 2
+    Flash = 3
+
+
+class RGBMode(enum.IntEnum):
+    Off = 0
+    Static = 1
+    Rainbow = 2
+
+
 class MessageKey:
     COMMAND = "cmd"
     TOKEN = "tkn"
@@ -46,6 +59,16 @@ class MessageKey:
     CALIBRATION_DOWN = "c_d"
     DATASTREAM_MODE = "dstrm"
     DATASTREAM_FREQUENCY = "dstrm_freq"
+    LIGHTING_MODE = "l_m"
+    LIGHTING_FADE_BRIGHTNESS = "l_b"
+    LIGHTING_FLASH_DURATION = "l_d"
+    RGB_MODE = "rgb_m"
+    RGB_BRIGHTNESS = "rgb_b"
+    RGB_SPEED = "rgb_s"
+    RGB_C1 = "rgb_c1"
+    RGB_C2 = "rgb_c2"
+    RGB_C3 = "rgb_c3"
+    CLEAR_FLASH = "clear"
 
 
 class BaseMessage:
@@ -197,6 +220,36 @@ def release_debounce(self, debounce_ms: int):
         self._assert_uint8(debounce_ms)
         self.data[MessageKey.RELEASE_DEBOUNCE] = debounce_ms
 
+    # LIGHTING MODE
+    @property
+    def mode(self):
+        return int(self.data[MessageKey.LIGHTING_MODE])
+
+    @mode.setter
+    def mode(self, mode: int):
+        self._assert_uint8(mode)
+        self.data[MessageKey.LIGHTING_MODE] = mode
+
+    # LIGHTING BRIGHTNESS
+    @property
+    def brightness(self):
+        return int(self.data[MessageKey.LIGHTING_FADE_BRIGHTNESS])
+
+    @brightness.setter
+    def brightness(self, brightness: int):
+        self._assert_uint8(brightness)
+        self.data[MessageKey.LIGHTING_FADE_BRIGHTNESS] = brightness
+
+    # LIGHTING FLASH DURATION
+    @property
+    def flash_duration(self):
+        return int(self.data[MessageKey.LIGHTING_FLASH_DURATION])
+
+    @flash_duration.setter
+    def flash_duration(self, flash_duration_us: int):
+        self.data[MessageKey.LIGHTING_FLASH_DURATION] = flash_duration_us
+
+
 class AnalogSettingsMessage(BaseMessage):
 
     # KEY ID
@@ -207,7 +260,6 @@ def key_id(self):
     @key_id.setter
     def key_id(self, key_id: int):
         self._assert_uint8(key_id)
-        assert key_id in list(KeyType)
         self.data[MessageKey.KEY_ID] = key_id
 
     # KEYMAP
@@ -217,7 +269,7 @@ def key_code(self):
 
     @key_code.setter
     def key_code(self, key_code: int):
-        self._assert_uint8(key_code)
+        self._assert_uint16(key_code)
         self.data[MessageKey.KEY_CODE] = key_code
 
     @property
@@ -310,6 +362,35 @@ def rapid_trigger(self, rapid_trigger_enable: bool):
         assert isinstance(rapid_trigger_enable, bool)
         self.data[MessageKey.RAPID_TRIGGER] = rapid_trigger_enable
 
+    # LIGHTING MODE
+    @property
+    def mode(self):
+        return int(self.data[MessageKey.LIGHTING_MODE])
+
+    @mode.setter
+    def mode(self, mode: int):
+        self._assert_uint8(mode)
+        self.data[MessageKey.LIGHTING_MODE] = mode
+
+    # LIGHTING BRIGHTNESS
+    @property
+    def brightness(self):
+        return int(self.data[MessageKey.LIGHTING_FADE_BRIGHTNESS])
+
+    @brightness.setter
+    def brightness(self, brightness: int):
+        self._assert_uint8(brightness)
+        self.data[MessageKey.LIGHTING_FADE_BRIGHTNESS] = brightness
+
+    # LIGHTING FLASH DURATION
+    @property
+    def flash_duration(self):
+        return int(self.data[MessageKey.LIGHTING_FLASH_DURATION])
+
+    @flash_duration.setter
+    def flash_duration(self, flash_duration_us: int):
+        self.data[MessageKey.LIGHTING_FLASH_DURATION] = flash_duration_us
+
 
 class AnalogCalibrationMessage(BaseMessage):
     """Analog key calibration message containing
@@ -323,7 +404,6 @@ def key_id(self):
     @key_id.setter
     def key_id(self, key_id: int):
         self._assert_uint8(key_id)
-        assert key_id in list(KeyType)
         self.data[MessageKey.KEY_ID] = key_id
 
     # CALIBRATION
@@ -362,6 +442,66 @@ def calibration_down(self):
             pass
 
 
+class RGBSettingsMessage(BaseMessage):
+    """KeyLightingMessage containing all info about a key's
+    per-key lighting settings"""
+
+    # RGB MODE
+    @property
+    def mode(self):
+        return int(self.data[MessageKey.RGB_MODE])
+
+    @mode.setter
+    def mode(self, mode: int):
+        self._assert_uint8(mode)
+        self.data[MessageKey.RGB_MODE] = mode
+
+    # RGB Color 1
+    @property
+    def color1(self):
+        return int(self.data[MessageKey.RGB_C1])
+
+    @color1.setter
+    def color1(self, color: int):
+        self.data[MessageKey.RGB_C1] = color
+
+    # RGB Color 2
+    @property
+    def color2(self):
+        return int(self.data[MessageKey.RGB_C2])
+
+    @color2.setter
+    def color2(self, color: int):
+        self.data[MessageKey.RGB_C2] = color
+
+    # RGB Color 3
+    @property
+    def color3(self):
+        return int(self.data[MessageKey.RGB_C3])
+
+    @color3.setter
+    def color3(self, color: int):
+        self.data[MessageKey.RGB_C3] = color
+
+    # RGB BRIGHTNESS
+    @property
+    def brightness(self):
+        return int(self.data[MessageKey.RGB_BRIGHTNESS])
+
+    @brightness.setter
+    def brightness(self, brightness: int):
+        self.data[MessageKey.RGB_BRIGHTNESS] = brightness
+
+    # RGB SPEED
+    @property
+    def speed(self):
+        return int(self.data[MessageKey.RGB_SPEED])
+
+    @speed.setter
+    def speed(self, speed: int):
+        self.data[MessageKey.RGB_SPEED] = speed
+
+
 class AnalogReadMessage(BaseMessage):
     """Analog key read message containing """
 
@@ -373,7 +513,6 @@ def key_id(self):
     @key_id.setter
     def key_id(self, key_id: int):
         self._assert_uint8(key_id)
-        assert key_id in list(KeyType)
         self.data[MessageKey.KEY_ID] = key_id
 
     # RAW ADC
@@ -399,7 +538,7 @@ def height_mm(self, dummy: int):
 #     """Composite class of all settings types"""
 #     pass
 
-AnyMessage = TypeVar("AnyMessage", DigitalSettingsMessage, AnalogSettingsMessage, EncoderSettingsMessage, AnalogCalibrationMessage, AnalogReadMessage, Union[DigitalSettingsMessage, AnalogSettingsMessage, EncoderSettingsMessage, AnalogCalibrationMessage, AnalogReadMessage])
+AnyMessage = TypeVar("AnyMessage", DigitalSettingsMessage, AnalogSettingsMessage, EncoderSettingsMessage, AnalogCalibrationMessage, AnalogReadMessage, RGBSettingsMessage, Union[DigitalSettingsMessage, AnalogSettingsMessage, EncoderSettingsMessage, AnalogCalibrationMessage, AnalogReadMessage, RGBSettingsMessage])
 
 
 class Fluxpad:
@@ -578,16 +717,19 @@ def _worker(self):
 class FluxpadSettings:
 
     KEY_SETTINGS_KEY = "key_settings"
+    RGB_SETTINGS_KEY = "rgb_settings"
 
     def __init__(self) -> None:
         self.key_settings_list: List[Union[EncoderSettingsMessage, AnalogSettingsMessage, DigitalSettingsMessage]] = [
             DigitalSettingsMessage(),
             DigitalSettingsMessage(),
             AnalogSettingsMessage(),
             AnalogSettingsMessage(),
+            AnalogSettingsMessage(),
             EncoderSettingsMessage(),
             EncoderSettingsMessage(),
         ]
+        self.rgb_settings = RGBSettingsMessage()
 
     def _set_key_ids(self):
         key_id = 0
@@ -616,6 +758,18 @@ def load_from_keypad(self, fluxpad: Fluxpad):
             else:
                 key_settings.data = response.data.copy()
 
+        try:
+            # Read RGB Settings
+            self.rgb_settings.set_zeros()
+            response = fluxpad.send_read_request(self.rgb_settings)
+
+            # Check all requested keys exist
+            assert set(response.data.keys()) == set(self.rgb_settings.data.keys()), f"Difference: {set(response.data.keys()).symmetric_difference(set(self.rgb_settings.data.keys()))}"
+            logging.debug("Got RGB settings")
+        except Exception:
+            logging.error(f"Failed to get RGB settings {self.rgb_settings.data}", exc_info=True)
+        else:
+            self.rgb_settings.data = response.data.copy()
 
     def save_to_fluxpad(self, fluxpad: Fluxpad, include_calibration: bool = False):
         """Save all settings to the given connected fluxpad"""
@@ -630,22 +784,33 @@ def save_to_fluxpad(self, fluxpad: Fluxpad, include_calibration: bool = False):
                 logging.debug(f"Wrote settings for Key ID {key_settings.key_id}")
             except Exception:
                 logging.error(f"Failed to write settings for Key ID {key_settings.key_id} with message {key_settings.data}", exc_info=True)
+
+        rgb_settings = self.rgb_settings
+        try:
+            response = fluxpad.send_write_request(rgb_settings)
+            logging.debug(f"Wrote rgb settings")
+        except Exception:
+            logging.error(f"Failed to write rgb settings with message {rgb_settings.data}", exc_info=True)
 
     def load_from_file(self, path: pathlib.Path):
         """Load all settings from the given file"""
         try:
             with path.open("r") as f:
                 root_json = json.load(f)
         except Exception:
-            logging.error(f"Failed to load settings from {path}", exc_info=1)
+            logging.error(f"Failed to load settings from {path}", exc_info=True)
             return
 
         try:
             for json_object in root_json[self.KEY_SETTINGS_KEY]:
                 self.key_settings_list[json_object[MessageKey.KEY_ID]].data = json_object
         except Exception:
-            logging.error(f"Failed to parse settings from {path}", exc_info=1)
-
+            logging.error(f"Failed to parse key settings from {path}", exc_info=True)
+
+        try:
+            self.rgb_settings.data = root_json[self.RGB_SETTINGS_KEY]
+        except Exception:
+            logging.error(f"Failed to parse rgb settings from {path}", exc_info=True)
 
     def save_to_file(self, path: pathlib.Path):
         """Save all settings to the given file"""
@@ -658,7 +823,8 @@ def save_to_file(self, path: pathlib.Path):
 
         # Construct master json to store all settings
         root_dict = dict()
-        root_dict[self.KEY_SETTINGS_KEY] = [key_settings.data for key_settings in self.key_settings_list]\
+        root_dict[self.KEY_SETTINGS_KEY] = [key_settings.data for key_settings in self.key_settings_list]
+        root_dict[self.RGB_SETTINGS_KEY] = self.rgb_settings.data
 
         with path.open("w") as f:
             json.dump(root_dict, f, indent=4)

APP/ttk_slider.py

@@ -98,7 +98,7 @@ def entry_defocus(self, event: tk.Event):
         self.entry.tk_focusNext().focus()
 
     def set_value(self, value):
-        print(f"hello {value}")
+        # print(f"Set slider value to {value}")
         self.double_var.set(value/self.resolution)
-        print(f"hello {self.double_var.get()}")
+        print(f"Set slider value to {self.double_var.get()}")
         self.on_slider_move(None)

CAD/.gitignore

@@ -6,4 +6,6 @@
 ~$*.SLDASM
 
 # ignore OS X desktops
-.DS_Store
+.DS_Store
+
+RFQs