Differences

This shows you the differences between two versions of the page.

Link to this comparison view

test-and-measurement:guides:waveforms-sdk-getting-started [2021/12/08 09:39] – [Getting Started with the WaveForms SDK] Álmos Veres-Vitályostest-and-measurement:guides:waveforms-sdk-getting-started [2022/10/04 11:38] (current) – external edit 127.0.0.1
Line 1: Line 1:
-====== Getting Started with the WaveForms SDK ======+====== Getting Started with WaveForms SDK ======
 <WRAP group> <WRAP group>
 WaveForms SDK is a set of tools provided within the WaveForms installation that are used to develop custom software solutions that use Digilent Test and Measurement devices. The WaveForms SDK API is available in several programming languages, making it easy to use across many different platforms. WaveForms SDK is a set of tools provided within the WaveForms installation that are used to develop custom software solutions that use Digilent Test and Measurement devices. The WaveForms SDK API is available in several programming languages, making it easy to use across many different platforms.
Line 35: Line 35:
   * macOS: **/Applications/WaveForms.app/Contents/Resources/SDK/samples**   * macOS: **/Applications/WaveForms.app/Contents/Resources/SDK/samples**
  
-For other examples, check: [[test-and-measurement:guides:waveforms-using-waveforms-sdk|]]. 
 </WRAP> </WRAP>
 ---- ----
Line 636: Line 635:
 <html> <html>
 <script src="https://emgithub.com/embed.js?target=https%3A%2F%2Fgithub.com%2FDigilent%2FWaveForms-SDK-Getting-Started%2Fblob%2Fmaster%2FWF_SDK%2F__init__.py&style=github&showCopy=on"></script></html> <script src="https://emgithub.com/embed.js?target=https%3A%2F%2Fgithub.com%2FDigilent%2FWaveForms-SDK-Getting-Started%2Fblob%2Fmaster%2FWF_SDK%2F__init__.py&style=github&showCopy=on"></script></html>
 +
 +Remember, that any submodule (the protocol folder in this case) also needs initialization:
 +<html>
 +<script src="https://emgithub.com/embed.js?target=https%3A%2F%2Fgithub.com%2FDigilent%2FWaveForms-SDK-Getting-Started%2Fblob%2Fmaster%2FWF_SDK%2Fprotocol%2F__init__.py&style=github&showCopy=on"></script></html>
 </WRAP> </WRAP>
 ---- ----
  
-===== Testing =====+==== Testing ====
 <WRAP group> <WRAP group>
 Copy your module folder (WF_SDK in this case) into the project directory, then create a new Python script. Import the necessary modules, then use your functions to control the Test & Measurement device. Copy your module folder (WF_SDK in this case) into the project directory, then create a new Python script. Import the necessary modules, then use your functions to control the Test & Measurement device.
Line 646: Line 649:
  
 **Note: ** //The example using the oscilloscope and the waveform generator won't work on devices without analog I/O capability (Digital Discovery).// **Note: ** //The example using the oscilloscope and the waveform generator won't work on devices without analog I/O capability (Digital Discovery).//
 +
 +**Note: ** //Name your test scripts "test_testname.py". This will be important if you want to install the module as a package.//
 </WRAP> </WRAP>
  
Line 719: Line 724:
 ---- ----
  
 +==== Installing the Package ====
 +<WRAP group>
 +Once you completed the package, you might want to install it, like other Python packages and use it on new projects as well. To do so, you must create some additional files in the project folder.
 +
 +First, exclude the test scripts from the final package. Create a file named **MANIFEST.in**, with the content:
 +<code>global-exclude test_*</code>
 +
 +The installer needs the list of dependencies to install your package. Specify this list on a file called **requirements.txt**:
 +<code>
 +setuptools==58.1.0
 +wheel==0.37.1</code>
 +
 +Finally, create a **README.md** file with the description of your package, then create the installer. The installer is the file named **setup.py**, with the following content:
 +<code python>
 +from setuptools import setup
 +
 +with open("README.md", "r") as f:
 +    long_description = f.read()
 +
 +setup(
 +   name = "WF_SDK",
 +   version = "1.0",
 +   description = "This module realizes communication with Digilent Test & Measurement devices",
 +   license = "MIT",
 +   long_description = long_description,
 +   author = "author_name",
 +   author_email = "author_email_address",
 +   url = "https://digilent.com/reference/test-and-measurement/guides/waveforms-sdk-getting-started",
 +   packages = ["WF_SDK", "WF_SDK.protocol"],
 +)
 +</code>
 +</WRAP>
 +
 +<WRAP group>
 +Once the necessary files are created, open a terminal, go to the project folder and install your package with the following command:
 +<code>pip install .</code>
 +
 +Alternatively, you can install the package from the GitHub repository, with the command:
 +<code>pip install git+https://github.com/Digilent/WaveForms-SDK-Getting-Started#egg=WF_SDK</code>
 +
 +**Note:** //Use "pip3" instead of "pip", if you are using Python 3.//
 +</WRAP>
 +----
 +
 +===== Other Programming Languages =====
 +<WRAP group>
 +Realizing the same package in other programming languages is also possible. To check the C++ version of the package and some test programs, follow [[https://github.com/Digilent/WaveForms-SDK-Getting-Started-Cpp|this]] link.
 +</WRAP>
 +----
 ===== Next Steps ===== ===== Next Steps =====
 <WRAP group> <WRAP group>