spikesafe-python 1.9.7__tar.gz → 1.10.2__tar.gz

{spikesafe_python-1.9.7/spikesafe_python.egg-info → spikesafe_python-1.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spikesafe-python
-Version: 1.9.7
+Version: 1.10.2
 Summary: SpikeSafe Python Library
 Author-email: Vektrex <support@vektrex.com>
 Classifier: Programming Language :: Python :: 3
@@ -26,6 +26,8 @@ GitHub Repository: [SpikeSafe Python Samples](https://github.com/VektrexElectron
 
 Library help documentation: [spikesafe_python_lib_docs](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tree/master/spikesafe_python_lib_docs)
 
+Release notes: [spikesafe_python_lib_docs/_releases](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tree/master/spikesafe_python_lib_docs/_releases)
+
 ## About
 
 The **spikesafe-python** package provides light-weight access Python helper classes and functions to easily communicate with to your SpikeSafe and parse data into easy to use objects.

{spikesafe_python-1.9.7 → spikesafe_python-1.10.2}/README.md

@@ -12,6 +12,8 @@ GitHub Repository: [SpikeSafe Python Samples](https://github.com/VektrexElectron
 
 Library help documentation: [spikesafe_python_lib_docs](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tree/master/spikesafe_python_lib_docs)
 
+Release notes: [spikesafe_python_lib_docs/_releases](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tree/master/spikesafe_python_lib_docs/_releases)
+
 ## About
 
 The **spikesafe-python** package provides light-weight access Python helper classes and functions to easily communicate with to your SpikeSafe and parse data into easy to use objects.

{spikesafe_python-1.9.7 → spikesafe_python-1.10.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spikesafe-python"
-version = "1.9.7"
+version = "1.10.2"
 authors = [
   { name="Vektrex", email="support@vektrex.com" },
 ]

{spikesafe_python-1.9.7 → spikesafe_python-1.10.2}/spikesafe_python/DigitizerDataFetch.py

@@ -21,22 +21,21 @@ class DigitizerDataFetch():
     
     Methods
     -------
-    DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
+    DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None, digitizer_number=None)
         Returns an array of voltage readings from the digitizer obtained through a fetch query
-    DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
+    DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None, digitizer_number=None)
         Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query
-    DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
+    DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number=None)
         Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query
-    DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
+    DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number=None)
         Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query
-    DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None)
+    DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None, digitizer_number=None)
         Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data
     DigitizerDataFetch.get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_count, hardware_trigger_count=None, hardware_trigger_delay_microseconds=None)
         Returns the estimated minimum possible time in seconds it will take for the SpikeSafe PSMU digitizer to acquire new voltage readings. If hardware triggering is used, this does not take into account the pulse period, so the actual time may be longer.
     """
-
     @staticmethod
-    def fetch_voltage_data(spike_safe_socket, enable_logging = None):
+    def fetch_voltage_data(spike_safe_socket, enable_logging = None, digitizer_number=None):
         """Returns an array of voltage readings from the digitizer obtained through a fetch query 
 
         Parameters
@@ -45,6 +44,8 @@ class DigitizerDataFetch():
             Socket object used to communicate with SpikeSafe
         enable_logging : bool, Optional
             Overrides spike_safe_socket.enable_logging attribute (default to None will use spike_safe_socket.enable_logging value)
+        digitizer_number : int, Optional
+            The Digitizer number to fetch from. If None, fetches from Digitizer 1.
         
         Returns
         -------
@@ -56,9 +57,10 @@ class DigitizerDataFetch():
         Exception
             On any error
         """
-        try:
+        try:            
             # fetch the Digitizer voltage readings
-            spike_safe_socket.send_scpi_command('VOLT:FETC?', enable_logging)
+            prefix = "VOLT" if digitizer_number is None else f"VOLT{digitizer_number}"
+            spike_safe_socket.send_scpi_command(f'{prefix}:FETC?', enable_logging)
             digitizer_data_string = spike_safe_socket.read_data(enable_logging)
 
             # set up the DigitizerData array to be returned
@@ -83,7 +85,7 @@ class DigitizerDataFetch():
             raise
 
     @staticmethod
-    def fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None):
+    def fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None, digitizer_number=None):
         """Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query 
 
         Parameters
