1083 lines
40 KiB
HTML
1083 lines
40 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
|
|
|
|
<head>
|
|
|
|
<title>fn_gen.dg2052.DG2052</title>
|
|
<meta name="generator" content="pydoctor 23.9.1">
|
|
|
|
</meta>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
|
|
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="apidocs.css" />
|
|
<link rel="stylesheet" type="text/css" href="extra.css" />
|
|
</head>
|
|
|
|
<body>
|
|
|
|
|
|
|
|
<nav class="navbar navbar-default mainnavbar">
|
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
|
|
<div class="navbar-header">
|
|
|
|
<div class="navlinks">
|
|
<span class="navbar-brand">
|
|
fn_gen <a href="index.html">API Documentation</a>
|
|
</span>
|
|
|
|
<a href="moduleIndex.html">
|
|
Modules
|
|
</a>
|
|
|
|
<a href="classIndex.html">
|
|
Classes
|
|
</a>
|
|
|
|
<a href="nameIndex.html">
|
|
Names
|
|
</a>
|
|
|
|
<div id="search-box-container">
|
|
<div class="input-group">
|
|
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
|
|
|
|
<span class="input-group-btn">
|
|
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
|
|
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="search-results-container" style="display: none;">
|
|
|
|
<div id="search-buttons">
|
|
<span class="label label-default" id="search-docstrings-button">
|
|
<label class="checkbox-inline">
|
|
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
|
|
search in docstrings
|
|
</input>
|
|
</label>
|
|
</span>
|
|
|
|
</div>
|
|
|
|
<noscript>
|
|
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
|
|
</noscript>
|
|
|
|
<div class="hint" id="search-help-box">
|
|
<p class="rst-last">
|
|
|
|
Search bar offers the following options:
|
|
<ul>
|
|
<li>
|
|
<strong>Term presence.</strong> The below example searches for documents that
|
|
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Search in specific fields.</strong> The following search matches all objects
|
|
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
|
|
|
|
<p>
|
|
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
|
|
Last two fields are only applicable if "search in docstrings" is enabled.
|
|
</p>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Fuzzy matches.</strong> The following search matches all documents
|
|
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
|
|
</li>
|
|
</ul>
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="search-status"> </div>
|
|
|
|
<div class="warning" id="search-warn-box" style="display: none;">
|
|
<p class="rst-last"><span id="search-warn"></span></p>
|
|
</div>
|
|
|
|
<table id="search-results">
|
|
<!-- Filled dynamically by JS -->
|
|
</table>
|
|
|
|
<div style="margin-top: 8px;">
|
|
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="container-fluid">
|
|
|
|
<!-- Side navigation -->
|
|
<div class="sidebarcontainer" style="display: none;">
|
|
|
|
<div class="sidebar"><nav class="sidebar">
|
|
|
|
|
|
<div>
|
|
|
|
<div class="thingTitle">
|
|
<span>Class</span>
|
|
<code class="thisobject"><a href="fn_gen.dg2052.DG2052.html" class="internal-link" title="This class">DG2052</a></code>
|
|
</div>
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Methods</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#__init__" class="internal-link" title="fn_gen.dg2052.DG2052.__init__">__init__</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#get_output_impedance" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_impedance">get<wbr></wbr>_output<wbr></wbr>_impedance</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#get_output_load" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_load">get<wbr></wbr>_output<wbr></wbr>_load</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#get_output_signal" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_signal">get<wbr></wbr>_output<wbr></wbr>_signal</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#get_output_state" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_state">get<wbr></wbr>_output<wbr></wbr>_state</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#get_output_volt_limits" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_volt_limits">get<wbr></wbr>_output<wbr></wbr>_volt<wbr></wbr>_limits</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#is_output_on" class="internal-link" title="fn_gen.dg2052.DG2052.is_output_on">is<wbr></wbr>_output<wbr></wbr>_on</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_dc" class="internal-link" title="fn_gen.dg2052.DG2052.set_dc">set<wbr></wbr>_dc</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_frequency" class="internal-link" title="fn_gen.dg2052.DG2052.set_frequency">set<wbr></wbr>_frequency</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_output" class="internal-link" title="fn_gen.dg2052.DG2052.set_output">set<wbr></wbr>_output</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_ramp" class="internal-link" title="fn_gen.dg2052.DG2052.set_ramp">set<wbr></wbr>_ramp</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_sine_wave" class="internal-link" title="fn_gen.dg2052.DG2052.set_sine_wave">set<wbr></wbr>_sine<wbr></wbr>_wave</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_square_wave" class="internal-link" title="fn_gen.dg2052.DG2052.set_square_wave">set<wbr></wbr>_square<wbr></wbr>_wave</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#set_sweep" class="internal-link" title="fn_gen.dg2052.DG2052.set_sweep">set<wbr></wbr>_sweep</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#toggle_output" class="internal-link" title="fn_gen.dg2052.DG2052.toggle_output">toggle<wbr></wbr>_output</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#trigger_sweep" class="internal-link" title="fn_gen.dg2052.DG2052.trigger_sweep">trigger<wbr></wbr>_sweep</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#whoami" class="internal-link" title="fn_gen.dg2052.DG2052.whoami">whoami</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Attributes</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#comm" class="internal-link" title="fn_gen.dg2052.DG2052.comm">comm</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#port" class="internal-link" title="fn_gen.dg2052.DG2052.port">port</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#rm" class="internal-link" title="fn_gen.dg2052.DG2052.rm">rm</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div><div>
|
|
|
|
<div class="thingTitle">
|
|
<span>Module</span>
|
|
<code><a href="fn_gen.dg2052.html" class="internal-link" title="The parent of this class">dg2052</a></code>
|
|
</div>
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Classes</div>
|
|
<ul>
|
|
|
|
<li class=" thisobject">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="fn_gen.dg2052.DG2052.html" class="internal-link" title="fn_gen.dg2052.DG2052">DG2052</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</nav>
|
|
</div>
|
|
<div id="collapseSideBar">
|
|
<a class="btn btn-link" onclick="toggleSideBarCollapse()" title="Toggle Sidebar Collapse">
|
|
</a>
|
|
</div>
|
|
<script src="sidebartoggle.js" type="text/javascript"></script>
|
|
|
|
</div>
|
|
|
|
<div id="main" class="">
|
|
|
|
|
|
|
|
|
|
<div class="page-header">
|
|
<h1 class="class"><code><code><a href="index.html" class="internal-link">fn_gen</a></code><wbr></wbr>.<code><a href="fn_gen.dg2052.html" class="internal-link" title="fn_gen.dg2052">dg2052</a></code><wbr></wbr>.<code><a href="fn_gen.dg2052.DG2052.html" class="internal-link" title="fn_gen.dg2052.DG2052">DG2052</a></code></code></h1>
|
|
<div id="showPrivate">
|
|
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="categoryHeader">
|
|
class documentation
|
|
</div>
|
|
|
|
<div class="extrasDocstring">
|
|
<p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">DG2052</span>(pyvisa.resources.MessageBasedResource):</code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="fn_gen.dg2052.DG2052.__init__">DG2052(port)</a></code></p>
|
|
<p><a href="classIndex.html#fn_gen.dg2052.DG2052">View In Hierarchy</a></p>
|
|
</div>
|
|
|
|
<div class="moduleDocstring">
|
|
<div><p>This is an object representing the Rigol DG2052 function generator. This object uses the SCPI protocol for communicating with the Rigol DG2052 function generator.</p></div>
|
|
</div>
|
|
|
|
<div id="splitTables">
|
|
<table class="children sortable" id="id4">
|
|
|
|
|
|
<tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#__init__" class="internal-link" title="fn_gen.dg2052.DG2052.__init__">__init__</a></code></td>
|
|
<td>Initializes the DG2052 object</td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#get_output_impedance" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_impedance">get<wbr></wbr>_output<wbr></wbr>_impedance</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#get_output_load" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_load">get<wbr></wbr>_output<wbr></wbr>_load</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#get_output_signal" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_signal">get<wbr></wbr>_output<wbr></wbr>_signal</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#get_output_state" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_state">get<wbr></wbr>_output<wbr></wbr>_state</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#get_output_volt_limits" class="internal-link" title="fn_gen.dg2052.DG2052.get_output_volt_limits">get<wbr></wbr>_output<wbr></wbr>_volt<wbr></wbr>_limits</a></code></td>
|
|
<td>Gets the output volt limits of the specified channel</td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#is_output_on" class="internal-link" title="fn_gen.dg2052.DG2052.is_output_on">is<wbr></wbr>_output<wbr></wbr>_on</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_dc" class="internal-link" title="fn_gen.dg2052.DG2052.set_dc">set<wbr></wbr>_dc</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_frequency" class="internal-link" title="fn_gen.dg2052.DG2052.set_frequency">set<wbr></wbr>_frequency</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_output" class="internal-link" title="fn_gen.dg2052.DG2052.set_output">set<wbr></wbr>_output</a></code></td>
|
|
<td>Sets the output channel ON or OFF</td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_ramp" class="internal-link" title="fn_gen.dg2052.DG2052.set_ramp">set<wbr></wbr>_ramp</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_sine_wave" class="internal-link" title="fn_gen.dg2052.DG2052.set_sine_wave">set<wbr></wbr>_sine<wbr></wbr>_wave</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_square_wave" class="internal-link" title="fn_gen.dg2052.DG2052.set_square_wave">set<wbr></wbr>_square<wbr></wbr>_wave</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#set_sweep" class="internal-link" title="fn_gen.dg2052.DG2052.set_sweep">set<wbr></wbr>_sweep</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#toggle_output" class="internal-link" title="fn_gen.dg2052.DG2052.toggle_output">toggle<wbr></wbr>_output</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#trigger_sweep" class="internal-link" title="fn_gen.dg2052.DG2052.trigger_sweep">trigger<wbr></wbr>_sweep</a></code></td>
|
|
<td><span class="undocumented">Undocumented</span></td>
|
|
</tr><tr class="method">
|
|
|
|
<td>Method</td>
|
|
<td><code><a href="#whoami" class="internal-link" title="fn_gen.dg2052.DG2052.whoami">whoami</a></code></td>
|
|
<td>shows the identification of the connected instrument</td>
|
|
</tr><tr class="instancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="#comm" class="internal-link" title="fn_gen.dg2052.DG2052.comm">comm</a></code></td>
|
|
<td>The communication method used (either TCPIP or USB)</td>
|
|
</tr><tr class="instancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="#port" class="internal-link" title="fn_gen.dg2052.DG2052.port">port</a></code></td>
|
|
<td>The SCPI port describing the device, consists of a communication method and device port followed by the "::INSTR" keyword. communication method: can be either USB or TCPIP (other communication methods are not supported for this device) device port: either COMM4 or /dev/USB0 for USB in windows and posix systems respectively or the IP Address for TCPIP...</td>
|
|
</tr><tr class="instancevariable">
|
|
|
|
<td>Instance Variable</td>
|
|
<td><code><a href="#rm" class="internal-link" title="fn_gen.dg2052.DG2052.rm">rm</a></code></td>
|
|
<td>The resource manager object for pyvisa (for future use)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="childList">
|
|
<div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.__init__">
|
|
|
|
</a>
|
|
<a name="__init__">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">__init__</span><span class="function-signature">(self, port: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>)</span>:
|
|
|
|
<a class="headerLink" href="#__init__" title="fn_gen.dg2052.DG2052.__init__">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p>Initializes the DG2052 object</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">port:</span><code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></td><td class="fieldArgDesc"><p>The SCPI port describing the device, consists of a communication method and device port followed by the "::INSTR" keyword.
|
|
communication method: can be either <code>USB</code> or <code>TCPIP</code> (other communication methods are not supported for this device)
|
|
device port: either <code>COMM4</code> or <code>/dev/USB0</code> for USB in windows and posix systems respectively or the IP Address for TCPIP</p>
|
|
<p>format: "<code>communication method</code>::<code>device port</code>::INSTR"</p>
|
|
<p>example: "<code>TCPI</code>::<code>192.168.1.11</code>::INSTR" or "<code>USB</code>::<code>COMM4</code>::INSTR"</p>
|
|
</td></tr></table></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.get_output_impedance">
|
|
|
|
</a>
|
|
<a name="get_output_impedance">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">get_output_impedance</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>) -> <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code></span>:
|
|
|
|
<a class="headerLink" href="#get_output_impedance" title="fn_gen.dg2052.DG2052.get_output_impedance">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.get_output_load">
|
|
|
|
</a>
|
|
<a name="get_output_load">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">get_output_load</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>) -> <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code></span>:
|
|
|
|
<a class="headerLink" href="#get_output_load" title="fn_gen.dg2052.DG2052.get_output_load">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.get_output_signal">
|
|
|
|
</a>
|
|
<a name="get_output_signal">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">get_output_signal</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>) -> <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></span>:
|
|
|
|
<a class="headerLink" href="#get_output_signal" title="fn_gen.dg2052.DG2052.get_output_signal">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.get_output_state">
|
|
|
|
</a>
|
|
<a name="get_output_state">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">get_output_state</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>) -> <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></span>:
|
|
|
|
<a class="headerLink" href="#get_output_state" title="fn_gen.dg2052.DG2052.get_output_state">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.get_output_volt_limits">
|
|
|
|
</a>
|
|
<a name="get_output_volt_limits">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">get_output_volt_limits</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>) -> <code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a>[<wbr></wbr><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a>, <wbr></wbr><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a>]</code></span>:
|
|
|
|
<a class="headerLink" href="#get_output_volt_limits" title="fn_gen.dg2052.DG2052.get_output_volt_limits">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p>Gets the output volt limits of the specified channel</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">channel:</span><code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[</code><span class="literal">1</span>, <span class="literal">2</span>]</td><td class="fieldArgDesc">The output channel of the device (either 1 or 2)</td></tr><tr class="fieldStart"><td class="fieldName" colspan="2">Returns</td></tr><tr><td class="fieldArgContainer"><code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a>[<a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code>, <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a>]</code></td><td class="fieldArgDesc">The low voltage limit and the hight voltage limit</td></tr></table></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.is_output_on">
|
|
|
|
</a>
|
|
<a name="is_output_on">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">is_output_on</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code></span>:
|
|
|
|
<a class="headerLink" href="#is_output_on" title="fn_gen.dg2052.DG2052.is_output_on">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_dc">
|
|
|
|
</a>
|
|
<a name="set_dc">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_dc</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, offset: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code>)</span>:
|
|
|
|
<a class="headerLink" href="#set_dc" title="fn_gen.dg2052.DG2052.set_dc">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_frequency">
|
|
|
|
</a>
|
|
<a name="set_frequency">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_frequency</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, freq)</span>:
|
|
|
|
<a class="headerLink" href="#set_frequency" title="fn_gen.dg2052.DG2052.set_frequency">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_output">
|
|
|
|
</a>
|
|
<a name="set_output">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_output</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, state: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>)</span>:
|
|
|
|
<a class="headerLink" href="#set_output" title="fn_gen.dg2052.DG2052.set_output">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p>Sets the output channel ON or OFF</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">channel:</span><code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[</code><span class="literal">1</span>, <span class="literal">2</span>]</td><td class="fieldArgDesc">The output channel of the device (either 1 or 2)</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">state:</span><code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code></td><td class="fieldArgDesc">The state of the output channel</td></tr></table></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_ramp">
|
|
|
|
</a>
|
|
<a name="set_ramp">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_ramp</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, freq: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 1000.0, amp: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 5, offset: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0, phase: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 0)</span>:
|
|
|
|
<a class="headerLink" href="#set_ramp" title="fn_gen.dg2052.DG2052.set_ramp">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_sine_wave">
|
|
|
|
</a>
|
|
<a name="set_sine_wave">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_sine_wave</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, freq: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 1000.0, amp: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 5.0, offset: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0.0, phase: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 0)</span>:
|
|
|
|
<a class="headerLink" href="#set_sine_wave" title="fn_gen.dg2052.DG2052.set_sine_wave">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_square_wave">
|
|
|
|
</a>
|
|
<a name="set_square_wave">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_square_wave</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, freq: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 1000.0, amp: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 5.0, offset: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0.0, phase: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 0)</span>:
|
|
|
|
<a class="headerLink" href="#set_square_wave" title="fn_gen.dg2052.DG2052.set_square_wave">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.set_sweep">
|
|
|
|
</a>
|
|
<a name="set_sweep">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">set_sweep</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>, amp: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 5, offset: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0, phase: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 0, signal_type: <code>SweepSignalType</code> = SweepSignalType.SINE, htime_start: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0, htime_stop: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0, freq_start: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 100, freq_stop: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 1000.0, marker: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#False" class="intersphinx-link">False</a>, freq_marker: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 550, rtime: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 0, time: <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code> = 1, spacing: <code>SweepSpacing</code> = SweepSpacing.LIN, step: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> = 2, trigger_slope: <code>SweepTriggerSlope</code> = SweepTriggerSlope.POSITIVE, trigger_source: <code>SweepTriggerSource</code> = SweepTriggerSource.INTERNAL)</span>:
|
|
|
|
<a class="headerLink" href="#set_sweep" title="fn_gen.dg2052.DG2052.set_sweep">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.toggle_output">
|
|
|
|
</a>
|
|
<a name="toggle_output">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">toggle_output</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>)</span>:
|
|
|
|
<a class="headerLink" href="#toggle_output" title="fn_gen.dg2052.DG2052.toggle_output">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.trigger_sweep">
|
|
|
|
</a>
|
|
<a name="trigger_sweep">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">trigger_sweep</span><span class="function-signature">(self, channel: <code><a href="https://docs.python.org/3/library/typing.html#typing.Literal" class="intersphinx-link">Literal</a>[<wbr></wbr>1, <wbr></wbr>2]</code>)</span>:
|
|
|
|
<a class="headerLink" href="#trigger_sweep" title="fn_gen.dg2052.DG2052.trigger_sweep">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p class="undocumented">Undocumented</p></div>
|
|
</div>
|
|
</div><div class="basemethod">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.whoami">
|
|
|
|
</a>
|
|
<a name="whoami">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
|
|
<span class="py-keyword">def</span> <span class="py-defname">whoami</span><span class="function-signature">(self) -> <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></span>:
|
|
|
|
<a class="headerLink" href="#whoami" title="fn_gen.dg2052.DG2052.whoami">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="docstring functionBody">
|
|
|
|
<div><p>shows the identification of the connected instrument</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Returns</td></tr><tr><td class="fieldArgContainer"><code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></td><td class="fieldArgDesc">The identification of the connected instrument</td></tr></table></div>
|
|
</div>
|
|
</div><div class="baseinstancevariable">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.comm">
|
|
|
|
</a>
|
|
<a name="comm">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">comm</span>: <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> =
|
|
|
|
<a class="headerLink" href="#comm" title="fn_gen.dg2052.DG2052.comm">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="functionBody">
|
|
|
|
<div><p>The communication method used (either TCPIP or USB)</p></div>
|
|
|
|
</div>
|
|
</div><div class="baseinstancevariable">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.port">
|
|
|
|
</a>
|
|
<a name="port">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">port</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> =
|
|
|
|
<a class="headerLink" href="#port" title="fn_gen.dg2052.DG2052.port">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="functionBody">
|
|
|
|
<div><p>The SCPI port describing the device, consists of a communication method and device port followed by the "::INSTR" keyword.
|
|
communication method: can be either USB or TCPIP (other communication methods are not supported for this device)
|
|
device port: either COMM4 or /dev/USB0 for USB in windows and posix systems respectively or the IP Address for TCPIP</p>
|
|
<p>format: "<communication method>::<device port>::INSTR"</p>
|
|
<p>example: "TCPI::192.168.1.11::INSTR" or "USB::COMM4::INSTR"</p>
|
|
</div>
|
|
|
|
</div>
|
|
</div><div class="baseinstancevariable">
|
|
|
|
|
|
<a name="fn_gen.dg2052.DG2052.rm">
|
|
|
|
</a>
|
|
<a name="rm">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">rm</span>: <code>ResourceManager</code> =
|
|
|
|
<a class="headerLink" href="#rm" title="fn_gen.dg2052.DG2052.rm">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="functionBody">
|
|
|
|
<div><p>The resource manager object for pyvisa (for future use)</p></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="navbar navbar-default">
|
|
|
|
|
|
<div class="container">
|
|
<a href="index.html">API Documentation</a> for fn_gen,
|
|
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
|
23.9.1 at 2024-02-06 18:56:15.
|
|
</div>
|
|
|
|
<!-- Search related scripts needs to be loaded at the end of HTML
|
|
parsing not to introduce overhead and display HTML data asap -->
|
|
<script src="ajax.js" type="text/javascript"></script>
|
|
<script src="searchlib.js" type="text/javascript"></script>
|
|
<script src="search.js" type="text/javascript"></script>
|
|
|
|
</footer>
|
|
|
|
<script src="pydoctor.js" type="text/javascript"></script>
|
|
|
|
</body>
|
|
</html> |