Skip to content

Commit

Permalink
Generated gh-pages for commit 9f55529
Browse files Browse the repository at this point in the history
Author: ThorvaldLarsen <thorvaldw@hotmail.com>

    RS SGS100A driver (#817)
  • Loading branch information
Documentation Bot committed Oct 26, 2017
1 parent fea7abd commit 6151313
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 10 deletions.
12 changes: 12 additions & 0 deletions _modules/qcodes/instrument_drivers/rohde_schwarz/SGS100A.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,11 @@ <h1>Source code for qcodes.instrument_drivers.rohde_schwarz.SGS100A</h1><div cla
<span class="n">set_cmd</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">set_status</span><span class="p">,</span>
<span class="n">get_parser</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parse_on_off</span><span class="p">,</span>
<span class="n">vals</span><span class="o">=</span><span class="n">vals</span><span class="o">.</span><span class="n">Strings</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="s1">&#39;IQ_state&#39;</span><span class="p">,</span>
<span class="n">get_cmd</span><span class="o">=</span><span class="s1">&#39;:IQ:STAT?&#39;</span><span class="p">,</span>
<span class="n">set_cmd</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">set_IQ_state</span><span class="p">,</span>
<span class="n">get_parser</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parse_on_off</span><span class="p">,</span>
<span class="n">vals</span><span class="o">=</span><span class="n">vals</span><span class="o">.</span><span class="n">Strings</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">(</span><span class="s1">&#39;pulsemod_state&#39;</span><span class="p">,</span>
<span class="n">get_cmd</span><span class="o">=</span><span class="s1">&#39;:SOUR:PULM:STAT?&#39;</span><span class="p">,</span>
<span class="n">set_cmd</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">set_pulsemod_state</span><span class="p">,</span>
Expand Down Expand Up @@ -267,6 +272,13 @@ <h1>Source code for qcodes.instrument_drivers.rohde_schwarz.SGS100A</h1><div cla
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Unable to set status to </span><span class="si">%s</span><span class="s1">, &#39;</span> <span class="o">%</span> <span class="n">stat</span> <span class="o">+</span>
<span class="s1">&#39;expected &quot;ON&quot; or &quot;OFF&quot;&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="RohdeSchwarz_SGS100A.set_IQ_state"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.rohde_schwarz.html#qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.set_IQ_state">[docs]</a> <span class="k">def</span> <span class="nf">set_IQ_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stat</span><span class="p">):</span>
<span class="k">if</span> <span class="n">stat</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;ON&#39;</span><span class="p">,</span> <span class="s1">&#39;OFF&#39;</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;:IQ:STAT </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">stat</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Unable to set status to </span><span class="si">%s</span><span class="s1">, &#39;</span> <span class="o">%</span> <span class="n">stat</span> <span class="o">+</span>
<span class="s1">&#39;expected &quot;ON&quot; or &quot;OFF&quot;&#39;</span><span class="p">)</span></div>

<div class="viewcode-block" id="RohdeSchwarz_SGS100A.set_pulsemod_state"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.rohde_schwarz.html#qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.set_pulsemod_state">[docs]</a> <span class="k">def</span> <span class="nf">set_pulsemod_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stat</span><span class="p">):</span>
<span class="k">if</span> <span class="n">stat</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;ON&#39;</span><span class="p">,</span> <span class="s1">&#39;OFF&#39;</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;:PULM:SOUR EXT&#39;</span><span class="p">)</span>
Expand Down
4 changes: 2 additions & 2 deletions api/generated/qcodes.instrument_drivers.QDev.html
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this

<dl class="attribute">
<dt id="qcodes.instrument_drivers.QDev.QDac.QDac.voltage_range_status">
<code class="descname">voltage_range_status</code><em class="property"> = {'X 0.1': 1, 'X 1': 10}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac.QDac.voltage_range_status" title="Permalink to this definition"></a></dt>
<code class="descname">voltage_range_status</code><em class="property"> = {'X 1': 10, 'X 0.1': 1}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac.QDac.voltage_range_status" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
Expand Down Expand Up @@ -382,7 +382,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this

<dl class="attribute">
<dt id="qcodes.instrument_drivers.QDev.QDac_channels.QDac.voltage_range_status">
<code class="descname">voltage_range_status</code><em class="property"> = {'X 0.1': 1, 'X 1': 10}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac_channels.QDac.voltage_range_status" title="Permalink to this definition"></a></dt>
<code class="descname">voltage_range_status</code><em class="property"> = {'X 1': 10, 'X 0.1': 1}</em><a class="headerlink" href="#qcodes.instrument_drivers.QDev.QDac_channels.QDac.voltage_range_status" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
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
5 changes: 5 additions & 0 deletions api/generated/qcodes.instrument_drivers.rohde_schwarz.html
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">parse_on_off</code><span class="sig-paren">(</span><em>stat</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument_drivers/rohde_schwarz/SGS100A.html#RohdeSchwarz_SGS100A.parse_on_off"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.parse_on_off" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.set_IQ_state">
<code class="descname">set_IQ_state</code><span class="sig-paren">(</span><em>stat</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument_drivers/rohde_schwarz/SGS100A.html#RohdeSchwarz_SGS100A.set_IQ_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.set_IQ_state" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.set_pulsemod_source">
<code class="descname">set_pulsemod_source</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/qcodes/instrument_drivers/rohde_schwarz/SGS100A.html#RohdeSchwarz_SGS100A.set_pulsemod_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#qcodes.instrument_drivers.rohde_schwarz.SGS100A.RohdeSchwarz_SGS100A.set_pulsemod_source" title="Permalink to this definition"></a></dt>
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"> = {'saTrackingGeneratorNotFound': -10, 'saInvalidModeErr': -7, 'saTooManyDevicesErr': -5, 'saBandwidthErr': -91, 'saCompressionWarning': 2, 'saUSBCommErr': -11, 'saExternalReferenceNotFound': -89, 'saInternetErr': -12, 'saInvalidDeviceErr': -2, 'saFrequencyRangeErr': -99, 'saNotConfiguredErr': -6, 'saOvenColdErr': -20, 'saUnknownErr': -666, 'saNoCorrections': 1, 'saDeviceNotFoundErr': -8, 'saInvalidScaleErr': -94, 'saBandwidthClamped': 4, 'saInvalidDetectorErr': -95, 'saInvalidParameterErr': -4, 'saDeviceNotConfiguredErr': -6, 'saParameterClamped': 3, 'saDeviceNotOpenErr': -3, 'saNoError': 0, 'saDeviceNotIdleErr': -9, 'saNullPtrErr': -1}</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"> = {'saNotConfiguredErr': -6, 'saExternalReferenceNotFound': -89, 'saNoError': 0, 'saDeviceNotOpenErr': -3, 'saBandwidthClamped': 4, 'saUSBCommErr': -11, 'saCompressionWarning': 2, 'saFrequencyRangeErr': -99, 'saTrackingGeneratorNotFound': -10, 'saInvalidDetectorErr': -95, 'saUnknownErr': -666, 'saInvalidDeviceErr': -2, 'saDeviceNotFoundErr': -8, 'saInvalidScaleErr': -94, 'saOvenColdErr': -20, 'saTooManyDevicesErr': -5, 'saNoCorrections': 1, 'saDeviceNotConfiguredErr': -6, 'saNullPtrErr': -1, 'saInternetErr': -12, 'saDeviceNotIdleErr': -9, 'saInvalidParameterErr': -4, 'saInvalidModeErr': -7, 'saParameterClamped': 3, 'saBandwidthErr': -91}</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', -1: 'saNullPtrErr', -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', -2: 'saInvalidDeviceErr'}</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"> = {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>
<dd></dd></dl>

<dl class="method">
Expand Down
4 changes: 2 additions & 2 deletions api/generated/qcodes.instrument_drivers.tektronix.html
Original file line number Diff line number Diff line change
Expand Up @@ -269,12 +269,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</table>
<dl class="attribute">
<dt id="qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_CHANNEL">
<code class="descname">AWG_FILE_FORMAT_CHANNEL</code><em class="property"> = {'DIGITAL_AMPLITUDE_N': 'd', 'MARKER1_AMPLITUDE_N': 'd', 'DIGITAL_HIGH_N': 'd', 'MARKER2_SKEW_N': 'd', 'MARKER1_SKEW_N': 'd', 'MARKER2_OFFSET_N': 'd', 'DIGITAL_OFFSET_N': 'd', 'PHASE_N': 'd', 'ANALOG_AMPLITUDE_N': 'd', 'MARKER1_HIGH_N': 'd', 'EXTERNAL_ADD_N': 'h', 'DC_OUTPUT_LEVEL_N': 'd', 'ANALOG_HIGH_N': 'd', 'MARKER2_HIGH_N': 'd', 'ANALOG_FILTER_N': 'h', 'ANALOG_METHOD_N': 'h', 'ANALOG_DIRECT_OUTPUT_N': 'h', 'MARKER1_LOW_N': 'd', 'MARKER1_METHOD_N': 'h', 'MARKER2_METHOD_N': 'h', 'ANALOG_OFFSET_N': 'd', 'ANALOG_LOW_N': 'd', 'DELAY_IN_TIME_N': 'd', 'OUTPUT_WAVEFORM_NAME_N': 's', 'DELAY_IN_POINTS_N': 'd', 'MARKER1_OFFSET_N': 'd', 'MARKER2_AMPLITUDE_N': 'd', 'PHASE_DELAY_INPUT_METHOD_N': 'h', 'DIGITAL_METHOD_N': 'h', 'DIGITAL_LOW_N': 'd', 'MARKER2_LOW_N': 'd', 'CHANNEL_STATE_N': 'h', 'CHANNEL_SKEW_N': 'd'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_CHANNEL" title="Permalink to this definition"></a></dt>
<code class="descname">AWG_FILE_FORMAT_CHANNEL</code><em class="property"> = {'PHASE_DELAY_INPUT_METHOD_N': 'h', 'DELAY_IN_TIME_N': 'd', 'MARKER2_METHOD_N': 'h', 'DIGITAL_AMPLITUDE_N': 'd', 'MARKER2_SKEW_N': 'd', 'PHASE_N': 'd', 'MARKER2_OFFSET_N': 'd', 'MARKER2_LOW_N': 'd', 'MARKER1_SKEW_N': 'd', 'ANALOG_METHOD_N': 'h', 'DELAY_IN_POINTS_N': 'd', 'DIGITAL_OFFSET_N': 'd', 'MARKER1_AMPLITUDE_N': 'd', 'DIGITAL_LOW_N': 'd', 'DIGITAL_HIGH_N': 'd', 'MARKER2_HIGH_N': 'd', 'ANALOG_OFFSET_N': 'd', 'MARKER1_OFFSET_N': 'd', 'CHANNEL_SKEW_N': 'd', 'ANALOG_AMPLITUDE_N': 'd', 'MARKER1_HIGH_N': 'd', 'ANALOG_FILTER_N': 'h', 'MARKER1_METHOD_N': 'h', 'OUTPUT_WAVEFORM_NAME_N': 's', 'ANALOG_DIRECT_OUTPUT_N': 'h', 'EXTERNAL_ADD_N': 'h', 'MARKER1_LOW_N': 'd', 'ANALOG_HIGH_N': 'd', 'ANALOG_LOW_N': 'd', 'MARKER2_AMPLITUDE_N': 'd', 'CHANNEL_STATE_N': 'h', 'DC_OUTPUT_LEVEL_N': 'd', 'DIGITAL_METHOD_N': 'h'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_CHANNEL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_HEAD">
<code class="descname">AWG_FILE_FORMAT_HEAD</code><em class="property"> = {'INTERLEAVE': 'h', 'TRIGGER_INPUT_SLOPE': 'h', 'COUPLING': 'h', 'INTERNAL_TRIGGER_RATE': 'd', 'REPETITION_RATE': 'd', 'JUMP_TIMING': 'h', 'TRIGGER_SOURCE': 'h', 'TRIGGER_INPUT_THRESHOLD': 'd', 'RUN_MODE': 'h', 'REFERENCE_MULTIPLIER_RATE': 'h', 'TRIGGER_INPUT_IMPEDANCE': 'h', 'DIVIDER_RATE': 'h', 'EXTERNAL_REFERENCE_TYPE': 'h', 'EVENT_INPUT_IMPEDANCE': 'h', 'HOLD_REPETITION_RATE': 'h', 'EVENT_INPUT_POLARITY': 'h', 'REFERENCE_CLOCK_FREQUENCY_SELECTION': 'h', 'INTERLEAVE_ADJ_PHASE': 'd', 'WAIT_VALUE': 'h', 'ZEROING': 'h', 'REFERENCE_SOURCE': 'h', 'TRIGGER_INPUT_POLARITY': 'h', 'RUN_STATE': 'h', 'EVENT_INPUT_THRESHOLD': 'd', 'SAMPLING_RATE': 'd', 'INTERLEAVE_ADJ_AMPLITUDE': 'd', 'CLOCK_SOURCE': 'h'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_HEAD" title="Permalink to this definition"></a></dt>
<code class="descname">AWG_FILE_FORMAT_HEAD</code><em class="property"> = {'EVENT_INPUT_POLARITY': 'h', 'REFERENCE_SOURCE': 'h', 'TRIGGER_SOURCE': 'h', 'SAMPLING_RATE': 'd', 'CLOCK_SOURCE': 'h', 'EXTERNAL_REFERENCE_TYPE': 'h', 'INTERNAL_TRIGGER_RATE': 'd', 'WAIT_VALUE': 'h', 'INTERLEAVE_ADJ_PHASE': 'd', 'COUPLING': 'h', 'TRIGGER_INPUT_POLARITY': 'h', 'TRIGGER_INPUT_THRESHOLD': 'd', 'REPETITION_RATE': 'd', 'TRIGGER_INPUT_SLOPE': 'h', 'INTERLEAVE_ADJ_AMPLITUDE': 'd', 'JUMP_TIMING': 'h', 'EVENT_INPUT_THRESHOLD': 'd', 'RUN_MODE': 'h', 'RUN_STATE': 'h', 'DIVIDER_RATE': 'h', 'ZEROING': 'h', 'REFERENCE_CLOCK_FREQUENCY_SELECTION': 'h', 'INTERLEAVE': 'h', 'TRIGGER_INPUT_IMPEDANCE': 'h', 'REFERENCE_MULTIPLIER_RATE': 'h', 'EVENT_INPUT_IMPEDANCE': 'h', 'HOLD_REPETITION_RATE': 'h'}</em><a class="headerlink" href="#qcodes.instrument_drivers.tektronix.AWG5014.Tektronix_AWG5014.AWG_FILE_FORMAT_HEAD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
Expand Down
Loading

0 comments on commit 6151313

Please sign in to comment.