====== WaveForms Getting Started Guide ======

~~TechArticle~~
<columns 100% 50%>
{{ :software:waveforms:waveforms-3:waveforms-logo-300_1.png?nolink&300 |}}
<newcolumn>
</columns>
==== Overview ====

WaveForms is the virtual instrument suite for Digilent [[test-and-measurement/start|Test and Measurement]] devices.\\
It configures, calibrates, and controls the devices' various Instruments.

Go to the [[software:waveforms:waveforms-3:start|WaveForms Resource Center]] and download the latest version of WaveForms.




==== Guide ====
=== Download and Install Waveforms ===
====Windows====
--> Installing WaveForms : Windows#

<WRAP group>
<WRAP column half>
=== Open the Executable File ===
Open the executable file that you downloaded.
</WRAP>
<WRAP column half>
{{ :learn:instrumentation:tutorials:downloadwf.png?nolink&500 |}}
</WRAP>
</WRAP>
---------------
<WRAP group>
<WRAP column half>
=== Welcome ===
Launch the WaveForms installer, by clicking on it in the Downloads folder. Upon launching the WaveForms installer, the welcome page will be seen. Click **Next**.
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:gsg-install-summary.png?nolink |}}
</WRAP>
</WRAP>
------------
<WRAP group>
<WRAP column half>
=== License Agreement ===
Read the license agreement on this screen, then, if in agreement to it, click **I Agree** to continue.
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:gsg-install-license.png?nolink |}}
</WRAP>
</WRAP>
-----------------
<WRAP group>
<WRAP column half>
=== Choose Components ===
In the "Choose Components" screen, a list is presented of each of the things that can be installed. In order to use your Test and Measurement device with the WaveForms application, the Adept Runtime, WaveForms Runtime, and WaveForms Application are required.
  * The Adept Runtime allows WaveForms to communicate with Digilent Test and Measurement devices.
  * The WaveForms Runtime contains a library and device support files needed to run custom applications.
  * The WaveForms Application is the Digilent virtual instrumentation interface.
  * The WaveForms SDK is the software development kit for creating custom applications.
  * If you have an ADP5250, make sure to check the box for its driver installation, to ensure that your PC will be able to communicate with the device.
**Note:** //Even with all components selected, the WaveForms install does not take much hard drive space (<200MB). Digilent recommends that all components are installed.//
</WRAP>
<WRAP column half>
{{:software:waveforms:waveforms-3:newinstall.jpg?600|}}
</WRAP>
</WRAP>
------------
<WRAP group>
<WRAP column half>
=== Shortcut Options ===
Click **Next**.
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:gsg-install-shortcuts.png?nolink |}}
</WRAP>
</WRAP>
-------------
<WRAP group>
<WRAP column half>
=== Choose Install Location ===
  * You'll need to choose an installation destination or just leave it at the default.
  * Click "Install".
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:gsg-install-location.png?nolink |}}
</WRAP>
</WRAP>
----------------
<WRAP group>
<WRAP column half>
=== Installing / Installation Complete ===
  * WaveForms will be installed as indicated by the progress bar.
  * Click "Next".
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:gsg-install-complete.png?nolink |}}
</WRAP>
</WRAP>
------------
<WRAP group>
<WRAP column half>
=== Complete ===
  * Check or uncheck the boxes to open WaveForms and the readme.
  * Click "Finish".
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:gsg-install-finish.png?nolink |}}
</WRAP>
</WRAP>
------------
<--

====Mac====

--> Installing WaveForms : Mac #
<WRAP group>
<WRAP column half>
===Download WaveForms ===

This tutorial will guide you through the steps involved in the installation process on Mac after downloading it.
</WRAP>
<WRAP column half>
{{youtube>2nAvh28o-t4?medium}}
</WRAP>
</WRAP>
---------
<WRAP group>
<WRAP column half>
Expand your downloads and open the **.dmg** file that you have downloaded.
</WRAP>
<WRAP column half>

{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-mac:mac-step1.jpg?nolink |Open the DMG File.}}
</WRAP>
</WRAP>
----
<WRAP group>
<WRAP column half>
From the desktop, open the **WaveForms** drive.
</WRAP>
<WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-mac:mac-step2.jpg?nolink |Open the New Drive.}}
</WRAP>
</WRAP>
----
<WRAP group>
<WRAP column half>
Drag the **WaveForms** icon into the **Applications** folder. \\
This will install the following components in Applications: 
  * **WaveForms Runtime** contains a library and device support files needed to run custom applications.
  * **WaveForms Application** is the Digilent virtual instrumentation interface.
  * **WaveForms SDK** is the software development kit for creating custom applications
</WRAP>
<WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-open-package-3.png?nolink |}}
</WRAP>
</WRAP>
----

