====== WaveForms Getting Started Guide ====== ~~TechArticle~~ {{ :waveforms3:waveforms.png?nolink&300 |}} ==== Overview ==== WaveForms is the virtual instrument suite for Electronics Explorer, Digital Discovery, Analog Discovery, Analog Discovery 2 and Analog Discovery Studio devices.\\ It configures, calibrates, and controls the Test and Measurements various devices. Through WaveForms you have access to all the board's Instruments. Go to the [[software:waveforms:waveforms-3:start|WaveForms Resource Center]] and download the latest version of WaveForms. ==== Guide ==== === Download and Install Waveforms === ====%hide windows==== --> Installing WaveForms : Windows# === Open the Executable File === Open the executable file that you downloaded. {{ :learn:instrumentation:tutorials:downloadwf.png?nolink&500 |}} --------------- === 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**. {{ reference:test-and-measurement:analog-discovery-studio:gsg-install-summary.png?nolink |}} ------------ === License Agreement === Read the license agreement on this screen, then, if in agreement to it, click **I Agree** to continue. {{ reference:test-and-measurement:analog-discovery-studio:gsg-install-license.png?nolink |}} ----------------- === Choose Components === In the "Choose Components" screen, a list is presented of each of the things that can be installed. In order to use the Analog Discovery 2 with the WaveForms application, the Adept Runtime, WaveForms Runtime, and WaveForms Application are required. * The Adept Runtime allows WaveForms to communicate with the Analog Discovery 2, Analog Discovery, Analog Discovery Studio, Digital Discovery, and Electronics Explorer Board. * 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.// {{:software:waveforms:waveforms-3:newinstall.jpg?600|}} ------------ === Shortcut Options === Click **Next**. {{ reference:test-and-measurement:analog-discovery-studio:gsg-install-shortcuts.png?nolink |}} ------------- === Choose Install Location === * You'll need to choose an installation destination or just leave it at the default. * Click "Install". {{ reference:test-and-measurement:analog-discovery-studio:gsg-install-location.png?nolink |}} ---------------- === Installing / Installation Complete === * WaveForms will be installed as indicated by the progress bar. * Click "Next". {{ reference:test-and-measurement:analog-discovery-studio:gsg-install-complete.png?nolink |}} ------------ === Complete === * Check or uncheck the boxes to open WaveForms and the readme. * Click "Finish". {{ reference:test-and-measurement:analog-discovery-studio:gsg-install-finish.png?nolink |}} ------------ <-- ====%hide mac==== --> Installing WaveForms : Mac # ===Download WaveForms === This tutorial will guide you through the steps involved in the installation process on Windows after downloading it. {{youtube>2nAvh28o-t4?medium}} --------- Expand your downloads and open the **.dmg** file that you have downloaded. {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-mac:mac-step1.jpg?nolink |Open the DMG File.}} ---- From the desktop, open the **WaveForms** drive. {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-mac:mac-step2.jpg?nolink |Open the New Drive.}} ---- 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 {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-open-package-3.png?nolink |}} ---- --> Install and Run Rosetta: Only for a Mac with Apple Silicon# 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 user name 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. {{:reference:software:waveforms:waveforms-3:rosetta2.jpg?400|}} ---- <-- --> Install Drivers : Only for OS-X 10.13 or earlier# 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.\\ {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-mac:mac-step4.jpg?nolink |Open the FTDI Diver Install.}} ---- === Launch Installer === Double click **DigilentFtdiDriver.pkg** to open the FTDI Driver Installer. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-1.png?nolink |}} ---- 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**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-open-waveforms-security.png?nolink |}} ---- === Introduction === Click **Continue**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-2.png?nolink |}} ---- === Read Me === Click **Continue**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-3.png?nolink |}} ---- === License === Read the license, then if in agreement, click **Continue**, then click **Agree** in the popup. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-4.png?nolink |}} ---- === Destination Select === Pick the users to install the drivers for, then click **Continue**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-5.png?nolink |}} ---- === Installation Type === Click **Install**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-6.png?nolink |}} ---- === Summary === Once the installation has completed, click **Close**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-install-driver-7.png?nolink |}} <-- 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**. {{ reference:test-and-measurement:analog-discovery-studio:getting-started-guide:mac-open-waveforms-security.png?nolink |}} <-- ====%hide linux==== --> Installing WaveForms : Linux # ===Download WaveForms === This tutorial will guide you through the steps involved in the installation process on Windows after downloading it. {{youtube>uYc8-HwGNCA?medium}} First, download the package for the [[software:adept:start|Adept Runtime]]. This program is required for WaveForms to connect to the Analog Discovery 2 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. \\ === Download Adept Runtime === * Download the correct version of Adept. The link for Adept downloads is located [[/digilent_adept_2|here]]. * 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. {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step1.jpg?nolink |Download Adept.}} ------------ --> Install Files using built-in Package Manager # === Open the Adept File === Open the file you downloaded for Adept in the previous step.\\ {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step2.jpg?nolink |Open the Adept File.}} ---------- === Click Install === Click "Install" on the window that pops up.\\ {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step3.jpg?nolink |Click Install.}} \\ ------------- === Open the WaveForms File === Open the file you downloaded to install WaveForms. {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step4.jpg?nolink |Open the WaveForms File.}} -------------- === 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 {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-linux:lin-step5.jpg?nolink |Click Install.}} -------------- <-- --> 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: sudo dpkg -i sudo dpkg -i sudo apt-get install -f <-- 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: sudo rpm -i sudo rpm -i 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 to the Scopes and Instruments section of the [[https://forum.digilentinc.com|Digilent Forum]]. <-- /*--> 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. \\ === 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. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:ARM_debian_option.png?600 |Select installation file.}} --------- === 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. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:Adept2_RPi_RuntimeUtilitiesDownload.png?600 |Download Adept 2.}} ------------ === Open the Adept 2 File === Open up the file you downloaded for Adept 2 in Step 2. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:DoubleClick_AdeptRuntimeDownload.png?600 |Open the Adept 2 file.}} ------------- === Click Install === Click "Install" in the window when prompted. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:InstallAdeptRuntime.png?600 |Install.}} ----------- === Open the WaveForms File === Open the file you downloaded to install WaveForms. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:DoubleClick_WaveFormsDownload.png?600 |Open the WaveForms file.}} ----------- === Click Install === Click "Install" in the window when prompted. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:Install_WaveForms.png?600 |Install WaveForms.}} ----------- === Open WaveForms === Go to your applications and open WaveForms. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:DoubleClick_WaveForms_Launch.png?600 |Open WaveForms.}} ---------- <--*/ /*--> Raspberry Pi # {{section>reference:test-and-measurement:guides:getting-started-with-raspberry-pi#installing_waveforms_on_raspberry_pi&noheader}} <--*/ ----------- === Using WaveForms for the First Time=== --> Windows # === No Device Connected === When WaveForms initially opens, if you have no device plugged in it will give you a warning that no device was detected. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-windows:fbzv36lioo5enzj.medium.jpg |No device connected.}} ----------- === Run Demo Mode === That's okay, because WaveForms offers a demo mode where you can try out the features without having a compatible device. {{:software:waveforms:waveforms-3:demo.jpg?600|Run Demo Mode}} ===Oscilloscope in Demo Mode === For example, here is a demonstration of the oscilloscope scoping a square amd sine wave. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-windows:fqxbtb1ioo5eo21.medium.jpg |Oscilloscope in demo mode.}} ---------- === Device Connected === When you plug in your Analog Discovery 2 it will appear on the device manager and you can then select it to connect to it. {{:software:waveforms:waveforms-3:deviceconnected.jpg?600|}} <-- --> Mac # === Open Demo Mode === We can run demo mode to get a feel for the interface and capabilities of WaveForms without having a device attached. Click on "Demo Mode" and then click "Select". {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-osx:frnqbf9iovpr764.medium.jpg |Open demo mode.}} ------------ ===Open Oscilloscope in Demo Mode === Open the oscilloscope tool and select "Play". You can see a square and sine wave being demonstrated. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-osx:f812rc7iovpr767.medium.jpg |Open oscilloscope.}} ---------- === Plug in and Select Device === When you plug in your device it will appear in the Device Manager. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-osx:fcovpociovpr768.medium.jpg |Plug in AD2.}} <-- --> Linux # === No Device === If you don't have device plugged in, a window will pop up with a warning stating that no device was detected. You don't need to have a device to run the software, so go ahead and click "OK" to proceed. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-linux:fxu03gyiovprgx1.medium.jpg |No device.}} ------ === Run Demo Mode === The device manager will now open. Click on "Demo Mode", and then click "Select". {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-linux:fuhj01siovprgxn.medium.jpg |Run demo mode.}} ---------- ===Demo Mode Oscilloscope=== As mentioned previously, if you don't have an Analog Discovery 2 yet, that's okay. You can still run WaveForms in demo mode and get a feel for the interface and capabilities. The below image is a demo of the oscilloscope displaying a sine and square wave. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-linux:ffr5kciiovprgzf.medium.jpg |Demo mode oscilloscope.}} --------- ===Plug in device=== If you plug in your device, a window will pop up indicating that it was detected. Select "OK" to proceed. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-linux:frlto0xiovprh01.medium.jpg |Detected device.}} ------------ ===Device Manager=== If you open the device manager, or you have the device plugged in when WaveForms is open, the window displayed in the image below will appear. Select the Analog Discovery 2, for example, just as you did for demo mode. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-linux:fzyhbvfiovprh0a.medium.jpg |Device manager.}} <-- /*-->Raspberry Pi 4 Model B # ===No Device=== If you don't have a Test and Measurement device plugged in, a window will pop up with a warning stating that no device was detected. You don't need to have a device to run the software, so go ahead and click "OK" to proceed. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:WaveForms_NoDevice.png?600 |No device.}} --------- ===Run Demo Mode=== The device manager will now open. Click on "Demo Mode", and then click "Select". {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:WaveForms_ChooseDemo.png?600 |Run demo mode NEED SS.}} -------- ===Demo Mode Oscilloscope=== You can run WaveForms in demo mode and get a feel for the interface and capabilities. The below image is a demo of the oscilloscope displaying a sine and square wave. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:WaveForms_demo_run.png?600 |Demo mode oscilloscope.}} === Plug in Analog Discovery 2 === The Raspberry Pi 4 has two blue USB 3.0 ports; it is recommended that one of these ports is used to plug in the Analog Discovery 2. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:rpi_4_ports.jpg?600 |Blue USB 3.0 ports}} {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:rpi4_and_analog_discovery_2.jpg?600 |Analog Discovery 2 connected to a blue USB 3.0 port}} If you plug in the Analog Discovery 2, a window will pop up indicating that it was detected. Select "Yes" to proceed. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:Waveforms_new_device.png?600 |Detected device NEED SS.}} ----------- === Device Manager === If you open the device manager, or you have the Analog Discovery 2 plugged in when WaveForms is open, the window displayed in the image below will appear. Select the Analog Discovery 2 labeled as //Discovery2// with a serial number. {{ :learn:instrumentation:tutorials:ad2-waveforms2015-installation-rpi:Waveforms_select_devce.png?600 |Device manager.}} ----------- === Check out the Tools === Note the welcome menu on the left hand side. From this menu you can launch each of the tools. {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-windows:step4.png?nolink&600 |Check out the Tools.}} ----------- === Start the WaveForm Generator === Open the WaveForm Generator, and click "run". {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-windows:step5.png?nolink&600 |Start the WaveForms Generator.}} ------------ === Start the Oscilloscope === Open the Oscilloscope, and click "run". {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-windows:step6.png?nolink&600 |Start the Oscilloscope.}} ------------- === Take a Measurement === Plug the yellow wire (Waveform Generator 1) into the orange wire (Oscilloscope Channel 1 positive.) Plug any black wire (ground) into the orange wire with the white stripe (Oscilloscope Channel 1 negative.) {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-windows:step7.png?nolink&600 |Take a Measurement.}} ------------ === View your First Measurement === Open the Oscilloscope to see your first measurement! To learn more about the tools, please visit our [[https://analogdiscovery.com/support/|support page]]. {{ :learn:instrumentation:tutorials:analog-discovery-2-getting-started-windows:step8.png?nolink&600 |View your First Measurement!}} <--*/ /*--> Raspberry Pi # {{section>reference:test-and-measurement:guides:getting-started-with-raspberry-pi#using_waveforms_on_raspberry_pi&noheader}} <--*/ ---- ====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. 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}}