quarchpy 2.2.13__py2.py3-none-any.whl → 2.2.14__py2.py3-none-any.whl

quarchpy/docs/_build/html/source/quarchpy.connection_specific.html

@@ -6,8 +6,8 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>quarchpy.connection_specific package &#8212; quarchpy  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <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>
@@ -47,310 +47,644 @@
 <span id="quarchpy-connection-specific-connection-qis-module"></span><h2>quarchpy.connection_specific.connection_QIS module<a class="headerlink" href="#module-quarchpy.connection_specific.connection_QIS" title="Link to this heading">¶</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.GetQisModuleSelection" title="Link to this definition">¶</a></dt>
-<dd><p>Fuction used to list the available deviced to QIS and present them to the user for selection.</p>
-<p>Returns myDeviceID - Str the connection string used to connect to the selected device.</p>
+<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.connection_specific.connection_QIS.QisInterface.add_header_to_buffer">
-<span class="sig-name descname"><span class="pre">add_header_to_buffer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outBuffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_b_array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_header_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">temp_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.add_header_to_buffer" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.add_header_to_byte_array">
-<span class="sig-name descname"><span class="pre">add_header_to_byte_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">return_b_array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_header_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">temp_dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tree</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_digital</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.add_header_to_byte_array" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.averageStripes">
-<span class="sig-name descname"><span class="pre">averageStripes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">leftover</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamAverage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newStripes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remainingStripes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.averageStripes" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.avgStringFromPwr">
-<span class="sig-name descname"><span class="pre">avgStringFromPwr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">avgPwrTwo</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.avgStringFromPwr" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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="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.connection_specific.connection_QIS.QisInterface.closeConnection" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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">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.connection_specific.connection_QIS.QisInterface.connect" title="Link to this definition">¶</a></dt>
-<dd><p>Connect() tries to open a socket  on the host and port specified in the objects variables
-If successful it returns the backends welcome string. If it fails it returns a string saying unable to connect
-The backend should be running and host and port set before running this function. Normally it should be called at the beggining
-of talking to the backend and left open until finished talking when the disconnect() function should be ran</p>
-<p>Param:
-connectionMessage: boolean, optional</p>
+<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.connection_specific.connection_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>Set to False if you don’t want a warning message to appear when an instance is already running on that port. Useful when using isQisRunning() from qisFuncs</p>
+<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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.convertStreamAverage" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_QIS.QisInterface.create_dir_structure">
-<span class="sig-name descname"><span class="pre">create_dir_structure</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">directory</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.connection_specific.connection_QIS.QisInterface.create_dir_structure" title="Link to this definition">¶</a></dt>
-<dd><p>Creates the QPS directory structure and (empty) files to be written to</p>
-<p>I’ve put a bunch of try-except just to be sure the directory is correctly created.
-( There’s probably a better way of doing this than this )</p>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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">Param<span class="colon">:</span></dt>
-<dd class="field-odd"><p>module: String  - Module string</p>
-</dd>
-<dt class="field-even">Param<span class="colon">:</span></dt>
-<dd class="field-even"><p>directory: String  - Name of directory for QPS stream (defaults to default recording location if invalid)</p>
+<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-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>success: Boolean - Was the file structure created successfully?</p>
+<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.connection_specific.connection_QIS.QisInterface.create_index_file">
-<span class="sig-name descname"><span class="pre">create_index_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.create_index_file" title="Link to this definition">¶</a></dt>
-<dd><p>Create the necessary index file for QPS data000.idx</p>
-<p>For future revisions, this should be updated if there are file limits on each data file
-Current implementation assumes only 1 of each data file are made.</p>
-<p>No Return./</p>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.create_index_file_digitals">
-<span class="sig-name descname"><span class="pre">create_index_file_digitals</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.create_index_file_digitals" title="Link to this definition">¶</a></dt>
-<dd><p>Create the necessary index file for QPS data101.idx</p>
-<p>For future revisions, this should be updated if there are file limits on each data file
-Current implementation assumes only 1 of each data file are made.</p>
-<p>No Return.</p>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.create_qps_directory">
-<span class="sig-name descname"><span class="pre">create_qps_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.create_qps_directory" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.create_qps_file">
-<span class="sig-name descname"><span class="pre">create_qps_file</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.create_qps_file" title="Link to this definition">¶</a></dt>
-<dd><p>Creates the end QPS file that is used to open QPS</p>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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>module</strong> – Module QTL number that was used for the stream</p>
+<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></p>
+<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.connection_specific.connection_QIS.QisInterface.deviceDictSetup">
-<span class="sig-name descname"><span class="pre">deviceDictSetup</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.deviceDictSetup" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.deviceMulti">
-<span class="sig-name descname"><span class="pre">deviceMulti</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.deviceMulti" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.disconnect">
-<span class="sig-name descname"><span class="pre">disconnect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.disconnect" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.getDeviceList" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.getStreamXmlHeader">
-<span class="sig-name descname"><span class="pre">getStreamXmlHeader</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.getStreamXmlHeader" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.get_list_details" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.interruptList" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_QIS.QisInterface.isXmlHeader">
-<span class="sig-name descname"><span class="pre">isXmlHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">headerText</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.isXmlHeader" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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">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">ipAddress</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.connection_specific.connection_QIS.QisInterface.qis_scan_devices" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.receiveText">
-<span class="sig-name descname"><span class="pre">receiveText</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.receiveText" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.rxBytes">
-<span class="sig-name descname"><span class="pre">rxBytes</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.rxBytes" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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">ipAddress</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.scanIP" title="Link to this definition">¶</a></dt>
-<dd><p>Triggers QIS to look at a specific IP address for a quarch 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>QisConnection</strong> (<a class="reference internal" href="#quarchpy.connection_specific.connection_QPS.QpsInterface" title="quarchpy.connection_specific.connection_QPS.QpsInterface"><em>QpsInterface</em></a>) – The interface to the instance of QPS you would like to use for the scan.</p></li>
-<li><p><strong>ipAddress</strong> (<em>str</em>) – The IP address of the module you are looking for eg ‘192.168.123.123’</p></li>
-<li><p><strong>sleep</strong> (<em>int</em><em>, </em><em>optional</em>) – This optional variable sleeps to allow the network to scan for the module before allowing new commands to be sent to QIS.</p></li>
-</ul>
+<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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.sendAndReceiveCmd" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_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.connection_specific.connection_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">sentText</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.sendAndReceiveText" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_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.connection_specific.connection_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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.sendCmd" title="Link to this definition">¶</a></dt>
-<dd><p>Send command is used to send a command to QIS and as far as I can see it has no difference than sendAndReceiveCmd</p>
+<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.connection_specific.connection_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.connection_specific.connection_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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.sendCommand" title="Link to this definition">¶</a></dt>
-<dd><p>Send command is used to send a command to QIS and as far as I can see it has no difference than sendAndReceiveCmd</p>
+<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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.sendText">
-<span class="sig-name descname"><span class="pre">sendText</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.sendText" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.sortFavourite">
-<span class="sig-name descname"><span class="pre">sortFavourite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">foundDevices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.sortFavourite" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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></em>, <em class="sig-param"><span class="n"><span class="pre">fileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamAverage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamDuration</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">inMemoryData</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.connection_specific.connection_QIS.QisInterface.startStream" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.startStreamQPS">
-<span class="sig-name descname"><span class="pre">startStreamQPS</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">fileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamAverage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.startStreamQPS" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.startStreamThread">
-<span class="sig-name descname"><span class="pre">startStreamThread</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">fileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamAverage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamDuration</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">inMemoryData</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.connection_specific.connection_QIS.QisInterface.startStreamThread" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.startStreamThreadQPS">
-<span class="sig-name descname"><span class="pre">startStreamThreadQPS</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">fileName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamAverage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.startStreamThreadQPS" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.stopStream" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_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.connection_specific.connection_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></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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamBufferStatus" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_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>
+</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.connection_specific.connection_QIS.QisInterface.streamGetStripesText">
-<span class="sig-name descname"><span class="pre">streamGetStripesText</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></em>, <em class="sig-param"><span class="n"><span class="pre">numStripes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4096</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipStatusCheck</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamGetStripesText" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.streamHeaderAverage">
-<span class="sig-name descname"><span class="pre">streamHeaderAverage</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderAverage" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderFormat" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderVersion">
-<span class="sig-name descname"><span class="pre">streamHeaderVersion</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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderVersion" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.streamInterrupt">
-<span class="sig-name descname"><span class="pre">streamInterrupt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamInterrupt" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_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.connection_specific.connection_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></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><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamRunningStatus" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.waitStop" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.write_b_array_to_idx_file">
-<span class="sig-name descname"><span class="pre">write_b_array_to_idx_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_b_array</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.write_b_array_to_idx_file" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.write_stripe_to_files_HD">
-<span class="sig-name descname"><span class="pre">write_stripe_to_files_HD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stripe</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.write_stripe_to_files_HD" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_QIS.QisInterface.write_stripe_to_files_PAM">
-<span class="sig-name descname"><span class="pre">write_stripe_to_files_PAM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stripe</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.write_stripe_to_files_PAM" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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.connection_specific.connection_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>
 
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.strToBb">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_QIS.</span></span><span class="sig-name descname"><span class="pre">strToBb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string_in</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_length</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.connection_specific.connection_QIS.strToBb" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+</dd></dl>
 
 </section>
 <section id="module-quarchpy.connection_specific.connection_QPS">
 <span id="quarchpy-connection-specific-connection-qps-module"></span><h2>quarchpy.connection_specific.connection_QPS module<a class="headerlink" href="#module-quarchpy.connection_specific.connection_QPS" title="Link to this heading">¶</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QPS.QpsInterface">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_QPS.</span></span><span class="sig-name descname"><span class="pre">QpsInterface</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">9822</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QPS.QpsInterface" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_QPS.</span></span><span class="sig-name descname"><span class="pre">QpsInterface</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">9822</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QPS.QpsInterface" 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.connection_specific.connection_QPS.QpsInterface.closeConnection">
