fix(driver Stanford830): learned to spell, fixed test notebook bug

Author: cint-transport

drivers_test_notebooks/srs830_test_notebook.ipynb

@@ -74,65 +74,37 @@
    "metadata": {
     "metadata": {}
    },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Stanford_Research_Systems,SR830,s/n86813,ver1.07 \\n'"
-      ]
-     },
-     "execution_count": 3,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "name"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {
-    "metadata": {}
-   },
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
       "Blacklisted settings that will not be tested or changed are: \n",
-      "[('_amplitude', 0.496), ('_input_configuration', 'A-B'), ('_time_constant', 30)]\n",
-      "\n",
-      "Beginning tests for:  Stanford830  version  1.0.1\n",
+      "[('_amplitude', 0.028),\n",
+      " ('_input_configuration', 'A-B'),\n",
+      " ('_sensitivity', 0.005),\n",
+      " ('_time_constant', 1)]\n",
       "\n",
-      "7 range properties found and tested out of 26 total settings found.\n",
-      "0 values properties found and tested out of 26 total settings found.\n",
-      "12 indexed values properties found and tested out of 26 total settings found.\n",
-      "2 dict values properties found and tested out of 26 total settings found.\n",
-      "3 blacklisted settings not testing (likely due to interdependencies not suitable for automated testing)\n",
-      "21 properties tested out of 26 total settings.\n",
-      "\n",
-      "Restored settings are different for the following:  {('id', 'Stanford_Research_Systems,SR830,s/n86813,ver1.07 '), ('buffer_points', 16383)}\n",
-      "\n",
-      "\n",
-      "\u001b[92m Property implementation tests passed, instrument: Stanford830 looks ready to go. \u001b[0m\n",
-      "Checking driver doc string.\n",
-      "\u001b[92m Docstring tests passed and looking good. \u001b[0m\n",
-      "The new test log for this driver is:  Passed with stanford830 version v1.0.1 tested on pyscan version v0.8.0 at 2024-10-01 10:01:28\n",
-      "\u001b[1;32m Stanford830 test results logged. \u001b[0m\n"
+      "Beginning tests for:  Stanford830  version  1.0.2\n",
+      "_id_settings\n",
+      "_phase_settings\n",
+      "_reference_source_settings\n",
+      "_frequency_settings\n",
+      "_reference_slope_settings\n",
+      "_harmonic_settings\n",
+      "_input_ground_settings\n",
+      "_input_coupling_settings\n"
      ]
     }
    ],
    "source": [
     "srs830 = ps.Stanford830(res)\n",
-    "\n",
     "test_driver(srs830, verbose=False)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "metadata": {
     "metadata": {}
    },
@@ -188,7 +160,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {
     "metadata": {}
    },
@@ -214,16 +186,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "-1.09223e-07 -1.09223e-07\n",
-      "1.0922e-07 1.0922e-07\n",
-      "1.0922e-07 1.0922e-07\n"
+      "-8.94074e-05 -4.76841e-07\n",
+      "0.000385048 2.3842e-07\n",
+      "-0.00506476 -9.53682e-07\n"
      ]
     }
    ],
@@ -254,22 +226,25 @@
     "\n",
     "\n",
     "srs830.set_channel_offset_expand(1, 0, 1)\n",
-    "srs830.set_display(1, 'x', 'none')\n"
+    "srs830.set_display(1, 'x', 'none')\n",
+    "\n",
+    "srs830.set_channel_offset_expand(2, 0, 1)\n",
+    "srs830.set_display(2, 'y', 'none')\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "0.002\n",
-      "0.00233333\n",
-      "0.003\n",
-      "0.00266667\n"
+      "0.000666667\n",
+      "-0.000666667\n",
+      "0.00566667\n",
+      "0.000666667\n"
      ]
     }
    ],
@@ -284,17 +259,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "-1.09223e-07\n",
-      "1.0922e-07\n",
-      "1.0922e-07\n",
-      "7734.592992720247\n"
+      "-8.98843e-05\n",
+      "0.000384809\n",
+      "-7.15259e-07\n",
+      "5908.116590643592\n"
      ]
     }
    ],
@@ -309,15 +284,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "-1.09223e-07\n",
-      "1.0922e-07\n"
+      "-8.98843e-05\n",
+      "0.000384809\n"
      ]
     }
    ],
@@ -330,23 +305,23 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "[-1.09223e-07, 1.0922e-07]\n",
-      "[-1.09223e-07, 1.0922e-07]\n",
-      "[-1.09223e-07, 7733.217892850435]\n",
-      "[-1.09223e-07, 0.0]\n",
-      "[-1.09223e-07, 0.001]\n",
-      "[-1.09223e-07, 0.00166667]\n",
-      "[-1.09223e-07, 0.004]\n",
-      "[-1.09223e-07, 1000.0]\n",
-      "[-1.09223e-07, -1.09223e-07]\n",
-      "[-1.09223e-07, 1.0922e-07]\n"
+      "[-8.98843e-05, 0.000385048]\n",
+      "[-8.98843e-05, -9.53682e-07]\n",
+      "[-8.98843e-05, 5909.491690513403]\n",
+      "[-8.98843e-05, 0.000666667]\n",
+      "[-8.98843e-05, -0.000666667]\n",
+      "[-8.98843e-05, 0.00166667]\n",
+      "[-8.96459e-05, -0.01]\n",
+      "[-8.98843e-05, 1000.0]\n",
+      "[-8.98843e-05, -8.98843e-05]\n",
+      "[-8.98843e-05, 0.000384809]\n"
      ]
     }
    ],
