Over The Air device config feature

miniscope_io/cli/main.py

@@ -5,7 +5,7 @@
 import click
 
 from miniscope_io.cli.stream import stream
-from miniscope_io.cli.update import update
+from miniscope_io.cli.update import device, update
 
 
 @click.group()
@@ -20,3 +20,4 @@ def cli(ctx: click.Context) -> None:
 
 cli.add_command(stream)
 cli.add_command(update)
+cli.add_command(device)

miniscope_io/cli/update.py

@@ -5,7 +5,7 @@
 import click
 import yaml
 
-from miniscope_io.device_update import DevUpdate
+from miniscope_io.device_update import device_update
 from miniscope_io.models.devupdate import DeviceCommand
 
 
@@ -25,53 +25,80 @@
     help="ID of the device to update. 0 will update all devices.",
 )
 @click.option(
-    "-t",
-    "--target",
+    "-k",
+    "--key",
     required=False,
     type=click.Choice(["LED", "GAIN", "ROI_X", "ROI_Y"]),
-    help="Target to update. Cannot be used with --restart.",
+    help="key to update. Cannot be used with --restart.",
 )
 @click.option(
     "-v",
     "--value",
     required=False,
     type=int,
-    help="Value to set. Must be used with --target and cannot be used with --restart.",
+    help="Value to set. Must be used with --key and cannot be used with --restart.",
 )
 @click.option(
     "-c",
     "--config",
     required=False,
     type=click.Path(exists=True, dir_okay=False),
-    help="YAML file with configuration to update. Specify target and value pairs in the file.",
+    help="YAML file with configuration to update. Specify key and value pairs in the file.",
 )
-@click.option(
-    "--reboot",
-    is_flag=True,
-    type=bool,
-    help="Restart the device. Cannot be used with --target or --value.",
-)
-def update(port: str, target: str, value: int, device_id: int, reboot: bool, config: str) -> None:
+def update(port: str, key: str, value: int, device_id: int, config: str) -> None:
     """
-    Update device configuration or restart it.
+    Update device configuration.
     """
 
     # Check mutual exclusivity
-    if (target and not value) or (value and not target):
-        raise click.UsageError("Both --target and --value are required if one is specified.")
+    if (key and not value) or (value and not key):
+        raise click.UsageError("Both --key and --value are required if one is specified.")
 
-    if ((target or value) and reboot) or (config and reboot) or (config and (target or value)):
+    if config and (key or value):
         raise click.UsageError(
-            "Options --target/--value and --restart" " and --config are mutually exclusive."
+            "Options --key/--value and --restart" " and --config are mutually exclusive."
         )
-    if target and value:
-        DevUpdate(port=port, target=target, value=value, device_id=device_id)
+    if key and value:
+        device_update(port=port, key=key, value=value, device_id=device_id)
     elif config:
         with open(config) as f:
             config_file = yaml.safe_load(f)
         for key, value in config_file:
-            DevUpdate(port=port, target=key, value=value, device_id=device_id)
-    elif reboot:
-        DevUpdate(port=port, target="DEVICE", value=DeviceCommand.REBOOT.value, device_id=device_id)
+            device_update(port=port, key=key, value=value, device_id=device_id)
+    else:
+        raise click.UsageError("Either --key with --value or --restart must be specified.")
+
+
+@click.command()
+@click.option(
+    "-p",
+    "--port",
+    required=False,
+    help="Serial port to connect to. Needed if multiple FTDI devices are connected.",
+)
+@click.option(
+    "-i",
+    "--device_id",
+    required=False,
+    default=0,
+    type=int,
+    help="ID of the device to update. 0 will update all devices.",
+)
+@click.option(
+    "--reboot",
+    is_flag=True,
+    type=bool,
+    help="Restart the device. Cannot be used with --key or --value.",
+)
+def device(port: str, device_id: int, reboot: bool) -> None:
+    """
+    Send device commands (e.g., reboot)
+    """
+
+    # Check mutual exclusivity
+    if reboot:
+        device_update(
+            port=port, key="DEVICE", value=DeviceCommand.REBOOT.value, device_id=device_id
+        )
     else:
-        raise click.UsageError("Either --target with --value or --restart must be specified.")
+        raise click.UsageError("Only --reboot is currently implemented.")

miniscope_io/device_update.py

@@ -12,9 +12,11 @@
 from miniscope_io.models.devupdate import DevUpdateCommand, UpdateCommandDefinitions
 
 logger = init_logger(name="device_update", level="INFO")
