feat: Platform Info model (#67)

Author: kjy5

models/csharp/EphysLinkModels.cs

@@ -65,21 +65,29 @@ string serial
 public struct GetManipulatorsResponse
 {
     public string[] Manipulators;
-    public int NumAxes;
-    public Vector4 Dimensions;
     public string Error;
 
-    public GetManipulatorsResponse(
-        string[] manipulators,
-        int numAxes,
-        Vector4 dimensions,
-        string error
-    )
+    public GetManipulatorsResponse(string[] manipulators, string error)
     {
         Manipulators = manipulators;
+        Error = error;
+    }
+}
+
+[Serializable]
+public struct PlatformInfo
+{
+    public string Name;
+    public string CliName;
+    public int NumAxes;
+    public Vector4 Dimensions;
+
+    public PlatformInfo(string name, string cliName, int numAxes, Vector4 dimensions)
+    {
+        Name = name;
+        CliName = cliName;
         NumAxes = numAxes;
         Dimensions = dimensions;
-        Error = error;
     }
 }
 

models/schemas/ephys_link/GetManipulatorsResponse.json

@@ -1 +1 @@
-{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Response format for requesting available manipulators.\n\nAttributes:\n    manipulators: List of manipulators.\n    num_axes: Number of axes for the manipulators.\n    dimensions: Dimensions of the manipulators (3-axis manipulators should set w to 0).\n    error: Error message if any.", "properties": {"Manipulators": {"items": {"type": "string"}, "title": "Manipulators", "type": "array"}, "NumAxes": {"default": 0, "minimum": -1, "title": "Numaxes", "type": "integer"}, "Dimensions": {"$ref": "#/$defs/Vector4", "default": {"x": 0.0, "y": 0.0, "z": 0.0, "w": 0.0}}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "GetManipulatorsResponse", "type": "object"}
+{"description": "Response format for requesting available manipulators.\n\nAttributes:\n    manipulators: List of manipulators by ID.\n    error: Error message if any.", "properties": {"Manipulators": {"items": {"type": "string"}, "title": "Manipulators", "type": "array"}, "Error": {"default": "", "title": "Error", "type": "string"}}, "title": "GetManipulatorsResponse", "type": "object"}

models/schemas/ephys_link/PlatformInfo.json

@@ -0,0 +1 @@
+{"$defs": {"Vector4": {"description": "4D vector.\n\nAttributes:\n    x: X component.\n    y: Y component.\n    z: Z component.\n    w: W component.", "properties": {"x": {"default": 0.0, "title": "X", "type": "number"}, "y": {"default": 0.0, "title": "Y", "type": "number"}, "z": {"default": 0.0, "title": "Z", "type": "number"}, "w": {"default": 0.0, "title": "W", "type": "number"}}, "title": "Vector4", "type": "object"}}, "description": "Information about the manipulator platform.\n\nAttributes:\n    name: Name of the manipulator platform.\n    cli_name: CLI identifier for the manipulator platform (for the `-t` flag).\n    num_axes: Number of axes on a manipulator.\n    dimensions: Dimensions of the manipulators (3-axis manipulators should set w to 0).", "properties": {"Name": {"minLength": 1, "title": "Name", "type": "string"}, "CliName": {"minLength": 1, "title": "Cliname", "type": "string"}, "NumAxes": {"default": 0, "minimum": -1, "title": "Numaxes", "type": "integer"}, "Dimensions": {"$ref": "#/$defs/Vector4", "default": {"x": 0.0, "y": 0.0, "z": 0.0, "w": 0.0}}}, "required": ["Name", "CliName"], "title": "PlatformInfo", "type": "object"}

src/vbl_aquarium/__about__.py

@@ -1 +1 @@
-__version__ = "1.0.0b1"
+__version__ = "1.0.0b2"

src/vbl_aquarium/models/ephys_link.py

@@ -35,6 +35,22 @@ class EphysLinkOptions(VBLBaseModel):
     serial: str = "no-e-stop"
 
 
+class PlatformInfo(VBLBaseModel):
+    """Information about the manipulator platform.
+
+    Attributes:
+        name: Name of the manipulator platform.
+        cli_name: CLI identifier for the manipulator platform (for the `-t` flag).
+        num_axes: Number of axes on a manipulator.
+        dimensions: Dimensions of the manipulators (3-axis manipulators should set w to 0).
+    """
+
+    name: str = Field(min_length=1)
+    cli_name: str = Field(min_length=1)
+    num_axes: int = Field(default=0, ge=-1)
+    dimensions: Vector4 = Vector4()
+
+
 class SetPositionRequest(VBLBaseModel):
     """Request format for moving a manipulator to a position.
 
@@ -79,16 +95,12 @@ class GetManipulatorsResponse(VBLBaseModel):
     """Response format for requesting available manipulators.
 
     Attributes:
-        manipulators: List of manipulators.
-        num_axes: Number of axes for the manipulators.
-        dimensions: Dimensions of the manipulators (3-axis manipulators should set w to 0).
+        manipulators: List of manipulators by ID.
         error: Error message if any.
     """
 
     # noinspection PyDataclass
     manipulators: list[str] = Field(default_factory=list)
-    num_axes: int = Field(default=0, ge=-1)
-    dimensions: Vector4 = Vector4()
     error: str = ""