@@ -102,6 +104,8 @@ class DigitizerDataFetch():
             The pulse period in seconds (default to 0s)
         enable_logging : bool, Optional
             Overrides spike_safe_socket.enable_logging attribute (default to None will use spike_safe_socket.enable_logging value)
+        digitizer_number : int, Optional
+            The Digitizer number to fetch from. If None, fetches from Digitizer 1.
         
         Returns
         -------
@@ -115,9 +119,10 @@ class DigitizerDataFetch():
         """
         try:
             # fetch the Digitizer voltage readings
-            spike_safe_socket.send_scpi_command('VOLT:FETC?', enable_logging)
+            prefix = "VOLT" if digitizer_number is None else f"VOLT{digitizer_number}"
+            spike_safe_socket.send_scpi_command(f'{prefix}:FETC?', enable_logging)
             digitizer_data_string = spike_safe_socket.read_data(enable_logging)
-
+    
             # set up the DigitizerData array to be returned
             digitizer_data_collection = []
 
@@ -141,7 +146,7 @@ class DigitizerDataFetch():
             raise
 
     @staticmethod
-    def fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None):
+    def fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number=None):
         """Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query 
 
         Parameters
@@ -156,6 +161,8 @@ class DigitizerDataFetch():
             The hardware trigger delay in microseconds (default to 0us)
         enable_logging : bool, Optional
             Overrides spike_safe_socket.enable_logging attribute (default to None will use spike_safe_socket.enable_logging value)
+        digitizer_number : int, Optional
+            The Digitizer number to fetch from. If None, fetches from Digitizer 1.
         
         Returns
         -------
@@ -172,7 +179,8 @@ class DigitizerDataFetch():
                 raise ValueError(f"{sampling_mode} sampling mode is invalid. Use sampling mode FAST_LOG, MEDIUM_LOG, or SLOW_LOG.")
 
             # fetch the Digitizer voltage readings
-            spike_safe_socket.send_scpi_command('VOLT:FETC?', enable_logging)
+            prefix = "VOLT" if digitizer_number is None else f"VOLT{digitizer_number}"
+            spike_safe_socket.send_scpi_command(f'{prefix}:FETC?', enable_logging)
             digitizer_data_string = spike_safe_socket.read_data(enable_logging)
 
             # set up the DigitizerData array to be returned
@@ -200,7 +208,7 @@ class DigitizerDataFetch():
             raise
 
     @staticmethod
-    def fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None):
+    def fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number=None):
         """Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query 
 
         Parameters
@@ -215,6 +223,8 @@ class DigitizerDataFetch():
             The hardware trigger delay in microseconds (default to 0us)
         enable_logging : bool, Optional
             Overrides spike_safe_socket.enable_logging attribute (default to None will use spike_safe_socket.enable_logging value)
+        digitizer_number : int, Optional
+            The Digitizer number to fetch from. If None, fetches from Digitizer 1.
         
         Returns
         -------
@@ -231,7 +241,8 @@ class DigitizerDataFetch():
             digitizer_sampling_mode_custom_sequence = DigitizerVfCustomSequence().parse_sequence(custom_sequence)
 
             # fetch the Digitizer voltage readings
-            spike_safe_socket.send_scpi_command('VOLT:FETC?', enable_logging)
+            prefix = "VOLT" if digitizer_number is None else f"VOLT{digitizer_number}"
+            spike_safe_socket.send_scpi_command(f'{prefix}:FETC?', enable_logging)
             digitizer_data_string = spike_safe_socket.read_data(enable_logging)
 
             # set up the DigitizerData array to be returned
@@ -259,7 +270,7 @@ class DigitizerDataFetch():
             raise
 
     @staticmethod
-    def wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None):
+    def wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None, digitizer_number=None):
         """Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data
 
         This is a useful function to call prior to sending a fetch query, because it determines whether fetched data will be freshly acquired
