Delsys API Python Example Code Overview

Overview

This guide walks you through setting up and running the Delsys API Python Example Code, which enables direct communication with Delsys Trigno systems and integration with third-party software for data collection, visualization, and export. It is designed for developers and researchers to pair and configure Avanti-Style Sensors, stream and plot EMG data in real time, and export the results to CSV for analysis. You will learn how to install the required tools, activate your API license, set up the development environment, and run the demo application to acquire and save sensor data.

Interactive Guide

For a step-by-step walk-through on installation steps, please refer to the interactive guide below

Statement of Expectation

"Delsys will provide support for the API to the point where the Python Example code is running, and data can be visualized within the GUI. Delsys does not provide support for custom coding projects or assistance with troubleshooting errors within code outside the scope of the Python example code.”

System Requirements

Step-by-Step Instructions

Step 1: Installation

1. Download Example Code

   1. Go to the Delsys GitHub repository.

   2. Click the green “Code” drop-down and select Download ZIP.

   3. Ensure the entire .zip file is downloaded; individual files are not available.

2. Install Python

   1. The Delsys API 2.8 + Python Example Code requires Python 3.12+.

   2. Python 3.12+ can be downloaded from the official Python 3.12.7 release page

   3. Ensure to install the 64-bit download.

   4. During installation, make sure to check Add to PATH.

3. Install Visual Studio Code (optional but recommended)

   1. Download Visual Studio Code via the official Microsoft Store listing

4. . Unblock and Extract Files

   1. Right-click the downloaded .zip → Properties → check Unblock → Apply → OK.

   2. Right-click again → Extract All → choose destination folder.

Recommendation

• Visual Studio Code is recommended for editing and debugging the Delsys API. The Delsys API can be run on any platform that supports running code.

• The following steps will be described using VS Code.

Step 2: Initial Setup

1. Open Project in VS Code

   1. In VS code: File → New Window → Open Folder.

   2. Select the extracted Python folder from your directory.

2. Install Python Extension for VS Code

   1. If prompted, install Pythonv2024.20.

   2. If not prompted, search for Pythonv2024.20 in Extensions (on the left side menu) and install it manually

3. Set Up an Environment

You can set up your environment using either the Virtual Environment method (recommended) or the Command Line method.

Option 1: Virtual Environment (Recommended)

1. Click the Python version indicator in the bottom right of VS Code.

2. Select Create Virtual Environment → .venv.

3. Choose Python 3.12.x 64-bit (Global).

4. Verify that requirements.txt is checked, then click OK.

Option 2: Command Line Install

1. Open the VS Code terminal (Terminal → New Terminal).

2. Run the following command: python -m pip install -r requirements.txt.

Important

• Using a virtual environment is recommended because it installs the Delsys API Python packages locally within your project. This prevents conflicts with other Python projects on your system and ensures that your project uses the correct package versions.

Step 3: Licensing

1. Obtain License & Key

   1. The Delsys API key/license is separate from the EMGworks and Trigno Discover license. Please contact Delsys Support to obtain a Delsys API license and key.

2. Insert License & Key

   1. Open TrignoBase.py (under AeroPy) in VS Code

   2. In the line mentioning “key”, paste the contents of DelsysAPI.key inside the quotes.

   3. In the line mentioning “license", paste the contents of DelsysAPI.lic inside the quotes

Important

• The entire license and key string must be placed within the quotation marks to ensure the Delsys API can read and validate it correctly. Missing or misplaced characters will cause license and key errors.

Step 4: Triggering and Analog Inputs (Trigno Centro Required)

Navigate to the DelsysPythonDemo.py code and click the ”Run Python File” button in the top right corner. The Delsys GUI will display.

Select "Display Plot" (optional) and "Connect" and the "Collect Data GUI" will display.

Triggering

1. Navigate to the Centro Triggers tab to access trigger settings.

   1. Start and Stop Output/Input triggers can be configured here.

   2. Enable triggers by selecting the trigger header

   3. Configure:

      1. BNC port number (channel)

      2. Rising/Falling edge

      3. Pulse voltage

Information

• The Sync Output Beacon option continuously outputs trigger pulses at the specified frequency during the trial.

Analog Inputs

1. Access the Analog Inputs panel.

2. Set the number of analog channels by selecting the corresponding header.

3. Adjust voltage input range from dropdown.

Information

Both Trigger and Analog Input settings should be configured before starting a data collection stream within the GUI.

Step 5: Streaming Data

1. Navigate to the Trial Controls Tab

2. Once sensors have been paired (See How to Activate and Pair Sensors article) and configured, select "Start" and the data will start streaming and plotting, if "Display Plot" has been selected.

Information

• Only EMG data is plotted by default in the Python Demo App. However, users can modify the code in CollectionDataController.py to visualize other channel types as needed.

Step 6: CSV Export

1. To export to CSV, first stop the data collection, then click the “Export to CSV” button.

2. If the export is successful, the terminal will display "CSV Export: True".

3. The data file will be saved within the Python folder in your directory with the default name "data.csv".

4. To change the file name, close the Delsys GUI and navigate to the CSVWriter.py file under the Export section. Change the filename in line 5 and run the CSVWriter.py file. Navigate to the DelsysPythonDemo.py to load the GUI and start a new collection.

Important

• The export CSV function is an example of how to save data. It is not an optimal project solution for saving data.

Information

• The GUI needs to be closed out before renaming a trial for a new data file to be created. To save multiple trials of data streams, the filename needs to be changed. Otherwise, the same "data.csv" file will be overwritten. In addition, any exported API CSV file needs to be closed out.

Troubleshooting Guide

For a documented FAQ guide, please refer to the Delsys Python Example: Getting Started Guide.

DOC-684-1-0