Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| software:waveforms:waveforms-3:getting-started-guide [2022/09/12 18:32] – changed forum.digilentinc.com to forum.digilent.com jeff.greenberg_ni.com | software:waveforms:waveforms-3:getting-started-guide [2022/10/04 11:38] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== WaveForms Getting Started Guide ====== | ||
| + | ~~TechArticle~~ | ||
| + | |||
| + | {{ : | ||
| + | |||
| + | ==== 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' | ||
| + | Go to the [[software: | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==== Guide ==== | ||
| + | === Download and Install Waveforms === | ||
| + | ====%hide windows==== | ||
| + | --> Installing WaveForms : Windows# | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Open the Executable File === | ||
| + | Open the executable file that you downloaded. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ : | ||
| + | </ | ||
| + | </ | ||
| + | --------------- | ||
| + | <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 column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ------------ | ||
| + | <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 column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ----------------- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Choose Components === | ||
| + | In the " | ||
| + | * 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, | ||
| + | **Note:** //Even with all components selected, the WaveForms install does not take much hard drive space (< | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{: | ||
| + | </ | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Shortcut Options === | ||
| + | Click **Next**. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ------------- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Choose Install Location === | ||
| + | * You'll need to choose an installation destination or just leave it at the default. | ||
| + | * Click " | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ---------------- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Installing / Installation Complete === | ||
| + | * WaveForms will be installed as indicated by the progress bar. | ||
| + | * Click " | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Complete === | ||
| + | * Check or uncheck the boxes to open WaveForms and the readme. | ||
| + | * Click " | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ------------ | ||
| + | <-- | ||
| + | |||
| + | ====%hide 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 Windows after downloading it. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{youtube> | ||
| + | </ | ||
| + | </ | ||
| + | --------- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | Expand your downloads and open the **.dmg** file that you have downloaded. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | |||
| + | {{ : | ||
| + | </ | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | From the desktop, open the **WaveForms** drive. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ : | ||
| + | </ | ||
| + | </ | ||
| + | ---- | ||
| + | <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 column half> | ||
| + | {{ reference: | ||
| + | </ | ||
| + | </ | ||
| + | ---- | ||
| + | |||
| + | --> 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. | ||
| + | </ | ||
| + | {{: | ||
| + | </ | ||
| + | ---- | ||
| + | <-- | ||
| + | |||
| + | --> 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 group>< | ||
| + | === Launch Installer === | ||
| + | Double click **DigilentFtdiDriver.pkg** to open the FTDI Driver Installer. | ||
| + | |||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | The OS may block the launch of the **driver installer**. If this is the case, go into the System Preferences' | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | === Introduction === | ||
| + | Click **Continue**. | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | === Read Me === | ||
| + | Click **Continue**. | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | === License === | ||
| + | Read the license, then if in agreement, click **Continue**, | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | === Destination Select === | ||
| + | Pick the users to install the drivers for, then click **Continue**. | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | === Installation Type === | ||
| + | Click **Install**. | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | ---- | ||
| + | <WRAP group>< | ||
| + | === Summary === | ||
| + | Once the installation has completed, click **Close**. | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | <-- | ||
| + | <WRAP group>< | ||
| + | The OS may block the launch of the **Waveforms **. If this is the case, go into the System Preferences' | ||
| + | </ | ||
| + | {{ reference: | ||
| + | </ | ||
| + | <-- | ||
| + | |||
| + | ====%hide 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 Windows after downloading it. | ||
| + | |||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{youtube> | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP group> | ||
| + | First, download the package for the [[software: | ||
| + | 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>< | ||
| + | === Download Adept Runtime === | ||
| + | |||
| + | * Download the correct version of Adept. The link for Adept downloads is located [[/ | ||
| + | * 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. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------ | ||
| + | --> Install Files using built-in Package Manager # | ||
| + | <WRAP group>< | ||
| + | === Open the Adept File === | ||
| + | Open the file you downloaded for Adept in the previous step.\\ | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ---------- | ||
| + | <WRAP group>< | ||
| + | === Click Install === | ||
| + | Click " | ||
| + | |||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | \\ | ||
| + | ------------- | ||
| + | <WRAP group>< | ||
| + | === Open the WaveForms File === | ||
| + | Open the file you downloaded to install WaveForms. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | -------------- | ||
| + | <WRAP group>< | ||
| + | === 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 | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | -------------- | ||
| + | <-- | ||
| + | --> Install Files using command line # | ||
| + | Alternatively, | ||
| + | |||
| + | < | ||
| + | sudo dpkg -i <path to Adept Runtime .deb file> | ||
| + | sudo dpkg -i <path to WaveForms .deb file> | ||
| + | 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 <path to Adept Runtime .rpm file> | ||
| + | sudo rpm -i <path to WaveForms .rpm file> | ||
| + | </ | ||
| + | |||
| + | If WaveForms has already been installed on the system, replace the " | ||
| + | |||
| + | For technical support with installing WaveForms on various Linux distributions, | ||
| + | |||
| + | </ | ||
| + | |||
| + | <-- | ||
| + | /*--> 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>< | ||
| + | === 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 group>< | ||
| + | === Download Adept 2 === | ||
| + | Download the correct version of [[/ | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group>< | ||
| + | === Open the Adept 2 File === | ||
| + | Open up the file you downloaded for Adept 2 in Step 2. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------- | ||
| + | <WRAP group>< | ||
| + | === Click Install === | ||
| + | Click " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group>< | ||
| + | === Open the WaveForms File === | ||
| + | Open the file you downloaded to install WaveForms. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group>< | ||
| + | === Click Install === | ||
| + | Click " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group>< | ||
| + | === Open WaveForms === | ||
| + | Go to your applications and open WaveForms. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ---------- | ||
| + | |||
| + | |||
| + | <--*/ | ||
| + | |||
| + | /*--> Raspberry Pi # | ||
| + | <WRAP group> | ||
| + | {{section> | ||
| + | </ | ||
| + | <--*/ | ||
| + | ----------- | ||
| + | === Using WaveForms for the First Time=== | ||
| + | |||
| + | --> Windows # | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === 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. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ : | ||
| + | </ | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === Run Demo Mode === | ||
| + | That's okay, because WaveForms offers a demo mode where you can try out the features without having a compatible device. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{: | ||
| + | |||
| + | </ | ||
| + | </ | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | ===Oscilloscope in Demo Mode === | ||
| + | For example, here is a demonstration of the oscilloscope scoping a square amd sine wave. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{ : | ||
| + | |||
| + | </ | ||
| + | </ | ||
| + | ---------- | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === 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. | ||
| + | </ | ||
| + | <WRAP column half> | ||
| + | {{: | ||
| + | |||
| + | </ | ||
| + | </ | ||
| + | <-- | ||
| + | |||
| + | --> Mac # | ||
| + | <WRAP group> | ||
| + | <WRAP column half> | ||
| + | === 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 " | ||
| + | |||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group>< | ||
| + | ===Open Oscilloscope in Demo Mode === | ||
| + | Open the oscilloscope tool and select " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ---------- | ||
| + | <WRAP group>< | ||
| + | === Plug in and Select Device === | ||
| + | When you plug in your device it will appear in the Device Manager. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | <-- | ||
| + | --> Linux # | ||
| + | |||
| + | <WRAP group>< | ||
| + | === 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 " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------ | ||
| + | <WRAP group>< | ||
| + | === Run Demo Mode === | ||
| + | The device manager will now open. Click on "Demo Mode", and then click " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ---------- | ||
| + | <WRAP group>< | ||
| + | ===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. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | --------- | ||
| + | <WRAP group>< | ||
| + | ===Plug in device=== | ||
| + | If you plug in your device, a window will pop up indicating that it was detected. Select " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group>< | ||
| + | ===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. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | <-- | ||
| + | / | ||
| + | <WRAP group>< | ||
| + | ===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 " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | --------- | ||
| + | <WRAP group>< | ||
| + | ===Run Demo Mode=== | ||
| + | The device manager will now open. Click on "Demo Mode", and then click " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | -------- | ||
| + | <WRAP group>< | ||
| + | ===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. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | |||
| + | <WRAP group>< | ||
| + | === 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. | ||
| + | </ | ||
| + | {{ : | ||
| + | |||
| + | {{ : | ||
| + | </ | ||
| + | < | ||
| + | If you plug in the Analog Discovery 2, a window will pop up indicating that it was detected. Select " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group>< | ||
| + | === 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 // | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group>< | ||
| + | === Check out the Tools === | ||
| + | Note the welcome menu on the left hand side. From this menu you can launch each of the tools. | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ----------- | ||
| + | <WRAP group>< | ||
| + | === Start the WaveForm Generator === | ||
| + | Open the WaveForm Generator, and click " | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group>< | ||
| + | === Start the Oscilloscope === | ||
| + | Open the Oscilloscope, | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------- | ||
| + | <WRAP group>< | ||
| + | === 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.) | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | ------------ | ||
| + | <WRAP group>< | ||
| + | === View your First Measurement === | ||
| + | Open the Oscilloscope to see your first measurement! To learn more about the tools, please visit our [[https:// | ||
| + | </ | ||
| + | {{ : | ||
| + | </ | ||
| + | <--*/ | ||
| + | |||
| + | /*--> Raspberry Pi # | ||
| + | <WRAP group> | ||
| + | {{section> | ||
| + | </ | ||
| + | <--*/ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ====Additional Resources==== | ||
| + | For additional resources visit the [[software: | ||
| + | |||
| + | For detailed steps about how to install and use WaveForms on Raspberry Pi, follow this guide: [[test-and-measurement: | ||
| + | |||
| + | {{tag> | ||

