feat: Support 4 shank in Pathfinder, defaults to 1 (#608)

Author: kjy5

Assets/Scripts/EphysLink/CommunicationManager.cs

@@ -310,6 +310,30 @@ public void GetAngles(string manipulatorId, Action<Vector3> onSuccessCallback,
             }).Emit("get_angles", manipulatorId);
         }
 
+        public void GetShankCount(string manipulatorId, Action<int> onSuccessCallback,
+            Action<string> onErrorCallback = null)
+        {
+            _connectionManager.Socket.ExpectAcknowledgement<ShankCountCallbackParameters>(data =>
+            {
+                if (data.error == "")
+                {
+                    try
+                    {
+                        onSuccessCallback?.Invoke(data.shank_count);
+                    }
+                    catch (Exception e)
+                    {
+                        onErrorCallback?.Invoke(e.ToString());
+                    }
+                }
+                else
+                {
+                    onErrorCallback?.Invoke(data.error);
+                    Debug.LogWarning(data.error);
+                }
+            }).Emit("get_shank_count", manipulatorId);
+        }
+
         /// <summary>
         ///     Request a manipulator be moved to a specific position.
         /// </summary>

Assets/Scripts/EphysLink/DataFormats.cs

@@ -130,6 +130,15 @@ public struct AngularCallbackParameters
         public string error;
     }
 
+    /// <summary>
+    /// Returned callback data format from shank count data.
+    /// </summary>
+    public struct ShankCountCallbackParameters
+    {
+        public int shank_count;
+        public string error;
+    }
+
     /// <summary>
     ///     Returned callback data format from driving to depth.
     /// </summary>

Assets/Scripts/Pinpoint/UI/EphysLinkSettings/ManipulatorConnectionPanel.cs

@@ -14,7 +14,8 @@ public class ManipulatorConnectionPanel : MonoBehaviour
     {
         #region Constructor
 
-        public void Initialize(Pinpoint.UI.EphysLinkSettings.EphysLinkSettings settingsMenu, string manipulatorID, int numAxes)
+        public void Initialize(Pinpoint.UI.EphysLinkSettings.EphysLinkSettings settingsMenu, string manipulatorID,
+            int numAxes)
         {
             // Set properties
             _ephysLinkSettings = settingsMenu;
@@ -37,19 +38,29 @@ public void Initialize(Pinpoint.UI.EphysLinkSettings.EphysLinkSettings settingsM
                 _probeConnectionGroup.SetActive(false);
                 _probePropertiesSection.SetActive(false);
 
-                // Create new probe
-                var trajectoryPlannerManager = FindObjectOfType<TrajectoryPlannerManager>();
-                var newProbe = trajectoryPlannerManager.AddNewProbe(ProbeProperties.ProbeType.Neuropixels1);
-
-                // Configure probe and link to Ephys Link
-                newProbe.ManipulatorBehaviorController.NumAxes = numAxes;
-                newProbe.Color = Color.magenta;
-                newProbe.name = "nsp_" + manipulatorID;
-                newProbe.Saved = false;
-                newProbe.SetIsEphysLinkControlled(true, manipulatorID);
+                CommunicationManager.Instance.GetShankCount(manipulatorID, shankCount =>
+                {
+                    // Use 2.4 if 4 shank, otherwise default to 1
+                    var probeType = shankCount == 4
+                        ? ProbeProperties.ProbeType.Neuropixels24
+                        : ProbeProperties.ProbeType.Neuropixels1;
+
+                    // Create new probe
+                    var trajectoryPlannerManager = FindObjectOfType<TrajectoryPlannerManager>();
+                    var newProbe = trajectoryPlannerManager.AddNewProbe(probeType);
+
+                    // Configure probe and link to Ephys Link
+                    newProbe.ManipulatorBehaviorController.NumAxes = numAxes;
+                    newProbe.Color = Color.magenta;
+                    newProbe.name = "nsp_" + manipulatorID;
+                    newProbe.Saved = false;
+                    newProbe.SetIsEphysLinkControlled(true, manipulatorID);
+                }, Debug.LogError);
+
+                // Exit (don't need to do anything else for Pathfinder)
                 return;
             }
-            
+
             // Restore or setup normal manipulator
 
             UpdateLinkableProbeOptions();

Library/com.unity.addressables/AddressablesBuildTEP.json

@@ -1,9 +1,9 @@
 {
-"Date": "12/11/2023 1:28:36 PM",
+"Date": "12/11/2023 3:35:16 PM",
 "UnityVersion": "2022.3.12f1",
 "com.unity.scriptablebuildpipeline": "1.21.20",
 "com.unity.addressables": "1.21.18",
 "traceEvents": [
-{"name": "Building Use Existing Build (requires built groups)", "ph": "X", "dur": 4203.7, "tid": 1, "ts": 1585, "pid": 1}
+{"name": "Building Use Existing Build (requires built groups)", "ph": "X", "dur": 6052.9, "tid": 1, "ts": 2179, "pid": 1}
 ]
 }