PyPI - quarchpy - Versions diffs - 2.1.11.dev4__py3-none-any.whl → 2.2.17.dev1__py3-none-any.whl - Mend

quarchpy 2.1.11.dev4py3-none-any.whl → 2.2.17.dev1py3-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.

Files changed (745) hide show

quarchpy/docs/_build/html/source/quarchpy.qis.html CHANGED Viewed

@@ -1,250 +1,986 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>quarchpy.qis package &#8212; quarchpy  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/jquery.js"></script>
-    <script src="../_static/underscore.js"></script>
-    <script src="../_static/doctools.js"></script>
-    <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="quarchpy.qps package" href="quarchpy.qps.html" />
-    <link rel="prev" title="quarchpy.device package" href="quarchpy.device.html" />
-  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
-  </head><body>
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-  <div class="section" id="quarchpy-qis-package">
-<h1>quarchpy.qis package<a class="headerlink" href="#quarchpy-qis-package" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
-</div>
-<div class="section" id="module-quarchpy.qis.qisFuncs">
-<span id="quarchpy-qis-qisfuncs-module"></span><h2>quarchpy.qis.qisFuncs module<a class="headerlink" href="#module-quarchpy.qis.qisFuncs" title="Permalink to this headline">¶</a></h2>
-<p>Contains general functions for starting and stopping QIS processes</p>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.GetQisModuleSelection">
-<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="Permalink to this definition">¶</a></dt>
-<dd><p>Prints a list of modules for user selection</p>
-<div class="deprecated">
-<p><span class="versionmodified deprecated">Deprecated since version 2.0.12: </span>Use the module selection functions of the QisInterface class instead</p>
-</div>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.checkAndCloseQis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">checkAndCloseQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.checkAndCloseQis" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.check_remote_qis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">check_remote_qis</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.check_remote_qis" title="Permalink to this definition">¶</a></dt>
-<dd><p>Checks if a local or specified instance of QIS is running and responding
-This continues to scan until qis is found or a timeout is hit.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns</dt>
-<dd class="field-odd"><p><strong>is_running</strong> – True if QIS is running and responding</p>
-</dd>
-<dt class="field-even">Return type</dt>
-<dd class="field-even"><p>bool</p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.closeQis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">closeQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.closeQis" title="Permalink to this definition">¶</a></dt>
-<dd><p>Helper function to close an instance of QIS.  By default this is the local version, but
-an address can be specified for remote systems.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>host</strong> (<em>str</em><em>, </em><em>optional</em>) – Host IP address if not localhost</p></li>
-<li><p><strong>port</strong> (<em>str</em><em>, </em><em>optional</em>) – QIS connection port if set to a value other than the default</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.isQisRunning">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">isQisRunning</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.isQisRunning" title="Permalink to this definition">¶</a></dt>
-<dd><p>Checks if a local instance of QIS is running and responding</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns</dt>
-<dd class="field-odd"><p><strong>is_running</strong> – True if QIS is running and responding</p>
-</dd>
-<dt class="field-even">Return type</dt>
-<dd class="field-even"><p>bool</p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.startLocalQis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">startLocalQis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">terminal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headless</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</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.qisFuncs.startLocalQis" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes QIS on the local system, using the version contained within quarchpy</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>terminal</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if QIS terminal should be shown on startup</p></li>
-<li><p><strong>headless</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if app should be run in headless mode for non graphical environments</p></li>
-<li><p><strong>args</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of additional parameters to be supplied to QIS on the command line</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-</div>
-<div class="section" id="module-quarchpy.qis">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.qis" title="Permalink to this headline">¶</a></h2>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.checkAndCloseQis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">checkAndCloseQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.checkAndCloseQis" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.closeQis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">closeQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.closeQis" title="Permalink to this definition">¶</a></dt>
-<dd><p>Helper function to close an instance of QIS.  By default this is the local version, but
-an address can be specified for remote systems.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>host</strong> (<em>str</em><em>, </em><em>optional</em>) – Host IP address if not localhost</p></li>
-<li><p><strong>port</strong> (<em>str</em><em>, </em><em>optional</em>) – QIS connection port if set to a value other than the default</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.isQisRunning">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">isQisRunning</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.isQisRunning" title="Permalink to this definition">¶</a></dt>
-<dd><p>Checks if a local instance of QIS is running and responding</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns</dt>
-<dd class="field-odd"><p><strong>is_running</strong> – True if QIS is running and responding</p>
-</dd>
-<dt class="field-even">Return type</dt>
-<dd class="field-even"><p>bool</p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.qis.startLocalQis">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">startLocalQis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">terminal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headless</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</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.startLocalQis" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes QIS on the local system, using the version contained within quarchpy</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>terminal</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if QIS terminal should be shown on startup</p></li>
-<li><p><strong>headless</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if app should be run in headless mode for non graphical environments</p></li>
-<li><p><strong>args</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of additional parameters to be supplied to QIS on the command line</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-</div>
-</div>
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="../index.html">quarchpy</a></h1>
-<h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Quarchpy)</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="modules.html">quarchpy</a><ul class="current">
-<li class="toctree-l2 current"><a class="reference internal" href="quarchpy.html">quarchpy package</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="readme.html">Quarchpy - Readme</a></li>
-<li class="toctree-l1"><a class="reference internal" href="licenses.html">LICENSES</a></li>
-</ul>
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="../index.html">Documentation overview</a><ul>
-  <li><a href="modules.html">quarchpy</a><ul>
-  <li><a href="quarchpy.html">quarchpy package</a><ul>
-      <li>Previous: <a href="quarchpy.device.html" title="previous chapter">quarchpy.device package</a></li>
-      <li>Next: <a href="quarchpy.qps.html" title="next chapter">quarchpy.qps package</a></li>
-  </ul></li>
-  </ul></li>
-  </ul></li>
-</ul>
-</div>
-<div id="searchbox" style="display: none" role="search">
-  <h3 id="searchlabel">Quick search</h3>
-    <div class="searchformwrapper">
-    <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
-      <input type="submit" value="Go" />
-    </form>
-    </div>
-</div>
-<script>$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="footer">
-      &copy;2020, Quarch Technology Ltd.
-      |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.0</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
-      |
-      <a href="../_sources/source/quarchpy.qis.rst.txt"
-          rel="nofollow">Page source</a>
-    </div>
-  </body>
+<!DOCTYPE html>
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>quarchpy.qis package &#8212; quarchpy  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="quarchpy.qps package" href="quarchpy.qps.html" />
+    <link rel="prev" title="quarchpy.device package" href="quarchpy.device.html" />
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  </head><body>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <section id="quarchpy-qis-package">
+<h1>quarchpy.qis package<a class="headerlink" href="#quarchpy-qis-package" title="Link to this heading">¶</a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
+</section>
+<section id="module-quarchpy.qis.qisFuncs">
+<span id="quarchpy-qis-qisfuncs-module"></span><h2>quarchpy.qis.qisFuncs module<a class="headerlink" href="#module-quarchpy.qis.qisFuncs" title="Link to this heading">¶</a></h2>
+<p>Contains general functions for starting and stopping QIS processes</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.GetQisModuleSelection">
+<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>
+<dd><p>Prints a list of modules for user selection</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.checkAndCloseQis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">checkAndCloseQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.checkAndCloseQis" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.check_remote_qis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">check_remote_qis</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.check_remote_qis" title="Link to this definition">¶</a></dt>
+<dd><p>Checks if a local or specified instance of QIS is running and responding
+This continues to scan until qis is found or a timeout is hit.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>is_running</strong> – True if QIS is running and responding</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>bool</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.closeQis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">closeQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.closeQis" title="Link to this definition">¶</a></dt>
+<dd><p>Helper function to close an instance of QIS.  By default this is the local version, but
+an address can be specified for remote systems.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host</strong> (<em>str</em><em>, </em><em>optional</em>) – Host IP address if not localhost</p></li>
+<li><p><strong>port</strong> (<em>str</em><em>, </em><em>optional</em>) – QIS connection port if set to a value other than the default</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.isQisRunning">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">isQisRunning</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.isQisRunning" title="Link to this definition">¶</a></dt>
+<dd><p>Checks if a local instance of QIS is running and responding
+:returns: <strong>is_running</strong> – True if QIS is running and responding
+:rtype: bool</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.isQisRunningAndResponding">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">isQisRunningAndResponding</span></span><span class="sig-paren">(</span><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">2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.isQisRunningAndResponding" title="Link to this definition">¶</a></dt>
+<dd><p>checks if qis is running and responding to a $version</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.reader">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">reader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.reader" title="Link to this definition">¶</a></dt>
+<dd><p>Used to read output and place it in a queue for multithreaded reading
+:param stream:
+:param q:
+:param source:
+:param lock: The lock for the queue
+:param stop_flag: Flag to exit the loop and close the thread
+:return: None</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.qisFuncs.startLocalQis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.qisFuncs.</span></span><span class="sig-name descname"><span class="pre">startLocalQis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">terminal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headless</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.qisFuncs.startLocalQis" title="Link to this definition">¶</a></dt>
+<dd><p>Executes QIS on the local system, using the version contained within quarchpy</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>terminal</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if QIS terminal should be shown on startup</p></li>
+<li><p><strong>headless</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if app should be run in headless mode for non graphical environments</p></li>
+<li><p><strong>args</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of additional parameters to be supplied to QIS on the command line</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
+<section id="module-quarchpy.qis">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.qis" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface">
+<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.GetQisModuleSelection">
+<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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>get_qis_module_selection</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.closeConnection">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>close_connection</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.close_connection">
+<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">&#x2192;</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>
+<dd><p>Orders QIS to release a given device (or all devices if no connection string is specified)
+This is more important for TCP connected devices as the socket is held open until
+specifically released.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>sock</strong> – The socket object to close the connection to. Defaults to the existing socket.</p></li>
+<li><p><strong>con_string</strong> – Specify the device ID to close, otherwise all devices will be closed</p></li>
+</ul>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>ConnectionResetError</strong> – Raised if the socket connection has already been reset.</p>
+</dd>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>‘OK’</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>The response received after sending the close command. On success, this will be</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.connect">
+<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">&#x2192;</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>
+<dd><p>Opens the connection to the QIS backend</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>connection_message</strong> – Defaults to True. If set to False, suppresses the warning message about an
+instance already running on the specified port. This can be useful when
+using <cite>isQisRunning()</cite> from <cite>qisFuncs</cite>.</p>
+</dd>
+</dl>
+<p>Raises:
+Exception:</p>
+<blockquote>
+<div><p>If the connection fails or the welcome string is not received an exception is raised</p>
+</div></blockquote>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The welcome string received from the backend server upon a successful
+connection.  This will confirm the QIS version but is generally not used other than
+for debugging</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.convertStreamAverage">
+<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>
+<dd><p>deprecated:: 2.2.13
+No indication this is used anywhere</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.device_control_index">
+<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">&#x2192;</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>
+<dd><p>Returns the index of the device in the control lists.  If the device is not
+registered, then it is added first.  This is a key part of allowing us to
+track the status of multiple streaming devices and manage them from outside
+their streaming thread</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>device</strong> – Device ID string</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Index of the device in the various control lists</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.device_dict_setup">
+<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">&#x2192;</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>
+<dd><p>Adds a dictionary entry for a new module we are connecting to (including the base QIS connection)
+This is used for tracking the status of modules throughout the streaming process</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>module</strong></p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.disconnect">
+<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">&#x2192;</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>
+<dd><p>Disconnects the current connection to the QIS backend.</p>
+<p>This method attempts to gracefully disconnect from the backend server and updates
+the connection state in the device dictionary. If an error occurs during the
+disconnection process, the state is updated to indicate the failure, and the
+exception is re-raised</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A message indicating that the disconnection process has started.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+<dt class="field-odd">Raises<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>Exception</strong> – Propagates any exception that occurs during the disconnection process.</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.getDeviceList">
+<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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>start_stream_thread_qps</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_device_list">
+<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">&#x2192;</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>
+<dd><p>returns a list of device IDs that are available for connection</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>sock</strong> – Optional connection socket</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A filtered iterable list of devices</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_list_details">
+<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">&#x2192;</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>
+<dd><p>Extended version of get_device_list which also returns the additional details
+fields for each module</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>sock</strong> – Optional connection socket</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Iterable list of strings containing the details of each device available for connection.</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_qis_module_selection">
+<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">&#x2192;</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>
+<dd><p>Scans for available modules and allows the user to select one through an interactive selection process.
+Can also handle additional custom options and some built-in ones such as rescanning</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>preferred_connection_only</strong> – bool
+by default (True), returns only one preferred connection eg: USB for simplicity</p></li>
+<li><p><strong>additional_options</strong> – list
+Additional operational options provided during module selection, such as rescan,
+all connection types, and IP scan. Defaults to [‘rescan’, ‘all con types’, ‘ip scan’]. These allow the
+additional options to be given to the user and handled in the top level script</p></li>
+<li><p><strong>scan</strong> – bool
+Indicates whether to initiate a rescanning process for devices before listing. Defaults to True and
+will take longer to return</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The identifier of the selected module, or the action selected from the additional options.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><ul class="simple">
+<li><p><strong>KeyError</strong> – Raised when unexpected keys are found in the scanned device data.</p></li>
+<li><p><strong>ValueError</strong> – Raised if no valid selection is made or the provided IP address is invalid.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.get_stream_xml_header">
+<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">&#x2192;</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>
+<dd><p>Gets the XML format header from an attached device (which must have run or be running a stream)
+Parses the string into XML and returns the root element</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>device</strong> – Device ID to return from</p></li>
+<li><p><strong>sock</strong> – Optional QIS socket to use for communication.</p></li>
+</ul>
+</dd>
+</dl>
+<p>Returns:</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.interruptList">
+<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>
+<dd><p>deprecated:: 2.2.13
+No indication this is used anywhere</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.is_xml_header">
+<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">&#x2192;</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>
+<dd><p>Checks if the given header string is in XML format (as apposed to legacy text format) or an invalid string</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>header_text</strong> – The header string to evaluate</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>True if the header is in XML form</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.qis_scan_devices">
+<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">&#x2192;</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>
+<dd><p>Begins a scan for devices and returns a simple list of devices</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>scan</strong> – Should a scan be initiated?  If False, the function will return immediately with the list</p></li>
+<li><p><strong>preferred_connection_only</strong> – The default (True), returns only one preferred connection eg: USB for simplicity</p></li>
+<li><p><strong>ip_address</strong> – IP address of the module you are looking for eg ‘192.168.123.123’</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>List of module strings found during scan</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>list</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.receive_text">
+<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">&#x2192;</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>
+<dd><p>Received bytes from the socket and converts to a test string
+:param sock: Socket to communicate over</p>
+<p>Returns:</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.rx_bytes">
+<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">&#x2192;</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>
+<dd><p>Reads an array of bytes from the socket as part of handling a command response</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>sock</strong> – Socket to communicate over</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Bytes read</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.scanIP">
+<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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>scan_ip</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.scan_ip">
+<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">&#x2192;</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>
+<dd><p>Triggers QIS to look at a specific IP address for a module</p>
+<p>Arguments</p>
+<dl class="simple">
+<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>
+</dd>
+<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>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendAndReceiveCmd">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>send_command</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendAndReceiveText">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>send_and_receive_text</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendCmd">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>send_command</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sendCommand">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>send_command</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.send_and_receive_text">
+<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">&#x2192;</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>
+<dd><p>Internal function for command handling.  This handles complex cases such as timeouts and XML
+response formatting, which conflicts with the default cursor</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>sock</strong> – The socket to communicate over</p></li>
+<li><p><strong>send_text</strong> – The command text to send</p></li>
+<li><p><strong>device</strong> – Optional device ID to send the command to</p></li>
+<li><p><strong>read_until_cursor</strong> – Flag to indicate if we should read until the cursor is returned</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Response string from the module</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.send_command">
+<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">&#x2192;</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>
+<dd><p>Sends a command and returns the response as a string.  Multiple lines are escaped with CRLF.
+The command is sent to the QIS socket, and depending on the command will be replied by either QIS
+or the hardware module.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>command</strong> – Command string</p></li>
+<li><p><strong>device</strong> – Optional Device ID string to send the command to. Use default/blank for QIS direct commands</p></li>
+<li><p><strong>qis_socket</strong> – Optional Socket to use for the command, if the default is not wanted</p></li>
+<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>
+<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>
+<li><p><strong>command_delay</strong> – Optional delay to prevent commands running in close succession.  Timed in seconds.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Command response string or None if no response expected</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.send_text">
+<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">&#x2192;</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>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>sock</strong> – Socket to communicate over</p></li>
+<li><p><strong>message</strong> – text command to send</p></li>
+<li><p><strong>device</strong> – Optional device ID to target with the command</p></li>
+</ul>
+</dd>
+</dl>
+<p>Returns:</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.sort_favourite">
+<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">&#x2192;</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>
+<dd><p>Reduces the list of located devices by referencing to the preferred type of connection.  Only
+one connection type will be returned for each module for easier user selection. ie: A module connected
+on both USB and TCP will now only return with USB</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>found_devices</strong> – List of located devices from a scan operation</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>List of devices filtered/sorted devices</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.startStream">
+<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>, <em class="sig-param"><span class="n"><span class="pre">gzipCompressLevel</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">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.startStream" title="Link to this definition">¶</a></dt>
+<dd><p>deprecated:: 2.2.13
+Use <cite>start_stream</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.start_stream">
+<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>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</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">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream" title="Link to this definition">¶</a></dt>
+<dd><p>Begins a stream process which will record data from the module to a CSV file or in memory CSV equivalent</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>module</strong> – The ID of the module for which the stream is being initiated.</p></li>
+<li><p><strong>file_name</strong> – The target file path+name for storing the  streamed data in CSV form.</p></li>
+<li><p><strong>max_file_size</strong> – The maximum size in megabytes allowed for the output file.</p></li>
+<li><p><strong>release_on_data</strong> – If set, blocks further streams until this one has started</p></li>
+<li><p><strong>separator</strong> – The value separator used to format the streamed CSV data.</p></li>
+<li><p><strong>stream_duration</strong> – The duration (in seconds) for which the streaming process should run. Unlimited if None.</p></li>
+<li><p><strong>in_memory_data</strong> – An in memory CSV StringIO as an alternate to file output</p></li>
+<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>
+<li><p><strong>use_gzip</strong> – A flag indicating whether the output file should be compressed using gzip to reduce disk use</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.start_stream_thread">
+<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>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</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">9</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>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>module</strong> – The name of the module from which data is to be streamed.</p></li>
+<li><p><strong>file_name</strong> – The path to the file where streamed data will be written. Mandatory if neither an in-memory
+buffer (in_memory_data) nor an external file handle (output_file_handle) is provided.</p></li>
+<li><p><strong>max_file_size</strong> – The maximum permissible file size in MB. After reaching this limit, streaming to the current
+file will stop</p></li>
+<li><p><strong>release_on_data</strong> – True to prevent the stream lock from releasing until data has been received</p></li>
+<li><p><strong>separator</strong> – Custom separator used to CSV data</p></li>
+<li><p><strong>stream_duration</strong> – Duration of streaming in seconds, relative to the sampling period. Defaults to streaming
+indefinitely.</p></li>
+<li><p><strong>in_memory_data</strong> – An in-memory buffer of type StringIO to hold streamed data. If set, data is written here
+instead of a file.</p></li>
+<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>
+<li><p><strong>use_gzip</strong> – If True, writes streamed data to a gzip-compressed file.</p></li>
+<li><p><strong>gzip_compress_level</strong> – (Default: 9) The compression level (0-9) to use for gzip.
+1 is fastest with low compression. 9 is slowest with high compression.</p></li>
+</ul>
+</dd>
+</dl>
+<p>Raises:
+TypeError</p>
+<blockquote>
+<div><p>If in_memory_data is passed but is not of type StringIO.</p>
+</div></blockquote>
+<dl class="simple">
+<dt>ValueError</dt><dd><p>If file_name is not provided and neither in_memory_data nor output_file_handle is given.
+Also raised for invalid or undecodable sampling periods.</p>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stopStream">
+<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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>stop_stream</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stop_stream">
+<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>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>module</strong> – The quarchPPM module instance for which the streaming process is to be stopped.</p></li>
+<li><p><strong>blocking</strong> – If set to True, the function will block and wait until the module has
+completely stopped streaming. Defaults to True.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamBufferStatus">
+<span class="sig-name descname"><span class="pre">streamBufferStatus</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">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.streamBufferStatus" title="Link to this definition">¶</a></dt>
+<dd><p>deprecated:: 2.2.13
+Use <cite>stream_buffer_status</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamHeaderFormat">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>stream_header_format</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamInterrupt">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+No indication this is used anywhere</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamRunningStatus">
+<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">&#x2192;</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>
+<dd><p>deprecated:: 2.2.13
+Use <cite>stream_running_status</cite> instead.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_buffer_status">
+<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">&#x2192;</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>
+<dd><p>returns the info on the stripes buffered during the stream</p>
+<p>Arguments</p>
+<dl class="simple">
+<dt>device<span class="classifier">str</span></dt><dd><p>The device ID to target</p>
+</dd>
+<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>String with the numbers of stripes buffered</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_get_stripes_text">
+<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">&#x2192;</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>
+<dd><p>Retrieve and process text data from a QIS stream.
+We try to ready a block of data and also check for end of data and error cases</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>sock</strong> – The socket instance used for communication with the device.</p></li>
+<li><p><strong>device</strong> – The device ID string</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><ul class="simple">
+<li><p>The status of the data stream as a comma seperated list of status items</p></li>
+<li><p>The retrieved text data from the stream.</p></li>
+</ul>
+</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A tuple containing</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_header_average">
+<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">&#x2192;</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>
+<dd><p>Gets the averaging used on the current stream, required for processing the stripe data returned from QIS</p>
+<p>Arguments</p>
+<dl class="simple">
+<dt>device<span class="classifier">str</span></dt><dd><p>The device ID to target</p>
+</dd>
+<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>String with the rate and unit</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_header_format">
+<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">&#x2192;</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>
+<dd><p>Formats the stream header for use at the top of a CSV file.  This adds the appropriate time column and
+each of the channel data columns</p>
+<p>Arguments</p>
+<dl class="simple">
+<dt>device:</dt><dd><p>The device ID to target</p>
+</dd>
+<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Get the CSV formatted header string for the current stream</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.stream_running_status">
+<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">&#x2192;</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>
+<dd><p>returns a single word status string for a given device.  Generally this will be running, overrun, or stopped</p>
+<p>Arguments</p>
+<dl class="simple">
+<dt>device<span class="classifier">str</span></dt><dd><p>The device ID to target</p>
+</dd>
+<dt>sock:</dt><dd><p>The socket to communicate over, or None to use the default.</p>
+</dd>
+</dl>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Single word status string to show the operation of streaming</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.QisInterface.waitStop">
+<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>
+<dd><p>deprecated:: 2.2.13
+No indication this is used anywhere</p>
+</dd></dl>
+</dd></dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo">
+<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Holds the raw header information data and allows access to its various elements
+in a simple way</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.data_valid">
+<span class="sig-name descname"><span class="pre">data_valid</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.data_valid" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.device_channels">
+<span class="sig-name descname"><span class="pre">device_channels</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.device_channels" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.device_groups">
+<span class="sig-name descname"><span class="pre">device_groups</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.device_groups" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.device_period">
+<span class="sig-name descname"><span class="pre">device_period</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.device_period" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.get_device_period">
+<span class="sig-name descname"><span class="pre">get_device_period</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.get_device_period" title="Link to this definition">¶</a></dt>
+<dd><p>Returns the sample rate of the stream (of the fastest group for multi-rate streams)</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>device_period</strong> – Sample rate time object including time unit</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>TimeValue</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.get_header_version">
+<span class="sig-name descname"><span class="pre">get_header_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.get_header_version" title="Link to this definition">¶</a></dt>
+<dd><p>Returns the header version number</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>header_version</strong> – Version number of the stream text header data</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>int</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.header_raw_xml">
+<span class="sig-name descname"><span class="pre">header_raw_xml</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.header_raw_xml" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.header_version">
+<span class="sig-name descname"><span class="pre">header_version</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.header_version" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.init_from_qis_device">
+<span class="sig-name descname"><span class="pre">init_from_qis_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">open_qis_device</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.init_from_qis_device" title="Link to this definition">¶</a></dt>
+<dd><p>Sets up the info class from a quaech device that is attached
+via QIS and so the header can be requested direct from the instrument</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>open_qis_device</strong> (<a class="reference internal" href="quarchpy.device.html#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><em>quarchDevice</em></a>) – Open connection to a quarch streaming device via QIS</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="quarchpy.qis.StreamHeaderInfo.init_from_stream_header">
+<span class="sig-name descname"><span class="pre">init_from_stream_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream_header</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.StreamHeaderInfo.init_from_stream_header" title="Link to this definition">¶</a></dt>
+<dd><p>Sets up the info class from stream header text, as supplied from the QIS
+stream text header command</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>stream_header</strong> (<em>str</em>) – Stream header text data</p>
+</dd>
+</dl>
+</dd></dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.checkAndCloseQis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">checkAndCloseQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.checkAndCloseQis" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.closeQis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">closeQis</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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.closeQis" title="Link to this definition">¶</a></dt>
+<dd><p>Helper function to close an instance of QIS.  By default this is the local version, but
+an address can be specified for remote systems.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>host</strong> (<em>str</em><em>, </em><em>optional</em>) – Host IP address if not localhost</p></li>
+<li><p><strong>port</strong> (<em>str</em><em>, </em><em>optional</em>) – QIS connection port if set to a value other than the default</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.isQisRunning">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">isQisRunning</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.isQisRunning" title="Link to this definition">¶</a></dt>
+<dd><p>Checks if a local instance of QIS is running and responding
+:returns: <strong>is_running</strong> – True if QIS is running and responding
+:rtype: bool</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qis.startLocalQis">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qis.</span></span><span class="sig-name descname"><span class="pre">startLocalQis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">terminal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headless</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.startLocalQis" title="Link to this definition">¶</a></dt>
+<dd><p>Executes QIS on the local system, using the version contained within quarchpy</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>terminal</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if QIS terminal should be shown on startup</p></li>
+<li><p><strong>headless</strong> (<em>bool</em><em>, </em><em>optional</em>) – True if app should be run in headless mode for non graphical environments</p></li>
+<li><p><strong>args</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of additional parameters to be supplied to QIS on the command line</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
+</section>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">quarchpy</a></h1>
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Quarchpy)</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">quarchpy</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="quarchpy.html">quarchpy package</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="readme.html">Quarchpy - Readme</a></li>
+<li class="toctree-l1"><a class="reference internal" href="licenses.html">LICENSES</a></li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  <li><a href="modules.html">quarchpy</a><ul>
+  <li><a href="quarchpy.html">quarchpy package</a><ul>
+      <li>Previous: <a href="quarchpy.device.html" title="previous chapter">quarchpy.device package</a></li>
+      <li>Next: <a href="quarchpy.qps.html" title="next chapter">quarchpy.qps package</a></li>
+  </ul></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2020, Quarch Technology Ltd.
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+      |
+      <a href="../_sources/source/quarchpy.qis.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+  </body>
 </html>

quarchpy 2.1.11.dev4__py3-none-any.whl → 2.2.17.dev1__py3-none-any.whl

quarchpy 2.1.11.dev4py3-none-any.whl → 2.2.17.dev1py3-none-any.whl