quarchpy 2.2.14__py2.py3-none-any.whl → 2.2.16__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- quarchpy/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/__pycache__/_version.cpython-310.pyc +0 -0
- quarchpy/__pycache__/connection.cpython-310.pyc +0 -0
- quarchpy/__pycache__/install_qps.cpython-310.pyc +0 -0
- quarchpy/_version.py +1 -1
- quarchpy/config_files/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/config_files/__pycache__/quarch_config_parser.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/StreamChannels.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_QIS.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_QPS.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_ReST.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_Serial.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_TCP.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_USB.cpython-310.pyc +0 -0
- quarchpy/connection_specific/__pycache__/mDNS.cpython-310.pyc +0 -0
- quarchpy/connection_specific/connection_QIS.py +1510 -1482
- quarchpy/connection_specific/connection_Telnet.py +8 -2
- quarchpy/connection_specific/jdk_jres/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/jdk_jres/__pycache__/fix_permissions.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/serialposix.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/serialutil.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_common.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_linux.cpython-310.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_posix.cpython-310.pyc +0 -0
- quarchpy/debug/__pycache__/SystemTest.cpython-310.pyc +0 -0
- quarchpy/debug/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/debug/__pycache__/versionCompare.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device_fixture_idn_info.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device_idn_info.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/device_network_info.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/discovered_device.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/packet_processing.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/quarchArray.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/quarchPPM.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/quarchQPS.cpython-310.pyc +0 -0
- quarchpy/device/__pycache__/scanDevices.cpython-310.pyc +0 -0
- quarchpy/device/quarchArray.py +9 -5
- quarchpy/device/quarchPPM.py +7 -10
- quarchpy/disk_test/__pycache__/AbsDiskFinder.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/DiskTargetSelection.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/disk_test/__pycache__/iometerDiskFinder.cpython-310.pyc +0 -0
- quarchpy/docs/CHANGES.rst +8 -0
- quarchpy/docs/_build/doctrees/CHANGES.doctree +0 -0
- quarchpy/docs/_build/doctrees/environment.pickle +0 -0
- quarchpy/docs/_build/doctrees/source/changelog.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.connection_specific.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.device.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.qis.doctree +0 -0
- quarchpy/docs/_build/html/CHANGES.html +169 -155
- quarchpy/docs/_build/html/_sources/CHANGES.rst.txt +11 -1
- quarchpy/docs/_build/html/genindex.html +21 -9
- quarchpy/docs/_build/html/index.html +80 -78
- quarchpy/docs/_build/html/objects.inv +0 -0
- quarchpy/docs/_build/html/searchindex.js +1 -1
- quarchpy/docs/_build/html/source/changelog.html +249 -233
- quarchpy/docs/_build/html/source/quarchpy.connection_specific.html +12 -3
- quarchpy/docs/_build/html/source/quarchpy.device.html +82 -28
- quarchpy/docs/_build/html/source/quarchpy.html +8 -2
- quarchpy/docs/_build/html/source/quarchpy.qis.html +12 -3
- quarchpy/fio/__pycache__/FIO_interface.cpython-310.pyc +0 -0
- quarchpy/fio/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/install_qps.py +99 -62
- quarchpy/iometer/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/iometer/__pycache__/gen_iometer_template.cpython-310.pyc +0 -0
- quarchpy/iometer/__pycache__/iometerFuncs.cpython-310.pyc +0 -0
- quarchpy/qis/__pycache__/StreamHeaderInfo.cpython-310.pyc +0 -0
- quarchpy/qis/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/qis/__pycache__/qisFuncs.cpython-310.pyc +0 -0
- quarchpy/qps/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/qps/__pycache__/qpsFuncs.cpython-310.pyc +0 -0
- quarchpy/qps/qpsFuncs.py +4 -0
- quarchpy/user_interface/__pycache__/__init__.cpython-310.pyc +0 -0
- quarchpy/user_interface/__pycache__/user_interface.cpython-310.pyc +0 -0
- quarchpy/utilities/__pycache__/TestCenter.cpython-310.pyc +0 -0
- quarchpy/utilities/__pycache__/TimeValue.cpython-310.pyc +0 -0
- quarchpy/utilities/__pycache__/__init__.cpython-310.pyc +0 -0
- {quarchpy-2.2.14.dist-info → quarchpy-2.2.16.dist-info}/METADATA +19 -2
- {quarchpy-2.2.14.dist-info → quarchpy-2.2.16.dist-info}/RECORD +87 -87
- {quarchpy-2.2.14.dist-info → quarchpy-2.2.16.dist-info}/WHEEL +1 -1
- {quarchpy-2.2.14.dist-info → quarchpy-2.2.16.dist-info}/top_level.txt +0 -0
|
@@ -447,14 +447,14 @@ on both USB and TCP will now only return with USB</p>
|
|
|
447
447
|
|
|
448
448
|
<dl class="py method">
|
|
449
449
|
<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.startStream">
|
|
450
|
-
<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>
|
|
450
|
+
<span class="sig-name descname"><span class="pre">startStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamDuration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inMemoryData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputFileHandle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzipCompressLevel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.startStream" title="Link to this definition">¶</a></dt>
|
|
451
451
|
<dd><p>deprecated:: 2.2.13
|
|
452
452
|
Use <cite>start_stream</cite> instead.</p>
|
|
453
453
|
</dd></dl>
|
|
454
454
|
|
|
455
455
|
<dl class="py method">
|
|
456
456
|
<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.start_stream">
|
|
457
|
-
<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>
|
|
457
|
+
<span class="sig-name descname"><span class="pre">start_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.start_stream" title="Link to this definition">¶</a></dt>
|
|
458
458
|
<dd><p>Begins a stream process which will record data from the module to a CSV file or in memory CSV equivalent</p>
|
|
459
459
|
<dl class="field-list simple">
|
|
460
460
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
@@ -478,7 +478,7 @@ Use <cite>start_stream</cite> instead.</p>
|
|
|
478
478
|
|
|
479
479
|
<dl class="py method">
|
|
480
480
|
<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.start_stream_thread">
|
|
481
|
-
<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>
|
|
481
|
+
<span class="sig-name descname"><span class="pre">start_stream_thread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.start_stream_thread" title="Link to this definition">¶</a></dt>
|
|
482
482
|
<dd><dl class="field-list simple">
|
|
483
483
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
484
484
|
<dd class="field-odd"><ul class="simple">
|
|
@@ -495,6 +495,8 @@ indefinitely.</p></li>
|
|
|
495
495
|
instead of a file.</p></li>
|
|
496
496
|
<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>
|
|
497
497
|
<li><p><strong>use_gzip</strong> – If True, writes streamed data to a gzip-compressed file.</p></li>
|
|
498
|
+
<li><p><strong>gzip_compress_level</strong> – (Default: 9) The compression level (0-9) to use for gzip.
|
|
499
|
+
1 is fastest with low compression. 9 is slowest with high compression.</p></li>
|
|
498
500
|
</ul>
|
|
499
501
|
</dd>
|
|
500
502
|
</dl>
|
|
@@ -539,6 +541,13 @@ completely stopped streaming. Defaults to True.</p></li>
|
|
|
539
541
|
</dl>
|
|
540
542
|
</dd></dl>
|
|
541
543
|
|
|
544
|
+
<dl class="py method">
|
|
545
|
+
<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.streamBufferStatus">
|
|
546
|
+
<span class="sig-name descname"><span class="pre">streamBufferStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamBufferStatus" title="Link to this definition">¶</a></dt>
|
|
547
|
+
<dd><p>deprecated:: 2.2.13
|
|
548
|
+
Use <cite>stream_buffer_status</cite> instead.</p>
|
|
549
|
+
</dd></dl>
|
|
550
|
+
|
|
542
551
|
<dl class="py method">
|
|
543
552
|
<dt class="sig sig-object py" id="quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderFormat">
|
|
544
553
|
<span class="sig-name descname"><span class="pre">streamHeaderFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderFormat" title="Link to this definition">¶</a></dt>
|
|
@@ -650,6 +650,22 @@ returned None.</p>
|
|
|
650
650
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.quarchArray">
|
|
651
651
|
<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.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">quarchArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray" title="Link to this definition">¶</a></dt>
|
|
652
652
|
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
653
|
+
<dl class="py method">
|
|
654
|
+
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.quarchArray.close_connection">
|
|
655
|
+
<span class="sig-name descname"><span class="pre">close_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray.close_connection" title="Link to this definition">¶</a></dt>
|
|
656
|
+
<dd><p>Closes the connection to the module.</p>
|
|
657
|
+
<p>Handles closing logic based on connection type (PY, QIS, QPS).
|
|
658
|
+
Clears the internal connection object reference upon successful close.</p>
|
|
659
|
+
<dl class="field-list simple">
|
|
660
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
661
|
+
<dd class="field-odd"><p>“OK” on success, “FAIL” on failure or if no connection exists.</p>
|
|
662
|
+
</dd>
|
|
663
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
664
|
+
<dd class="field-even"><p>str</p>
|
|
665
|
+
</dd>
|
|
666
|
+
</dl>
|
|
667
|
+
</dd></dl>
|
|
668
|
+
|
|
653
669
|
<dl class="py method">
|
|
654
670
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.quarchArray.getSubDevice">
|
|
655
671
|
<span class="sig-name descname"><span class="pre">getSubDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray.getSubDevice" title="Link to this definition">¶</a></dt>
|
|
@@ -667,18 +683,33 @@ returned None.</p>
|
|
|
667
683
|
<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.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">subDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.subDevice" title="Link to this definition">¶</a></dt>
|
|
668
684
|
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
669
685
|
<dl class="py method">
|
|
670
|
-
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.subDevice.
|
|
671
|
-
<span class="sig-name descname"><span class="pre">
|
|
672
|
-
<dd><p>
|
|
673
|
-
<p>
|
|
686
|
+
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.subDevice.close_connection">
|
|
687
|
+
<span class="sig-name descname"><span class="pre">close_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchArray.subDevice.close_connection" title="Link to this definition">¶</a></dt>
|
|
688
|
+
<dd><p>Closes the connection to the module.</p>
|
|
689
|
+
<p>Handles closing logic based on connection type (PY, QIS, QPS).
|
|
690
|
+
Clears the internal connection object reference upon successful close.</p>
|
|
691
|
+
<dl class="field-list simple">
|
|
692
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
693
|
+
<dd class="field-odd"><p>“OK” on success, “FAIL” on failure or if no connection exists.</p>
|
|
694
|
+
</dd>
|
|
695
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
696
|
+
<dd class="field-even"><p>str</p>
|
|
697
|
+
</dd>
|
|
698
|
+
</dl>
|
|
699
|
+
</dd></dl>
|
|
700
|
+
|
|
701
|
+
<dl class="py method">
|
|
702
|
+
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.subDevice.send_command">
|
|
703
|
+
<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">CommandString</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.device.quarchArray.subDevice.send_command" title="Link to this definition">¶</a></dt>
|
|
704
|
+
<dd><p>Executes a text command on the connected device.</p>
|
|
674
705
|
<p>Sends the command string via the appropriate underlying connection object
|
|
675
706
|
(PY, QIS, or QPS) and returns the response. Handles QIS/QPS specific
|
|
676
707
|
formatting or command routing as needed.</p>
|
|
677
708
|
<dl class="field-list simple">
|
|
678
709
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
679
710
|
<dd class="field-odd"><ul class="simple">
|
|
680
|
-
<li><p><strong>
|
|
681
|
-
<li><p><strong>
|
|
711
|
+
<li><p><strong>command_string</strong> (<em>str</em>) – The text command to send (e.g., “<a href="#id9"><span class="problematic" id="id10">*</span></a>IDN?”).</p></li>
|
|
712
|
+
<li><p><strong>is_response_expected</strong> (<em>bool</em><em>, </em><em>optional</em>) – If False, the method may return
|
|
682
713
|
faster as it doesn’t wait for/read a response. Defaults to True.</p></li>
|
|
683
714
|
</ul>
|
|
684
715
|
</dd>
|
|
@@ -854,7 +885,7 @@ XLC modules), and then enables the power output if it’s off.</p>
|
|
|
854
885
|
|
|
855
886
|
<dl class="py method">
|
|
856
887
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.startStream">
|
|
857
|
-
<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">fileName</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">'streamData.txt'</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">200000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</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">'Stream</span> <span class="pre">With</span> <span class="pre">No</span> <span class="pre">Name'</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">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">streamAverage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">releaseOnData</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">separator</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">inMemoryData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">outputFileHandle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.startStream" title="Link to this definition">¶</a></dt>
|
|
888
|
+
<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">fileName</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">'streamData.txt'</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">200000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</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">'Stream</span> <span class="pre">With</span> <span class="pre">No</span> <span class="pre">Name'</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">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">streamAverage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">releaseOnData</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">separator</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">inMemoryData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">outputFileHandle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzipCompressLevel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.startStream" title="Link to this definition">¶</a></dt>
|
|
858
889
|
<dd><p>DEPRECATED: Use start_stream instead.</p>
|
|
859
890
|
<p>Starts a data stream from the device.</p>
|
|
860
891
|
<dl class="field-list simple">
|
|
@@ -862,11 +893,8 @@ XLC modules), and then enables the power output if it’s off.</p>
|
|
|
862
893
|
<dd class="field-odd"><ul class="simple">
|
|
863
894
|
<li><p><strong>fileName</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
|
|
864
895
|
<li><p><strong>fileMaxMB</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
|
|
865
|
-
<li><p><strong>streamName</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
|
|
866
896
|
<li><p><strong>streamDuration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
|
|
867
897
|
in seconds. Defaults to None (continuous).</p></li>
|
|
868
|
-
<li><p><strong>streamAverage</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
|
|
869
|
-
Defaults to None.</p></li>
|
|
870
898
|
<li><p><strong>releaseOnData</strong> (<em>bool</em>) – If True, releases the connection on data
|
|
871
899
|
reception.</p></li>
|
|
872
900
|
<li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
|
|
@@ -876,6 +904,7 @@ streamed data in memory. Defaults to None.</p></li>
|
|
|
876
904
|
stream data to. Defaults to None.</p></li>
|
|
877
905
|
<li><p><strong>useGzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
|
|
878
906
|
gzip. Defaults to None.</p></li>
|
|
907
|
+
<li><p><strong>gzipCompressLevel</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The gzip compression level</p></li>
|
|
879
908
|
</ul>
|
|
880
909
|
</dd>
|
|
881
910
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
@@ -889,18 +918,15 @@ gzip. Defaults to None.</p></li>
|
|
|
889
918
|
|
|
890
919
|
<dl class="py method">
|
|
891
920
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.start_stream">
|
|
892
|
-
<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">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'streamData.txt'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_max_mb</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">200000</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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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><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">separator</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.start_stream" title="Link to this definition">¶</a></dt>
|
|
921
|
+
<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">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'streamData.txt'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_max_mb</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">200000</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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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><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">separator</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.start_stream" title="Link to this definition">¶</a></dt>
|
|
893
922
|
<dd><p>Starts a data stream from the device.</p>
|
|
894
923
|
<dl class="field-list simple">
|
|
895
924
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
896
925
|
<dd class="field-odd"><ul class="simple">
|
|
897
926
|
<li><p><strong>file_name</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
|
|
898
927
|
<li><p><strong>file_max_mb</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
|
|
899
|
-
<li><p><strong>stream_name</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
|
|
900
928
|
<li><p><strong>stream_duration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
|
|
901
929
|
in seconds. Defaults to None (continuous).</p></li>
|
|
902
|
-
<li><p><strong>stream_average</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
|
|
903
|
-
Defaults to None.</p></li>
|
|
904
930
|
<li><p><strong>release_on_data</strong> (<em>bool</em>) – If True, releases the connection on data
|
|
905
931
|
reception.</p></li>
|
|
906
932
|
<li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
|
|
@@ -910,6 +936,7 @@ streamed data in memory. Defaults to None.</p></li>
|
|
|
910
936
|
stream data to. Defaults to None.</p></li>
|
|
911
937
|
<li><p><strong>use_gzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
|
|
912
938
|
gzip. Defaults to None.</p></li>
|
|
939
|
+
<li><p><strong>gzip_compress_level</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The gzip compression level</p></li>
|
|
913
940
|
</ul>
|
|
914
941
|
</dd>
|
|
915
942
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
@@ -2323,6 +2350,22 @@ Defaults to “5”.</p></li>
|
|
|
2323
2350
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray">
|
|
2324
2351
|
<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.device.</span></span><span class="sig-name descname"><span class="pre">quarchArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray" title="Link to this definition">¶</a></dt>
|
|
2325
2352
|
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
2353
|
+
<dl class="py method">
|
|
2354
|
+
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.close_connection">
|
|
2355
|
+
<span class="sig-name descname"><span class="pre">close_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchArray.close_connection" title="Link to this definition">¶</a></dt>
|
|
2356
|
+
<dd><p>Closes the connection to the module.</p>
|
|
2357
|
+
<p>Handles closing logic based on connection type (PY, QIS, QPS).
|
|
2358
|
+
Clears the internal connection object reference upon successful close.</p>
|
|
2359
|
+
<dl class="field-list simple">
|
|
2360
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
2361
|
+
<dd class="field-odd"><p>“OK” on success, “FAIL” on failure or if no connection exists.</p>
|
|
2362
|
+
</dd>
|
|
2363
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
2364
|
+
<dd class="field-even"><p>str</p>
|
|
2365
|
+
</dd>
|
|
2366
|
+
</dl>
|
|
2367
|
+
</dd></dl>
|
|
2368
|
+
|
|
2326
2369
|
<dl class="py method">
|
|
2327
2370
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.getSubDevice">
|
|
2328
2371
|
<span class="sig-name descname"><span class="pre">getSubDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.getSubDevice" title="Link to this definition">¶</a></dt>
|
|
@@ -2881,7 +2924,7 @@ XLC modules), and then enables the power output if it’s off.</p>
|
|
|
2881
2924
|
|
|
2882
2925
|
<dl class="py method">
|
|
2883
2926
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.startStream">
|
|
2884
|
-
<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">fileName</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">'streamData.txt'</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">200000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</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">'Stream</span> <span class="pre">With</span> <span class="pre">No</span> <span class="pre">Name'</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">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">streamAverage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">releaseOnData</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">separator</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">inMemoryData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">outputFileHandle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.startStream" title="Link to this definition">¶</a></dt>
|
|
2927
|
+
<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">fileName</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">'streamData.txt'</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">200000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamName</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">'Stream</span> <span class="pre">With</span> <span class="pre">No</span> <span class="pre">Name'</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">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">streamAverage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">releaseOnData</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">separator</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">inMemoryData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">outputFileHandle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzipCompressLevel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.startStream" title="Link to this definition">¶</a></dt>
|
|
2885
2928
|
<dd><p>DEPRECATED: Use start_stream instead.</p>
|
|
2886
2929
|
<p>Starts a data stream from the device.</p>
|
|
2887
2930
|
<dl class="field-list simple">
|
|
@@ -2889,11 +2932,8 @@ XLC modules), and then enables the power output if it’s off.</p>
|
|
|
2889
2932
|
<dd class="field-odd"><ul class="simple">
|
|
2890
2933
|
<li><p><strong>fileName</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
|
|
2891
2934
|
<li><p><strong>fileMaxMB</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
|
|
2892
|
-
<li><p><strong>streamName</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
|
|
2893
2935
|
<li><p><strong>streamDuration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
|
|
2894
2936
|
in seconds. Defaults to None (continuous).</p></li>
|
|
2895
|
-
<li><p><strong>streamAverage</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
|
|
2896
|
-
Defaults to None.</p></li>
|
|
2897
2937
|
<li><p><strong>releaseOnData</strong> (<em>bool</em>) – If True, releases the connection on data
|
|
2898
2938
|
reception.</p></li>
|
|
2899
2939
|
<li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
|
|
@@ -2903,6 +2943,7 @@ streamed data in memory. Defaults to None.</p></li>
|
|
|
2903
2943
|
stream data to. Defaults to None.</p></li>
|
|
2904
2944
|
<li><p><strong>useGzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
|
|
2905
2945
|
gzip. Defaults to None.</p></li>
|
|
2946
|
+
<li><p><strong>gzipCompressLevel</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The gzip compression level</p></li>
|
|
2906
2947
|
</ul>
|
|
2907
2948
|
</dd>
|
|
2908
2949
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
@@ -2916,18 +2957,15 @@ gzip. Defaults to None.</p></li>
|
|
|
2916
2957
|
|
|
2917
2958
|
<dl class="py method">
|
|
2918
2959
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.start_stream">
|
|
2919
|
-
<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">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'streamData.txt'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_max_mb</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">200000</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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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><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">separator</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.start_stream" title="Link to this definition">¶</a></dt>
|
|
2960
|
+
<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">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'streamData.txt'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_max_mb</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">200000</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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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><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">separator</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IO</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.quarchPPM.start_stream" title="Link to this definition">¶</a></dt>
|
|
2920
2961
|
<dd><p>Starts a data stream from the device.</p>
|
|
2921
2962
|
<dl class="field-list simple">
|
|
2922
2963
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
2923
2964
|
<dd class="field-odd"><ul class="simple">
|
|
2924
2965
|
<li><p><strong>file_name</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
|
|
2925
2966
|
<li><p><strong>file_max_mb</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
|
|
2926
|
-
<li><p><strong>stream_name</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
|
|
2927
2967
|
<li><p><strong>stream_duration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
|
|
2928
2968
|
in seconds. Defaults to None (continuous).</p></li>
|
|
2929
|
-
<li><p><strong>stream_average</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
|
|
2930
|
-
Defaults to None.</p></li>
|
|
2931
2969
|
<li><p><strong>release_on_data</strong> (<em>bool</em>) – If True, releases the connection on data
|
|
2932
2970
|
reception.</p></li>
|
|
2933
2971
|
<li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
|
|
@@ -2937,6 +2975,7 @@ streamed data in memory. Defaults to None.</p></li>
|
|
|
2937
2975
|
stream data to. Defaults to None.</p></li>
|
|
2938
2976
|
<li><p><strong>use_gzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
|
|
2939
2977
|
gzip. Defaults to None.</p></li>
|
|
2978
|
+
<li><p><strong>gzip_compress_level</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The gzip compression level</p></li>
|
|
2940
2979
|
</ul>
|
|
2941
2980
|
</dd>
|
|
2942
2981
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
@@ -3907,18 +3946,33 @@ when polling. Defaults to 0.1.</p></li>
|
|
|
3907
3946
|
<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.device.</span></span><span class="sig-name descname"><span class="pre">subDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.subDevice" title="Link to this definition">¶</a></dt>
|
|
3908
3947
|
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
3909
3948
|
<dl class="py method">
|
|
3910
|
-
<dt class="sig sig-object py" id="quarchpy.device.subDevice.
|
|
3911
|
-
<span class="sig-name descname"><span class="pre">
|
|
3912
|
-
<dd><p>
|
|
3913
|
-
<p>
|
|
3949
|
+
<dt class="sig sig-object py" id="quarchpy.device.subDevice.close_connection">
|
|
3950
|
+
<span class="sig-name descname"><span class="pre">close_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.device.subDevice.close_connection" title="Link to this definition">¶</a></dt>
|
|
3951
|
+
<dd><p>Closes the connection to the module.</p>
|
|
3952
|
+
<p>Handles closing logic based on connection type (PY, QIS, QPS).
|
|
3953
|
+
Clears the internal connection object reference upon successful close.</p>
|
|
3954
|
+
<dl class="field-list simple">
|
|
3955
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
3956
|
+
<dd class="field-odd"><p>“OK” on success, “FAIL” on failure or if no connection exists.</p>
|
|
3957
|
+
</dd>
|
|
3958
|
+
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
3959
|
+
<dd class="field-even"><p>str</p>
|
|
3960
|
+
</dd>
|
|
3961
|
+
</dl>
|
|
3962
|
+
</dd></dl>
|
|
3963
|
+
|
|
3964
|
+
<dl class="py method">
|
|
3965
|
+
<dt class="sig sig-object py" id="quarchpy.device.subDevice.send_command">
|
|
3966
|
+
<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">CommandString</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.device.subDevice.send_command" title="Link to this definition">¶</a></dt>
|
|
3967
|
+
<dd><p>Executes a text command on the connected device.</p>
|
|
3914
3968
|
<p>Sends the command string via the appropriate underlying connection object
|
|
3915
3969
|
(PY, QIS, or QPS) and returns the response. Handles QIS/QPS specific
|
|
3916
3970
|
formatting or command routing as needed.</p>
|
|
3917
3971
|
<dl class="field-list simple">
|
|
3918
3972
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
3919
3973
|
<dd class="field-odd"><ul class="simple">
|
|
3920
|
-
<li><p><strong>
|
|
3921
|
-
<li><p><strong>
|
|
3974
|
+
<li><p><strong>command_string</strong> (<em>str</em>) – The text command to send (e.g., “<a href="#id21"><span class="problematic" id="id22">*</span></a>IDN?”).</p></li>
|
|
3975
|
+
<li><p><strong>is_response_expected</strong> (<em>bool</em><em>, </em><em>optional</em>) – If False, the method may return
|
|
3922
3976
|
faster as it doesn’t wait for/read a response. Defaults to True.</p></li>
|
|
3923
3977
|
</ul>
|
|
3924
3978
|
</dd>
|