--> Install and Run Rosetta: Only for a Mac with Apple Silicon#
<WRAP group>
<WRAP column half>
The WaveForms app has not yet been ported to run on Mac computers with Apple Silicon.  Apple has provided a translation framework called [[https://support.apple.com/en-us/HT211861|Rosetta2]] which allows programs like WaveForms that were written for Intel processors to run on Apple Silicon Macs.  When you attempt to run WaveForms, you may be prompted to install Rosetta in order to open the app.  Click install and enter your username and password to allow the installation process to proceed.  Rosetta will then be ready to run the WaveForms application or any other software originally written for Intel processors. 
</WRAP><WRAP column half>
{{:reference:software:waveforms:waveforms-3:rosetta2.jpg?400|}}
</WRAP></WRAP>
----
<--

--> Install Drivers : Only for OS-X 10.13 or earlier#
<WRAP group>
<WRAP column half>
Double-click the FTDI driver icon to start the installation process.\\
On MacOS (10.13) Sierra High and older versions, the device driver should be installed to support Analog Discovery 1 & 2 and Digital Discovery devices.\\
On MacOS (10.14) Mojave, the device driver is not required. According to some reports, on new MacBook machines the device is not detected if the driver is installed, so uninstall the driver if the device does not connect.\\
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-mac:mac-step4.jpg?nolink |Open the FTDI Diver Install.}}
</WRAP></WRAP>
----


<WRAP group><WRAP column half>
=== Launch Installer ===
Double click **DigilentFtdiDriver.pkg** to open the FTDI Driver Installer.

</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-1.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
The OS may block the launch of the **driver installer**. If this is the case, go into the System Preferences' Security and Privacy page and click **Open Anyway**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-open-waveforms-security.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
=== Introduction ===
Click **Continue**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-2.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
=== Read Me ===
Click **Continue**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-3.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
=== License ===
Read the license, then if in agreement, click **Continue**, then click **Agree** in the popup.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-4.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
=== Destination Select ===
Pick the users to install the drivers for, then click **Continue**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-5.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
=== Installation Type ===
Click **Install**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-6.png?nolink |}}
</WRAP></WRAP>
----
<WRAP group><WRAP column half>
=== Summary ===
Once the installation has completed, click **Close**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-7.png?nolink |}}
</WRAP></WRAP>
<--
<WRAP group><WRAP column half>
The OS may block the launch of the **Waveforms **. If this is the case, go into the System Preferences' Security and Privacy page and click **Open Anyway**.
</WRAP><WRAP column half>
{{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-open-waveforms-security.png?nolink |}}
</WRAP></WRAP>
<--

====Linux====

--> Installing WaveForms : Linux #
<WRAP group>
<WRAP column half>
===Download WaveForms ===
This tutorial will guide you through the steps involved in the installation process on Linux after downloading it.

</WRAP>
<WRAP column half>
{{youtube>uYc8-HwGNCA?medium}}
</WRAP>
</WRAP>

<WRAP group>
First, download the package for the Adept Runtime. This program is required for WaveForms to connect to your device and must be installed prior to installing WaveForms.\\
For systems using **.deb packages**, (Ubuntu, Fedora, etc), use the built-in package manager to install the Adept Runtime and then WaveForms - typically, a package manager can be opened by double-clicking on the file in question. \\

<WRAP group><WRAP column half>
=== Download Adept Runtime ===

  * Download the correct version of the Adept Runtime. All Adept downloads can be found here: [[https://cloud.digilent.com/myproducts/Adept?pc=1&tab=2|Adept's Product Catalog Entry]]. Make sure to follow the link for **Adept Runtime Downloads**.
  * Make sure the version of the Adept install file is the same as WaveForms. I used the 64-bit RPM for WaveForms so I will use the 64-bit RPM for Adept.
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step1.jpg?nolink |Download Adept.}}
</WRAP></WRAP>
------------
--> Install Files using built-in Package Manager #
<WRAP group><WRAP column half>
=== Open the Adept File ===
Open the file you downloaded for Adept in the previous step.\\
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step2.jpg?nolink |Open the Adept File.}}
</WRAP></WRAP>
----------
<WRAP group><WRAP column half>
=== Click Install ===
Click "Install" on the window that pops up.\\

</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step3.jpg?nolink |Click Install.}}
</WRAP></WRAP>
\\
-------------
<WRAP group><WRAP column half>
=== Open the WaveForms File ===
Open the file you downloaded to install WaveForms.
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step4.jpg?nolink |Open the WaveForms File.}}
</WRAP></WRAP>
--------------
<WRAP group><WRAP column half>
 === Click Install ===
Click Install in the window that pops up.\\
This will install the following components: 
  * **WaveForms Runtime** contains a library and device support files needed to run custom applications.
  * **WaveForms Application** is the Digilent virtual instrumentation interface.
  * **WaveForms SDK** is the software development kit for creating custom applications
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step5.jpg?nolink |Click Install.}}
</WRAP></WRAP>
--------------
<--
--> Install Files using command line #
Alternatively, use the following set of commands in the terminal to install the Adept Runtime and WaveForms from the downloaded packages:

