quarchpy 2.1.24.dev1__py2.py3-none-any.whl → 2.1.24.dev3__py2.py3-none-any.whl

quarchpy/docs/_build/html/source/quarchpy.qps.html

@@ -36,11 +36,112 @@
 <section id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
 </section>
-<section id="quarchpy-qps-qpsfuncs-module">
-<h2>quarchpy.qps.qpsFuncs module<a class="headerlink" href="#quarchpy-qps-qpsfuncs-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.qps.qpsFuncs">
+<span id="quarchpy-qps-qpsfuncs-module"></span><h2>quarchpy.qps.qpsFuncs module<a class="headerlink" href="#module-quarchpy.qps.qpsFuncs" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.GetQpsModuleSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">GetQpsModuleSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">QpsConnection</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">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.qps.qpsFuncs.GetQpsModuleSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.closeQps">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">closeQps</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.qps.qpsFuncs.closeQps" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.isQpsRunning">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">isQpsRunning</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>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qps.qpsFuncs.isQpsRunning" title="Link to this definition">¶</a></dt>
+<dd><p>This func will return true if QPS is running with a working QIS connection. This is becuase</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.legacyAdjustTime">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">legacyAdjustTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qps.qpsFuncs.legacyAdjustTime" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.reader">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">reader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stream</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qps.qpsFuncs.reader" title="Link to this definition">¶</a></dt>
+<dd><p>Used to read output and place it in a queue for multithreaded reading
+:param stream:
+:param q:
+:param source:
+:param lock: The lock for the queue
+:param stop_flag: Flag to exit the loop and close the thread
+:return: None</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.startLocalQps">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">startLocalQps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keepQisRunning</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</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">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startQPSMinimised</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.qps.qpsFuncs.startLocalQps" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsFuncs.toQpsTimeStamp">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.qpsFuncs.</span></span><span class="sig-name descname"><span class="pre">toQpsTimeStamp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qps.qpsFuncs.toQpsTimeStamp" title="Link to this definition">¶</a></dt>
+<dd><p>DEPRECATED - QPS expects time passed as a string and error handling is done in QPS.
+Returns the parameter passed as a valid qps timestamp
+Assumes</p>
+<p># 1620817118182 - ACCEPTED value for QPS    - Milliseconds, 13 chars</p>
+<p># 1620817126    - time.time() Value         - Seconds</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>int/float/datetime</strong> – Timestamp, mS</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>int             : QPS valid time, mS</p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
-<section id="module-contents">
-<h2>Module contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.qps">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.qps" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.GetQpsModuleSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.</span></span><span class="sig-name descname"><span class="pre">GetQpsModuleSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">QpsConnection</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">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.qps.GetQpsModuleSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.closeQps">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.</span></span><span class="sig-name descname"><span class="pre">closeQps</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.qps.closeQps" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.isQpsRunning">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.</span></span><span class="sig-name descname"><span class="pre">isQpsRunning</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>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qps.isQpsRunning" title="Link to this definition">¶</a></dt>
+<dd><p>This func will return true if QPS is running with a working QIS connection. This is becuase</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.qps.qpsInterface">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.</span></span><span class="sig-name descname"><span class="pre">qpsInterface</span></span><a class="headerlink" href="#quarchpy.qps.qpsInterface" title="Link to this definition">¶</a></dt>
+<dd><p>alias of <a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QPS.QpsInterface" title="quarchpy.connection_specific.connection_QPS.QpsInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">QpsInterface</span></code></a></p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.startLocalQps">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.</span></span><span class="sig-name descname"><span class="pre">startLocalQps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keepQisRunning</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</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">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startQPSMinimised</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.qps.startLocalQps" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.qps.toQpsTimeStamp">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.qps.</span></span><span class="sig-name descname"><span class="pre">toQpsTimeStamp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qps.toQpsTimeStamp" title="Link to this definition">¶</a></dt>
+<dd><p>DEPRECATED - QPS expects time passed as a string and error handling is done in QPS.
+Returns the parameter passed as a valid qps timestamp
+Assumes</p>
+<p># 1620817118182 - ACCEPTED value for QPS    - Milliseconds, 13 chars</p>
+<p># 1620817126    - time.time() Value         - Seconds</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>int/float/datetime</strong> – Timestamp, mS</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>int             : QPS valid time, mS</p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 </section>
 

quarchpy/docs/_build/html/source/quarchpy.user_interface.html

@@ -36,11 +36,163 @@
 <section id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
 </section>