@@ -424,7 +758,7 @@ Current implementation assumes only 1 of each data file are made.</p>
 <span id="quarchpy-connection-specific-connection-rest-module"></span><h2>quarchpy.connection_specific.connection_ReST module<a class="headerlink" href="#module-quarchpy.connection_specific.connection_ReST" title="Link to this heading">¶</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_ReST.ReSTConn">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_ReST.</span></span><span class="sig-name descname"><span class="pre">ReSTConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_ReST.ReSTConn" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_ReST.</span></span><span class="sig-name descname"><span class="pre">ReSTConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_ReST.ReSTConn" 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.connection_specific.connection_ReST.ReSTConn.close">
@@ -443,7 +777,7 @@ Current implementation assumes only 1 of each data file are made.</p>
 <span id="quarchpy-connection-specific-connection-serial-module"></span><h2>quarchpy.connection_specific.connection_Serial module<a class="headerlink" href="#module-quarchpy.connection_specific.connection_Serial" title="Link to this heading">¶</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_Serial.SerialConn">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_Serial.</span></span><span class="sig-name descname"><span class="pre">SerialConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_Serial.SerialConn" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_Serial.</span></span><span class="sig-name descname"><span class="pre">SerialConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_Serial.SerialConn" 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.connection_specific.connection_Serial.SerialConn.close">
