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
test-and-measurement:guides:waveforms-script-editor [2021/05/14 23:07] – ↷ Links adapted because of a move operation Arthur Browntest-and-measurement:guides:waveforms-script-editor [2024/02/28 19:27] (current) – [Prerequisites] James Colvin
Line 3: Line 3:
 ~~TechArticle~~ ~~TechArticle~~
  
-{{reference:test-and-measurement:analog-discovery-studio:hardware-reference-manual:script-editor.png?nolink&800}}+{{test-and-measurement:analog-discovery-3:script-splashscreen.png?nolink&800}}
  
 ===== Introduction ===== ===== Introduction =====
Line 10: Line 10:
 ===== Prerequisites ===== ===== Prerequisites =====
   * A Digilent Test & Measurement Device compatible with WaveForms:   * A Digilent Test & Measurement Device compatible with WaveForms:
 +    * [[test-and-measurement:analog-discovery-3:start|Analog Discovery 3]]
 +    * [[test-and-measurement:analog-discovery-pro-5250:start|Analog Discovery Pro (ADP5250)]]
     * [[test-and-measurement:analog-discovery-pro-3x50:start|Analog Discovery Pro (ADP3450/ADP3250)]]     * [[test-and-measurement:analog-discovery-pro-3x50:start|Analog Discovery Pro (ADP3450/ADP3250)]]
 +    * [[test-and-measurement:analog-discovery-pro-2230:start|Analog Discovery Pro (ADP2230)]]
 +    * [[test-and-measurement:discovery-power-supply-3340:start|Discovery USB Programmable Power Supply (DPS3340)]]
     * [[test-and-measurement:analog-discovery-studio:start|Analog Discovery Studio]]     * [[test-and-measurement:analog-discovery-studio:start|Analog Discovery Studio]]
     * [[test-and-measurement:digital-discovery:start|Digital Discovery]]     * [[test-and-measurement:digital-discovery:start|Digital Discovery]]
Line 26: Line 30:
 Plug in the Test & Measurement Device, then start WaveForms and make sure the device is connected. Plug in the Test & Measurement Device, then start WaveForms and make sure the 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.+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 on the buffer size (2). Click the Select button (3) 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:** //"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.//+**Note:** //The Device Manager can be opened by clicking on the "Connected Device" button in the bottom right corner of the screen (4.), or by selecting "Device Manager" from the "Settings" menu at the top of the screen.//
 </WRAP> </WRAP>
 <WRAP column half> <WRAP column half>
-{{ reference:test-and-measurement:guides:waveforms-oscilloscope-device-manager.png?600 |}}+{{:test-and-measurement:analog-discovery-3:waveforms-device-manager.png?nolink&600|Device Manager}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
Line 41: Line 45:
 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. 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> </WRAP><WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-instrument-panel:waveforms-instrument-panel-script.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-instrument.png?nolink&600 |}}
 </WRAP></WRAP> </WRAP></WRAP>
 ---- ----
Line 53: Line 57:
 </WRAP> </WRAP>
 <WRAP column half> <WRAP column half>
-{{ :learn:instrumentation:tutorials:analog-discovery-studio-script-editor:script-callout.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-callout.png?nolink&600 |}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
Line 80: Line 84:
 For the //Script Editor// to make use of the instruments, they must be open in WaveForms. In WaveForms' Welcome tab, open the //Oscilloscope// instrument, then open the //Waveform Generator// instrument. Their settings do not need to be changed. For the //Script Editor// to make use of the instruments, they must be open in WaveForms. In WaveForms' Welcome tab, open the //Oscilloscope// instrument, then open the //Waveform Generator// instrument. Their settings do not need to be changed.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-script-editor:open-scope-and-wavegen.png?600 |}}+{{ :learn:instrumentation:tutorials:waveforms-script-editor:open-scope-and-wavegen.png?nolink&600 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 ---- ----
Line 88: Line 92:
 Open the //Scope and Wavegen// example script, by selecting it from the **Example** dropdown. Open the //Scope and Wavegen// example script, by selecting it from the **Example** dropdown.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-script-editor:open-analog-example-script.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:open-scope-wavegen-script.png?nolink&600 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 ---- ----
Line 130: Line 134:
 More information on the functions and objects available in the //Script Editor// can be found in the in WaveForms' **Help** tab's **Script** page. Additional configuration options for each of the individual instruments not covered by the Script page can be found in the pages dedicated to those instruments. More information on the functions and objects available in the //Script Editor// can be found in the in WaveForms' **Help** tab's **Script** page. Additional configuration options for each of the individual instruments not covered by the Script page can be found in the pages dedicated to those instruments.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-script-editor:help-tab.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:script-help-tab.png?nolink&600 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 ---- ----
Line 141: Line 145:
 Print statements and uncaught errors are shown in the //Output// panel. Print statements and uncaught errors are shown in the //Output// panel.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-output.png?600|}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-output.png?nolink&600|}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 ---- ----
Line 150: Line 154:
 Debugging 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. Debugging 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> </WRAP> <WRAP column half>
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-debugger.png?600|}}+{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-debugger.png?nolink&600|}}
 </WRAP> </WRAP> </WRAP> </WRAP>
  
Line 175: Line 179:
 Open the //Protocol UART// example script, by selecting it from the **Example** dropdown. Open the //Protocol UART// example script, by selecting it from the **Example** dropdown.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-script-editor:open-example.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:open-protocol-script-example.png?nolink&600 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 ---- ----
Line 206: Line 210:
 More information on the functions and objects available in the //Script Editor// can be found in the in WaveForms' **Help** tab's **Script** page. Additional configuration options for each of the individual instruments not covered by the Script page can be found in the pages dedicated to those instruments. More information on the functions and objects available in the //Script Editor// can be found in the in WaveForms' **Help** tab's **Script** page. Additional configuration options for each of the individual instruments not covered by the Script page can be found in the pages dedicated to those instruments.
 </WRAP> <WRAP column half> </WRAP> <WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-script-editor:help-tab.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:script-help-tab.png?nolink&600 |}}
 </WRAP> </WRAP> </WRAP> </WRAP>
 ---- ----
Line 261: Line 265:
 **File** is used to open an existing WaveForms //Script Editor// project, save the current //Script Editor// project, or close the //Script Editor//.  **File** is used to open an existing WaveForms //Script Editor// project, save the current //Script Editor// project, or close the //Script Editor//. 
 </WRAP><WRAP column half> </WRAP><WRAP column half>
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-file.png?600|}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-file.png?nolink&600|}}
 </WRAP></WRAP> </WRAP></WRAP>
  
Line 267: Line 271:
 **Edit** contains buttons for Undo and Redo, as well as options for enabling shortcuts for code completion and finding and replacing. **Edit** contains buttons for Undo and Redo, as well as options for enabling shortcuts for code completion and finding and replacing.
 </WRAP><WRAP column half> </WRAP><WRAP column half>
-{{ reference:test-and-measurement:guides:script_edit.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-edit.png?nolink&600 |}}
 </WRAP></WRAP> </WRAP></WRAP>
  
Line 273: Line 277:
 **Control** accesses the Debug, Run, Stop and Abort actions. **Control** accesses the Debug, Run, Stop and Abort actions.
 </WRAP><WRAP column half> </WRAP><WRAP column half>
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-control-drop.png?600|}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-control.png?nolink&600|}}
 </WRAP></WRAP> </WRAP></WRAP>
  
Line 279: Line 283:
 **View** has options to enable the Output panel and a plotting window. **View** has options to enable the Output panel and a plotting window.
 </WRAP><WRAP column half> </WRAP><WRAP column half>
-{{ reference:test-and-measurement:guides:script_view.png?nolink&600 |}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-view.png?nolink&600 |}}
 </WRAP></WRAP> </WRAP></WRAP>
  
 +<WRAP group><WRAP column half>
 The **Window** menu can be used to access other instruments, the WaveForms home page and the WaveForms Help. The **Window** menu can be used to access other instruments, the WaveForms home page and the WaveForms Help.
 +</WRAP><WRAP column half>
 +{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-window.png?nolink&600 |}}
 +</WRAP></WRAP>
 ---- ----
  
Line 301: Line 309:
 <WRAP column half> <WRAP column half>
  
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-editor-panel.png?600|}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-editor-panel.png?nolink&600|}}
  
 </WRAP> </WRAP>
Line 316: Line 324:
 <WRAP column half> <WRAP column half>
  
-{{:learn:instrumentation:tutorials:analog-discovery-studio-script-editor:waveforms-script-editor-output-panel.png?600|}}+{{:test-and-measurement:analog-discovery-3:waveforms-script-output-panel.png?nolink&600|}}
  
 </WRAP> </WRAP>
Line 331: Line 339:
 </WRAP> </WRAP>
 <WRAP column half> <WRAP column half>
-{{ :learn:instrumentation:tutorials:waveforms-script-editor:waveforms-scripts-help.png?600 |}}+{{:test-and-measurement:analog-discovery-3:script-help-tab.png?nolink&600 |}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
Line 341: Line 349:
 For more information on WaveForms visit the [[software:waveforms:waveforms-3:reference-manual|WaveForms Reference Manual]].  For more information on WaveForms visit the [[software:waveforms:waveforms-3:reference-manual|WaveForms Reference Manual]]. 
  
-For technical support, please visit the [[https://forum.digilentinc.com/forum/8-scopes-instruments/|Scopes and Instruments]] section of the Digilent Forums.+For technical support, please visit the [[https://forum.digilent.com/forum/8-test-and-measurement/|Test and Measurement]] section of the Digilent Forums.