Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
learn:instrumentation:tutorials:analog-discovery-studio-script-editor:start [2019/06/10 20:11] – Andrew Holzerlearn:instrumentation:tutorials:analog-discovery-studio-script-editor:start [2021/06/02 23:47] (current) – Arthur Brown
Line 1: Line 1:
-====== Using the Script Editor (Under Construction) ====== +====== Using the Script Editor  (REDIRECT) ====== 
- +~~REDIRECT>test-and-measurement/guides/waveforms-script-editor~~ 
-{{:reference:instrumentation:analog-discovery-studio:hardware-reference-manual:script-editor.png?nolink&800}} +~~NOSEMANTIC~~ 
- +{{tag>redirect}}
-===== Introduction ===== +
-This guide explains the use of the //Supplies// instrument in WaveForms. This instrument is used to create and run scripts that can control all of the other instruments in WaveForms. +
----- +
-===== Prerequisites ===== +
-  * A Digilent Test & Measurement Device +
-  * A Computer with WaveForms Software Installed +
- +
----- +
- +
-==== 1. Opening the WaveGen ==== +
- +
-<WRAP group> +
-<WRAP column half> +
-== 1.1 == +
-Plug in your Test & Measurement Device, then start WaveForms and make sure your device is connected. +
- +
-If no device is connected to the host computer when WaveForms launches, the **Device Manager** will be launched. Make sure that the device is plugged in and turned on, at which point it will appear in the Device Manager's device list (1.). Click on the device in the list to select it, then click the **Select** button (2.) to close the Device Manager. +
- +
-**Note:** //"DEMO" devices are also listed, which allow the user to use WaveForms and create projects without a physical device.// +
- +
-**Note:** //The Device Manager can be opened by clicking on the "Connected Device" button in the bottom right corner of the screen (3.), or by selecting "Device Manager" from the "Settings" menu at the top of the screen.// +
-</WRAP> +
-<WRAP column half> +
-{{ :learn:instrumentation:tutorials:analog-discovery-studio-oscilloscope:waveforms-device-manager.png?600 |}} +
-</WRAP> +
-</WRAP> +
----- +
-<WRAP group><WRAP column half> +
-== 1.2 == +
-Once the Welcome page loads, in the instrument panel at the left side of the window, click on the **Script** button to open the //Script Editor// instrument. +
-</WRAP><WRAP column half> +
-{{ :learn:instrumentation:tutorials:waveforms-instrument-panel:waveforms-instrument-panel-script.png?nolink&600 |}} +
-</WRAP></WRAP> +
----- +
- +
-<WRAP group> +
-<WRAP column half> +
- +
-=== 1.3 === +
-When the Script Editor has opened, you should see the script editor (1), the output panel (2) below the editor, and the control toolbar (3) at the top. +
- +
-</WRAP> +
-<WRAP column half> +
- +
-~~ Image of Scripting instrument w/ sections outlined & numbered ~~ +
- +
-</WRAP> +
-</WRAP> +
- +
----- +
- +
-==== 2. Using the Script Editor ==== +
- +
-//This section walks through how to use the script editor//  +
- +
-<WRAP group> +
-<WRAP column half> +
- +
-=== 2.1 Hardware Setup === +
-To demonstrate the Script Editor, the //Scope// and //Wavegen// instruments will be used. +
- +
-First, connect the Test & Measurement scope channel 1 pin (orange wire) to the device's wavegen channel 1 output pin (yellow wire). For devices that use differential input channels, make sure to connect the scope channel 1 negative pin (orange wire with white stripes) to the ground pin associated with wavegen channel 1 (black wire). +
- +
-</WRAP> +
-<WRAP column half> +
- +
-{{ :learn:instrumentation:tutorials:analog-discovery-studio-oscilloscope:scope-hw-setup.png?nolink&600 |}} +
- +
-</WRAP> +
-</WRAP> +
- +
----- +
- +
-<WRAP group> +
-<WRAP column half> +
- +
-=== 2.2 Software Setup ===  +
-Instruments must be opened in WaveForms before the //Script Editor// can make use of them. In WaveForms' Welcome tab, open the //Scope// instrument, then open the //Wavegen// instrument. +
- +
-</WRAP> +
-<WRAP column half> +
- +
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-instruments.png?600|}} +
- +
-</WRAP> +
-</WRAP> +
- +
----- +
- +
-<WRAP group> +
-<WRAP column half> +
- +
-=== 2.3 Running the Script === +
- +
-Return to the Scripts page by clicking on its tab in the bar at the top of the screen. Click the "Run" ({{:learn:instrumentation:tutorials:waveforms-buttons:waveforms-run.png?nolink}}) button to start running the script. +
- +
-Print statements and uncaught errors are shown in the output panel. +
- +
-</WRAP> +
-<WRAP column half> +
- +
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-output.png?600|}} +
- +
-</WRAP> +
-</WRAP> +
- +
-<WRAP group> +
-<WRAP column half> +
- +
-=== 2.4 Debugging === +
- +
-Debugging scripts is done inside WaveForms itself, allowing the user to step through the execution of the script. The debugger is accessed by clicking the "Debug" ({{:learn:instrumentation:tutorials:waveforms-buttons:waveforms-single.png?nolink}}) button, which will open a new window with the Qt debugger tool. +
- +
-</WRAP> +
-<WRAP column half> +
- +
-FIXME image: Debugger +
- +
-</WRAP> +
-</WRAP> +
- +
----- +
- +
-==== 3. Script Editor User Interface Overview ==== +
-==== Next Steps ==== +
- +
-If voltage values seen in the //Voltmeter// are significantly different from the expected voltage output of the //Supplies//, please calibrate the device by following the **Calibration Guide**. FIXME link +
- +
-For more guides on how to use both the Digilent <test & measurement device> and WaveForms, return to the device's Resource Center, linked from the **Test and Measurement** page. FIXME link +
- +
-For technical support, please visit the **Scopes and Instruments** section of the Digilent Forums. FIXME link +
- +
-{{tag>analog-discovery-studio tutorial}}+