611 lines
35 KiB
HTML
611 lines
35 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>All Documents</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>
|
|
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
<div class="container">
|
|
<h1>All Documents</h1>
|
|
|
|
<ul>
|
|
<li id="fn_gen">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen</div>
|
|
<div class="url">index.html</div>
|
|
<div class="type">Package</div>
|
|
<div class="kind">Package</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.common">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.common</div>
|
|
<div class="url">fn_gen.common.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052</div>
|
|
<div class="url">fn_gen.dg2052.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
|
</li><li id="fn_gen.enums">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums</div>
|
|
<div class="url">fn_gen.enums.html</div>
|
|
<div class="type">Package</div>
|
|
<div class="kind">Package</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.enums.comm_method">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.comm<wbr></wbr>_method</div>
|
|
<div class="url">fn_gen.enums.comm_method.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
|
</li><li id="fn_gen.enums.sweep_signal_type">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_signal<wbr></wbr>_type</div>
|
|
<div class="url">fn_gen.enums.sweep_signal_type.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
|
</li><li id="fn_gen.enums.sweep_spacing">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_spacing</div>
|
|
<div class="url">fn_gen.enums.sweep_spacing.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_slope">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_slope</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_slope.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_source">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_source</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_source.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
|
</li><li id="fn_gen.errors">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors</div>
|
|
<div class="url">fn_gen.errors.html</div>
|
|
<div class="type">Package</div>
|
|
<div class="kind">Package</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.undefined_communication_method_error">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_communication<wbr></wbr>_method<wbr></wbr>_error</div>
|
|
<div class="url">fn_gen.errors.undefined_communication_method_error.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.undefined_value_error">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_value<wbr></wbr>_error</div>
|
|
<div class="url">fn_gen.errors.undefined_value_error.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.value_out_of_bounds_error">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.value<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_bounds<wbr></wbr>_error</div>
|
|
<div class="url">fn_gen.errors.value_out_of_bounds_error.html</div>
|
|
<div class="type">Module</div>
|
|
<div class="kind">Module</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_communication<wbr></wbr>_method<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Undefined<wbr></wbr>Communication<wbr></wbr>Method<wbr></wbr>Error</div>
|
|
<div class="url">fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Exception</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.__init__">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_communication<wbr></wbr>_method<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Undefined<wbr></wbr>Communication<wbr></wbr>Method<wbr></wbr>Error<wbr></wbr>.__init__</div>
|
|
<div class="url">fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.html#__init__</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.value<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_bounds<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Value<wbr></wbr>Out<wbr></wbr>Of<wbr></wbr>Bounds<wbr></wbr>Error</div>
|
|
<div class="url">fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Exception</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.__init__">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.value<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_bounds<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Value<wbr></wbr>Out<wbr></wbr>Of<wbr></wbr>Bounds<wbr></wbr>Error<wbr></wbr>.__init__</div>
|
|
<div class="url">fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.html#__init__</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.undefined_value_error.UndefinedValueError">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_value<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Undefined<wbr></wbr>Value<wbr></wbr>Error</div>
|
|
<div class="url">fn_gen.errors.undefined_value_error.UndefinedValueError.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Exception</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.errors.undefined_value_error.UndefinedValueError.__init__">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_value<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Undefined<wbr></wbr>Value<wbr></wbr>Error<wbr></wbr>.__init__</div>
|
|
<div class="url">fn_gen.errors.undefined_value_error.UndefinedValueError.html#__init__</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.common.check_bounds">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.common<wbr></wbr>.check<wbr></wbr>_bounds</div>
|
|
<div class="url">fn_gen.common.html#check_bounds</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Function</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.enums.comm_method.CommMethod">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.comm<wbr></wbr>_method<wbr></wbr>.<wbr></wbr>Comm<wbr></wbr>Method</div>
|
|
<div class="url">fn_gen.enums.comm_method.CommMethod.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Class</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The communication method accepted by the function generator</div>
|
|
</li><li id="fn_gen.enums.comm_method.CommMethod.USB">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.comm<wbr></wbr>_method<wbr></wbr>.<wbr></wbr>Comm<wbr></wbr>Method<wbr></wbr>.USB</div>
|
|
<div class="url">fn_gen.enums.comm_method.CommMethod.html#USB</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">For USB devices</div>
|
|
</li><li id="fn_gen.enums.comm_method.CommMethod.LAN">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.comm<wbr></wbr>_method<wbr></wbr>.<wbr></wbr>Comm<wbr></wbr>Method<wbr></wbr>.LAN</div>
|
|
<div class="url">fn_gen.enums.comm_method.CommMethod.html#LAN</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">For LAN devices</div>
|
|
</li><li id="fn_gen.enums.sweep_spacing.SweepSpacing">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_spacing<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Spacing</div>
|
|
<div class="url">fn_gen.enums.sweep_spacing.SweepSpacing.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Class</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The spacing used in the sweep function</div>
|
|
</li><li id="fn_gen.enums.sweep_spacing.SweepSpacing.LIN">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_spacing<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Spacing<wbr></wbr>.LIN</div>
|
|
<div class="url">fn_gen.enums.sweep_spacing.SweepSpacing.html#LIN</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">A linear sweep</div>
|
|
</li><li id="fn_gen.enums.sweep_spacing.SweepSpacing.LOG">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_spacing<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Spacing<wbr></wbr>.LOG</div>
|
|
<div class="url">fn_gen.enums.sweep_spacing.SweepSpacing.html#LOG</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">A logarithmic sweep</div>
|
|
</li><li id="fn_gen.enums.sweep_spacing.SweepSpacing.STEP">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_spacing<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Spacing<wbr></wbr>.STEP</div>
|
|
<div class="url">fn_gen.enums.sweep_spacing.SweepSpacing.html#STEP</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">A stepwise sweep</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_slope<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Slope</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Class</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The type of slope used for the external sweep trigger</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.POSITIVE">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_slope<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Slope<wbr></wbr>.POSITIVE</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.html#POSITIVE</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">This option triggers the sweep on the positive edge</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.NEGATIVE">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_slope<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Slope<wbr></wbr>.NEGATIVE</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.html#NEGATIVE</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">Ths option triggers the sweep on the negative edge</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_source.SweepTriggerSource">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_source<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Source</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Class</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The Source of the trigger for the sweep</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.INTERNAL">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_source<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Source<wbr></wbr>.INTERNAL</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#INTERNAL</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">An Internal trigger signal, defined by htime_start, htime_stop</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_source<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Source<wbr></wbr>.EXTERNAL</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">An external trigger signal</div>
|
|
</li><li id="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.MANUAL">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_source<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Trigger<wbr></wbr>Source<wbr></wbr>.MANUAL</div>
|
|
<div class="url">fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#MANUAL</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">A manual trigger set in code by the trigger function</div>
|
|
</li><li id="fn_gen.enums.sweep_signal_type.SweepSignalType">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_signal<wbr></wbr>_type<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Signal<wbr></wbr>Type</div>
|
|
<div class="url">fn_gen.enums.sweep_signal_type.SweepSignalType.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Class</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The type of signal used in the sweep function</div>
|
|
</li><li id="fn_gen.enums.sweep_signal_type.SweepSignalType.SINE">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_signal<wbr></wbr>_type<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Signal<wbr></wbr>Type<wbr></wbr>.SINE</div>
|
|
<div class="url">fn_gen.enums.sweep_signal_type.SweepSignalType.html#SINE</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The Sine function sweep</div>
|
|
</li><li id="fn_gen.enums.sweep_signal_type.SweepSignalType.SQUARE">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_signal<wbr></wbr>_type<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Signal<wbr></wbr>Type<wbr></wbr>.SQUARE</div>
|
|
<div class="url">fn_gen.enums.sweep_signal_type.SweepSignalType.html#SQUARE</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The Square function sweep</div>
|
|
</li><li id="fn_gen.enums.sweep_signal_type.SweepSignalType.RAMP">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_signal<wbr></wbr>_type<wbr></wbr>.<wbr></wbr>Sweep<wbr></wbr>Signal<wbr></wbr>Type<wbr></wbr>.RAMP</div>
|
|
<div class="url">fn_gen.enums.sweep_signal_type.SweepSignalType.html#RAMP</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Constant</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The Ramp function sweep</div>
|
|
</li><li id="fn_gen.dg2052.DG2052">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html</div>
|
|
<div class="type">Class</div>
|
|
<div class="kind">Class</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">This is an object representing the Rigol DG2052 function generator. This object uses the SCPI protocol for communicating with the Rigol DG2052 function generator.</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.port">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.port</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#port</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Instance Variable</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">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...</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.rm">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.rm</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#rm</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Instance Variable</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The resource manager object for pyvisa (for future use)</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.comm">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.comm</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#comm</div>
|
|
<div class="type">Attribute</div>
|
|
<div class="kind">Instance Variable</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">The communication method used (either TCPIP or USB)</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.__init__">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.__init__</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#__init__</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">Initializes the DG2052 object</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.whoami">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.whoami</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#whoami</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">shows the identification of the connected instrument</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_output">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_output</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_output</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">Sets the output channel ON or OFF</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.toggle_output">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.toggle<wbr></wbr>_output</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#toggle_output</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.get_output_volt_limits">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_volt<wbr></wbr>_limits</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#get_output_volt_limits</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary">Gets the output volt limits of the specified channel</div>
|
|
</li><li id="fn_gen.dg2052.DG2052.get_output_impedance">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_impedance</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#get_output_impedance</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.get_output_load">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_load</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#get_output_load</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.get_output_signal">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_signal</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#get_output_signal</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.get_output_state">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_state</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#get_output_state</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.is_output_on">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.is<wbr></wbr>_output<wbr></wbr>_on</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#is_output_on</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_dc">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_dc</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_dc</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_sine_wave">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_sine<wbr></wbr>_wave</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_sine_wave</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_frequency">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_frequency</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_frequency</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_square_wave">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_square<wbr></wbr>_wave</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_square_wave</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_ramp">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_ramp</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_ramp</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.set_sweep">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_sweep</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#set_sweep</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li><li id="fn_gen.dg2052.DG2052.trigger_sweep">
|
|
|
|
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.trigger<wbr></wbr>_sweep</div>
|
|
<div class="url">fn_gen.dg2052.DG2052.html#trigger_sweep</div>
|
|
<div class="type">Function</div>
|
|
<div class="kind">Method</div>
|
|
<div class="privacy">PUBLIC</div>
|
|
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |