Merge pull request #60 from VektrexElectronicSystems:development

v1.10.0

Author: eljayg

README.md

@@ -16,37 +16,41 @@ Use these code samples to start learning how to communicate with your SpikeSafe
 ## Usage
 
 ### Python
-Download and install [Python](https://www.python.org/downloads/), which will install:  
+Download from the official [Python](https://www.python.org/downloads/) website.
+
+During Python installation check the box Add Python to PATH when prompted.
+- Confirm Python PATH is set in **Command Prompt** by typing `py --version` to verify the Python version
+
+Installing Python will install:
 - IDLE  
 - Python Launcher  
 - Python3 Interpreter
 
-It is recommended to use a version of Python with the status key of bugfix or higher, see [Python Release Cycle](https://devguide.python.org/versions/#versions).
+After Python installation is complete, restart the computer to ensure packages under the [Packages](#packages) Section can be successfully installed.
+
+Vektrex targets working support for versions of Python with the status key of bugfix or higher, see [Python Release Cycle](https://devguide.python.org/versions/#versions).
 
 #### Windows Setup
 
 ##### Use the Standard Console Command Prompt
 To open Command Prompt press the key combination Windows + R to open a Run dialog, and then type cmd and hit Enter or click Ok.
 
 ##### Add Python to PATH
-It is recommended that the path of Python Interpreter is added for easy usage. There are two ways to add Python to Windows PATH.
-
-1. During Python installation check the box Add Python to PATH when prompted.
-   - Confirm Python PATH is set in **Command Prompt** by typing `py --version` to verify the Python version
-
-2. Manually add Python to Windows Path:
-   - Press the key combination **Windows + R** to open a Run dialog
-   - Type `sysdm.cpl` to open the System Properties
-   - Press **Advanced** tab and then press on **Environment Variables…** to open Environment Variables dialog
-   - Under the **User variables** box, press on **New…** to add the `Path` variable (if your **Path** variable already exists, then press on **Edit…** instead):
-   - Set the Path **Variable value** to the 1) `Python application path` and 2) `Python Scripts path`. To find these paths and set the value:
-     - Type `Python` in the Windows Search Bar
-     - Right-click on the **Python App**, and then press **Open file location**
-     - Right-click on the **Python shortcut**, and then press **Open file location** (this is the `Python application path`)
-     - Navigate to the **scripts** folder (this is the `Python Scripts path`)
-     - Set the Path **Variable value** to `Python application path;Python Scripts path` (paths are separated by a semicolon)
-   - Press **OK**
-   - Confirm Python PATH is set in **Command Prompt** by typing `py --version` to verify the Python version
+It is recommended that the path of Python Interpreter is added for easy usage. If this was not done in as part of the [Python](#python) section, it can be manually done afterwards.
+
+Manually add Python to Windows Path:
+- Press the key combination **Windows + R** to open a Run dialog
+- Type `sysdm.cpl` to open the System Properties
+- Press **Advanced** tab and then press on **Environment Variables…** to open Environment Variables dialog
+- Under the **User variables** box, press on **New…** to add the `Path` variable (if your **Path** variable already exists, then press on **Edit…** instead):
+- Set the Path **Variable value** to the 1) `Python application path` and 2) `Python Scripts path`. To find these paths and set the value:
+   - Type `Python` in the Windows Search Bar
+   - Right-click on the **Python App**, and then press **Open file location**
+   - Right-click on the **Python shortcut**, and then press **Open file location** (this is the `Python application path`)
+   - Navigate to the **scripts** folder (this is the `Python Scripts path`)
+   - Set the Path **Variable value** to `Python application path;Python Scripts path` (paths are separated by a semicolon)
+- Press **OK**
+- Confirm Python PATH is set in **Command Prompt** by typing `py --version` to verify the Python version
 
 #### Mac OS X Setup
 
@@ -78,43 +82,43 @@ To run these sequences a light-weight IDE, or to target cross-platform developme
 To run these sequences in a more feature rich IDE, use the free [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/). See [Python In Visual Studio](https://docs.microsoft.com/en-us/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-00-installation?view=vs-2022) to simply setup your IDE with Python. Optionall, using a [virtual environment](https://docs.microsoft.com/en-us/visualstudio/python/managing-python-environments-in-visual-studio?view=vs-2022) is recommended to successfully meet the installation requirements to run these sequences.
 
 ### Packages
+SpikeSafePythonSamples requires packages to run all scripts.
 
-#### Managing Packages
-##### How to Install/Upgraded Packages
-Installing packages use pip. It is recommended that pip be updated to latest version.
+There are two ways to install these packages:
+1. See Section [Automatically Install Packages](#automatically-install-packages)
+2. See Section [Manually Install Packages](#manually-install-packages)
 
-To install/upgrade pip, run command: 
-| OS | Command |
-| - | - |
-| Windows | `py -m pip install --upgrade pip` |
-| macOS | `python3 -m pip install --upgrade pip` |
+After all packages are installed, refer to section [Package Helpers](#package-helpers) to verify package details.
 
-To display the version of pip, run command:
-| OS | Command |
-| - | - |
-| Windows | `pip -V` |
-| macOS | `pip3 -V` |
+#### Automatically Install Packages
+All necessary SpikeSafePythonSamples packages may be installed automatically. See [Install SpikeSafePythonSamples Packages](/getting_started/install_spikesafe_python_samples_packages/) and run the python .py script in this directory.
 
-##### How to View All Installed Packages
-A list of all installed packages can be displayed.
+#### Manually Install Packages
+All necessary SpikeSafePythonSamples packages may be installed manually. Perform all of the subsections below.
 
-To view all installed packages, run command:
+##### Installing pip Package
+Installing packages use [pip](https://pypi.org/project/pip/). It is recommended that pip be updated to latest version.
+
+First, check if your environment has pip installed, run command:
 | OS | Command |
 | - | - |
-| Windows | `pip freeze` |
-| macOS | `pip3 freeze` |
+| Windows | `py -m pip --version` |
+| macOS | `python3 -m pip --version` |
 
-##### How to View Details of an Installed Package
-After a package is installed the details of a package can be displayed.
+If your environment does not have pip installed, run command:
+| OS | Command |
+| - | - |
+| Windows | `py -m ensurepip --upgrade` |
+| macOS | `python3 -m ensurepip --upgrade` |
 
-To view details of a package, run command: 
+To install/upgrade pip, run command: 
 | OS | Command |
 | - | - |
-| Windows | `pip show <package name>` |
-| macOS | `pip3 show <package name>` |
+| Windows | `py -m pip install --upgrade pip` |
+| macOS | `python3 -m pip install --upgrade pip` |
 
 ##### Installing spikesafe-python Package
-The [spikesafe-python](https://pypi.org/project/spikesafe-python/) library will need to be installed. Vektrex recommends always having the latest version of spikesafe-python when running these sequences; the current version is 1.4.5.
+The [spikesafe-python](https://pypi.org/project/spikesafe-python/) library will need to be installed. Vektrex recommends always having the latest version of spikesafe-python when running these sequences; the current version is 1.5.15.
 
 To install this package, run command:
 | OS | Command |
@@ -126,7 +130,7 @@ Once the spikesafe-python package is installed, each script in this repository c
 
 Complete class documentation is available for spikesafe-python in [spikesafe-python API Overview](spikesafe_python_lib_docs).
 
-#### Installing matplotlib Package
+##### Installing matplotlib Package
 Some sequences involve graphing measurement results. To properly graph results, the [matplotlib](https://matplotlib.org/) library is required (version 3.2.1 or greater). Once the matplotlib library is installed, each sequence that involves graphing can be run as a standalone Python file.
 
 To install this package, run command:
@@ -135,7 +139,7 @@ To install this package, run command:
 | Windows | `py -m pip install matplotlib` |
 | macOS | `python3 -m pip install matplotlib` |
 
-#### Installing PyCLibrary Package
+##### Installing PyCLibrary Package
 Some sequences require external C resources, and requires the [PyCLibrary](https://pyclibrary.readthedocs.io/en/latest/) library. Once the PyCLibrary library is installed, each sequence that involves external C resources can be run as a standalone Python file.
 
 To install this package, run command:
@@ -144,7 +148,7 @@ To install this package, run command:
 | Windows | `py -m pip install pyclibrary` |
 | macOS | `python3 -m pip install pyclibrary` |
 
-#### Installing pyserial Package
+##### Installing pyserial Package
 Some sequences involve connecting to a serial interface instrument and requires the [pyserial](https://pypi.org/project/pyserial/) library (version 3.5 or greater). Once the pyserial library is installed, each sequence that involves a serial interface can be run as a standalone Python file.
 
 To install this package, run command:
@@ -153,6 +157,26 @@ To install this package, run command:
 | Windows | `py -m pip install pyserial` |
 | macOS | `python3 -m pip install pyserial` |
 
+#### Package Helpers
+
+##### How to View All Installed Packages
+A list of all installed packages can be displayed.
+
+To view all installed packages, run command:
+| OS | Command |
+| - | - |
+| Windows | `pip freeze` |
+| macOS | `pip3 freeze` |
+
+##### How to View Details of an Installed Package
+After a package is installed the details of a package can be displayed.
+
+To view details of a package, run command: 
+| OS | Command |
+| - | - |
+| Windows | `pip show <package name>` |
+| macOS | `pip3 show <package name>` |
+
 ### General Usage
 For most examples, you may 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'`.
 

application_specific_examples/controlling_thermal_platform_temperature/ControllingThermalPlatformTemperature.py

@@ -30,6 +30,8 @@
 try:
     log.info("ControllingThermalPlatformTemperature.py started.")
 
+    log.info("Python version: {}".format(sys.version))
+
     TEC_controller = SerialInterfaceDll()
 
     # Set the beep enable sound

application_specific_examples/fixed_pulse_count_using_software_timing/FixedPulseCountUsingSoftwareTimingExample.py

@@ -4,6 +4,10 @@
 import sys
 import time
 import logging
+from spikesafe_python.Compensation import get_optimum_compensation
+from spikesafe_python.Precision import get_precise_compliance_voltage_command_argument
+from spikesafe_python.Precision import get_precise_current_command_argument
+from spikesafe_python.Precision import get_precise_time_command_argument
 from spikesafe_python.ReadAllEvents import log_all_events
 from spikesafe_python.ReadAllEvents import read_until_event
 from spikesafe_python.SpikeSafeEvents import SpikeSafeEvents
@@ -31,6 +35,8 @@
 ### start of main program
 try:
     log.info("FixedPulseCountUsingSoftwareTimingExample.py started.")
+
+    log.info("Python version: {}".format(sys.version))
 
     # instantiate new TcpSocket to connect to SpikeSafe
     tcp_socket = TcpSocket()
@@ -54,35 +60,38 @@
     log_all_events(tcp_socket)
 
     # set Channel 1's Pulse On Time to 1us and check for all events
-    tcp_socket.send_scpi_command('SOUR1:PULS:TON 0.000001')
+    pulse_on_time = 0.000001
+    tcp_socket.send_scpi_command(f'SOUR1:PULS:TON {get_precise_time_command_argument(pulse_on_time)}')
     log_all_events(tcp_socket)
 
     # set Channel 1's Pulse Off Time 9us and check for all events
-    tcp_socket.send_scpi_command('SOUR1:PULS:TOFF 0.000009')
+    tcp_socket.send_scpi_command(f'SOUR1:PULS:TOFF {get_precise_time_command_argument(0.000009)}')
     log_all_events(tcp_socket)
 
     # set Channel 1's Pulse Width adjustment to disabled and check for all events
     tcp_socket.send_scpi_command('SOUR1:PULS:AADJ 0')
     log_all_events(tcp_socket)
 
     # set Channel 1's current to 100mA and check for all events
-    tcp_socket.send_scpi_command('SOUR1:CURR 0.1')
+    set_current = 0.1
+    tcp_socket.send_scpi_command(f'SOUR1:CURR {get_precise_current_command_argument(set_current)}')
     log_all_events(tcp_socket)
 
     # set Channel 1's voltage to 20V and check for all events
-    tcp_socket.send_scpi_command('SOUR1:VOLT 20')
+    tcp_socket.send_scpi_command(f'SOUR1:VOLT {get_precise_compliance_voltage_command_argument(20)}')
     log_all_events(tcp_socket)
 
     # set Channel 1's Auto Range to On and check for all events
     tcp_socket.send_scpi_command('SOUR1:CURR:RANG:AUTO 1')
     log_all_events(tcp_socket)
 
-    # set Channel 1's Load Impedance to High and check for all events
-    tcp_socket.send_scpi_command('SOUR1:PULS:CCOM 1')
+    # set Channel 1's Load Impedance and Rise Time, and check for all events
+    tcp_socket.send_scpi_command('SOUR1:CURR? MAX')
+    spikesafe_model_max_current = float(tcp_socket.read_data())
+    load_impedance, rise_time = get_optimum_compensation(spikesafe_model_max_current, set_current, pulse_on_time)
+    tcp_socket.send_scpi_command(f'SOUR1:PULS:CCOM {load_impedance}')
     log_all_events(tcp_socket)
-
-    # set Channel 1's Rise Time to Fast and check for all events
-    tcp_socket.send_scpi_command('SOUR1:PULS:RCOM 1')
+    tcp_socket.send_scpi_command(f'SOUR1:PULS:RCOM {rise_time}')
     log_all_events(tcp_socket)
 
     # set Channel 1's Ramp mode to Fast and check for all events

application_specific_examples/making_tj_measurements/TjMeasurement.py

@@ -14,7 +14,12 @@
 import statistics
 from spikesafe_python.DigitizerDataFetch import wait_for_new_voltage_data
 from spikesafe_python.DigitizerDataFetch import fetch_voltage_data
+from spikesafe_python.Discharge import get_spikesafe_channel_discharge_time
 from spikesafe_python.MemoryTableReadData import log_memory_table_read
+from spikesafe_python.Precision import get_precise_compliance_voltage_command_argument
+from spikesafe_python.Precision import get_precise_current_command_argument
+from spikesafe_python.Precision import get_precise_time_command_argument
+from spikesafe_python.Precision import get_precise_time_microseconds_command_argument
 from spikesafe_python.ReadAllEvents import log_all_events
 from spikesafe_python.ReadAllEvents import read_until_event
 from spikesafe_python.SpikeSafeEvents import SpikeSafeEvents
@@ -86,23 +91,23 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
 ### start of main program
 try:
     log.info("TjMeasurement.py started.")
+
+    log.info("Python version: {}".format(sys.version))
 
     # instantiate new TcpSocket to connect to SpikeSafe
     tcp_socket = TcpSocket()
     tcp_socket.open_socket(ip_address, port_number)
 
-    # reset to default state and check for all events,
+    # 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
     # it is best practice to check for errors after sending each command      
     tcp_socket.send_scpi_command('*RST')                  
     log_all_events(tcp_socket)
-
-    # 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('VOLT:ABOR')
-
+    
     # 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('SOUR0:CURR:BIAS 0.033')
-    tcp_socket.send_scpi_command('SOUR1:VOLT 40')
+    tcp_socket.send_scpi_command(f'SOUR0:CURR:BIAS {get_precise_current_command_argument(0.033)}')
+    compliance_voltage = 40
+    tcp_socket.send_scpi_command(f'SOUR1:VOLT {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')  
 
@@ -135,27 +140,33 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
 
     # turn off Channel 1 
     tcp_socket.send_scpi_command('OUTP1 0')
+    wait_time = get_spikesafe_channel_discharge_time(compliance_voltage)
+    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('SOUR1:CURR 3.5')
-    tcp_socket.send_scpi_command('SOUR0:CURR:BIAS 0.033')
-    tcp_socket.send_scpi_command('SOUR1:VOLT 40')
-    tcp_socket.send_scpi_command('SOUR1:PULS:TON 1')
-    tcp_socket.send_scpi_command('SOUR1:PULS:TOFF 0.001')
+    tcp_socket.send_scpi_command(f'SOUR1:CURR {get_precise_current_command_argument(3.5)}')
+    tcp_socket.send_scpi_command(f'SOUR0:CURR:BIAS {get_precise_current_command_argument(0.033)}')
+    tcp_socket.send_scpi_command(f'SOUR1:VOLT {get_precise_compliance_voltage_command_argument(40)}')
+    tcp_socket.send_scpi_command(f'SOUR1:PULS:TON {get_precise_time_command_argument(1)}')
+    tcp_socket.send_scpi_command(f'SOUR1:PULS:TOFF {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')
-    tcp_socket.send_scpi_command('VOLT:APER 2')
-    tcp_socket.send_scpi_command('VOLT:TRIG:DEL 0')
+    aperture = 2
+    tcp_socket.send_scpi_command(f'VOLT:APER {get_precise_time_microseconds_command_argument(aperture)}')
+    hardware_trigger_delay = 0
+    tcp_socket.send_scpi_command(f'VOLT:TRIG:DEL {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')
-    tcp_socket.send_scpi_command('VOLT:TRIG:COUN 1')
-    tcp_socket.send_scpi_command('VOLT:READ:COUN 500')
+    hardware_trigger_count = 1
+    tcp_socket.send_scpi_command(f'VOLT:TRIG:COUN {hardware_trigger_count}')
+    reading_count = 500
+    tcp_socket.send_scpi_command(f'VOLT:READ:COUN {reading_count}')
 
     # check all SpikeSafe event since all settings have been sent
     log_all_events(tcp_socket)
@@ -172,7 +183,7 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
     # initialize the digitizer. Measurements will be taken once a current pulse is outputted
     tcp_socket.send_scpi_command('VOLT:INIT')
 
-    # wait for the Digitizer measurements to complete 
+    # wait for the Digitizer measurements to complete
     wait_for_new_voltage_data(tcp_socket, 0.5)
 
     # fetch the Digitizer voltage readings using VOLT:FETC? query