-
Notifications
You must be signed in to change notification settings - Fork 0
/
FormatPy.html
265 lines (243 loc) · 18.8 KB
/
FormatPy.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FormatPy — RsSmw 5.30.48.80 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Fpanel" href="Fpanel.html" />
<link rel="prev" title="Update" href="Display_Update.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> RsSmw
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="readme.html">Revision History</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="enums.html">Enums</a></li>
<li class="toctree-l1"><a class="reference internal" href="repcap.html">RepCaps</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="RsSmw.html">RsSmw API Structure</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Bert.html">Bert</a></li>
<li class="toctree-l2"><a class="reference internal" href="Bler.html">Bler</a></li>
<li class="toctree-l2"><a class="reference internal" href="Calibration.html">Calibration</a></li>
<li class="toctree-l2"><a class="reference internal" href="Clock.html">Clock</a></li>
<li class="toctree-l2"><a class="reference internal" href="Connector.html">Connector</a></li>
<li class="toctree-l2"><a class="reference internal" href="Device.html">Device</a></li>
<li class="toctree-l2"><a class="reference internal" href="Diagnostic.html">Diagnostic</a></li>
<li class="toctree-l2"><a class="reference internal" href="Display.html">Display</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">FormatPy</a></li>
<li class="toctree-l2"><a class="reference internal" href="Fpanel.html">Fpanel</a></li>
<li class="toctree-l2"><a class="reference internal" href="HardCopy.html">HardCopy</a></li>
<li class="toctree-l2"><a class="reference internal" href="Initiate.html">Initiate<Channel></a></li>
<li class="toctree-l2"><a class="reference internal" href="Instruments.html">Instruments</a></li>
<li class="toctree-l2"><a class="reference internal" href="Kboard.html">Kboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="MassMemory.html">MassMemory</a></li>
<li class="toctree-l2"><a class="reference internal" href="Memory.html">Memory</a></li>
<li class="toctree-l2"><a class="reference internal" href="Output.html">Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Read.html">Read<Channel></a></li>
<li class="toctree-l2"><a class="reference internal" href="Sconfiguration.html">Sconfiguration</a></li>
<li class="toctree-l2"><a class="reference internal" href="Sense.html">Sense<Channel></a></li>
<li class="toctree-l2"><a class="reference internal" href="Service.html">Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="Slist.html">Slist</a></li>
<li class="toctree-l2"><a class="reference internal" href="Source.html">Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="Status.html">Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="System.html">System</a></li>
<li class="toctree-l2"><a class="reference internal" href="Test.html">Test</a></li>
<li class="toctree-l2"><a class="reference internal" href="Trigger.html">Trigger<InputIx></a></li>
<li class="toctree-l2"><a class="reference internal" href="Unit.html">Unit</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">RsSmw Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="logger.html">RsSmw Logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">RsSmw Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">RsSmw</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="RsSmw.html">RsSmw API Structure</a> »</li>
<li>FormatPy</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/FormatPy.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="formatpy">
<h1>FormatPy<a class="headerlink" href="#formatpy" title="Permalink to this headline"></a></h1>
<p class="rubric">SCPI Commands :</p>
<div class="highlight-python notranslate" id="index-0"><div class="highlight"><pre><span></span><span class="n">FORMat</span><span class="p">:</span><span class="n">BORDer</span>
<span class="n">FORMat</span><span class="p">:</span><span class="n">SREGister</span>
<span class="n">FORMat</span><span class="p">:[</span><span class="n">DATA</span><span class="p">]</span>
</pre></div>
</div>
<dl class="py class">
<dt class="sig sig-object py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FormatPyCls</span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>FormatPy commands group definition. 3 total commands, 0 Subgroups, 3 group commands</p>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">get_border</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">RsSmw.enums.ByteOrder</span></span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls.get_border"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SCPI: FORMat:BORDer</span>
<span class="n">value</span><span class="p">:</span> <span class="n">enums</span><span class="o">.</span><span class="n">ByteOrder</span> <span class="o">=</span> <span class="n">driver</span><span class="o">.</span><span class="n">formatPy</span><span class="o">.</span><span class="n">get_border</span><span class="p">()</span>
</pre></div>
</div>
<p>Determines the sequence of bytes within a binary block. This only affects blocks which use the IEEE754 format internally.</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">return</dt>
<dd class="field-odd"><p>border: NORMal| SWAPped NORMal Expects/sends the least significant byte of each IEEE754 floating-point number first and the most significant byte last. SWAPped Expects/sends the most significant byte of each IEEE754 floating-point number first and the least significant byte last.</p>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">RsSmw.enums.FormData</span></span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SCPI: FORMat:[DATA]</span>
<span class="n">value</span><span class="p">:</span> <span class="n">enums</span><span class="o">.</span><span class="n">FormData</span> <span class="o">=</span> <span class="n">driver</span><span class="o">.</span><span class="n">formatPy</span><span class="o">.</span><span class="n">get_data</span><span class="p">()</span>
</pre></div>
</div>
<p>Determines the data format the instrument uses to return data via the IEC/IEEE bus. The instrument automatically detects
the data format used by the controller, and assigns it accordingly. Data format determined by this SCPI command is in
this case irrelevant.</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">return</dt>
<dd class="field-odd"><p>data: ASCii| PACKed ASCii Transfers numerical data as plain text separated by commas. PACKed Transfers numerical data as binary block data. The format within the binary data depends on the command. The various binary data formats are explained in the description of the parameter types.</p>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">get_sregister</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">RsSmw.enums.FormStatReg</span></span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls.get_sregister"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SCPI: FORMat:SREGister</span>
<span class="n">value</span><span class="p">:</span> <span class="n">enums</span><span class="o">.</span><span class="n">FormStatReg</span> <span class="o">=</span> <span class="n">driver</span><span class="o">.</span><span class="n">formatPy</span><span class="o">.</span><span class="n">get_sregister</span><span class="p">()</span>
</pre></div>
</div>
<p>Determines the numeric format for responses of the status register.</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">return</dt>
<dd class="field-odd"><p>format_py: ASCii| BINary| HEXadecimal| OCTal ASCii Returns the register content as a decimal number. BINary|HEXadecimal|OCTal Returns the register content either as a binary, hexadecimal or octal number. According to the selected format, the number starts with #B (binary) , #H (hexadecimal) or #O (octal) .</p>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">set_border</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">border</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RsSmw.enums.ByteOrder</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls.set_border"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SCPI: FORMat:BORDer</span>
<span class="n">driver</span><span class="o">.</span><span class="n">formatPy</span><span class="o">.</span><span class="n">set_border</span><span class="p">(</span><span class="n">border</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">ByteOrder</span><span class="o">.</span><span class="n">NORMal</span><span class="p">)</span>
</pre></div>
</div>
<p>Determines the sequence of bytes within a binary block. This only affects blocks which use the IEEE754 format internally.</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">param border</dt>
<dd class="field-odd"><p>NORMal| SWAPped NORMal Expects/sends the least significant byte of each IEEE754 floating-point number first and the most significant byte last. SWAPped Expects/sends the most significant byte of each IEEE754 floating-point number first and the least significant byte last.</p>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">set_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RsSmw.enums.FormData</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls.set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SCPI: FORMat:[DATA]</span>
<span class="n">driver</span><span class="o">.</span><span class="n">formatPy</span><span class="o">.</span><span class="n">set_data</span><span class="p">(</span><span class="n">data</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">FormData</span><span class="o">.</span><span class="n">ASCii</span><span class="p">)</span>
</pre></div>
</div>
<p>Determines the data format the instrument uses to return data via the IEC/IEEE bus. The instrument automatically detects
the data format used by the controller, and assigns it accordingly. Data format determined by this SCPI command is in
this case irrelevant.</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">param data</dt>
<dd class="field-odd"><p>ASCii| PACKed ASCii Transfers numerical data as plain text separated by commas. PACKed Transfers numerical data as binary block data. The format within the binary data depends on the command. The various binary data formats are explained in the description of the parameter types.</p>
</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">set_sregister</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format_py</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RsSmw.enums.FormStatReg</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/RsSmw/Implementations/FormatPy.html#FormatPyCls.set_sregister"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SCPI: FORMat:SREGister</span>
<span class="n">driver</span><span class="o">.</span><span class="n">formatPy</span><span class="o">.</span><span class="n">set_sregister</span><span class="p">(</span><span class="n">format_py</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">FormStatReg</span><span class="o">.</span><span class="n">ASCii</span><span class="p">)</span>
</pre></div>
</div>
<p>Determines the numeric format for responses of the status register.</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">param format_py</dt>
<dd class="field-odd"><p>ASCii| BINary| HEXadecimal| OCTal ASCii Returns the register content as a decimal number. BINary|HEXadecimal|OCTal Returns the register content either as a binary, hexadecimal or octal number. According to the selected format, the number starts with #B (binary) , #H (hexadecimal) or #O (octal) .</p>
</dd>
</dl>
</div></blockquote>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Display_Update.html" class="btn btn-neutral float-left" title="Update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Fpanel.html" class="btn btn-neutral float-right" title="Fpanel" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright © Rohde & Schwarz 2023.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>