Feature: Added Documentation in
This commit is contained in:
@@ -139,7 +139,7 @@
|
||||
<div class="type">Package</div>
|
||||
<div class="kind">Package</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol)</div>
|
||||
</li><li id="fn_gen.common">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.common</div>
|
||||
@@ -147,7 +147,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Common functions that are used all over the package</div>
|
||||
</li><li id="fn_gen.dg2052">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052</div>
|
||||
@@ -155,7 +155,7 @@
|
||||
<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>
|
||||
<div class="summary">The main funciton generator module</div>
|
||||
</li><li id="fn_gen.enums">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums</div>
|
||||
@@ -163,7 +163,7 @@
|
||||
<div class="type">Package</div>
|
||||
<div class="kind">Package</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Some enums that are used within this package</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>
|
||||
@@ -171,7 +171,7 @@
|
||||
<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>
|
||||
<div class="summary">Communication Method Enumeration</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>
|
||||
@@ -179,7 +179,7 @@
|
||||
<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>
|
||||
<div class="summary">Enumeration representing the different signal types used in a sweep</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>
|
||||
@@ -187,7 +187,7 @@
|
||||
<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>
|
||||
<div class="summary">The spacings used for the sweep</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>
|
||||
@@ -195,7 +195,7 @@
|
||||
<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>
|
||||
<div class="summary">The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></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>
|
||||
@@ -203,7 +203,7 @@
|
||||
<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>
|
||||
<div class="summary">The different sources available to trigger a sweep</div>
|
||||
</li><li id="fn_gen.errors">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors</div>
|
||||
@@ -211,7 +211,7 @@
|
||||
<div class="type">Package</div>
|
||||
<div class="kind">Package</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">A combination of errors used within the package</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>
|
||||
@@ -219,7 +219,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">An error type used when the communication method is not in the <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> enum</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>
|
||||
@@ -227,7 +227,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">An error used when the value used is not defined</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>
|
||||
@@ -235,7 +235,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">An error used when the value used is out of bounds for the function</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>
|
||||
@@ -291,7 +291,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Function</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Checks the whether the given value is within bounds</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>
|
||||
@@ -444,30 +444,30 @@
|
||||
<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">
|
||||
</li><li id="fn_gen.dg2052.DG2052.__comm">
|
||||
|
||||
<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="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 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="privacy">PRIVATE</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></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="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="privacy">PRIVATE</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.__port">
|
||||
|
||||
<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="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 communication method used (either TCPIP or USB)</div>
|
||||
<div class="privacy">PRIVATE</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></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>
|
||||
@@ -483,7 +483,7 @@
|
||||
<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>
|
||||
<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>
|
||||
@@ -499,7 +499,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Toggles the corresponding output channel</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>
|
||||
@@ -515,7 +515,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the output impedance.</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>
|
||||
@@ -523,7 +523,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the output load.</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>
|
||||
@@ -531,7 +531,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the signal type and parameters.</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>
|
||||
@@ -539,7 +539,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the output state of the signal</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>
|
||||
@@ -547,7 +547,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns a boolean representing the state of the output</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>
|
||||
@@ -555,7 +555,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to DC voltage mode</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>
|
||||
@@ -563,7 +563,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to A Sine Wave</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>
|
||||
@@ -571,7 +571,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the frequency of the set signal</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>
|
||||
@@ -579,7 +579,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to A Square Wave</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>
|
||||
@@ -587,7 +587,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to A Ramp (Triangular) Wave</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>
|
||||
@@ -595,7 +595,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the parameters of a signal sweep</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>
|
||||
@@ -603,7 +603,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Triggers a sweep manually (Only works if the sweep was setup with <code>trigger_source</code> as <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#MANUAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.MANUAL">SweepTriggerSource.MANUAL</a></code>)</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user