-<section id="quarchpy-user-interface-user-interface-module">
-<h2>quarchpy.user_interface.user_interface module<a class="headerlink" href="#quarchpy-user-interface-user-interface-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.user_interface.user_interface">
+<span id="quarchpy-user-interface-user-interface-module"></span><h2>quarchpy.user_interface.user_interface module<a class="headerlink" href="#module-quarchpy.user_interface.user_interface" title="Link to this heading">¶</a></h2>
+<p>This module provides standard user interface elements to quarchpy functions, ensuring common style
+and support for both terminal and TestCenter (quarch internal) execution</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.User_interface">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">User_interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ui</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.User_interface" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>This class is a singleton pattern and provides common access to the user interace for user
+interaction.  The UI can be the terminal or TestCenter</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.User_interface.instance">
+<span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#quarchpy.user_interface.user_interface.User_interface.instance" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.check_path_write_permissions">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">check_path_write_permissions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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">'Please</span> <span class="pre">enter</span> <span class="pre">a</span> <span class="pre">valid</span> <span class="pre">path</span> <span class="pre">with</span> <span class="pre">write</span> <span class="pre">permissions:</span> <span class="pre">'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.check_path_write_permissions" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.dictToList">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">dictToList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableData</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.dictToList" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.displayTable">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">displayTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableData</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">message</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">tableHeaders</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">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">printToConsole</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">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.displayTable" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.endTestBlock">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">endTestBlock</span></span><span class="sig-paren">(</span><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">'End</span> <span class="pre">test</span> <span class="pre">block'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.endTestBlock" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.get_check_valid_calPath">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">get_check_valid_calPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">calPath</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">'Enter</span> <span class="pre">the</span> <span class="pre">desired</span> <span class="pre">save</span> <span class="pre">path</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">calibration</span> <span class="pre">report.'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.get_check_valid_calPath" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.is_user_admin">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">is_user_admin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.is_user_admin" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.listSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">listSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</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">message</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">selectionList</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">additionalOptions</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">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</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">indexReq</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">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.listSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logCalibrationResult">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logCalibrationResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">report</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logCalibrationResult" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logDebug">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logDebug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logDebug" title="Link to this definition">¶</a></dt>
+<dd><p>Processes a debug message and diaplays it using python standard logging or a debug message in test centre.
+:param text - a string of text:
+:param or a list of strings:</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logResults">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">test</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logResults" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logSimpleResult">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logSimpleResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logSimpleResult" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logWarning">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logWarning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logWarning" title="Link to this definition">¶</a></dt>
+<dd><p>Processes a warning message and diaplays it using python standard logging or a warning message in test centre.
+:param text - a string of text:
+:param or a list of strings:</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.niceListSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">niceListSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">selectionList</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</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">message</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">tableHeaders</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">indexReq</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.niceListSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.printText">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">printText</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillLine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminalWidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.printText" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.progressBar">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">progressBar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iteration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</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">suffix</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">decimals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill</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">fullWidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.progressBar" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.quarchSleep">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">quarchSleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sleepLength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updatePeriod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</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.user_interface.user_interface.quarchSleep" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.requestDialog">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">requestDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</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">message</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">desiredType</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">minRange</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">maxRange</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">defaultUserInput</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.user_interface.user_interface.requestDialog" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.setup_logging">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logLevel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.setup_logging" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showDialog">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showDialog</span></span><span class="sig-paren">(</span><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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</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.user_interface.user_interface.showDialog" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showImage">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</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">message</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">imagePath</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.user_interface.user_interface.showImage" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showYesNoDialog">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showYesNoDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showYesNoDialog" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.startTestBlock">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">startTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.startTestBlock" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.storeResult">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">storeResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.storeResult" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.userRangeIntSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">userRangeIntSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inputString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intLength</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.userRangeIntSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.validateUserInput">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">validateUserInput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">userStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desiredType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minRange</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxRange</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.validateUserInput" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.visual_sleep">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">visual_sleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sleepLength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updatePeriod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</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.user_interface.user_interface.visual_sleep" title="Link to this definition">¶</a></dt>
+<dd><p>Wrapper for sleep function that gives a visual indicator of the sleep time</p>
+</dd></dl>
+
 </section>
-<section id="module-contents">
-<h2>Module contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.user_interface">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.user_interface" title="Link to this heading">¶</a></h2>
 </section>
 </section>
 

quarchpy/docs/_build/html/source/quarchpy.utilities.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.utilities package &#8212; quarchpy  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b3523f8e" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=61cd365c" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
@@ -18,8 +18,9 @@
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
   
+
+  
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
   
@@ -36,11 +37,96 @@
 <section id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
 </section>
-<section id="quarchpy-utilities-testcenter-module">
-<h2>quarchpy.utilities.TestCenter module<a class="headerlink" href="#quarchpy-utilities-testcenter-module" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.utilities.TestCenter">
+<span id="quarchpy-utilities-testcenter-module"></span><h2>quarchpy.utilities.TestCenter module<a class="headerlink" href="#module-quarchpy.utilities.TestCenter" title="Link to this heading">¶</a></h2>
+<p>Implements the standard TestCenter API for Python, allowing a Python script to execute all TestCenter functions.
+This is Quarch internal use only.  Each function uses the stdin/stdout to communicate with the TestCenter process
+as such, communication is based on simple strings</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.utilities.TestCenter.beginTestBlock">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.utilities.TestCenter.</span></span><span class="sig-name descname"><span class="pre">beginTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stack_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.utilities.TestCenter.beginTestBlock" title="Link to this definition">¶</a></dt>
+<dd><p>Notes the start of a block of tests.  This allows multiple nested layers of related tests
+to improve readability of the results.  This has no effect on the test execution, only
+on the reporting of the results.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>message_text</strong> (<em>str</em>) – User message describing the test block.  This will be shown in the results</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>test_response</strong> – String returned from test function. This will be “1” on success and “0” on error</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.utilities.TestCenter.endTest">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.utilities.TestCenter.</span></span><span class="sig-name descname"><span class="pre">endTest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stack_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.utilities.TestCenter.endTest" title="Link to this definition">¶</a></dt>
+<dd><p>Orders the end of the test.  This will terminate the test parser and disponse of any resources
+held by the test libraries (including quarch module connections)</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.utilities.TestCenter.endTestBlock">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.utilities.TestCenter.</span></span><span class="sig-name descname"><span class="pre">endTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stack_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.utilities.TestCenter.endTestBlock" title="Link to this definition">¶</a></dt>
+<dd><p>Notes the end of a block of tests.  This allows multiple nested layers of related tests
+to improve readability of the results.  This has no effect on the test execution, only
+on the reporting of the results.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>test_response</strong> – String returned from test function. This will be “1” on success and “0” on error</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 function">
+<dt class="sig sig-object py" id="quarchpy.utilities.TestCenter.setup">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.utilities.TestCenter.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interface_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">command_params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stack_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.utilities.TestCenter.setup" title="Link to this definition">¶</a></dt>
+<dd><p>Sets up a test interface, passing the interface parameters onto TestCenter to process</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>interface_name</strong> (<em>str</em>) – Name of the interface to setup</p></li>
+<li><p><strong>command_params</strong> (<em>iterable object</em>) – List of parameter strings to be passed to the setup function</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>setup_response</strong> – String returned from setup function. Generally “1” or “0” as a boolean success flag</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.utilities.TestCenter.testPoint">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.utilities.TestCenter.</span></span><span class="sig-name descname"><span class="pre">testPoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">command_params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stack_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.utilities.TestCenter.testPoint" title="Link to this definition">¶</a></dt>
+<dd><p>Runs a test point from the testcenter library functions</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_name</strong> (<em>str</em>) – In the form InterfaceName.TestName</p></li>
+<li><p><strong>command_params</strong> (<em>iterable object</em>) – List of parameter strings to be passed to the test function</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>test_response</strong> – String returned from test function. This varies based on the TestPoint spec</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
-<section id="module-contents">
-<h2>Module contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
+<section id="module-quarchpy.utilities">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.utilities" title="Link to this heading">¶</a></h2>
 </section>
 </section>
 
@@ -108,11 +194,11 @@
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2020, Quarch Technology Ltd.
+      &#169;2020, Quarch Technology Ltd.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
       
       |
       <a href="../_sources/source/quarchpy.utilities.rst.txt"

quarchpy/docs/_build/html/source/readme.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 - Readme &#8212; quarchpy  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b3523f8e" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=61cd365c" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
@@ -18,8 +18,9 @@
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
   
+
+  
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
   
@@ -129,11 +130,11 @@
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2020, Quarch Technology Ltd.
+      &#169;2020, Quarch Technology Ltd.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
       
       |
       <a href="../_sources/source/readme.rst.txt"