Merge pull request #77 from VektrexElectronicSystems/development

Development v1.16.0

Author: eljayg

README.md

@@ -4,14 +4,16 @@ Use these code samples to start learning how to communicate with your SpikeSafe
  - [SpikeSafe PSMU](https://www.vektrex.com/products/spikesafe-source-measure-unit/)
  - [SpikeSafe Performance Series ("PRF")](https://www.vektrex.com/products/spikesafe-performance-series-precision-pulsed-current-sources/)
 
+Additional turn-key software solutions for advanced scenarios, such as LM-92 UV Measurement and Reliability/Burn-in Test, may be purchased. For a complete list, visit [Vektrex Software Applications](https://www.vektrex.com/software-applications/).
+
 ## Directory
 
 - [Getting Started](getting_started) - These sequences are primarily intended for first-time users of Vektrex products. They contain steps to perform the basic tasks that are necessary to run the sequences within the run_spikesafe_operating_modes folder.
 - [Run SpikeSafe Operating Modes](run_spikesafe_operating_modes) - These folders contain examples to run specific SpikeSafe modes designed to test LEDs, Lasers, and electrical equipment. Basic settings will be sent to the SpikeSafe, and then one or more channels will be enabled to demonstrate the operation of each mode.
 - [Making Integrated Voltage Measurements](making_integrated_voltage_measurements) - These folders contain examples to measure voltage using the SpikeSafe PSMU's integrated voltage Digitizer. The SpikeSafe outputs current to an LED, Laser, or electrical equipment, and then voltage measurements are read and displayed onscreen.
 - [Using the Force Sense Selector Switch](using_force_sense_selector_switch) - These folders contain examples to operate the optional integrated switch within the SpikeSafe PSMU. The SpikeSafe outputs to an LED, Laser, or electrical equipment as in the previous examples, and the switch is used to either disconnect the SpikeSafe from the test circuit or to operate an auxiliary source to power the DUT.
 - [Application-Specific Examples](application_specific_examples) - These folders consist of more advanced sequences to address specific test scenarios, as well as some demonstrations to fine-tune your SpikeSafe current output. These sequences explain how to make light measurements using a SpikeSafe and a spectrometer, how to make in-situ junction temperature measurements on LEDs, and how to take full advantage of all SpikeSafe features.
-- [spikesafe-python API Overview](spikesafe_python_lib_docs). These folders contain complete class documentation for the spikesafe-python package used to power all of the aforementioned example directories.
+- [spikesafe-python API Overview](spikesafe_python_lib_docs). These folders contain complete class documentation for the [spikesafe-python](https://pypi.org/project/spikesafe-python/) package used to power all of the aforementioned example directories.
 
 ## Downloading Files
 
@@ -23,7 +25,7 @@ If only a specific sequence or folder is needed, right-click the desired file/fo
 
 ### Setup Steps
 
-1. **Install Python 3.10 to 3.13**
+1. **Install Python 3.10 to 3.14**
    - Download Python from [python.org](https://www.python.org/downloads/).
    - During installation check **Add Python to PATH**.
 
@@ -64,9 +66,9 @@ To run these sequences in a more feature rich IDE, use the free [Visual Studio C
 
 Start with [TCP Socket Sample](getting_started/tcp_socket_sample) to learn how setup a simple socket to communicate with your SpikeSafe. Then check out the rest of the samples under [Getting Started](getting_started).
 
-You will need to modify the specified IP address within a sequence to match the IP address that is physically set on your SpikeSafe's DIP switch. In each sequence, the default IP address of 10.0.0.220 is set in the line `ip_address = '10.0.0.220'`.
+You will need to modify the specified IP address within a sequence to match the IP address that is physically set on your SpikeSafe's DIP switch. In each sequence, the default IP address of 10.0.0.220 is set in the line `ip_address: str = '10.0.0.220'`.
 
-Each file can be modified to include additional settings and commands to fit individual needs. Complete class documentation is available in [spikesafe-python API Overview](spikesafe_python_lib_docs).
+Each file can be modified to include additional settings and commands to fit individual needs. Complete class documentation for the [spikesafe-python](https://pypi.org/project/spikesafe-python/) package is available in [spikesafe-python API Overview](spikesafe_python_lib_docs).
 
 Most examples will log messages to the SpikeSafePythonSamples.log file under your local SpikeSafePythonSamples\ directory. Please refer to this file to ensure your sequence is running correctly.
 
@@ -81,12 +83,18 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
 
 ## FAQ
 
-I'm developing an application using NI-VISA, what is the recommended practice for handling termination characters?  
-See [Termination Characters in NI-VISA](https://www.ni.com/en-us/support/documentation/supplemental/06/termination-characters-in-ni-visa.html)
+I'm developing an application using C/C++, how do I get started?  
+See [Wrapping C/C++ for Python](https://intermediate-and-advanced-software-carpentry.readthedocs.io/en/latest/c++-wrapping.html)
+
+I'm developing an application using LabView, how do I get started?  
+See [Integrating Python Code in LabVIEW](https://www.ni.com/en/support/documentation/supplemental/18/installing-python-for-calling-python-code.html?srsltid=AfmBOopUCkwZOUDOXRi8BDeCwXPoa-t65l7ChqWDWXJgeQWCP3ZqJAqT)
 
 I'm developing an application using MATLAB, how do I get started?  
 See [System Requirements for MATLAB Engine API for Python](https://www.mathworks.com/help/matlab/matlab_external/system-requirements-for-matlab-engine-for-python.html) to ensure your system can support Python. Then see [Call Python from MATLAB](https://www.mathworks.com/help/matlab/call-python-libraries.html) on how to access Python libraries in MATLAB.
 
+I'm developing an application using NI-VISA, what is the recommended practice for handling termination characters?  
+See [Termination Characters in NI-VISA](https://www.ni.com/en-us/support/documentation/supplemental/06/termination-characters-in-ni-visa.html)
+
 Why does my script's performance vary between different operating systems and machines?  
 See [Remarks](/spikesafe_python_lib_docs/Threading/wait/README.md#remarks) describing resolution of system timers between operating systems.
 

application_specific_examples/fixed_pulse_count_using_software_timing/FixedPulseCountUsingSoftwareTimingExample.py

@@ -9,8 +9,8 @@
 ### set these before starting application
 
 # SpikeSafe IP address and port number
-ip_address = '10.0.0.220'
-port_number = 8282 
+ip_address: str = '10.0.0.220'
+port_number:int = 8282 
 
 ### setting up sequence log
 log = logging.getLogger(__name__)
@@ -39,6 +39,9 @@
     tcp_socket.send_scpi_command('*RST')                  
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
+    # parse the SpikeSafe information
+    spikesafe_info = spikesafe_python.SpikeSafeInfoParser.parse_spikesafe_info(tcp_socket)
+
     # set Channel 1's mode to DC Dynamic and check for all events
     tcp_socket.send_scpi_command('SOUR1:FUNC:SHAP PULSEDDYNAMIC')
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
@@ -52,7 +55,7 @@
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
     # set Channel 1's Pulse On Time to 1us and check for all events
-    pulse_on_time = 0.000001
+    pulse_on_time: float = 0.000001
     tcp_socket.send_scpi_command(f'SOUR1:PULS:TON {spikesafe_python.Precision.get_precise_time_command_argument(pulse_on_time)}')
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
@@ -65,12 +68,13 @@
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
     # set Channel 1's current to 100mA and check for all events
-    set_current = 0.1
+    set_current: float = 0.1
     tcp_socket.send_scpi_command(f'SOUR1:CURR {spikesafe_python.Precision.get_precise_current_command_argument(set_current)}')
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
     # set Channel 1's voltage to 20V and check for all events
-    tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(20)}')
+    compliance_voltage: float = 20
+    tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(compliance_voltage)}')
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
     # set Channel 1's Auto Range to On and check for all events
@@ -91,7 +95,7 @@
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
     # Start the channel
-    tcp_socket.send_scpi_command('OUTP1 ON')
+    tcp_socket.send_scpi_command('OUTP1 1')
 
     # wait until Channel 1 is ready
     spikesafe_python.ReadAllEvents.read_until_event(tcp_socket, spikesafe_python.SpikeSafeEvents.CHANNEL_READY) # event 100 is "Channel Ready"
@@ -101,7 +105,14 @@
     time.sleep(0.030)
 
     # disable Channel
-    tcp_socket.send_scpi_command('OUTP1 OFF')
+    tcp_socket.send_scpi_command('OUTP1 0')
+
+    # wait until the channel is fully discharged
+    if spikesafe_info.supports_discharge_query:
+        spikesafe_python.Discharge.wait_for_spikesafe_channel_discharge(tcp_socket, channel_number=1)
+    else:
+        wait_time = spikesafe_python.Discharge.get_spikesafe_channel_discharge_time(compliance_voltage)
+        spikesafe_python.Threading.wait(wait_time)
 
     # disconnect from SpikeSafe    
     tcp_socket.close_socket()      

application_specific_examples/making_tj_measurements/TjMeasurement.py

@@ -15,7 +15,7 @@
 import spikesafe_python
 from matplotlib import pyplot as plt
 
-def log_and_print_to_console(message_string):
+def log_and_print_to_console(message_string: str) -> None:
     log.info(message_string.replace('\n',''))
     print(message_string)
 
@@ -24,7 +24,7 @@ def receive_user_input_and_log():
     log.info(inputText)
     return inputText
 
-def calculate_Vf0(start_point, end_point, digitizer_data_list):
+def calculate_Vf0(start_point: int, end_point: int, digitizer_data_list: list[spikesafe_python.DigitizerData]) -> float:
     # only want to reference the data within the straight line
     straight_line_digitizer_data = []
     for index in range(start_point, end_point):
@@ -56,8 +56,8 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
 ### set these before starting application
 
 # SpikeSafe IP address and port number
-ip_address = '10.0.0.220'
-port_number = 8282 
+ip_address: str = '10.0.0.220'
+port_number:int = 8282 
 
 # The graph zoom offset is used to zoom in or out to better visualize data in the final graph to make it easier to determine Vf(0). Value is in volts
 # A value of zero corresponds to a completely zoomed in graph. Increase the value to zoom out. Recommended values are between 0.001 and 0.100
@@ -90,10 +90,13 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
     tcp_socket.send_scpi_command('*RST')                  
     spikesafe_python.ReadAllEvents.log_all_events(tcp_socket)
 
+    # parse the SpikeSafe information
+    spikesafe_info = spikesafe_python.SpikeSafeInfoParser.parse_spikesafe_info(tcp_socket)
+    
     # set up Channel 1 for Bias Current output to determine the K-factor
     tcp_socket.send_scpi_command('SOUR1:FUNC:SHAP BIAS')
     tcp_socket.send_scpi_command(f'SOUR0:CURR:BIAS {spikesafe_python.Precision.get_precise_current_command_argument(0.033)}')
-    compliance_voltage = 40
+    compliance_voltage: float = 40
     tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(compliance_voltage)}')
     tcp_socket.send_scpi_command('SOUR1:CURR:PROT 50')    
     tcp_socket.send_scpi_command('OUTP1:RAMP FAST')  
@@ -127,32 +130,38 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
 
     # turn off Channel 1 
     tcp_socket.send_scpi_command('OUTP1 0')
-    wait_time = spikesafe_python.Discharge.get_spikesafe_channel_discharge_time(compliance_voltage)
-    spikesafe_python.Threading.wait(wait_time)
+    
+    # wait until the channel is fully discharged
+    if spikesafe_info.supports_discharge_query:
+        spikesafe_python.Discharge.wait_for_spikesafe_channel_discharge(tcp_socket, channel_number=1)
+    else:
+        wait_time = spikesafe_python.Discharge.get_spikesafe_channel_discharge_time(compliance_voltage)
+        spikesafe_python.Threading.wait(wait_time)
 
     log_and_print_to_console('\nK-factor values obtained. Stopped bias current output. Configuring to perform Electrical Test Method measurement.')
 
     # set up Channel 1 for CDBC output to make the junction temperature measurement
     tcp_socket.send_scpi_command('SOUR1:FUNC:SHAP BIASPULSEDDYNAMIC')
     tcp_socket.send_scpi_command(f'SOUR1:CURR {spikesafe_python.Precision.get_precise_current_command_argument(3.5)}')
     tcp_socket.send_scpi_command(f'SOUR0:CURR:BIAS {spikesafe_python.Precision.get_precise_current_command_argument(0.033)}')
-    tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(40)}')
+    compliance_voltage: float = 40
+    tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(compliance_voltage)}')
     tcp_socket.send_scpi_command(f'SOUR1:PULS:TON {spikesafe_python.Precision.get_precise_time_command_argument(1)}')
     tcp_socket.send_scpi_command(f'SOUR1:PULS:TOFF {spikesafe_python.Precision.get_precise_time_command_argument(0.001)}')
     tcp_socket.send_scpi_command('SOUR1:CURR:PROT 50')    
     tcp_socket.send_scpi_command('OUTP1:RAMP FAST')  
 
     # set Digitizer settings to take a series of quick measurements during the Off Time of CDBC operation
     tcp_socket.send_scpi_command('VOLT:RANG 100')
-    aperture = 2
+    aperture: int = 2
     tcp_socket.send_scpi_command(f'VOLT:APER {spikesafe_python.Precision.get_precise_time_microseconds_command_argument(aperture)}')
-    hardware_trigger_delay = 0
+    hardware_trigger_delay: int = 0
     tcp_socket.send_scpi_command(f'VOLT:TRIG:DEL {spikesafe_python.Precision.get_precise_time_microseconds_command_argument(hardware_trigger_delay)}')
     tcp_socket.send_scpi_command('VOLT:TRIG:SOUR HARDWARE')
     tcp_socket.send_scpi_command('VOLT:TRIG:EDGE FALLING')
-    hardware_trigger_count = 1
+    hardware_trigger_count: int = 1
     tcp_socket.send_scpi_command(f'VOLT:TRIG:COUN {hardware_trigger_count}')
-    reading_count = 500
+    reading_count: int = 500
     tcp_socket.send_scpi_command(f'VOLT:READ:COUN {reading_count}')
 
     # check all SpikeSafe event since all settings have been sent
@@ -180,6 +189,13 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
     # turn off Channel 1 after routine is complete
     tcp_socket.send_scpi_command('OUTP1 0')
 
+    # wait until the channel is fully discharged
+    if spikesafe_info.supports_discharge_query:
+        spikesafe_python.Discharge.wait_for_spikesafe_channel_discharge(tcp_socket, channel_number=1)
+    else:
+        wait_time = spikesafe_python.Discharge.get_spikesafe_channel_discharge_time(compliance_voltage)
+        spikesafe_python.Threading.wait(wait_time)
+
     # prepare digitizer voltage data to plot
     samples = []
     voltage_readings = []

application_specific_examples/making_transient_dual_interface_measurement/digitizer_log_sampling_demo.py

@@ -10,17 +10,17 @@
 from matplotlib import pyplot as plt 
 import numpy as np
 
-def log_and_print_to_console(message_string):
+def log_and_print_to_console(message_string: str) -> None:
     print(message_string)
 
-def receive_user_input_and_log():
+def receive_user_input_and_log() -> str:
     inputText = input()
     return inputText
 
 ### set these before starting application
 
 # SpikeSafe port number
-port_number = 8282         
+port_number: int = 8282         
 
 ok_string = "0, OK"
 channel_ready_string = "100, Channel Ready; Channel(s) 1"
@@ -55,7 +55,10 @@ def receive_user_input_and_log():
     tcp_socket.open_socket(ip_address, port_number)
 
     # reset to default state and check for all events,  this will automatically abort digitizer in order get it into a known state. This is good practice when connecting to a SpikeSafe PSMU  
-    tcp_socket.send_scpi_command('*RST')    
+    tcp_socket.send_scpi_command('*RST')
+    
+    # parse the SpikeSafe information
+    spikesafe_info = spikesafe_python.SpikeSafeInfoParser.parse_spikesafe_info(tcp_socket)    
 
     # Set digitizer range to 10V
     tcp_socket.send_scpi_command('VOLT:RANG 10')
@@ -95,7 +98,8 @@ def receive_user_input_and_log():
     tcp_socket.send_scpi_command('SOUR1:FUNC:SHAP DCDYNAMIC')
 
     # set MCV to 25
-    tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(40)}')
+    compliance_voltage: float = 40
+    tcp_socket.send_scpi_command(f'SOUR1:VOLT {spikesafe_python.Precision.get_precise_compliance_voltage_command_argument(compliance_voltage)}')
 
     # set Auto Range
     tcp_socket.send_scpi_command('SOUR1:CURR:RANG:AUTO 1')
@@ -117,7 +121,7 @@ def receive_user_input_and_log():
     tcp_socket.send_scpi_command('VOLT:INIT')
 
     # Start the channel
-    tcp_socket.send_scpi_command('OUTP1 ON')
+    tcp_socket.send_scpi_command('OUTP1 1')
     # wait for channel ready
     while True:
         tcp_socket.send_scpi_command('SYST:ERR?')
@@ -145,6 +149,16 @@ def receive_user_input_and_log():
         syst_err_string = tcp_socket.read_data()    
         if syst_err_string == ok_string:
             break
+    
+    # disable Channel
+    tcp_socket.send_scpi_command('OUTP1 0')
+
+    # wait until the channel is fully discharged
+    if spikesafe_info.supports_discharge_query:
+        spikesafe_python.Discharge.wait_for_spikesafe_channel_discharge(tcp_socket, channel_number=1)
+    else:
+        wait_time = spikesafe_python.Discharge.get_spikesafe_channel_discharge_time(compliance_voltage)
+        spikesafe_python.Threading.wait(wait_time)
 
     # disconnect from SpikeSafe    
     tcp_socket.close_socket()      

application_specific_examples/making_transient_dual_interface_measurement/produce_conductive_thermal_resistance.py

@@ -9,10 +9,10 @@
 from matplotlib import pyplot as plt 
 import numpy as np
 
-def log_and_print_to_console(message_string):
+def log_and_print_to_console(message_string: str) -> None:
     print(message_string)
 
-def receive_user_input_and_log():
+def receive_user_input_and_log() -> str:
     inputText = input()
     return inputText
 
@@ -72,6 +72,7 @@ def receive_user_input_and_log():
     else:
         num_of_data = num_of_data_noGrease
 
+    sampling_mode_string = ""
     if sampling_mode_input == fast_sampling_mode:
         sampling_mode_string = fast_sampling_string
     elif sampling_mode_input == medium_sampling_mode: