Skip to content

Latest commit

 

History

History

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 SpikeSafePythonSamples/Run SpikeSafe Operating Modes.

Directory

For first-time users, Vektrex recommends running the sequences in the order shown below:

  1. Importing SpikeSafePythonSamples packages - Automatically installs all necessary packages to run all SpikeSafePythonSamples scripts
  2. TCP Sample - A more in depth example that connects to the SpikeSafe using a TCP socket. An *IDN? query is sent with more verbose Python commands
  3. Importing spikesafe-python package - Shows how to properly import spikesafe-python package for a smooth development experience
  4. Read *IDN? - Uses the SCPI Standard "*IDN?" query and following information queries to obtain the model of your SpikeSafe
  5. Read All Events - Reads all events from the SpikeSafe event queue
  6. Read Memory Table Data - Reads the SpikeSafe status and obtains current operational information from the SpikeSafe
  7. Discharge Channel - Shows how to properly shut down the SpikeSafe channel and wait for the load voltage to discharge before taking further action
  8. SCPI Logging - Shows how to log SpikeSafe SCPI messages sent over the TCP socket to a file

Usage

To run these sequences, an IDE such as Visual Studio Code is required. The spikesafe-python repository will need to be installed as a package using the command python -m pip install spikesafe-python. Vektrex recommends always having the latest version of spikesafe-python when running these sequences; the current version is 1.1.0. It may help to run these sequences in a virtual environment.

Simply change the line ip_address = '10.0.0.220' to match the IP address of you connected SpikeSafe and run the sequence (generally by pressing F5). Observe the outputs that appear in both the terminal window and SpikeSafePythonSamples.log, which will output wherever you have saved the SpikeSafePythonSamples repository.