+FTDI_VENDOR_ID = 0x0403
+FTDI_PRODUCT_ID = 0x6001
 
 
-def DevUpdate(
+def device_update(
     target: str,
     value: int,
     device_id: int,
@@ -93,8 +95,6 @@ def find_ftdi_device() -> list[str]:
     """
     Find FTDI devices connected to the computer.
     """
-    FTDI_VENDOR_ID = 0x0403
-    FTDI_PRODUCT_ID = 0x6001
     ports = serial.tools.list_ports.comports()
     ftdi_ports = []
 

miniscope_io/models/devupdate.py

@@ -30,7 +30,7 @@ class UpdateCommandDefinitions:
     reset_byte = 0b11111111
 
 
-class UpdateTarget(Enum):
+class UpdateTarget(int, Enum):
     """
     Targets to update. Needs to be under 6-bit.
     """
@@ -74,7 +74,9 @@ def validate_values(cls, values: dict) -> dict:
         elif target in UpdateTarget:
             raise NotImplementedError()
         else:
-            raise ValueError(f"{target} is not a valid update target, need an instance of UpdateTarget")
+            raise ValueError(
+                f"{target} is not a valid update target," "need an instance of UpdateTarget"
+            )
         return values
 
     @field_validator("port")
@@ -116,4 +118,7 @@ def validate_target(cls, value: str) -> UpdateTarget:
         try:
             return UpdateTarget[value]
         except KeyError as e:
-            raise ValueError(f"Target {value} not found, must be a member of UpdateTarget: {list(UpdateTarget.__members__.keys())}.") from e
+            raise ValueError(
+                f"Target {value} not found, must be a member of UpdateTarget:"
+                f" {list(UpdateTarget.__members__.keys())}."
+            ) from e

tests/test_device_update.py

@@ -3,14 +3,14 @@
 from pydantic import ValidationError
 from unittest.mock import MagicMock, patch, call
 from miniscope_io.models.devupdate import UpdateCommandDefinitions, UpdateTarget
-from miniscope_io.device_update import DevUpdate, find_ftdi_device
+from miniscope_io.device_update import device_update, find_ftdi_device
 
 
 @patch("miniscope_io.device_update.serial.tools.list_ports.comports")
 @patch("miniscope_io.device_update.serial.Serial")
 def test_devupdate_with_device_connected(mock_serial, mock_comports):
     """
-    Test DevUpdate function with a device connected.
+    Test device_update function with a device connected.
     """
     mock_serial_instance = mock_serial.return_value
     mock_comports.return_value = [
@@ -22,7 +22,7 @@ def test_devupdate_with_device_connected(mock_serial, mock_comports):
     device_id = 1
     port = "COM3"
 
-    DevUpdate(target, value, device_id, port)
+    device_update(target, value, device_id, port)
 
     mock_serial.assert_called_once_with(port=port, baudrate=2400, timeout=5, stopbits=2)
 
@@ -50,7 +50,7 @@ def test_devupdate_with_device_connected(mock_serial, mock_comports):
 @patch("miniscope_io.device_update.serial.tools.list_ports.comports")
 def test_devupdate_without_device_connected(mock_comports):
     """
-    Test DevUpdate function without a device connected.
+    Test device_update function without a device connected.
     """
     mock_comports.return_value = [
     ]
@@ -59,7 +59,7 @@ def test_devupdate_without_device_connected(mock_comports):
     device_id = 0
 
     with pytest.raises(ValueError, match="No FTDI devices found."):
-        DevUpdate(target, value, device_id)
+        device_update(target, value, device_id)
 
 @patch("miniscope_io.device_update.serial.tools.list_ports.comports")
 def test_find_ftdi_device(mock_comports):
@@ -91,7 +91,7 @@ def test_invalid_target_raises_error(mock_comports):
     port = "COM3"
 
     with pytest.raises(ValidationError, match="Target RANDOM_STRING not found"):
-        DevUpdate(target, value, device_id, port)
+        device_update(target, value, device_id, port)
 
 @patch("miniscope_io.models.devupdate.serial.tools.list_ports.comports")
 def test_invalid_led_value_raises_error(mock_comports):
@@ -108,7 +108,7 @@ def test_invalid_led_value_raises_error(mock_comports):
     port = "COM3"
 
     with pytest.raises(ValidationError, match="For LED, value must be between 0 and 100"):
-        DevUpdate(target, value, device_id, port)
+        device_update(target, value, device_id, port)
 
 
 @patch("miniscope_io.device_update.serial.tools.list_ports.comports")
@@ -126,7 +126,7 @@ def test_devupdate_with_multiple_ftdi_devices(mock_comports):
     device_id = 1
 
     with pytest.raises(ValueError, match="Multiple FTDI devices found. Please specify the port."):
-        DevUpdate(target, value, device_id)
+        device_update(target, value, device_id)
 
 @patch("miniscope_io.device_update.serial.Serial")
 def test_devupdate_serial_exception_handling(mock_serial):
@@ -141,7 +141,7 @@ def test_devupdate_serial_exception_handling(mock_serial):
     port = "COM3"
 
     with pytest.raises(ValidationError):
-        DevUpdate(target, value, device_id, port)
+        device_update(target, value, device_id, port)
 
 @patch("miniscope_io.device_update.serial.tools.list_ports.comports")
 def test_specified_port_not_ftdi_device(mock_comports):
@@ -157,4 +157,4 @@ def test_specified_port_not_ftdi_device(mock_comports):
     device_id = 1
 
     with pytest.raises(ValueError, match="No FTDI devices found."):
-        DevUpdate(target, value, device_id)
+        device_update(target, value, device_id)