<code>
sudo dpkg -i <path to Adept Runtime .deb file>
sudo dpkg -i <path to WaveForms .deb file>
sudo apt-get install -f
</code>
<--

For systems using **.rpm packages**, (Red Hat Linux, etc), use the following set of commands in the terminal to install the Adept Runtime and WaveForms from the downloaded packages:

<code>
sudo rpm -i <path to Adept Runtime .rpm file>
sudo rpm -i <path to WaveForms .rpm file>
</code>

If WaveForms has already been installed on the system, replace the "-i" flag passed to the rpm command with "-U" to upgrade the existing installation.

For technical support with installing WaveForms on various Linux distributions, please visit the Test and Measurement section of the [[https://forum.digilent.com|Digilent Forum]].

</WRAP>

<--
/*--> Raspberry Pi 4 Model B#
This tutorial will guide you through the steps involved in the installation process on a Raspberry Pi 4 Model B after downloading it from the website. We will be using Raspberry Pi 4 Model B 1 GB version in this tutorial. The 2 GB and 4 GB versions of the Raspberry Pi 4 Model B also work with this tutorial. \\

<WRAP group><WRAP column half>
=== Download WaveForms ===
Download the correct installation file for WaveForms for your distribution of Linux. Since we are using a Raspberry Pi 4 Model B with the Raspbian OS, we will choose the Debian flavor of the ARM build.
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:ARM_debian_option.png?600 |Select installation file.}}
</WRAP></WRAP>
---------
<WRAP group><WRAP column half>
=== Download Adept 2 ===
Download the correct version of [[/software/adept/start|Adept 2]]. Make sure that the version of the Adept install file is the same as WaveForms. We chose the ARM version for WaveForms, so we will use the ARM version of both the Runtime and Utilities for Adept. 
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:Adept2_RPi_RuntimeUtilitiesDownload.png?600 |Download Adept 2.}}
</WRAP></WRAP>
------------
<WRAP group><WRAP column half>
=== Open the Adept 2 File ===
Open up the file you downloaded for Adept 2 in Step 2. 
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:DoubleClick_AdeptRuntimeDownload.png?600 |Open the Adept 2 file.}}
</WRAP></WRAP>
-------------
<WRAP group><WRAP column half>
=== Click Install ===
Click "Install" in the window when prompted. 
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:InstallAdeptRuntime.png?600 |Install.}}
</WRAP></WRAP>
-----------
<WRAP group><WRAP column half>
=== Open the WaveForms File ===
Open the file you downloaded to install WaveForms.  
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:DoubleClick_WaveFormsDownload.png?600 |Open the WaveForms file.}}
</WRAP></WRAP>
-----------
<WRAP group><WRAP column half>
=== Click Install ===
Click "Install" in the window when prompted. 
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:Install_WaveForms.png?600 |Install WaveForms.}}
</WRAP></WRAP>
-----------
<WRAP group><WRAP column half>
=== Open WaveForms ===
Go to your applications and open WaveForms.
</WRAP><WRAP column half>
{{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:DoubleClick_WaveForms_Launch.png?600 |Open WaveForms.}}
</WRAP></WRAP>
----------


<--*/

/*--> Raspberry Pi #
<WRAP group>
{{section>reference:test-and-measurement:guides:getting-started-with-raspberry-pi#installing_waveforms_on_raspberry_pi&noheader}}
</WRAP>
<--*/
----
==== Using WaveForms ====
<columns 100% 50% 50%>
WaveForms supports "Demo devices" which can be used in place of physical hardware when trying it out for the first time. Launch the WaveForms application and select a demo device from the list of supported devices in the Device Manager.

You can also use your computer's sound card as an analog input and output device to familiarize yourself with the user interface for common instruments like the Scope and Wavegen before purchasing a device.
<newcolumn>
{{ :software:waveforms:waveforms-3:device-manager.png?400 |}}
</columns>

----

For detailed overviews of each of the instruments in WaveForms and other WaveForms features, check out the guides below:

{{section>test-and-measurement:guides:start#waveforms_tutorials}}

----
====Additional Resources====
For additional resources visit the [[software:waveforms:waveforms-3:start|WaveForms Resource Center]]. There you'll find the reference manuals, tutorials, downloads, and more.

If you want to try out WaveForms SDK for scripting or a custom application, check out its resource center: [[software:waveforms:waveforms-sdk:start]].

For detailed steps about how to install and use WaveForms on Raspberry Pi, follow this guide: [[test-and-measurement:guides:getting-started-with-raspberry-pi]].

{{tag>learn instrumentation tutorial ad2 waveforms-2015 installation linux mac windows rpi}}