Add enable property to ConfigureHeadstage64OpticalStimulator

jonnew · jonnew · commit debe53f7f562 · 2025-09-25T13:24:42.000-04:00
- Address review comments
- Fix several typos
diff --git a/OpenEphys.Onix1/ConfigureHeadstage64ElectricalStimulator.cs b/OpenEphys.Onix1/ConfigureHeadstage64ElectricalStimulator.cs
@@ -30,7 +30,7 @@ public ConfigureHeadstage64ElectricalStimulator()
         /// false, <see cref="Headstage64ElectricalStimulatorData"/> will not produce data.
         /// </remarks>
         [Category(ConfigurationCategory)]
-        [Description("Specifies whether the digital IO device is enabled.")]
+        [Description("Specifies whether the headstage-64 electrical stimulator will produce stimulus reports.")]
         public bool Enable { get; set; }
 
         /// <summary>
@@ -68,7 +68,7 @@ static class Headstage64ElectricalStimulator
         public const double AbsMaxMicroAmps = 2500;
 
         // managed registers
-        public const uint ENABLE = 0; // Eanble stimulus report stream
+        public const uint ENABLE = 0; // Enable stimulus report stream
         public const uint BIPHASIC = 1; // Biphasic pulse (0 = monophasic, 1 = biphasic; NB: currently ignored)
         public const uint CURRENT1 = 2; // Phase 1 current
         public const uint CURRENT2 = 3; // Phase 2 current
diff --git a/OpenEphys.Onix1/ConfigureHeadstage64OpticalStimulator.cs b/OpenEphys.Onix1/ConfigureHeadstage64OpticalStimulator.cs
@@ -4,14 +4,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// Configures a headstage-64 dual-channel optical stimulator.
+    /// Configures a headstage-64 optical stimulator.
     /// </summary>
     /// <remarks>
     /// This configuration operator can be linked to a data IO operator, such as <see
     /// cref="Headstage64OpticalStimulatorTrigger"/>, using a shared
     /// <c>DeviceName</c>.
     /// </remarks>
