quarchpy 2.2.13__py2.py3-none-any.whl → 2.2.14__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- quarchpy/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/__pycache__/_version.cpython-310.pyc +0 -0
- quarchpy/__pycache__/connection.cpython-310.pyc +0 -0
- quarchpy/__pycache__/install_qps.cpython-310.pyc +0 -0
- quarchpy/_version.py +1 -1
- quarchpy/config_files/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/config_files/__pycache__/quarch_config_parser.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/StreamChannels.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_QIS.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_QPS.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_ReST.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_Serial.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_TCP.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_USB.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/mDNS.cpython-310.pyc +0 -0
- quarchpy/connection_specific/jdk_jres/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/jdk_jres/__pycache__/fix_permissions.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/serialposix.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/serialutil.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_common.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_linux.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_posix.cpython-310.pyc +0 -0
- quarchpy/debug/__pycache__/SystemTest.cpython-310.pyc +0 -0
- quarchpy/debug/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/debug/__pycache__/versionCompare.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device_fixture_idn_info.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device_idn_info.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device_network_info.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/discovered_device.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/packet_processing.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/quarchArray.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/quarchPPM.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/quarchQPS.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/scanDevices.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/AbsDiskFinder.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/DiskTargetSelection.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/iometerDiskFinder.cpython-310.pyc +0 -0
- quarchpy/docs/CHANGES.rst +4 -0
- quarchpy/docs/_build/doctrees/CHANGES.doctree +0 -0
- quarchpy/docs/_build/doctrees/environment.pickle +0 -0
- quarchpy/docs/_build/doctrees/index.doctree +0 -0
- quarchpy/docs/_build/doctrees/readme.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/changelog.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/licenses.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/modules.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.calibration.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.config_files.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.connection_specific.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.debug.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.device.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.disk_test.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.fio.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.iometer.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.qis.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.qps.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.user_interface.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.utilities.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/readme.doctree +0 -0
- quarchpy/docs/_build/html/CHANGES.html +187 -144
- quarchpy/docs/_build/html/_sources/CHANGES.rst.txt +29 -0
- quarchpy/docs/_build/html/_static/basic.css +0 -8
- quarchpy/docs/_build/html/_static/pygments.css +62 -62
- quarchpy/docs/_build/html/_static/searchtools.js +8 -5
- quarchpy/docs/_build/html/genindex.html +384 -146
- quarchpy/docs/_build/html/index.html +81 -74
- quarchpy/docs/_build/html/objects.inv +0 -0
- quarchpy/docs/_build/html/py-modindex.html +3 -3
- quarchpy/docs/_build/html/readme.html +3 -3
- quarchpy/docs/_build/html/search.html +3 -3
- quarchpy/docs/_build/html/searchindex.js +1 -1
- quarchpy/docs/_build/html/source/changelog.html +265 -215
- quarchpy/docs/_build/html/source/licenses.html +3 -3
- quarchpy/docs/_build/html/source/modules.html +3 -3
- quarchpy/docs/_build/html/source/quarchpy.calibration.html +3 -3
- quarchpy/docs/_build/html/source/quarchpy.config_files.html +3 -3
- quarchpy/docs/_build/html/source/quarchpy.connection_specific.html +520 -186
- quarchpy/docs/_build/html/source/quarchpy.debug.html +3 -13
- quarchpy/docs/_build/html/source/quarchpy.device.html +3482 -614
- quarchpy/docs/_build/html/source/quarchpy.disk_test.html +8 -8
- quarchpy/docs/_build/html/source/quarchpy.fio.html +3 -3
- quarchpy/docs/_build/html/source/quarchpy.html +171 -69
- quarchpy/docs/_build/html/source/quarchpy.iometer.html +3 -3
- quarchpy/docs/_build/html/source/quarchpy.qis.html +515 -179
- quarchpy/docs/_build/html/source/quarchpy.qps.html +3 -3
- quarchpy/docs/_build/html/source/quarchpy.user_interface.html +4 -4
- quarchpy/docs/_build/html/source/quarchpy.utilities.html +20 -3
- quarchpy/docs/_build/html/source/readme.html +3 -3
- quarchpy/fio/__pycache__/FIO_interface.cpython-310.pyc +0 -0
- quarchpy/fio/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/install_qps.py +1 -1
- quarchpy/iometer/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/iometer/__pycache__/gen_iometer_template.cpython-310.pyc +0 -0
- quarchpy/iometer/__pycache__/iometerFuncs.cpython-310.pyc +0 -0
- quarchpy/qis/__pycache__/StreamHeaderInfo.cpython-310.pyc +0 -0
- quarchpy/qis/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/qis/__pycache__/qisFuncs.cpython-310.pyc +0 -0
- quarchpy/qis/qisFuncs.py +1 -1
- quarchpy/qps/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/qps/__pycache__/qpsFuncs.cpython-310.pyc +0 -0
- quarchpy/qps/qpsFuncs.py +8 -19
- quarchpy/user_interface/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/user_interface/__pycache__/user_interface.cpython-310.pyc +0 -0
- quarchpy/utilities/__pycache__/TestCenter.cpython-310.pyc +0 -0
- quarchpy/utilities/__pycache__/TimeValue.cpython-310.pyc +0 -0
- quarchpy/utilities/__pycache__/__init__.cpython-310.pyc +0 -0
- {quarchpy-2.2.13.dist-info → quarchpy-2.2.14.dist-info}/METADATA +5 -1
- {quarchpy-2.2.13.dist-info → quarchpy-2.2.14.dist-info}/RECORD +117 -117
- {quarchpy-2.2.13.dist-info → quarchpy-2.2.14.dist-info}/WHEEL +0 -0
- {quarchpy-2.2.13.dist-info → quarchpy-2.2.14.dist-info}/top_level.txt +0 -0
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
7
7
|
|
|
8
8
|
<title>quarchpy.qis package — quarchpy documentation</title>
|
|
9
|
-
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=
|
|
10
|
-
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=
|
|
9
|
+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
|
|
10
|
+
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
|
|
11
11
|
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
|
|
12
12
|
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
|
13
13
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
@@ -45,9 +45,6 @@
|
|
|
45
45
|
<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.GetQisModuleSelection">
|
|
46
46
|
<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">GetQisModuleSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">QisConnection</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.GetQisModuleSelection" title="Link to this definition">¶</a></dt>
|
|
47
47
|
<dd><p>Prints a list of modules for user selection</p>
|
|
48
|
-
<div class="deprecated">
|
|
49
|
-
<p><span class="versionmodified deprecated">Deprecated since version 2.0.12: </span>Use the module selection functions of the QisInterface class instead</p>
|
|
50
|
-
</div>
|
|
51
48
|
</dd></dl>
|
|
52
49
|
|
|
53
50
|
<dl class="py function">
|
|
@@ -131,302 +128,641 @@ an address can be specified for remote systems.</p>
|
|
|
131
128
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.qis" title="Link to this heading">¶</a></h2>
|
|
132
129
|
<dl class="py class">
|
|
133
130
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface">
|
|
134
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">QisInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'127.0.0.1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">9722</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connectionMessage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface" title="Link to this definition">¶</a></dt>
|
|
131
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">QisInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'127.0.0.1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">9722</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connectionMessage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface" title="Link to this definition">¶</a></dt>
|
|
135
132
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
136
133
|
<dl class="py method">
|
|
137
134
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.GetQisModuleSelection">
|
|
138
135
|
<span class="sig-name descname"><span class="pre">GetQisModuleSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['rescan',</span> <span class="pre">'all</span> <span class="pre">con</span> <span class="pre">types',</span> <span class="pre">'ip</span> <span class="pre">scan']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.GetQisModuleSelection" title="Link to this definition">¶</a></dt>
|
|
139
|
-
<dd><p>
|
|
140
|
-
<
|
|
136
|
+
<dd><p>deprecated:: 2.2.13
|
|
137
|
+
Use <cite>get_qis_module_selection</cite> instead.</p>
|
|
141
138
|
</dd></dl>
|
|
142
139
|
|
|
143
140
|
<dl class="py method">
|
|
144
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
145
|
-
<span class="sig-name descname"><span class="pre">
|
|
146
|
-
<dd
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.add_header_to_byte_array">
|
|
150
|
-
<span class="sig-name descname"><span class="pre">add_header_to_byte_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">return_b_array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_header_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">temp_dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tree</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_digital</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.add_header_to_byte_array" title="Link to this definition">¶</a></dt>
|
|
151
|
-
<dd></dd></dl>
|
|
152
|
-
|
|
153
|
-
<dl class="py method">
|
|
154
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.averageStripes">
|
|
155
|
-
<span class="sig-name descname"><span class="pre">averageStripes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">leftover</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamAverage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newStripes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remainingStripes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.averageStripes" title="Link to this definition">¶</a></dt>
|
|
156
|
-
<dd></dd></dl>
|
|
157
|
-
|
|
158
|
-
<dl class="py method">
|
|
159
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.avgStringFromPwr">
|
|
160
|
-
<span class="sig-name descname"><span class="pre">avgStringFromPwr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">avgPwrTwo</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.avgStringFromPwr" title="Link to this definition">¶</a></dt>
|
|
161
|
-
<dd></dd></dl>
|
|
141
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.closeConnection">
|
|
142
|
+
<span class="sig-name descname"><span class="pre">closeConnection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">conString</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.closeConnection" title="Link to this definition">¶</a></dt>
|
|
143
|
+
<dd><p>deprecated:: 2.2.13
|
|
144
|
+
Use <cite>close_connection</cite> instead.</p>
|
|
145
|
+
</dd></dl>
|
|
162
146
|
|
|
163
147
|
<dl class="py method">
|
|
164
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
165
|
-
<span class="sig-name descname"><span class="pre">
|
|
166
|
-
<dd
|
|
148
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.close_connection">
|
|
149
|
+
<span class="sig-name descname"><span class="pre">close_connection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con_string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.close_connection" title="Link to this definition">¶</a></dt>
|
|
150
|
+
<dd><p>Orders QIS to release a given device (or all devices if no connection string is specified)
|
|
151
|
+
This is more important for TCP connected devices as the socket is held open until
|
|
152
|
+
specifically released.</p>
|
|
153
|
+
<dl class="field-list simple">
|
|
154
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
155
|
+
<dd class="field-odd"><ul class="simple">
|
|
156
|
+
<li><p><strong>sock</strong> – The socket object to close the connection to. Defaults to the existing socket.</p></li>
|
|
157
|
+
<li><p><strong>con_string</strong> – Specify the device ID to close, otherwise all devices will be closed</p></li>
|
|
158
|
+
</ul>
|
|
159
|
+
</dd>
|
|
160
|
+
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
161
|
+
<dd class="field-even"><p><strong>ConnectionResetError</strong> – Raised if the socket connection has already been reset.</p>
|
|
162
|
+
</dd>
|
|
163
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
164
|
+
<dd class="field-odd"><p>‘OK’</p>
|
|
165
|
+
</dd>
|
|
166
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
167
|
+
<dd class="field-even"><p>The response received after sending the close command. On success, this will be</p>
|
|
168
|
+
</dd>
|
|
169
|
+
</dl>
|
|
170
|
+
</dd></dl>
|
|
167
171
|
|
|
168
172
|
<dl class="py method">
|
|
169
173
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.connect">
|
|
170
|
-
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">
|
|
171
|
-
<dd><p>
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
174
|
+
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.connect" title="Link to this definition">¶</a></dt>
|
|
175
|
+
<dd><p>Opens the connection to the QIS backend</p>
|
|
176
|
+
<dl class="field-list simple">
|
|
177
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
178
|
+
<dd class="field-odd"><p><strong>connection_message</strong> – Defaults to True. If set to False, suppresses the warning message about an
|
|
179
|
+
instance already running on the specified port. This can be useful when
|
|
180
|
+
using <cite>isQisRunning()</cite> from <cite>qisFuncs</cite>.</p>
|
|
181
|
+
</dd>
|
|
182
|
+
</dl>
|
|
183
|
+
<p>Raises:
|
|
184
|
+
Exception:</p>
|
|
177
185
|
<blockquote>
|
|
178
|
-
<div><p>
|
|
186
|
+
<div><p>If the connection fails or the welcome string is not received an exception is raised</p>
|
|
179
187
|
</div></blockquote>
|
|
188
|
+
<dl class="field-list simple">
|
|
189
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
190
|
+
<dd class="field-odd"><p>The welcome string received from the backend server upon a successful
|
|
191
|
+
connection. This will confirm the QIS version but is generally not used other than
|
|
192
|
+
for debugging</p>
|
|
193
|
+
</dd>
|
|
194
|
+
</dl>
|
|
180
195
|
</dd></dl>
|
|
181
196
|
|
|
182
197
|
<dl class="py method">
|
|
183
198
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.convertStreamAverage">
|
|
184
199
|
<span class="sig-name descname"><span class="pre">convertStreamAverage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">streamAveraging</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.convertStreamAverage" title="Link to this definition">¶</a></dt>
|
|
185
|
-
<dd
|
|
200
|
+
<dd><p>deprecated:: 2.2.13
|
|
201
|
+
No indication this is used anywhere</p>
|
|
202
|
+
</dd></dl>
|
|
186
203
|
|
|
187
204
|
<dl class="py method">
|
|
188
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
189
|
-
<span class="sig-name descname"><span class="pre">
|
|
190
|
-
<dd><p>
|
|
191
|
-
|
|
192
|
-
|
|
205
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.device_control_index">
|
|
206
|
+
<span class="sig-name descname"><span class="pre">device_control_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</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">int</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.device_control_index" title="Link to this definition">¶</a></dt>
|
|
207
|
+
<dd><p>Returns the index of the device in the control lists. If the device is not
|
|
208
|
+
registered, then it is added first. This is a key part of allowing us to
|
|
209
|
+
track the status of multiple streaming devices and manage them from outside
|
|
210
|
+
their streaming thread</p>
|
|
193
211
|
<dl class="field-list simple">
|
|
194
|
-
<dt class="field-odd">
|
|
195
|
-
<dd class="field-odd"><p>
|
|
196
|
-
</dd>
|
|
197
|
-
<dt class="field-even">Param<span class="colon">:</span></dt>
|
|
198
|
-
<dd class="field-even"><p>directory: String - Name of directory for QPS stream (defaults to default recording location if invalid)</p>
|
|
212
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
213
|
+
<dd class="field-odd"><p><strong>device</strong> – Device ID string</p>
|
|
199
214
|
</dd>
|
|
200
|
-
<dt class="field-
|
|
201
|
-
<dd class="field-
|
|
215
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
216
|
+
<dd class="field-even"><p>Index of the device in the various control lists</p>
|
|
202
217
|
</dd>
|
|
203
218
|
</dl>
|
|
204
219
|
</dd></dl>
|
|
205
220
|
|
|
206
221
|
<dl class="py method">
|
|
207
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
208
|
-
<span class="sig-name descname"><span class="pre">
|
|
209
|
-
<dd><p>
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
<
|
|
222
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.device_dict_setup">
|
|
223
|
+
<span class="sig-name descname"><span class="pre">device_dict_setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</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="headerlink" href="#quarchpy.qis.QisInterface.device_dict_setup" title="Link to this definition">¶</a></dt>
|
|
224
|
+
<dd><p>Adds a dictionary entry for a new module we are connecting to (including the base QIS connection)
|
|
225
|
+
This is used for tracking the status of modules throughout the streaming process</p>
|
|
226
|
+
<dl class="field-list simple">
|
|
227
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
228
|
+
<dd class="field-odd"><p><strong>module</strong></p>
|
|
229
|
+
</dd>
|
|
230
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
231
|
+
<dd class="field-even"><p>None</p>
|
|
232
|
+
</dd>
|
|
233
|
+
</dl>
|
|
213
234
|
</dd></dl>
|
|
214
235
|
|
|
215
236
|
<dl class="py method">
|
|
216
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
217
|
-
<span class="sig-name descname"><span class="pre">
|
|
218
|
-
<dd><p>
|
|
219
|
-
<p>
|
|
220
|
-
|
|
221
|
-
|
|
237
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.disconnect">
|
|
238
|
+
<span class="sig-name descname"><span class="pre">disconnect</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.disconnect" title="Link to this definition">¶</a></dt>
|
|
239
|
+
<dd><p>Disconnects the current connection to the QIS backend.</p>
|
|
240
|
+
<p>This method attempts to gracefully disconnect from the backend server and updates
|
|
241
|
+
the connection state in the device dictionary. If an error occurs during the
|
|
242
|
+
disconnection process, the state is updated to indicate the failure, and the
|
|
243
|
+
exception is re-raised</p>
|
|
244
|
+
<dl class="field-list simple">
|
|
245
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
246
|
+
<dd class="field-odd"><p>A message indicating that the disconnection process has started.</p>
|
|
247
|
+
</dd>
|
|
248
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
249
|
+
<dd class="field-even"><p>str</p>
|
|
250
|
+
</dd>
|
|
251
|
+
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
|
252
|
+
<dd class="field-odd"><p><strong>Exception</strong> – Propagates any exception that occurs during the disconnection process.</p>
|
|
253
|
+
</dd>
|
|
254
|
+
</dl>
|
|
222
255
|
</dd></dl>
|
|
223
256
|
|
|
224
257
|
<dl class="py method">
|
|
225
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
226
|
-
<span class="sig-name descname"><span class="pre">
|
|
227
|
-
<dd
|
|
258
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.getDeviceList">
|
|
259
|
+
<span class="sig-name descname"><span class="pre">getDeviceList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.getDeviceList" title="Link to this definition">¶</a></dt>
|
|
260
|
+
<dd><p>deprecated:: 2.2.13
|
|
261
|
+
Use <cite>start_stream_thread_qps</cite> instead.</p>
|
|
262
|
+
</dd></dl>
|
|
228
263
|
|
|
229
264
|
<dl class="py method">
|
|
230
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
231
|
-
<span class="sig-name descname"><span class="pre">
|
|
232
|
-
<dd><p>
|
|
265
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_device_list">
|
|
266
|
+
<span class="sig-name descname"><span class="pre">get_device_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">filter</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.get_device_list" title="Link to this definition">¶</a></dt>
|
|
267
|
+
<dd><p>returns a list of device IDs that are available for connection</p>
|
|
233
268
|
<dl class="field-list simple">
|
|
234
269
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
235
|
-
<dd class="field-odd"><p><strong>
|
|
270
|
+
<dd class="field-odd"><p><strong>sock</strong> – Optional connection socket</p>
|
|
236
271
|
</dd>
|
|
237
272
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
238
|
-
<dd class="field-even"><p
|
|
273
|
+
<dd class="field-even"><p>A filtered iterable list of devices</p>
|
|
239
274
|
</dd>
|
|
240
275
|
</dl>
|
|
241
276
|
</dd></dl>
|
|
242
277
|
|
|
243
278
|
<dl class="py method">
|
|
244
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
245
|
-
<span class="sig-name descname"><span class="pre">
|
|
246
|
-
<dd
|
|
247
|
-
|
|
248
|
-
<dl class="
|
|
249
|
-
<dt class="
|
|
250
|
-
<
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
<
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
<dl class="py method">
|
|
259
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.getDeviceList">
|
|
260
|
-
<span class="sig-name descname"><span class="pre">getDeviceList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.getDeviceList" title="Link to this definition">¶</a></dt>
|
|
261
|
-
<dd></dd></dl>
|
|
279
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_list_details">
|
|
280
|
+
<span class="sig-name descname"><span class="pre">get_list_details</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">list</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.get_list_details" title="Link to this definition">¶</a></dt>
|
|
281
|
+
<dd><p>Extended version of get_device_list which also returns the additional details
|
|
282
|
+
fields for each module</p>
|
|
283
|
+
<dl class="field-list simple">
|
|
284
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
285
|
+
<dd class="field-odd"><p><strong>sock</strong> – Optional connection socket</p>
|
|
286
|
+
</dd>
|
|
287
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
288
|
+
<dd class="field-even"><p>Iterable list of strings containing the details of each device available for connection.</p>
|
|
289
|
+
</dd>
|
|
290
|
+
</dl>
|
|
291
|
+
</dd></dl>
|
|
262
292
|
|
|
263
293
|
<dl class="py method">
|
|
264
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
265
|
-
<span class="sig-name descname"><span class="pre">
|
|
266
|
-
<dd
|
|
294
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_qis_module_selection">
|
|
295
|
+
<span class="sig-name descname"><span class="pre">get_qis_module_selection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">preferred_connection_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'DEF_ARGS'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.get_qis_module_selection" title="Link to this definition">¶</a></dt>
|
|
296
|
+
<dd><p>Scans for available modules and allows the user to select one through an interactive selection process.
|
|
297
|
+
Can also handle additional custom options and some built-in ones such as rescanning</p>
|
|
298
|
+
<dl class="field-list simple">
|
|
299
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
300
|
+
<dd class="field-odd"><ul class="simple">
|
|
301
|
+
<li><p><strong>preferred_connection_only</strong> – bool
|
|
302
|
+
by default (True), returns only one preferred connection eg: USB for simplicity</p></li>
|
|
303
|
+
<li><p><strong>additional_options</strong> – list
|
|
304
|
+
Additional operational options provided during module selection, such as rescan,
|
|
305
|
+
all connection types, and IP scan. Defaults to [‘rescan’, ‘all con types’, ‘ip scan’]. These allow the
|
|
306
|
+
additional options to be given to the user and handled in the top level script</p></li>
|
|
307
|
+
<li><p><strong>scan</strong> – bool
|
|
308
|
+
Indicates whether to initiate a rescanning process for devices before listing. Defaults to True and
|
|
309
|
+
will take longer to return</p></li>
|
|
310
|
+
</ul>
|
|
311
|
+
</dd>
|
|
312
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
313
|
+
<dd class="field-even"><p>The identifier of the selected module, or the action selected from the additional options.</p>
|
|
314
|
+
</dd>
|
|
315
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
316
|
+
<dd class="field-odd"><p>str</p>
|
|
317
|
+
</dd>
|
|
318
|
+
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
319
|
+
<dd class="field-even"><ul class="simple">
|
|
320
|
+
<li><p><strong>KeyError</strong> – Raised when unexpected keys are found in the scanned device data.</p></li>
|
|
321
|
+
<li><p><strong>ValueError</strong> – Raised if no valid selection is made or the provided IP address is invalid.</p></li>
|
|
322
|
+
</ul>
|
|
323
|
+
</dd>
|
|
324
|
+
</dl>
|
|
325
|
+
</dd></dl>
|
|
267
326
|
|
|
268
327
|
<dl class="py method">
|
|
269
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
270
|
-
<span class="sig-name descname"><span class="pre">
|
|
271
|
-
<dd
|
|
328
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_stream_xml_header">
|
|
329
|
+
<span class="sig-name descname"><span class="pre">get_stream_xml_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">Element</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.get_stream_xml_header" title="Link to this definition">¶</a></dt>
|
|
330
|
+
<dd><p>Gets the XML format header from an attached device (which must have run or be running a stream)
|
|
331
|
+
Parses the string into XML and returns the root element</p>
|
|
332
|
+
<dl class="field-list simple">
|
|
333
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
334
|
+
<dd class="field-odd"><ul class="simple">
|
|
335
|
+
<li><p><strong>device</strong> – Device ID to return from</p></li>
|
|
336
|
+
<li><p><strong>sock</strong> – Optional QIS socket to use for communication.</p></li>
|
|
337
|
+
</ul>
|
|
338
|
+
</dd>
|
|
339
|
+
</dl>
|
|
340
|
+
<p>Returns:</p>
|
|
341
|
+
</dd></dl>
|
|
272
342
|
|
|
273
343
|
<dl class="py method">
|
|
274
344
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.interruptList">
|
|
275
345
|
<span class="sig-name descname"><span class="pre">interruptList</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.interruptList" title="Link to this definition">¶</a></dt>
|
|
276
|
-
<dd
|
|
346
|
+
<dd><p>deprecated:: 2.2.13
|
|
347
|
+
No indication this is used anywhere</p>
|
|
348
|
+
</dd></dl>
|
|
277
349
|
|
|
278
350
|
<dl class="py method">
|
|
279
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
280
|
-
<span class="sig-name descname"><span class="pre">
|
|
281
|
-
<dd
|
|
351
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.is_xml_header">
|
|
352
|
+
<span class="sig-name descname"><span class="pre">is_xml_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header_text</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">bool</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.is_xml_header" title="Link to this definition">¶</a></dt>
|
|
353
|
+
<dd><p>Checks if the given header string is in XML format (as apposed to legacy text format) or an invalid string</p>
|
|
354
|
+
<dl class="field-list simple">
|
|
355
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
356
|
+
<dd class="field-odd"><p><strong>header_text</strong> – The header string to evaluate</p>
|
|
357
|
+
</dd>
|
|
358
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
359
|
+
<dd class="field-even"><p>True if the header is in XML form</p>
|
|
360
|
+
</dd>
|
|
361
|
+
</dl>
|
|
362
|
+
</dd></dl>
|
|
282
363
|
|
|
283
364
|
<dl class="py method">
|
|
284
365
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.qis_scan_devices">
|
|
285
|
-
<span class="sig-name descname"><span class="pre">qis_scan_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">
|
|
286
|
-
<dd
|
|
366
|
+
<span class="sig-name descname"><span class="pre">qis_scan_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preferred_connection_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">list</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.qis_scan_devices" title="Link to this definition">¶</a></dt>
|
|
367
|
+
<dd><p>Begins a scan for devices and returns a simple list of devices</p>
|
|
368
|
+
<dl class="field-list simple">
|
|
369
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
370
|
+
<dd class="field-odd"><ul class="simple">
|
|
371
|
+
<li><p><strong>scan</strong> – Should a scan be initiated? If False, the function will return immediately with the list</p></li>
|
|
372
|
+
<li><p><strong>preferred_connection_only</strong> – The default (True), returns only one preferred connection eg: USB for simplicity</p></li>
|
|
373
|
+
<li><p><strong>ip_address</strong> – IP address of the module you are looking for eg ‘192.168.123.123’</p></li>
|
|
374
|
+
</ul>
|
|
375
|
+
</dd>
|
|
376
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
377
|
+
<dd class="field-even"><p>List of module strings found during scan</p>
|
|
378
|
+
</dd>
|
|
379
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
380
|
+
<dd class="field-odd"><p>list</p>
|
|
381
|
+
</dd>
|
|
382
|
+
</dl>
|
|
383
|
+
</dd></dl>
|
|
287
384
|
|
|
288
385
|
<dl class="py method">
|
|
289
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
290
|
-
<span class="sig-name descname"><span class="pre">
|
|
291
|
-
<dd
|
|
386
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.receive_text">
|
|
387
|
+
<span class="sig-name descname"><span class="pre">receive_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.receive_text" title="Link to this definition">¶</a></dt>
|
|
388
|
+
<dd><p>Received bytes from the socket and converts to a test string
|
|
389
|
+
:param sock: Socket to communicate over</p>
|
|
390
|
+
<p>Returns:</p>
|
|
391
|
+
</dd></dl>
|
|
292
392
|
|
|
293
393
|
<dl class="py method">
|
|
294
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
295
|
-
<span class="sig-name descname"><span class="pre">
|
|
296
|
-
<dd
|
|
394
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.rx_bytes">
|
|
395
|
+
<span class="sig-name descname"><span class="pre">rx_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</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">bytes</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.rx_bytes" title="Link to this definition">¶</a></dt>
|
|
396
|
+
<dd><p>Reads an array of bytes from the socket as part of handling a command response</p>
|
|
397
|
+
<dl class="field-list simple">
|
|
398
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
399
|
+
<dd class="field-odd"><p><strong>sock</strong> – Socket to communicate over</p>
|
|
400
|
+
</dd>
|
|
401
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
402
|
+
<dd class="field-even"><p>Bytes read</p>
|
|
403
|
+
</dd>
|
|
404
|
+
</dl>
|
|
405
|
+
</dd></dl>
|
|
297
406
|
|
|
298
407
|
<dl class="py method">
|
|
299
408
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.scanIP">
|
|
300
|
-
<span class="sig-name descname"><span class="pre">scanIP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ipAddress</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.scanIP" title="Link to this definition">¶</a></dt>
|
|
301
|
-
<dd><p>
|
|
302
|
-
<
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
<
|
|
306
|
-
<
|
|
307
|
-
<
|
|
308
|
-
</
|
|
409
|
+
<span class="sig-name descname"><span class="pre">scanIP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">QisConnection</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipAddress</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.scanIP" title="Link to this definition">¶</a></dt>
|
|
410
|
+
<dd><p>deprecated:: 2.2.13
|
|
411
|
+
Use <cite>scan_ip</cite> instead.</p>
|
|
412
|
+
</dd></dl>
|
|
413
|
+
|
|
414
|
+
<dl class="py method">
|
|
415
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.scan_ip">
|
|
416
|
+
<span class="sig-name descname"><span class="pre">scan_ip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qis_connection</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_address</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">bool</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.scan_ip" title="Link to this definition">¶</a></dt>
|
|
417
|
+
<dd><p>Triggers QIS to look at a specific IP address for a module</p>
|
|
418
|
+
<p>Arguments</p>
|
|
419
|
+
<dl class="simple">
|
|
420
|
+
<dt>QisConnection<span class="classifier">QpsInterface</span></dt><dd><p>The interface to the instance of QIS you would like to use for the scan.</p>
|
|
421
|
+
</dd>
|
|
422
|
+
<dt>ipAddress<span class="classifier">str</span></dt><dd><p>The IP address of the module you are looking for eg ‘192.168.123.123’</p>
|
|
309
423
|
</dd>
|
|
310
424
|
</dl>
|
|
311
425
|
</dd></dl>
|
|
312
426
|
|
|
313
427
|
<dl class="py method">
|
|
314
428
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendAndReceiveCmd">
|
|
315
|
-
<span class="sig-name descname"><span class="pre">sendAndReceiveCmd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betweenCommandDelay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendAndReceiveCmd" title="Link to this definition">¶</a></dt>
|
|
316
|
-
<dd
|
|
429
|
+
<span class="sig-name descname"><span class="pre">sendAndReceiveCmd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betweenCommandDelay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendAndReceiveCmd" title="Link to this definition">¶</a></dt>
|
|
430
|
+
<dd><p>deprecated:: 2.2.13
|
|
431
|
+
Use <cite>send_command</cite> instead.</p>
|
|
432
|
+
</dd></dl>
|
|
317
433
|
|
|
318
434
|
<dl class="py method">
|
|
319
435
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendAndReceiveText">
|
|
320
|
-
<span class="sig-name descname"><span class="pre">sendAndReceiveText</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">
|
|
321
|
-
<dd
|
|
436
|
+
<span class="sig-name descname"><span class="pre">sendAndReceiveText</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sendText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendAndReceiveText" title="Link to this definition">¶</a></dt>
|
|
437
|
+
<dd><p>deprecated:: 2.2.13
|
|
438
|
+
Use <cite>send_and_receive_text</cite> instead.</p>
|
|
439
|
+
</dd></dl>
|
|
322
440
|
|
|
323
441
|
<dl class="py method">
|
|
324
442
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendCmd">
|
|
325
|
-
<span class="sig-name descname"><span class="pre">sendCmd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betweenCommandDelay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendCmd" title="Link to this definition">¶</a></dt>
|
|
326
|
-
<dd><p>
|
|
443
|
+
<span class="sig-name descname"><span class="pre">sendCmd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betweenCommandDelay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendCmd" title="Link to this definition">¶</a></dt>
|
|
444
|
+
<dd><p>deprecated:: 2.2.13
|
|
445
|
+
Use <cite>send_command</cite> instead.</p>
|
|
327
446
|
</dd></dl>
|
|
328
447
|
|
|
329
448
|
<dl class="py method">
|
|
330
449
|
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendCommand">
|
|
331
|
-
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betweenCommandDelay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendCommand" title="Link to this definition">¶</a></dt>
|
|
332
|
-
<dd><p>
|
|
450
|
+
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readUntilCursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betweenCommandDelay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.sendCommand" title="Link to this definition">¶</a></dt>
|
|
451
|
+
<dd><p>deprecated:: 2.2.13
|
|
452
|
+
Use <cite>send_command</cite> instead.</p>
|
|
333
453
|
</dd></dl>
|
|
334
454
|
|
|
335
455
|
<dl class="py method">
|
|
336
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
337
|
-
<span class="sig-name descname"><span class="pre">
|
|
338
|
-
<dd
|
|
456
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.send_and_receive_text">
|
|
457
|
+
<span class="sig-name descname"><span class="pre">send_and_receive_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">read_until_cursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.send_and_receive_text" title="Link to this definition">¶</a></dt>
|
|
458
|
+
<dd><p>Internal function for command handling. This handles complex cases such as timeouts and XML
|
|
459
|
+
response formatting, which conflicts with the default cursor</p>
|
|
460
|
+
<dl class="field-list simple">
|
|
461
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
462
|
+
<dd class="field-odd"><ul class="simple">
|
|
463
|
+
<li><p><strong>sock</strong> – The socket to communicate over</p></li>
|
|
464
|
+
<li><p><strong>send_text</strong> – The command text to send</p></li>
|
|
465
|
+
<li><p><strong>device</strong> – Optional device ID to send the command to</p></li>
|
|
466
|
+
<li><p><strong>read_until_cursor</strong> – Flag to indicate if we should read until the cursor is returned</p></li>
|
|
467
|
+
</ul>
|
|
468
|
+
</dd>
|
|
469
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
470
|
+
<dd class="field-even"><p>Response string from the module</p>
|
|
471
|
+
</dd>
|
|
472
|
+
</dl>
|
|
473
|
+
</dd></dl>
|
|
339
474
|
|
|
340
475
|
<dl class="py method">
|
|
341
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
342
|
-
<span class="sig-name descname"><span class="pre">
|
|
343
|
-
<dd
|
|
476
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.send_command">
|
|
477
|
+
<span class="sig-name descname"><span class="pre">send_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qis_socket</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">socket</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_cursor_expected</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_response_expected</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command_delay</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.0</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.send_command" title="Link to this definition">¶</a></dt>
|
|
478
|
+
<dd><p>Sends a command and returns the response as a string. Multiple lines are escaped with CRLF.
|
|
479
|
+
The command is sent to the QIS socket, and depending on the command will be replied by either QIS
|
|
480
|
+
or the hardware module.</p>
|
|
481
|
+
<dl class="field-list simple">
|
|
482
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
483
|
+
<dd class="field-odd"><ul class="simple">
|
|
484
|
+
<li><p><strong>command</strong> – Command string</p></li>
|
|
485
|
+
<li><p><strong>device</strong> – Optional Device ID string to send the command to. Use default/blank for QIS direct commands</p></li>
|
|
486
|
+
<li><p><strong>qis_socket</strong> – Optional Socket to use for the command, if the default is not wanted</p></li>
|
|
487
|
+
<li><p><strong>no_cursor_expected</strong> – Optional Flag true if the command does not return a cursor, so we should not wait for it</p></li>
|
|
488
|
+
<li><p><strong>no_response_expected</strong> – Optional Flag true if the command does not return a response, so we should not wait for it.</p></li>
|
|
489
|
+
<li><p><strong>command_delay</strong> – Optional delay to prevent commands running in close succession. Timed in seconds.</p></li>
|
|
490
|
+
</ul>
|
|
491
|
+
</dd>
|
|
492
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
493
|
+
<dd class="field-even"><p>Command response string or None if no response expected</p>
|
|
494
|
+
</dd>
|
|
495
|
+
</dl>
|
|
496
|
+
</dd></dl>
|
|
344
497
|
|
|
345
498
|
<dl class="py method">
|
|
346
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
347
|
-
<span class="sig-name descname"><span class="pre">
|
|
348
|
-
<dd
|
|
499
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.send_text">
|
|
500
|
+
<span class="sig-name descname"><span class="pre">send_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'$help'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</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">bool</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.send_text" title="Link to this definition">¶</a></dt>
|
|
501
|
+
<dd><dl class="field-list simple">
|
|
502
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
503
|
+
<dd class="field-odd"><ul class="simple">
|
|
504
|
+
<li><p><strong>sock</strong> – Socket to communicate over</p></li>
|
|
505
|
+
<li><p><strong>message</strong> – text command to send</p></li>
|
|
506
|
+
<li><p><strong>device</strong> – Optional device ID to target with the command</p></li>
|
|
507
|
+
</ul>
|
|
508
|
+
</dd>
|
|
509
|
+
</dl>
|
|
510
|
+
<p>Returns:</p>
|
|
511
|
+
</dd></dl>
|
|
349
512
|
|
|
350
513
|
<dl class="py method">
|
|
351
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
352
|
-
<span class="sig-name descname"><span class="pre">
|
|
353
|
-
<dd
|
|
514
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sort_favourite">
|
|
515
|
+
<span class="sig-name descname"><span class="pre">sort_favourite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">found_devices</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">list</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.sort_favourite" title="Link to this definition">¶</a></dt>
|
|
516
|
+
<dd><p>Reduces the list of located devices by referencing to the preferred type of connection. Only
|
|
517
|
+
one connection type will be returned for each module for easier user selection. ie: A module connected
|
|
518
|
+
on both USB and TCP will now only return with USB</p>
|
|
519
|
+
<dl class="field-list simple">
|
|
520
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
521
|
+
<dd class="field-odd"><p><strong>found_devices</strong> – List of located devices from a scan operation</p>
|
|
522
|
+
</dd>
|
|
523
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
524
|
+
<dd class="field-even"><p>List of devices filtered/sorted devices</p>
|
|
525
|
+
</dd>
|
|
526
|
+
</dl>
|
|
527
|
+
</dd></dl>
|
|
354
528
|
|
|
355
529
|
<dl class="py method">
|
|
356
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
357
|
-
<span class="sig-name descname"><span class="pre">
|
|
358
|
-
<dd
|
|
530
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.startStream">
|
|
531
|
+
<span class="sig-name descname"><span class="pre">startStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamDuration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inMemoryData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputFileHandle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.startStream" title="Link to this definition">¶</a></dt>
|
|
532
|
+
<dd><p>deprecated:: 2.2.13
|
|
533
|
+
Use <cite>start_stream</cite> instead.</p>
|
|
534
|
+
</dd></dl>
|
|
359
535
|
|
|
360
536
|
<dl class="py method">
|
|
361
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
362
|
-
<span class="sig-name descname"><span class="pre">
|
|
363
|
-
<dd
|
|
537
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.start_stream">
|
|
538
|
+
<span class="sig-name descname"><span class="pre">start_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream" title="Link to this definition">¶</a></dt>
|
|
539
|
+
<dd><p>Begins a stream process which will record data from the module to a CSV file or in memory CSV equivalent</p>
|
|
540
|
+
<dl class="field-list simple">
|
|
541
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
542
|
+
<dd class="field-odd"><ul class="simple">
|
|
543
|
+
<li><p><strong>module</strong> – The ID of the module for which the stream is being initiated.</p></li>
|
|
544
|
+
<li><p><strong>file_name</strong> – The target file path+name for storing the streamed data in CSV form.</p></li>
|
|
545
|
+
<li><p><strong>max_file_size</strong> – The maximum size in megabytes allowed for the output file.</p></li>
|
|
546
|
+
<li><p><strong>release_on_data</strong> – If set, blocks further streams until this one has started</p></li>
|
|
547
|
+
<li><p><strong>separator</strong> – The value separator used to format the streamed CSV data.</p></li>
|
|
548
|
+
<li><p><strong>stream_duration</strong> – The duration (in seconds) for which the streaming process should run. Unlimited if None.</p></li>
|
|
549
|
+
<li><p><strong>in_memory_data</strong> – An in memory CSV StringIO as an alternate to file output</p></li>
|
|
550
|
+
<li><p><strong>output_file_handle</strong> – A file handle to an output file where the stream data is written as an alternate to a file name</p></li>
|
|
551
|
+
<li><p><strong>use_gzip</strong> – A flag indicating whether the output file should be compressed using gzip to reduce disk use</p></li>
|
|
552
|
+
</ul>
|
|
553
|
+
</dd>
|
|
554
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
555
|
+
<dd class="field-even"><p>None</p>
|
|
556
|
+
</dd>
|
|
557
|
+
</dl>
|
|
558
|
+
</dd></dl>
|
|
364
559
|
|
|
365
560
|
<dl class="py method">
|
|
366
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
367
|
-
<span class="sig-name descname"><span class="pre">
|
|
368
|
-
<dd
|
|
561
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.start_stream_thread">
|
|
562
|
+
<span class="sig-name descname"><span class="pre">start_stream_thread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream_thread" title="Link to this definition">¶</a></dt>
|
|
563
|
+
<dd><dl class="field-list simple">
|
|
564
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
565
|
+
<dd class="field-odd"><ul class="simple">
|
|
566
|
+
<li><p><strong>module</strong> – The name of the module from which data is to be streamed.</p></li>
|
|
567
|
+
<li><p><strong>file_name</strong> – The path to the file where streamed data will be written. Mandatory if neither an in-memory
|
|
568
|
+
buffer (in_memory_data) nor an external file handle (output_file_handle) is provided.</p></li>
|
|
569
|
+
<li><p><strong>max_file_size</strong> – The maximum permissible file size in MB. After reaching this limit, streaming to the current
|
|
570
|
+
file will stop</p></li>
|
|
571
|
+
<li><p><strong>release_on_data</strong> – True to prevent the stream lock from releasing until data has been received</p></li>
|
|
572
|
+
<li><p><strong>separator</strong> – Custom separator used to CSV data</p></li>
|
|
573
|
+
<li><p><strong>stream_duration</strong> – Duration of streaming in seconds, relative to the sampling period. Defaults to streaming
|
|
574
|
+
indefinitely.</p></li>
|
|
575
|
+
<li><p><strong>in_memory_data</strong> – An in-memory buffer of type StringIO to hold streamed data. If set, data is written here
|
|
576
|
+
instead of a file.</p></li>
|
|
577
|
+
<li><p><strong>output_file_handle</strong> – A pre-opened file handle where data will be written. If set, file_name is ignored.</p></li>
|
|
578
|
+
<li><p><strong>use_gzip</strong> – If True, writes streamed data to a gzip-compressed file.</p></li>
|
|
579
|
+
</ul>
|
|
580
|
+
</dd>
|
|
581
|
+
</dl>
|
|
582
|
+
<p>Raises:
|
|
583
|
+
TypeError</p>
|
|
584
|
+
<blockquote>
|
|
585
|
+
<div><p>If in_memory_data is passed but is not of type StringIO.</p>
|
|
586
|
+
</div></blockquote>
|
|
587
|
+
<dl class="simple">
|
|
588
|
+
<dt>ValueError</dt><dd><p>If file_name is not provided and neither in_memory_data nor output_file_handle is given.
|
|
589
|
+
Also raised for invalid or undecodable sampling periods.</p>
|
|
590
|
+
</dd>
|
|
591
|
+
</dl>
|
|
592
|
+
<dl class="field-list simple">
|
|
593
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
594
|
+
<dd class="field-odd"><p>None</p>
|
|
595
|
+
</dd>
|
|
596
|
+
</dl>
|
|
597
|
+
</dd></dl>
|
|
369
598
|
|
|
370
599
|
<dl class="py method">
|
|
371
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
372
|
-
<span class="sig-name descname"><span class="pre">
|
|
373
|
-
<dd
|
|
600
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stopStream">
|
|
601
|
+
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blocking</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.stopStream" title="Link to this definition">¶</a></dt>
|
|
602
|
+
<dd><p>deprecated:: 2.2.13
|
|
603
|
+
Use <cite>stop_stream</cite> instead.</p>
|
|
604
|
+
</dd></dl>
|
|
374
605
|
|
|
375
606
|
<dl class="py method">
|
|
376
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
377
|
-
<span class="sig-name descname"><span class="pre">
|
|
378
|
-
<dd
|
|
607
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stop_stream">
|
|
608
|
+
<span class="sig-name descname"><span class="pre">stop_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blocking</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.stop_stream" title="Link to this definition">¶</a></dt>
|
|
609
|
+
<dd><dl class="field-list simple">
|
|
610
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
611
|
+
<dd class="field-odd"><ul class="simple">
|
|
612
|
+
<li><p><strong>module</strong> – The quarchPPM module instance for which the streaming process is to be stopped.</p></li>
|
|
613
|
+
<li><p><strong>blocking</strong> – If set to True, the function will block and wait until the module has
|
|
614
|
+
completely stopped streaming. Defaults to True.</p></li>
|
|
615
|
+
</ul>
|
|
616
|
+
</dd>
|
|
617
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
618
|
+
<dd class="field-even"><p>None</p>
|
|
619
|
+
</dd>
|
|
620
|
+
</dl>
|
|
621
|
+
</dd></dl>
|
|
379
622
|
|
|
380
623
|
<dl class="py method">
|
|
381
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
382
|
-
<span class="sig-name descname"><span class="pre">
|
|
383
|
-
<dd
|
|
624
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamHeaderFormat">
|
|
625
|
+
<span class="sig-name descname"><span class="pre">streamHeaderFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.streamHeaderFormat" title="Link to this definition">¶</a></dt>
|
|
626
|
+
<dd><p>deprecated:: 2.2.13
|
|
627
|
+
Use <cite>stream_header_format</cite> instead.</p>
|
|
628
|
+
</dd></dl>
|
|
384
629
|
|
|
385
630
|
<dl class="py method">
|
|
386
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
387
|
-
<span class="sig-name descname"><span class="pre">
|
|
388
|
-
<dd
|
|
631
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamInterrupt">
|
|
632
|
+
<span class="sig-name descname"><span class="pre">streamInterrupt</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">bool</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.streamInterrupt" title="Link to this definition">¶</a></dt>
|
|
633
|
+
<dd><p>deprecated:: 2.2.13
|
|
634
|
+
No indication this is used anywhere</p>
|
|
635
|
+
</dd></dl>
|
|
389
636
|
|
|
390
637
|
<dl class="py method">
|
|
391
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
392
|
-
<span class="sig-name descname"><span class="pre">
|
|
393
|
-
<dd
|
|
638
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamRunningStatus">
|
|
639
|
+
<span class="sig-name descname"><span class="pre">streamRunningStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.streamRunningStatus" title="Link to this definition">¶</a></dt>
|
|
640
|
+
<dd><p>deprecated:: 2.2.13
|
|
641
|
+
Use <cite>stream_running_status</cite> instead.</p>
|
|
642
|
+
</dd></dl>
|
|
394
643
|
|
|
395
644
|
<dl class="py method">
|
|
396
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
397
|
-
<span class="sig-name descname"><span class="pre">
|
|
398
|
-
<dd
|
|
645
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_buffer_status">
|
|
646
|
+
<span class="sig-name descname"><span class="pre">stream_buffer_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.stream_buffer_status" title="Link to this definition">¶</a></dt>
|
|
647
|
+
<dd><p>returns the info on the stripes buffered during the stream</p>
|
|
648
|
+
<p>Arguments</p>
|
|
649
|
+
<dl class="simple">
|
|
650
|
+
<dt>device<span class="classifier">str</span></dt><dd><p>The device ID to target</p>
|
|
651
|
+
</dd>
|
|
652
|
+
<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
|
|
653
|
+
</dd>
|
|
654
|
+
</dl>
|
|
655
|
+
<dl class="field-list simple">
|
|
656
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
657
|
+
<dd class="field-odd"><p>String with the numbers of stripes buffered</p>
|
|
658
|
+
</dd>
|
|
659
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
660
|
+
<dd class="field-even"><p>str</p>
|
|
661
|
+
</dd>
|
|
662
|
+
</dl>
|
|
663
|
+
</dd></dl>
|
|
399
664
|
|
|
400
665
|
<dl class="py method">
|
|
401
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
402
|
-
<span class="sig-name descname"><span class="pre">
|
|
403
|
-
<dd
|
|
666
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_get_stripes_text">
|
|
667
|
+
<span class="sig-name descname"><span class="pre">stream_get_stripes_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.stream_get_stripes_text" title="Link to this definition">¶</a></dt>
|
|
668
|
+
<dd><p>Retrieve and process text data from a QIS stream.
|
|
669
|
+
We try to ready a block of data and also check for end of data and error cases</p>
|
|
670
|
+
<dl class="field-list simple">
|
|
671
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
672
|
+
<dd class="field-odd"><ul class="simple">
|
|
673
|
+
<li><p><strong>sock</strong> – The socket instance used for communication with the device.</p></li>
|
|
674
|
+
<li><p><strong>device</strong> – The device ID string</p></li>
|
|
675
|
+
</ul>
|
|
676
|
+
</dd>
|
|
677
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
678
|
+
<dd class="field-even"><p><ul class="simple">
|
|
679
|
+
<li><p>The status of the data stream as a comma seperated list of status items</p></li>
|
|
680
|
+
<li><p>The retrieved text data from the stream.</p></li>
|
|
681
|
+
</ul>
|
|
682
|
+
</p>
|
|
683
|
+
</dd>
|
|
684
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
685
|
+
<dd class="field-odd"><p>A tuple containing</p>
|
|
686
|
+
</dd>
|
|
687
|
+
</dl>
|
|
688
|
+
</dd></dl>
|
|
404
689
|
|
|
405
690
|
<dl class="py method">
|
|
406
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
407
|
-
<span class="sig-name descname"><span class="pre">
|
|
408
|
-
<dd
|
|
691
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_header_average">
|
|
692
|
+
<span class="sig-name descname"><span class="pre">stream_header_average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.stream_header_average" title="Link to this definition">¶</a></dt>
|
|
693
|
+
<dd><p>Gets the averaging used on the current stream, required for processing the stripe data returned from QIS</p>
|
|
694
|
+
<p>Arguments</p>
|
|
695
|
+
<dl class="simple">
|
|
696
|
+
<dt>device<span class="classifier">str</span></dt><dd><p>The device ID to target</p>
|
|
697
|
+
</dd>
|
|
698
|
+
<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
|
|
699
|
+
</dd>
|
|
700
|
+
</dl>
|
|
701
|
+
<dl class="field-list simple">
|
|
702
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
703
|
+
<dd class="field-odd"><p>String with the rate and unit</p>
|
|
704
|
+
</dd>
|
|
705
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
706
|
+
<dd class="field-even"><p>str</p>
|
|
707
|
+
</dd>
|
|
708
|
+
</dl>
|
|
709
|
+
</dd></dl>
|
|
409
710
|
|
|
410
711
|
<dl class="py method">
|
|
411
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
412
|
-
<span class="sig-name descname"><span class="pre">
|
|
413
|
-
<dd
|
|
712
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_header_format">
|
|
713
|
+
<span class="sig-name descname"><span class="pre">stream_header_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.stream_header_format" title="Link to this definition">¶</a></dt>
|
|
714
|
+
<dd><p>Formats the stream header for use at the top of a CSV file. This adds the appropriate time column and
|
|
715
|
+
each of the channel data columns</p>
|
|
716
|
+
<p>Arguments</p>
|
|
717
|
+
<dl class="simple">
|
|
718
|
+
<dt>device:</dt><dd><p>The device ID to target</p>
|
|
719
|
+
</dd>
|
|
720
|
+
<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
|
|
721
|
+
</dd>
|
|
722
|
+
</dl>
|
|
723
|
+
<dl class="field-list simple">
|
|
724
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
725
|
+
<dd class="field-odd"><p>Get the CSV formatted header string for the current stream</p>
|
|
726
|
+
</dd>
|
|
727
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
728
|
+
<dd class="field-even"><p>str</p>
|
|
729
|
+
</dd>
|
|
730
|
+
</dl>
|
|
731
|
+
</dd></dl>
|
|
414
732
|
|
|
415
733
|
<dl class="py method">
|
|
416
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
417
|
-
<span class="sig-name descname"><span class="pre">
|
|
418
|
-
<dd
|
|
734
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_running_status">
|
|
735
|
+
<span class="sig-name descname"><span class="pre">stream_running_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.stream_running_status" title="Link to this definition">¶</a></dt>
|
|
736
|
+
<dd><p>returns a single word status string for a given device. Generally this will be running, overrun, or stopped</p>
|
|
737
|
+
<p>Arguments</p>
|
|
738
|
+
<dl class="simple">
|
|
739
|
+
<dt>device<span class="classifier">str</span></dt><dd><p>The device ID to target</p>
|
|
740
|
+
</dd>
|
|
741
|
+
<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
|
|
742
|
+
</dd>
|
|
743
|
+
</dl>
|
|
744
|
+
<dl class="field-list simple">
|
|
745
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
746
|
+
<dd class="field-odd"><p>Single word status string to show the operation of streaming</p>
|
|
747
|
+
</dd>
|
|
748
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
749
|
+
<dd class="field-even"><p>str</p>
|
|
750
|
+
</dd>
|
|
751
|
+
</dl>
|
|
752
|
+
</dd></dl>
|
|
419
753
|
|
|
420
754
|
<dl class="py method">
|
|
421
|
-
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.
|
|
422
|
-
<span class="sig-name descname"><span class="pre">
|
|
423
|
-
<dd
|
|
755
|
+
<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.waitStop">
|
|
756
|
+
<span class="sig-name descname"><span class="pre">waitStop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.waitStop" title="Link to this definition">¶</a></dt>
|
|
757
|
+
<dd><p>deprecated:: 2.2.13
|
|
758
|
+
No indication this is used anywhere</p>
|
|
759
|
+
</dd></dl>
|
|
424
760
|
|
|
425
761
|
</dd></dl>
|
|
426
762
|
|
|
427
763
|
<dl class="py class">
|
|
428
764
|
<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo">
|
|
429
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">StreamHeaderInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream_header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo" title="Link to this definition">¶</a></dt>
|
|
765
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">StreamHeaderInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream_header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo" title="Link to this definition">¶</a></dt>
|
|
430
766
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
431
767
|
<p>Holds the raw header information data and allows access to its various elements
|
|
432
768
|
in a simple way</p>
|
|
@@ -626,7 +962,7 @@ an address can be specified for remote systems.</p>
|
|
|
626
962
|
©2020, Quarch Technology Ltd.
|
|
627
963
|
|
|
628
964
|
|
|
|
629
|
-
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.
|
|
965
|
+
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
|
|
630
966
|
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
|
631
967
|
|
|
632
968
|
|
|