Skip to content

Commit

Permalink
SCPI doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@prasimix
prasimix committed Feb 12, 2021
1 parent 44e934d commit dd837ad
Show file tree
Hide file tree
Showing 31 changed files with 1,045 additions and 113 deletions.
1,031 changes: 932 additions & 99 deletions docs/SCPI reference guide/Commands/EEZ BB3 SCPI reference 5.17 - SYSTem.html
View file

Large diffs are not rendered by default.

123 changes: 110 additions & 13 deletions docs/SCPI reference guide/Commands/EEZ BB3 SCPI reference 5.8 - INSTrument.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
.cmd_code_Start { text-align: left; margin-top: 1.99mm; font-family: "Courier New"; }
.cmd_code_single { text-align: left; margin-top: 1.99mm; margin-bottom: 1.99mm; font-family: "Courier New"; }
.cmd_root { text-align: left; color: #0066cc; }
.note { font-style: italic; }
.scpi0 { text-align: left; }
.scpi1 { text-align: left; margin-left: 4.99mm; }
.scpi2 { text-align: left; margin-left: 10mm; }
Expand Down Expand Up @@ -120,6 +121,14 @@
<p>&#160;</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 37%;">
<p class="scpi2"><a href="#inst_scal"><span style="text-decoration: underline;">:SCALe[&lt;n&gt;] {&lt;value&gt;}</span></a></p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 63%;">
<p>Sets full scale value</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 37%;">
<p class="scpi2"><a href="#inst_disp_trac"><span style="text-decoration: underline;">:TRACe[&lt;n&gt;] {&lt;value&gt;}</span></a></p>
Expand Down Expand Up @@ -225,10 +234,10 @@
<p class="Default_nt2">Usage<span style="font-style: italic;"> </span>example</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p class="cmd_code">INST?</p>
<p class="cmd_code_single">CH1</p>
<p>Select power channel and determine its position in slot 1:</p>
<p class="cmd_code_Start">INST CH1</p>
<p class="cmd_code">INST:SEL?</p>
<p class="cmd_code_Start">CH1</p>
<p class="cmd_code_Start">(@101)</p>
<p class="cmd_code">&#160;</p>
<p>Select AO1 channel on the SMX46 module installed in slot 3:</p>
<p class="cmd_code_single">INST (@301)</p>
Expand Down Expand Up @@ -261,6 +270,8 @@
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p>This query returns a comma-separated list of strings which contains the names of all logical instruments. If no logical instruments are defined, a single null string is returned.</p>
<p>&#160;</p>
<p class="note">Returned names can only be used with the INSTrument[:SELect] command.</p>
</td>
</tr>
<tr style="background: transparent;">
Expand Down Expand Up @@ -299,6 +310,8 @@
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p>Use this query to get a list of string – number pairs. The string contains the name of the logical instrument. The immediately following NR1-formatted number is its associated logical instrument number. All response data elements are comma separated. If no logical instrument is defined, a null string followed by a zero is returned.</p>
<p>&#160;</p>
<p class="note">Returned logical instrument numbers can only be used with the INSTrument:NSELect command.</p>
</td>
</tr>
<tr style="background: transparent;">
Expand Down Expand Up @@ -450,7 +463,91 @@
</td>
</tr>
</table>
<p class="Heading_3">5.8.5. <a name="inst_disp_trac"></a>INSTrument:DISPlay:TRACe[&lt;n&gt;]</p>
<p class="Heading_3">5.8.5. <a name="inst_scal"></a>INSTrument:DISPlay:SCALe[&lt;n&gt;]</p>
<table style="border-collapse: collapse; background: transparent; width: 169.92mm;">
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Syntax</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p class="cmd_root">INSTrument:DISPlay:SCALe[&lt;n&gt;] {&lt;value&gt;}</p>
<p class="cmd_root">INSTrument:DISPlay:SCALe[&lt;n&gt;]?</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Description</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p>This command sets the full scale vale of YT and bar graph views on the display position (trace) defined with [&lt;n&gt;]. </p>
</td>
</tr>
<tr style="background: transparent;">
<td rowspan="2" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Parameters</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 1px solid #000000; vertical-align: top; background: transparent; width: 22%;">
<p style="text-align: center;">Name</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 1px solid #000000; vertical-align: top; background: transparent; width: 18%;">
<p style="text-align: center;">Type</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 1px solid #000000; vertical-align: top; background: transparent; width: 31%;">
<p style="text-align: center;">Range</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 1px solid #000000; vertical-align: top; background: transparent; width: 17%;">
<p style="text-align: center;">Default</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 22%;">
<p>&lt;value&gt;</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 18%;">
<p style="text-align: center;">Discrete|NR2</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 31%;">
<p style="text-align: center;">AUTO|LIMit|MAXimum</p>
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 17%;">
<p style="text-align: center;">–</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Return</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p>Query returns the currently selected full scale value on the selected display position (trace).</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Usage<span style="font-style: italic;"> </span>example</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p class="cmd_code">INST:DISP:SCAL2?</p>
<p class="cmd_code_Start">&quot;LIM&quot;</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Errors</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p class="cmd_code">-222,&quot;Data out of range&quot;</p>
</td>
</tr>
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
<p class="Default_nt2">Related Commands</p>
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p>DISPlay:VIEW</p>
</td>
</tr>
</table>
<p class="Heading_3">5.8.6. <a name="inst_disp_trac"></a>INSTrument:DISPlay:TRACe[&lt;n&gt;]</p>
<table style="border-collapse: collapse; background: transparent; width: 169.92mm;">
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
Expand Down Expand Up @@ -515,7 +612,7 @@
</td>
<td colspan="4" style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p class="cmd_code">INST:DISP:TRAC2?</p>
<p class="cmd_code_Start">CURR</p>
<p class="cmd_code_Start">&quot;CURR&quot;</p>
</td>
</tr>
<tr style="background: transparent;">
Expand All @@ -537,7 +634,7 @@
</td>
</tr>
</table>
<p class="Heading_3">5.8.6. <a name="inst_disp_trac_swap"></a>INSTrument:DISPlay:TRACe:SWAP</p>
<p class="Heading_3">5.8.7. <a name="inst_disp_trac_swap"></a>INSTrument:DISPlay:TRACe:SWAP</p>
<table style="border-collapse: collapse; background: transparent; width: 169.92mm;">
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
Expand All @@ -561,14 +658,14 @@
</td>
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 87%;">
<p class="cmd_code">INST:DISP:TRAC1?</p>
<p class="cmd_code_single">VOLT</p>
<p class="cmd_code_single">&quot;VOLT&quot;</p>
<p class="cmd_code">INST:DISP:TRAC2?</p>
<p class="cmd_code_single">CURR</p>
<p class="cmd_code_single">&quot;CURR&quot;</p>
<p class="cmd_code">INT:DISP:TRAC:SWAP</p>
<p class="cmd_code">INST:DISP:TRAC1?</p>
<p class="cmd_code_single">CURR</p>
<p class="cmd_code_single">&quot;CURR&quot;</p>
<p class="cmd_code">INST:DISP:TRAC2?</p>
<p class="cmd_code_Start">VOLT</p>
<p class="cmd_code_Start">&quot;VOLT&quot;</p>
</td>
</tr>
<tr style="background: transparent;">
Expand All @@ -582,7 +679,7 @@
</td>
</tr>
</table>
<p class="Heading_3">5.8.7. <a name="inst_disp_yt_rate"></a>INSTrument:DISPlay:YT:RATE</p>
<p class="Heading_3">5.8.8. <a name="inst_disp_yt_rate"></a>INSTrument:DISPlay:YT:RATE</p>
<table style="border-collapse: collapse; background: transparent; width: 169.92mm;">
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
Expand Down Expand Up @@ -659,7 +756,7 @@
</td>
</tr>
</table>
<p class="Heading_3">5.8.8. <a name="inst_coup_trig"></a>INSTrument:COUPle:TRIGger</p>
<p class="Heading_3">5.8.9. <a name="inst_coup_trig"></a>INSTrument:COUPle:TRIGger</p>
<table style="border-collapse: collapse; background: transparent; width: 169.92mm;">
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
Expand Down Expand Up @@ -747,7 +844,7 @@
</td>
</tr>
</table>
<p class="Heading_3">5.8.9. <a name="inst_nsel"></a>INSTrument:NSELect</p>
<p class="Heading_3">5.8.10. <a name="inst_nsel"></a>INSTrument:NSELect</p>
<table style="border-collapse: collapse; background: transparent; width: 169.92mm;">
<tr style="background: transparent;">
<td style="border-left: 0; border-right: 0; border-top: 0; border-bottom: 0; vertical-align: top; background: transparent; width: 13%;">
Expand Down
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col10.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col11.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col12.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col13.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col14.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col15.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col16.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col17.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col18.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col19.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col2.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col20.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col21.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col22.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col23.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...rence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col24.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col3.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col4.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col5.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col6.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col7.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col8.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...erence guide/Commands/images/EEZ BB3 SCPI reference 5.17 - SYSTem-syst_col9.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/SCPI reference guide/EEZ BB3 SCPI reference - last page.odt
View file
Binary file not shown.
Binary file modified docs/SCPI reference guide/EEZ BB3 SCPI reference - start page.odt
View file
Binary file not shown.
Binary file modified docs/SCPI reference guide/EEZ BB3 SCPI reference 5.17 - SYSTem.odt
View file
Binary file not shown.
Binary file modified docs/SCPI reference guide/EEZ BB3 SCPI reference 5.8 - INSTrument.odt
View file
Binary file not shown.
4 changes: 3 additions & 1 deletion readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ Currently supported modules:

* [DCP405](https://github.com/eez-open/modular-psu/tree/master/dcp405) 0 - 40 V / 5 A programmable power source
* [DCM220](https://github.com/eez-open/modular-psu/tree/master/dcm220) dual 1 - 20 V / 4 A auxiliary power source
* [DCM224](https://github.com/eez-open/dib-dcm224) dual 1 - 24 V / 4.9 A auxiliary power source

Under development:

* [MIO168](https://github.com/eez-open/dib-mio168) mixed I/O module
* [PREL6](https://github.com/eez-open/dib-prel6) 6 power relays module
* [SMX46](https://github.com/eez-open/dib-smx46) 4 x 6 programmable switch matrix
* [SMX46](https://github.com/eez-open/dib-smx46) 4 x 6 programmable switch matrix
* [MUX14D](https://github.com/eez-open/dib-mux14d) dual 7:1 reed relay 2-wire multiplexer

---

Expand Down

0 comments on commit dd837ad

Please sign in to comment.