@@ -367,7 +342,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -388,20 +363,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "159"
-      ]
-     },
-     "execution_count": 15,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "# test buffer_points\n",
     "\n",
@@ -412,7 +376,8 @@
     "# srs830.start()\n",
     "srs830.trigger()\n",
     "sleep(20)\n",
-    "srs830.buffer_points\n"
+    "srs830.buffer_points\n",
+    "srs830.pause()\n"
    ]
   }
  ],
@@ -432,7 +397,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.2"
+   "version": "3.12.4"
   }
  },
  "nbformat": 4,

pyscan/drivers/stanford830.py

@@ -76,17 +76,17 @@ class Stanford830(InstrumentDriver):
     display2_output_source : str
         Gets/sets the displayed source on display 2
         Indexed values['y', 'display']
-    auxillary_voltage1 : float
-        Gets/sets the channel 1 auxillary output voltage
+    auxiliary_voltage1 : float
+        Gets/sets the channel 1 auxiliary output voltage
         range - [-10.5, 10.500]
-    auxillary_voltage2 : float
-        Gets/sets the channel 2 auxillary output voltage
+    auxiliary_voltage2 : float
+        Gets/sets the channel 2 auxiliary output voltage
         range - [-10.5, 10.500]
-    auxillary_voltage3 : float
-        Gets/sets the channel 3 auxillary output voltage
+    auxiliary_voltage3 : float
+        Gets/sets the channel 3 auxiliary output voltage
         range - [-10.5, 10.500]
-    auxillary_voltage4 : float
-        Gets/sets the channel 4 auxillary output voltage
+    auxiliary_voltage4 : float
+        Gets/sets the channel 4 auxiliary output voltage
         range - [-10.5, 10.500]
     sample_rate : float
         Get/sets the sample rate in Hz
@@ -136,7 +136,7 @@ def __init__(self, instrument):
         super().__init__(instrument)
 
         self.debug = False
-        self._version = "1.0.2"
+        self._version = "1.0.3"
 
         self.black_list_for_testing = [
             '_input_configuration',
@@ -297,31 +297,31 @@ def initialize_properties(self):
             'indexed_values': ['y', 'display'],
             'return_type': int})
 
-        # Auxillary Input/Ouput Properties
+        # auxiliary Input/Ouput Properties
 
         self.add_device_property({
-            'name': 'auxillary_voltage1',
+            'name': 'auxiliary_voltage1',
             'write_string': 'AUXV 1, {}',
             'query_string': 'AUXV? 1',
             'range': [-10.5, 10.500],
             'return_type': float})
 
         self.add_device_property({
-            'name': 'auxillary_voltage2',
+            'name': 'auxiliary_voltage2',
             'write_string': 'AUXV 2, {}',
             'query_string': 'AUXV? 2',
             'range': [-10.5, 10.500],
             'return_type': float})
 
         self.add_device_property({
-            'name': 'auxillary_voltage3',
+            'name': 'auxiliary_voltage3',
             'write_string': 'AUXV 3, {}',
             'query_string': 'AUXV? 3',
             'range': [-10.5, 10.500],
             'return_type': float})
 
         self.add_device_property({
-            'name': 'auxillary_voltage4',
+            'name': 'auxiliary_voltage4',
             'write_string': 'AUXV 4, {}',
             'query_string': 'AUXV? 4',
             'range': [-10.5, 10.500],
@@ -478,20 +478,20 @@ def set_channel_offset_expand(self, channel, offset, expand):
 
         self.write('OEXP {}, {}, {}'.format(channel, offset, index))
 
-    # Auxillary Input/Ouptut Methods
+    # auxiliary Input/Ouptut Methods
 
     def read_aux_input(self, index):
         '''
-        Reads the voltage input to an auxillary input channel
+        Reads the voltage input to an auxiliary input channel
 
         Parameters
         ----------
         index: int
-            Auxillary input channel number 1, 2, 3, or 4
+            auxiliary input channel number 1, 2, 3, or 4
         '''
 
         indicies = [1, 2, 3, 4]
-        assert index in indicies, 'Auxillary input index must be 1, 2, 3, or 4'
+        assert index in indicies, 'auxiliary input index must be 1, 2, 3, or 4'
 
         return float(self.query('OAUX ? {}'.format(index)))
 

pyscan/drivers/testing/driver_test_logs/stanford830_test_log.txt

@@ -1 +1 @@
-Passed with stanford830 version v1.0.2 tested on pyscan version v0.8.0 at 2024-10-01 18:31:03
+Passed with stanford830 version v1.0.3 tested on pyscan version v0.8.0 at 2024-10-02 10:40:42