@@ -274,6 +285,8 @@ class DigitizerDataFetch():
             Overrides spike_safe_socket.enable_logging attribute (default to None will use spike_safe_socket.enable_logging value)
         timeout : float, Optional
             Timeout in seconds for waiting for new data. If None, wait indefinitely.
+        digitizer_number : int, Optional
+            The Digitizer number to fetch from. If None, fetches from Digitizer 1.
             
         Raises
         ------
@@ -283,9 +296,10 @@ class DigitizerDataFetch():
         try:
             digitizer_has_new_data = ''
             start_time = time.time()  # Record the start time
+            prefix = "VOLT" if digitizer_number is None else f"VOLT{digitizer_number}"
             while True:                  
                 # check for new digitizer data
-                spike_safe_socket.send_scpi_command('VOLT:NDAT?', enable_logging)
+                spike_safe_socket.send_scpi_command(f'{prefix}:NDAT?', enable_logging)
                 digitizer_has_new_data = spike_safe_socket.read_data(enable_logging)
                 if (digitizer_has_new_data == 'TRUE' or digitizer_has_new_data == 'PARTIAL'):
                     break
@@ -500,29 +514,29 @@ class DigitizerDataFetch():
                 return accumulated_time_since_start + aperture
             
 
-def fetch_voltage_data(spike_safe_socket, enable_logging = None):
+def fetch_voltage_data(spike_safe_socket, enable_logging = None, digitizer_number=None):
     """
     Obsolete: Use DigitizerDataFetch.fetch_voltage_data() instead.
     """
-    return DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging)
+    return DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging, digitizer_number=digitizer_number)
 
-def fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None):
+def fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None, digitizer_number=None):
     """
     Obsolete: Use DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear() instead.
     """
-    return DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds, pulse_period_seconds, enable_logging)
+    return DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds, pulse_period_seconds, enable_logging, digitizer_number=digitizer_number)
 
-def fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None):
+def fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number=None):
     """
     Obsolete: Use DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic() instead.
     """
-    return DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds, enable_logging)
+    return DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds, enable_logging, digitizer_number=digitizer_number)
 
-def fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None):
+def fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number=None):
     """
     Obsolete: Use DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom() instead.
     """
-    return DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds, enable_logging)
+    return DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds, enable_logging, digitizer_number=digitizer_number)
 
 def get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_count, hardware_trigger_count=None, hardware_trigger_delay_microseconds=None):
     """
@@ -530,8 +544,8 @@ def get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_
     """
     return DigitizerDataFetch.get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_count, hardware_trigger_count, hardware_trigger_delay_microseconds)
 
-def wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None):
+def wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None, digitizer_number=None):
     """
     Obsolete: Use DigitizerDataFetch.wait_for_new_voltage_data() instead.
     """
-    return DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time, enable_logging, timeout)
+    return DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time, enable_logging, timeout, digitizer_number=digitizer_number)

