Use these code samples to start learning how to communicate with your SpikeSafe via TCP/IP using Python. Sequences can be run with the following Vektrex products:
- 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 - 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 - 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 - 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 - 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. These folders contain complete class documentation for the spikesafe-python package used to power all of the aforementioned example directories.
Download from the official Python website.
During Python installation check the box Add Python to PATH when prompted.
- Confirm Python PATH is set in Command Prompt by typing
py --versionto verify the Python version
Installing Python will install:
- IDLE
- Python Launcher
- Python3 Interpreter
After Python installation is complete, restart the computer to ensure packages under the 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.
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.
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 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.cplto 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
Pathvariable (if your Path variable already exists, then press on Edit… instead): - Set the Path Variable value to the 1)
Python application pathand 2)Python Scripts path. To find these paths and set the value:- Type
Pythonin 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)
- Type
- Press OK
- Confirm Python PATH is set in Command Prompt by typing
py --versionto verify the Python version
To open Terminal navigate to Applications, then Utilities, then double-click the Terminal program.
It is recommended that the path of Python Interpreter is added for easy usage. To do this:
- The path for Python interpreter can be found by opening Python Launcher application (this is the
Python install directory) - Open Terminal
- Type
sudo nano /etc/paths - Enter path of the
Python install directoryhere - Press
Control + Xto exit - Press
Yto save - Confirm Python PATH is set in Terminal by typing
python3 --versionto verify the Python version
To run these sequences a light-weight IDE, or to target cross-platform development, use the free Visual Studio Code. See Getting Started with Python in VS Code to simply setup your IDE with Python. Optionally, using a virtual environment is recommended to successfully meet the installation requirements to run these sequences. To setup your virtual environment run the follow commands and then continue to install the remaining Python packages later in this document:
| OS | Command |
|---|---|
| Windows | py -m venv .venv followed by .venv\scripts\activate |
| macOS | python3 -m venv .venv followed by .venv\scripts\activate |
To run these sequences in a more feature rich IDE, use the free Visual Studio Community. See Python In Visual Studio to simply setup your IDE with Python. Optionall, using a virtual environment is recommended to successfully meet the installation requirements to run these sequences.
SpikeSafePythonSamples requires packages to run all scripts.
There are two ways to install these packages:
- See Section Automatically Install Packages
- See Section Manually Install Packages
After all packages are installed, refer to section Package Helpers to verify package details.
All necessary SpikeSafePythonSamples packages may be installed automatically. See Install SpikeSafePythonSamples Packages and run the python .py script in this directory.
All necessary SpikeSafePythonSamples packages may be installed manually. Perform all of the subsections below.
Installing packages use pip. It is recommended that pip be updated to latest version.
First, check if your environment has pip installed, run command:
| OS | Command |
|---|---|
| Windows | py -m pip --version |
| macOS | python3 -m pip --version |
If your environment does not have pip installed, run command:
| OS | Command |
|---|---|
| Windows | py -m ensurepip --upgrade |
| macOS | python3 -m ensurepip --upgrade |
To install/upgrade pip, run command:
| OS | Command |
|---|---|
| Windows | py -m pip install --upgrade pip |
| macOS | python3 -m pip install --upgrade pip |
The spikesafe-python library will need to be installed. Vektrex recommends always having the latest version of spikesafe-python when running these sequences.
To install this package, run command:
| OS | Command |
|---|---|
| Windows | py -m pip install spikesafe-python |
| macOS | python3 -m pip install spikesafe-python |
Once the spikesafe-python package is installed, each script in this repository can be run independently as a standalone Python file. Run a file in its current state and verify that the expected outputs are obtained, as specified by the file's markdown description.
Complete class documentation is available for spikesafe-python in spikesafe-python API Overview.
Some sequences involve graphing measurement results. To properly graph results, the matplotlib 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:
| OS | Command |
|---|---|
| Windows | py -m pip install matplotlib |
| macOS | python3 -m pip install matplotlib |
Some sequences require external C resources, and requires the PyCLibrary 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:
| OS | Command |
|---|---|
| Windows | py -m pip install pyclibrary |
| macOS | python3 -m pip install pyclibrary |
Some sequences involve connecting to a serial interface instrument and requires the 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:
| OS | Command |
|---|---|
| Windows | py -m pip install pyserial |
| macOS | python3 -m pip install pyserial |
A list of all installed packages can be displayed.
To view all installed packages, run command:
| OS | Command |
|---|---|
| Windows | py -m pip freeze |
| macOS | python3 -m pip freeze |
After a package is installed the details of a package can be displayed.
To view details of a package, run command:
| OS | Command |
|---|---|
| Windows | py -m pip show <package name> |
| macOS | python3 -m pip <package name> |
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'.
Each file can be modified to include additional settings and commands to fit individual needs. Refer to SpikeSafe documentation for more information on the SpikeSafe API.
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.
On this page, press "Clone or download" to download all files in this repository. We recommend saving this repository to your working directory for all other GitHub repositories.
If only a specific sequence or folder is needed, right-click the desired file/folder and select "Save link as...".
First start with 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.
We use SemVer for versioning. For the versions available, see the tags on this repository.
I'm developing an application using NI-VISA, what is the recommended practice for handling termination characters?
See Termination Characters in NI-VISA
I'm developing an application using MATLAB, how do I get started?
See System Requirements for MATLAB Engine API for Python to ensure your system can support Python. Then see Call Python from MATLAB on how to access Python libraries in MATLAB.
Why does my script's performance vary between different operating systems and machines?
See Remarks describing resolution of system timers between operating systems.
If any further assistance is needed beyond the information provided within this repository, email support@vektrex.com.
Feature requests and bug reports can be submitted to the Vektrex website's support page. Select "Other" as the Product/System and enter "SpikeSafePythonSamples GitHub Repository" as the Subject.
SpikeSafePythonSamples is licensed under the MIT license, which allows for non-commercial and commercial use.