@@ -467,7 +801,7 @@ Current implementation assumes only 1 of each data file are made.</p>
 <span id="quarchpy-connection-specific-connection-tcp-module"></span><h2>quarchpy.connection_specific.connection_TCP module<a class="headerlink" href="#module-quarchpy.connection_specific.connection_TCP" title="Link to this heading">¶</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_TCP.TCPConn">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_TCP.</span></span><span class="sig-name descname"><span class="pre">TCPConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_TCP.TCPConn" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_TCP.</span></span><span class="sig-name descname"><span class="pre">TCPConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_TCP.TCPConn" 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.connection_specific.connection_TCP.TCPConn.close">
@@ -489,7 +823,7 @@ Current implementation assumes only 1 of each data file are made.</p>
 <span id="quarchpy-connection-specific-connection-usb-module"></span><h2>quarchpy.connection_specific.connection_USB module<a class="headerlink" href="#module-quarchpy.connection_specific.connection_USB" title="Link to this heading">¶</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_USB.TQuarchUSB_IF">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_USB.</span></span><span class="sig-name descname"><span class="pre">TQuarchUSB_IF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_USB.TQuarchUSB_IF" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_USB.</span></span><span class="sig-name descname"><span class="pre">TQuarchUSB_IF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_USB.TQuarchUSB_IF" 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.connection_specific.connection_USB.TQuarchUSB_IF.BulkRead">
@@ -619,7 +953,7 @@ response of the previous command which caused the stuck buffer.</p>
 
 <dl class="py class">
 <dt class="sig sig-object py" id="quarchpy.connection_specific.connection_USB.USBConn">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.connection_specific.connection_USB.</span></span><span class="sig-name descname"><span class="pre">USBConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_USB.USBConn" title="Link to this definition">¶</a></dt>
+<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.connection_specific.connection_USB.</span></span><span class="sig-name descname"><span class="pre">USBConn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConnTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_USB.USBConn" 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.connection_specific.connection_USB.USBConn.close">
@@ -715,7 +1049,7 @@ response of the previous command which caused the stuck buffer.</p>
       &#169;2020, Quarch Technology Ltd.
       
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      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>
       
       |