-    [Description("Configures a headstage-64 dual-channel optical stimulator.")]
+    [Description("Configures a headstage-64 optical stimulator.")]
     public class ConfigureHeadstage64OpticalStimulator : SingleDeviceFactory
     {
         /// <summary>
@@ -22,6 +22,17 @@ public ConfigureHeadstage64OpticalStimulator()
         {
         }
 
+        /// <summary>
+        /// Gets or sets the data enable state.
+        /// </summary>
+        /// <remarks>
+        /// If set to true, <see cref="Headstage64OpticalStimulatorData"/> will produce data. If set to
+        /// false, <see cref="Headstage64OpticalStimulatorData"/> will not produce data.
+        /// </remarks>
+        [Category(ConfigurationCategory)]
+        [Description("Specifies whether the headstage-64 optical stimulator will produce stimulus reports.")]
+        public bool Enable { get; set; }
+
         /// <summary>
         /// Configure a headstage-64 dual-channel optical stimulator.
         /// </summary>
@@ -37,10 +48,12 @@ public override IObservable<ContextTask> Process(IObservable<ContextTask> source
         {
             var deviceName = DeviceName;
             var deviceAddress = DeviceAddress;
+            var enable = Enable;
             return source.ConfigureDevice(context =>
             {
                 var device = context.GetDeviceContext(deviceAddress, DeviceType);
-                device.WriteRegister(Headstage64OpticalStimulator.ENABLE, 0);
+                device.WriteRegister(Headstage64OpticalStimulator.ENABLE, enable ? 1u : 0u);
+                device.WriteRegister(Headstage64OpticalStimulator.STIMENABLE, 0u);
                 return DeviceManager.RegisterDevice(deviceName, device, DeviceType);
             });
         }
@@ -55,7 +68,7 @@ static class Headstage64OpticalStimulator
         public const uint PotResistanceOhms = 100_000;
 
         // managed registers
-        public const uint NULLPARM = 0; // No command
+        public const uint ENABLE = 0; // Enable stimulus report stream
         public const uint MAXCURRENT = 1; // Max LED/LD current, (0 to 255 = 800mA to 0 mA.See fig XX of CAT4016 datasheet)
         public const uint PULSEMASK = 2; // Bitmask determining which of the(up to 32) channels is affected by trigger
         public const uint PULSEDUR = 3; // Pulse duration, microseconds
@@ -65,7 +78,7 @@ static class Headstage64OpticalStimulator
         public const uint TRAINCOUNT = 7; // Number of bursts in train
         public const uint TRAINDELAY = 8; // Stimulus start delay, microseconds
         public const uint TRIGGER = 9; // Trigger stimulation (0 = off, 1 = deliver)
-        public const uint ENABLE = 10; // 1: enables the stimulator, 0: stimulator ignores triggers (so that a common trigger can be used)
+        public const uint STIMENABLE = 10; // 1: enables the stimulator, 0: stimulator ignores triggers (so that a common trigger can be used)
         public const uint RESTMASK = 11; // Bitmask determining the off state of the up to 32 current channels
         public const uint RESET = 12; // None If 1, Reset all parameters to default (not implemented)
         public const uint MINRHEOR = 13; // The series resistor between the potentiometer (rheostat) and RSET bin on the CAT4016
diff --git a/OpenEphys.Onix1/Headstage64ElectricalStimulatorDataFrame.cs b/OpenEphys.Onix1/Headstage64ElectricalStimulatorDataFrame.cs
@@ -4,7 +4,7 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A headstage-64 onboard electrical stimulator report.
+    /// A headstage-64 electrical stimulus report.
     /// </summary>
     /// <remarks>
     /// These frames provide synchronized information about the stimulus timing, trigger source, and stimulus
@@ -15,7 +15,7 @@ public class Headstage64ElectricalStimulatorDataFrame : DataFrame
         /// <summary>
         /// Initializes a new instance of the <see cref="Headstage64ElectricalStimulatorDataFrame"/> class.
         /// </summary>
-        /// <param name="frame">An ONI containing a headstage-64 onboard electrical stimulator report.</param>
+        /// <param name="frame">An ONI frame containing a electrical stimulus report.</param>
         public unsafe Headstage64ElectricalStimulatorDataFrame(oni.Frame frame)
             : base(frame.Clock)
         {
@@ -87,12 +87,12 @@ public unsafe Headstage64ElectricalStimulatorDataFrame(oni.Frame frame)
         public uint PulsesPerBurst { get; }
 
         /// <summary>
-        /// Gets inter-burst interval duration in microseconds.
+        /// Gets the inter-burst interval duration in microseconds.
         /// </summary>
         public uint InterBurstInterval { get; }
 
         /// <summary>
-        /// Gets the number of burst per train.
+        /// Gets the number of bursts per train.
         /// </summary>
         public uint BurstsPerTrain { get; }
 
diff --git a/OpenEphys.Onix1/Headstage64OpticalStimulatorDataFrame.cs b/OpenEphys.Onix1/Headstage64OpticalStimulatorDataFrame.cs
@@ -3,7 +3,7 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A headstage-64 onboard optical stimulator report.
+    /// A headstage-64 optical stimulus report.
     /// </summary>
     /// <remarks>
     /// These frames provide synchronized information about the stimulus timing, trigger source, and stimulus
@@ -14,7 +14,7 @@ public class Headstage64OpticalStimulatorDataFrame : DataFrame
         /// <summary>
         /// Initializes a new instance of the <see cref="Headstage64OpticalStimulatorDataFrame"/> class.
         /// </summary>
-        /// <param name="frame">An ONI containing a headstage-64 onboard optical stimulator report.</param>
+        /// <param name="frame">An ONI frame containing a headstage-64 optical stimulus report.</param>
         public unsafe Headstage64OpticalStimulatorDataFrame(oni.Frame frame)
             : base(frame.Clock)
         {
@@ -80,12 +80,12 @@ public unsafe Headstage64OpticalStimulatorDataFrame(oni.Frame frame)
         public uint PulsesPerBurst { get; }
 
         /// <summary>
-        /// Gets inter-burst interval duration in milliseconds.
+        /// Gets the inter-burst interval duration in milliseconds.
         /// </summary>
         public double InterBurstInterval { get; }
 
         /// <summary>
-        /// Gets the number of burst per train.
+        /// Gets the number of bursts per train.
         /// </summary>
         public uint BurstsPerTrain { get; }
 
diff --git a/OpenEphys.Onix1/Headstage64OpticalStimulatorTrigger.cs b/OpenEphys.Onix1/Headstage64OpticalStimulatorTrigger.cs
@@ -245,8 +245,10 @@ static uint pulseFrequencyToRegister(double pulseHz, double pulseDuration)
                     }
 
                     return new CompositeDisposable(
-                        enable.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.ENABLE, value ? 1u : 0u)),
-                        maxCurrent.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.MAXCURRENT, Headstage64OpticalStimulator.MilliampsToPotSetting(value))),
+                        enable.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.STIMENABLE, value ? 1u : 0u)),
+                        maxCurrent.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.MAXCURRENT, Headstage64OpticalStimulator.MilliampsToPotSetting(value))),
                         channelOneCurrent.SubscribeSafe(observer, value =>
                         {
                             currentSourceMask = percentToPulseMask(0, value, currentSourceMask);
@@ -257,12 +259,18 @@ static uint pulseFrequencyToRegister(double pulseHz, double pulseDuration)
                             currentSourceMask = percentToPulseMask(1, value, currentSourceMask);
                             device.WriteRegister(Headstage64OpticalStimulator.PULSEMASK, currentSourceMask);
                         }),
-                        pulseDuration.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.PULSEDUR, pulseDurationToRegister(value, PulsesPerSecond))),
-                        pulsesPerSecond.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.PULSEPERIOD, pulseFrequencyToRegister(value, PulseDuration))),
-                        pulsesPerBurst.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.BURSTCOUNT, value)),
-                        interBurstInterval.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.IBI, (uint)(1000 * value))),
-                        burstsPerTrain.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.TRAINCOUNT, value)),
-                        delay.SubscribeSafe(observer, value => device.WriteRegister(Headstage64OpticalStimulator.TRAINDELAY, (uint)(1000 * value))),
+                        pulseDuration.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.PULSEDUR, pulseDurationToRegister(value, PulsesPerSecond))),
+                        pulsesPerSecond.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.PULSEPERIOD, pulseFrequencyToRegister(value, PulseDuration))),
+                        pulsesPerBurst.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.BURSTCOUNT, value)),
+                        interBurstInterval.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.IBI, (uint)(1000 * value))),
+                        burstsPerTrain.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.TRAINCOUNT, value)),
+                        delay.SubscribeSafe(observer, value => 
+                            device.WriteRegister(Headstage64OpticalStimulator.TRAINDELAY, (uint)(1000 * value))),
                         source.SubscribeSafe(triggerObserver)
                     );
                 }));
