Skip to content

Commit

Permalink
Generated gh-pages for commit 1886482
Browse files Browse the repository at this point in the history
Author: peendebak <P.T.eendebak@tudelft.nl>

    fix arguments of IVVI driver (#803)
  • Loading branch information
Documentation Bot committed Oct 23, 2017
1 parent 9391085 commit f313cbc
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 13 deletions.
4 changes: 1 addition & 3 deletions _modules/qcodes/instrument_drivers/QuTech/IVVI.html
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h1>Source code for qcodes.instrument_drivers.QuTech.IVVI</h1><div class="highli
<span class="n">Halfrange</span> <span class="o">=</span> <span class="n">Fullrange</span> <span class="o">/</span> <span class="mi">2</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">reset</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">numdacs</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">dac_step</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">dac_delay</span><span class="o">=.</span><span class="mi">1</span><span class="p">,</span> <span class="n">dac_max_delay</span><span class="o">=</span><span class="mf">0.2</span><span class="p">,</span> <span class="n">safe_version</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">dac_delay</span><span class="o">=.</span><span class="mi">1</span><span class="p">,</span> <span class="n">safe_version</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">polarity</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;BIP&#39;</span><span class="p">,</span> <span class="s1">&#39;BIP&#39;</span><span class="p">,</span> <span class="s1">&#39;BIP&#39;</span><span class="p">,</span> <span class="s1">&#39;BIP&#39;</span><span class="p">],</span>
<span class="n">use_locks</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
Expand All @@ -210,7 +210,6 @@ <h1>Source code for qcodes.instrument_drivers.QuTech.IVVI</h1><div class="highli
<span class="sd"> default=[&#39;BIP&#39;, &#39;BIP&#39;, &#39;BIP&#39;, &#39;BIP&#39;]</span>
<span class="sd"> dac_step (float) : max step size for dac parameter</span>
<span class="sd"> dac_delay (float) : delay (in seconds) for dac</span>
<span class="sd"> dac_max_delay (float) : maximum delay before emitting a warning</span>
<span class="sd"> safe_version (bool) : if True then do not send version commands</span>
<span class="sd"> to the IVVI controller</span>
<span class="sd"> use_locks (bool) : if True then locks are used in the `ask`</span>
Expand Down Expand Up @@ -302,7 +301,6 @@ <h1>Source code for qcodes.instrument_drivers.QuTech.IVVI</h1><div class="highli
<span class="bp">self</span><span class="o">.</span><span class="n">pol_num</span><span class="p">[</span><span class="n">i</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">Fullrange</span><span class="p">),</span>
<span class="n">step</span><span class="o">=</span><span class="n">dac_step</span><span class="p">,</span>
<span class="n">delay</span><span class="o">=</span><span class="n">dac_delay</span><span class="p">,</span>
<span class="n">max_delay</span><span class="o">=</span><span class="n">dac_max_delay</span><span class="p">,</span>
<span class="n">max_val_age</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>

<span class="bp">self</span><span class="o">.</span><span class="n">_update_time</span> <span class="o">=</span> <span class="mi">5</span> <span class="c1"># seconds</span>
Expand Down
2 changes: 1 addition & 1 deletion api/generated/qcodes.instrument_drivers.Advantech.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<p>Tested with driver version 3.1.10.0 and ddl version 3.1.12.1.</p>
<dl class="attribute">
<dt id="qcodes.instrument_drivers.Advantech.PCIE_1751.Advantech_PCIE_1751.ERRORMSG">
<code class="descname">ERRORMSG</code><em class="property"> = {0: 'The operation is completed successfully.', 2684354560: 'The interrupt resource is not available.', 2684354562: 'The property value is out of range.', 2684354563: 'The property value is not supported.', 2684354564: 'The property value conflicts with the current state.', 2684354565: 'The value range of all channels in a group should be same, such as 4~20mA of PCI-1724.', 3758096384: &quot;The handle is NULL or its type doesn't match the required operation.&quot;, 2684354561: 'The parameter is out of the range.', 3758096392: 'The required function is not supported.', 3758096393: 'The required event is not supported.', 3758096394: 'The required property is not supported.', 3758096395: 'The required property is read-only.', 3758096396: 'The specified property value conflicts with the current state.', 3758096386: 'The parameter value is not supported.', 3758096398: 'The specified property value is not supported.', 3758096397: 'The specified property value is out of range.', 3758096400: 'The required privilege is not available because someone else had own it.', 3758096401: 'The driver of specified device was not found.', 3758096402: 'The driver version of the specified device mismatched.', 3758096387: 'The parameter value format is not the expected.', 3758096404: 'The device is not opened.', 3758096405: 'The required device does not exist.', 3758096406: 'The required device is unrecognized by driver.', 3758096407: 'The configuration data of the specified device is lost or unavailable.', 3758096408: &quot;The function is not initialized and can't be started.&quot;, 3758096388: 'Not enough memory is available to complete the operation.', 3758096410: 'The interrupt resource is not available.', 3758096399: &quot;The handle hasn't own the privilege of the operation the user wanted.&quot;, 3758096412: 'Time out when reading/writing the device.', 3758096413: 'The given signature does not match with the device current one.', 3758096414: 'The function cannot be executed while the buffered AI is running.', 3758096389: 'The data buffer is null.', 3758096411: 'The DMA channel is not available.', 3758096385: 'The parameter value is out of range.', 3758096390: 'The data buffer is too small for the operation.', 3758096391: 'The data length exceeded the limitation.', 3758096403: 'The loaded driver count exceeded the limitation.', 3758096409: 'The function is busy.', 3758096415: 'The value range is not available in single-ended mode.', 3758161919: 'Undefined error.'}</em><a class="headerlink" href="#qcodes.instrument_drivers.Advantech.PCIE_1751.Advantech_PCIE_1751.ERRORMSG" title="Permalink to this definition"></a></dt>
<code class="descname">ERRORMSG</code><em class="property"> = {0: 'The operation is completed successfully.', 2684354560: 'The interrupt resource is not available.', 2684354561: 'The parameter is out of the range.', 2684354562: 'The property value is out of range.', 2684354563: 'The property value is not supported.', 2684354564: 'The property value conflicts with the current state.', 2684354565: 'The value range of all channels in a group should be same, such as 4~20mA of PCI-1724.', 3758096384: &quot;The handle is NULL or its type doesn't match the required operation.&quot;, 3758096385: 'The parameter value is out of range.', 3758096386: 'The parameter value is not supported.', 3758096387: 'The parameter value format is not the expected.', 3758096388: 'Not enough memory is available to complete the operation.', 3758096389: 'The data buffer is null.', 3758096390: 'The data buffer is too small for the operation.', 3758096391: 'The data length exceeded the limitation.', 3758096392: 'The required function is not supported.', 3758096393: 'The required event is not supported.', 3758096394: 'The required property is not supported.', 3758096395: 'The required property is read-only.', 3758096396: 'The specified property value conflicts with the current state.', 3758096397: 'The specified property value is out of range.', 3758096398: 'The specified property value is not supported.', 3758096399: &quot;The handle hasn't own the privilege of the operation the user wanted.&quot;, 3758096400: 'The required privilege is not available because someone else had own it.', 3758096401: 'The driver of specified device was not found.', 3758096402: 'The driver version of the specified device mismatched.', 3758096403: 'The loaded driver count exceeded the limitation.', 3758096404: 'The device is not opened.', 3758096405: 'The required device does not exist.', 3758096406: 'The required device is unrecognized by driver.', 3758096407: 'The configuration data of the specified device is lost or unavailable.', 3758096408: &quot;The function is not initialized and can't be started.&quot;, 3758096409: 'The function is busy.', 3758096410: 'The interrupt resource is not available.', 3758096411: 'The DMA channel is not available.', 3758096412: 'Time out when reading/writing the device.', 3758096413: 'The given signature does not match with the device current one.', 3758096414: 'The function cannot be executed while the buffered AI is running.', 3758096415: 'The value range is not available in single-ended mode.', 3758161919: 'Undefined error.'}</em><a class="headerlink" href="#qcodes.instrument_drivers.Advantech.PCIE_1751.Advantech_PCIE_1751.ERRORMSG" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
Expand Down
3 changes: 1 addition & 2 deletions api/generated/qcodes.instrument_drivers.QuTech.html
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<span id="qcodes-instrument-drivers-qutech-ivvi-module"></span><h2>qcodes.instrument_drivers.QuTech.IVVI module<a class="headerlink" href="#module-qcodes.instrument_drivers.QuTech.IVVI" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="qcodes.instrument_drivers.QuTech.IVVI.IVVI">
<em class="property">class </em><code class="descclassname">qcodes.instrument_drivers.QuTech.IVVI.</code><code class="descname">IVVI</code><span class="sig-paren">(</span><em>name, address, reset=False, numdacs=16, dac_step=10, dac_delay=0.1, dac_max_delay=0.2, safe_version=True, polarity=['BIP', 'BIP', 'BIP', 'BIP'], use_locks=False, **kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument_drivers/QuTech/IVVI.html#IVVI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.QuTech.IVVI.IVVI" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">qcodes.instrument_drivers.QuTech.IVVI.</code><code class="descname">IVVI</code><span class="sig-paren">(</span><em>name, address, reset=False, numdacs=16, dac_step=10, dac_delay=0.1, safe_version=True, polarity=['BIP', 'BIP', 'BIP', 'BIP'], use_locks=False, **kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument_drivers/QuTech/IVVI.html#IVVI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.QuTech.IVVI.IVVI" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">qcodes.instrument.visa.VisaInstrument</span></code></p>
<dl class="docutils">
<dt>Status: Alpha version, tested for basic get-set commands</dt>
Expand Down Expand Up @@ -246,7 +246,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
default=[‘BIP’, ‘BIP’, ‘BIP’, ‘BIP’]</li>
<li><strong>dac_step</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#float" title="(in Python v3.5)"><em>float</em></a>) – max step size for dac parameter</li>
<li><strong>dac_delay</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#float" title="(in Python v3.5)"><em>float</em></a>) – delay (in seconds) for dac</li>
<li><strong>dac_max_delay</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#float" title="(in Python v3.5)"><em>float</em></a>) – maximum delay before emitting a warning</li>
<li><strong>safe_version</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – if True then do not send version commands
to the IVVI controller</li>
<li><strong>use_locks</strong> (<a class="reference external" href="https://docs.python.org/3.5/library/functions.html#bool" title="(in Python v3.5)"><em>bool</em></a>) – if True then locks are used in the <cite>ask</cite>
Expand Down
2 changes: 1 addition & 1 deletion api/generated/qcodes.instrument_drivers.ithaco.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>measured_param</strong> (<a class="reference internal" href="qcodes.Parameter.html#qcodes.Parameter" title="qcodes.Parameter"><em>Parameter</em></a>) – a gettable parameter returning the
voltage read from the Ithaco output.</li>
<li><strong>c_amp_ins</strong> (<a class="reference internal" href="#qcodes.instrument_drivers.ithaco.Ithaco_1211.Ithaco_1211" title="qcodes.instrument_drivers.ithaco.Ithaco_1211.Ithaco_1211"><em>Ithaco_1211</em></a>) – <p>an Ithaco instance where you manually
<li><strong>c_amp_ins</strong> (<a class="reference internal" href="#module-qcodes.instrument_drivers.ithaco.Ithaco_1211" title="qcodes.instrument_drivers.ithaco.Ithaco_1211"><em>Ithaco_1211</em></a>) – <p>an Ithaco instance where you manually
maintain the present settings of the real Ithaco amp.</p>
<p>Note: it should be possible to use other current preamps, if they
define parameters <code class="docutils literal"><span class="pre">sens</span></code> (sensitivity, in A/V), <code class="docutils literal"><span class="pre">sens_factor</span></code>
Expand Down
4 changes: 2 additions & 2 deletions api/generated/qcodes.instrument_drivers.signal_hound.html
Original file line number Diff line number Diff line change
Expand Up @@ -318,12 +318,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this

<dl class="attribute">
<dt id="qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus">
<code class="descname">saStatus</code><em class="property"> = {'saInternetErr': -12, 'saInvalidDeviceErr': -2, 'saTrackingGeneratorNotFound': -10, 'saDeviceNotOpenErr': -3, 'saTooManyDevicesErr': -5, 'saNoCorrections': 1, 'saFrequencyRangeErr': -99, 'saExternalReferenceNotFound': -89, 'saNotConfiguredErr': -6, 'saInvalidParameterErr': -4, 'saCompressionWarning': 2, 'saInvalidModeErr': -7, 'saUnknownErr': -666, 'saDeviceNotConfiguredErr': -6, 'saBandwidthErr': -91, 'saParameterClamped': 3, 'saUSBCommErr': -11, 'saDeviceNotFoundErr': -8, 'saDeviceNotIdleErr': -9, 'saBandwidthClamped': 4, 'saOvenColdErr': -20, 'saNullPtrErr': -1, 'saInvalidDetectorErr': -95, 'saNoError': 0, 'saInvalidScaleErr': -94}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus" title="Permalink to this definition"></a></dt>
<code class="descname">saStatus</code><em class="property"> = {'saUnknownErr': -666, 'saFrequencyRangeErr': -99, 'saInvalidDetectorErr': -95, 'saInvalidScaleErr': -94, 'saBandwidthErr': -91, 'saExternalReferenceNotFound': -89, 'saOvenColdErr': -20, 'saInternetErr': -12, 'saUSBCommErr': -11, 'saTrackingGeneratorNotFound': -10, 'saDeviceNotIdleErr': -9, 'saDeviceNotFoundErr': -8, 'saInvalidModeErr': -7, 'saNotConfiguredErr': -6, 'saDeviceNotConfiguredErr': -6, 'saTooManyDevicesErr': -5, 'saInvalidParameterErr': -4, 'saDeviceNotOpenErr': -3, 'saInvalidDeviceErr': -2, 'saNullPtrErr': -1, 'saNoError': 0, 'saNoCorrections': 1, 'saCompressionWarning': 2, 'saParameterClamped': 3, 'saBandwidthClamped': 4}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus_inverted">
<code class="descname">saStatus_inverted</code><em class="property"> = {0: 'saNoError', 1: 'saNoCorrections', 2: 'saCompressionWarning', 3: 'saParameterClamped', 4: 'saBandwidthClamped', -2: 'saInvalidDeviceErr', -99: 'saFrequencyRangeErr', -95: 'saInvalidDetectorErr', -94: 'saInvalidScaleErr', -91: 'saBandwidthErr', -666: 'saUnknownErr', -89: 'saExternalReferenceNotFound', -20: 'saOvenColdErr', -12: 'saInternetErr', -11: 'saUSBCommErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saDeviceNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -1: 'saNullPtrErr'}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus_inverted" title="Permalink to this definition"></a></dt>
<code class="descname">saStatus_inverted</code><em class="property"> = {-666: 'saUnknownErr', -99: 'saFrequencyRangeErr', -95: 'saInvalidDetectorErr', -94: 'saInvalidScaleErr', -91: 'saBandwidthErr', -89: 'saExternalReferenceNotFound', -20: 'saOvenColdErr', -12: 'saInternetErr', -11: 'saUSBCommErr', -10: 'saTrackingGeneratorNotFound', -9: 'saDeviceNotIdleErr', -8: 'saDeviceNotFoundErr', -7: 'saInvalidModeErr', -6: 'saDeviceNotConfiguredErr', -5: 'saTooManyDevicesErr', -4: 'saInvalidParameterErr', -3: 'saDeviceNotOpenErr', -2: 'saInvalidDeviceErr', -1: 'saNullPtrErr', 0: 'saNoError', 1: 'saNoCorrections', 2: 'saCompressionWarning', 3: 'saParameterClamped', 4: 'saBandwidthClamped'}</em><a class="headerlink" href="#qcodes.instrument_drivers.signal_hound.USB_SA124B.SignalHound_USB_SA124B.saStatus_inverted" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
Expand Down
Loading

0 comments on commit f313cbc

Please sign in to comment.