{spikesafe_python-1.9.7 → spikesafe_python-1.10.2/spikesafe_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spikesafe-python
-Version: 1.9.7
+Version: 1.10.2
 Summary: SpikeSafe Python Library
 Author-email: Vektrex <support@vektrex.com>
 Classifier: Programming Language :: Python :: 3
@@ -26,6 +26,8 @@ GitHub Repository: [SpikeSafe Python Samples](https://github.com/VektrexElectron
 
 Library help documentation: [spikesafe_python_lib_docs](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tree/master/spikesafe_python_lib_docs)
 
+Release notes: [spikesafe_python_lib_docs/_releases](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tree/master/spikesafe_python_lib_docs/_releases)
+
 ## About
 
 The **spikesafe-python** package provides light-weight access Python helper classes and functions to easily communicate with to your SpikeSafe and parse data into easy to use objects.

{spikesafe_python-1.9.7 → spikesafe_python-1.10.2}/tests/test_digitizer_fetch_time_of_sampling.py

@@ -431,4 +431,79 @@ def test_fetch_voltage_data_sampling_mode_custom_trigger_delay(custom_sequence,
 
     # Ensure the mocked methods were called correctly
     mock_socket.send_scpi_command.assert_called_once_with('VOLT:FETC?', None)
-    mock_socket.read_data.assert_called_once()
+    mock_socket.read_data.assert_called_once()
+
+def test_fetch_voltage_data_with_digitizer_number():
+    mock_socket = MagicMock()
+    mock_socket.read_data.return_value = "1.0,2.0,3.0"
+    result = spikesafe_python.DigitizerDataFetch.fetch_voltage_data(
+        spike_safe_socket=mock_socket,
+        enable_logging=None,
+        digitizer_number=2
+    )
+    mock_socket.send_scpi_command.assert_called_once_with('VOLT2:FETC?', None)
+    mock_socket.read_data.assert_called_once()
+    assert [d.voltage_reading for d in result] == [1.0, 2.0, 3.0]
+
+def test_fetch_voltage_data_sampling_mode_linear_with_digitizer_number():
+    mock_socket = MagicMock()
+    mock_socket.read_data.return_value = "1.0,2.0,3.0"
+    result = spikesafe_python.DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(
+        spike_safe_socket=mock_socket,
+        time_sampling_mode=spikesafe_python.DigitizerEnums.TimeSamplingMode.MIDDLE_OF_TIME,
+        aperture_microseconds=2,
+        reading_count=3,
+        hardware_trigger_delay_microseconds=0,
+        pulse_period_seconds=0,
+        digitizer_number=2
+    )
+    mock_socket.send_scpi_command.assert_called_once_with('VOLT2:FETC?', None)
+    mock_socket.read_data.assert_called_once()
+    assert [d.voltage_reading for d in result] == [1.0, 2.0, 3.0]
+
+def test_fetch_voltage_data_sampling_mode_logarithmic_with_digitizer_number():
+    mock_socket = MagicMock()
+    mock_socket.read_data.return_value = "1.0,2.0,3.0"
+    result = spikesafe_python.DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(
+        spike_safe_socket=mock_socket,
+        time_sampling_mode=spikesafe_python.DigitizerEnums.TimeSamplingMode.MIDDLE_OF_TIME,
+        sampling_mode=spikesafe_python.DigitizerEnums.SamplingMode.FAST_LOG,
+        hardware_trigger_delay_microseconds=0,
+        enable_logging=None,
+        digitizer_number=2
+    )
+    mock_socket.send_scpi_command.assert_called_once_with('VOLT2:FETC?', None)
+    mock_socket.read_data.assert_called_once()
+    assert [d.voltage_reading for d in result] == [1.0, 2.0, 3.0]
+
+def test_fetch_voltage_data_sampling_mode_custom_with_digitizer_number():
+    mock_socket = MagicMock()
+    mock_socket.read_data.return_value = "1.0,2.0,3.0"
+    result = spikesafe_python.DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(
+        spike_safe_socket=mock_socket,
+        time_sampling_mode=spikesafe_python.DigitizerEnums.TimeSamplingMode.MIDDLE_OF_TIME,
+        custom_sequence="1@2,1@4,1@6",
+        hardware_trigger_delay_microseconds=0,
+        enable_logging=None,
+        digitizer_number=2
+    )
+    mock_socket.send_scpi_command.assert_called_once_with('VOLT2:FETC?', None)
+    mock_socket.read_data.assert_called_once()
+    assert [d.voltage_reading for d in result] == [1.0, 2.0, 3.0]
+
+def test_wait_for_new_voltage_data_with_digitizer_number():
+    mock_socket = MagicMock()
+    # Simulate the digitizer not ready on first call, ready on second
+    mock_socket.read_data.side_effect = ["FALSE","TRUE"]
+    result = spikesafe_python.DigitizerDataFetch.wait_for_new_voltage_data(
+        spike_safe_socket=mock_socket,
+        wait_time=0.0,
+        enable_logging=None,
+        timeout=None,
+        digitizer_number=2
+    )
+    # Should call send_scpi_command twice with the correct digitizer number
+    expected_cmd = 'VOLT2:NDAT?'
+    actual_calls = mock_socket.send_scpi_command.call_args_list
+    assert all(call[0][0] == expected_cmd for call in actual_calls)
+    assert mock_socket.send_scpi_command.call_count == 2