quarchpy 2.2.15__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.
Files changed (85) hide show
  1. quarchpy/__pycache__/__init__.cpython-310.pyc +0 -0
  2. quarchpy/__pycache__/_version.cpython-310.pyc +0 -0
  3. quarchpy/__pycache__/connection.cpython-310.pyc +0 -0
  4. quarchpy/__pycache__/install_qps.cpython-310.pyc +0 -0
  5. quarchpy/_version.py +1 -1
  6. quarchpy/config_files/__pycache__/__init__.cpython-310.pyc +0 -0
  7. quarchpy/config_files/__pycache__/quarch_config_parser.cpython-310.pyc +0 -0
  8. quarchpy/connection_specific/__pycache__/StreamChannels.cpython-310.pyc +0 -0
  9. quarchpy/connection_specific/__pycache__/__init__.cpython-310.pyc +0 -0
  10. quarchpy/connection_specific/__pycache__/connection_QIS.cpython-310.pyc +0 -0
  11. quarchpy/connection_specific/__pycache__/connection_QPS.cpython-310.pyc +0 -0
  12. quarchpy/connection_specific/__pycache__/connection_ReST.cpython-310.pyc +0 -0
  13. quarchpy/connection_specific/__pycache__/connection_Serial.cpython-310.pyc +0 -0
  14. quarchpy/connection_specific/__pycache__/connection_TCP.cpython-310.pyc +0 -0
  15. quarchpy/connection_specific/__pycache__/connection_USB.cpython-310.pyc +0 -0
  16. quarchpy/connection_specific/__pycache__/mDNS.cpython-310.pyc +0 -0
  17. quarchpy/connection_specific/connection_QIS.py +1510 -1485
  18. quarchpy/connection_specific/jdk_jres/__pycache__/__init__.cpython-310.pyc +0 -0
  19. quarchpy/connection_specific/jdk_jres/__pycache__/fix_permissions.cpython-310.pyc +0 -0
  20. quarchpy/connection_specific/serial/__pycache__/__init__.cpython-310.pyc +0 -0
  21. quarchpy/connection_specific/serial/__pycache__/serialposix.cpython-310.pyc +0 -0
  22. quarchpy/connection_specific/serial/__pycache__/serialutil.cpython-310.pyc +0 -0
  23. quarchpy/connection_specific/serial/tools/__pycache__/__init__.cpython-310.pyc +0 -0
  24. quarchpy/connection_specific/serial/tools/__pycache__/list_ports.cpython-310.pyc +0 -0
  25. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_common.cpython-310.pyc +0 -0
  26. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_linux.cpython-310.pyc +0 -0
  27. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_posix.cpython-310.pyc +0 -0
  28. quarchpy/debug/__pycache__/SystemTest.cpython-310.pyc +0 -0
  29. quarchpy/debug/__pycache__/__init__.cpython-310.pyc +0 -0
  30. quarchpy/debug/__pycache__/versionCompare.cpython-310.pyc +0 -0
  31. quarchpy/device/__pycache__/__init__.cpython-310.pyc +0 -0
  32. quarchpy/device/__pycache__/device.cpython-310.pyc +0 -0
  33. quarchpy/device/__pycache__/device_fixture_idn_info.cpython-310.pyc +0 -0
  34. quarchpy/device/__pycache__/device_idn_info.cpython-310.pyc +0 -0
  35. quarchpy/device/__pycache__/device_network_info.cpython-310.pyc +0 -0
  36. quarchpy/device/__pycache__/discovered_device.cpython-310.pyc +0 -0
  37. quarchpy/device/__pycache__/packet_processing.cpython-310.pyc +0 -0
  38. quarchpy/device/__pycache__/quarchArray.cpython-310.pyc +0 -0
  39. quarchpy/device/__pycache__/quarchPPM.cpython-310.pyc +0 -0
  40. quarchpy/device/__pycache__/quarchQPS.cpython-310.pyc +0 -0
  41. quarchpy/device/__pycache__/scanDevices.cpython-310.pyc +0 -0
  42. quarchpy/device/quarchPPM.py +7 -10
  43. quarchpy/disk_test/__pycache__/AbsDiskFinder.cpython-310.pyc +0 -0
  44. quarchpy/disk_test/__pycache__/DiskTargetSelection.cpython-310.pyc +0 -0
  45. quarchpy/disk_test/__pycache__/__init__.cpython-310.pyc +0 -0
  46. quarchpy/disk_test/__pycache__/iometerDiskFinder.cpython-310.pyc +0 -0
  47. quarchpy/docs/CHANGES.rst +4 -0
  48. quarchpy/docs/_build/doctrees/CHANGES.doctree +0 -0
  49. quarchpy/docs/_build/doctrees/environment.pickle +0 -0
  50. quarchpy/docs/_build/doctrees/source/changelog.doctree +0 -0
  51. quarchpy/docs/_build/doctrees/source/quarchpy.connection_specific.doctree +0 -0
  52. quarchpy/docs/_build/doctrees/source/quarchpy.device.doctree +0 -0
  53. quarchpy/docs/_build/doctrees/source/quarchpy.qis.doctree +0 -0
  54. quarchpy/docs/_build/html/CHANGES.html +163 -157
  55. quarchpy/docs/_build/html/_sources/CHANGES.rst.txt +4 -0
  56. quarchpy/docs/_build/html/genindex.html +7 -3
  57. quarchpy/docs/_build/html/index.html +80 -79
  58. quarchpy/docs/_build/html/objects.inv +0 -0
  59. quarchpy/docs/_build/html/searchindex.js +1 -1
  60. quarchpy/docs/_build/html/source/changelog.html +243 -236
  61. quarchpy/docs/_build/html/source/quarchpy.connection_specific.html +12 -3
  62. quarchpy/docs/_build/html/source/quarchpy.device.html +8 -16
  63. quarchpy/docs/_build/html/source/quarchpy.html +2 -0
  64. quarchpy/docs/_build/html/source/quarchpy.qis.html +12 -3
  65. quarchpy/fio/__pycache__/FIO_interface.cpython-310.pyc +0 -0
  66. quarchpy/fio/__pycache__/__init__.cpython-310.pyc +0 -0
  67. quarchpy/install_qps.py +99 -62
  68. quarchpy/iometer/__pycache__/__init__.cpython-310.pyc +0 -0
  69. quarchpy/iometer/__pycache__/gen_iometer_template.cpython-310.pyc +0 -0
  70. quarchpy/iometer/__pycache__/iometerFuncs.cpython-310.pyc +0 -0
  71. quarchpy/qis/__pycache__/StreamHeaderInfo.cpython-310.pyc +0 -0
  72. quarchpy/qis/__pycache__/__init__.cpython-310.pyc +0 -0
  73. quarchpy/qis/__pycache__/qisFuncs.cpython-310.pyc +0 -0
  74. quarchpy/qps/__pycache__/__init__.cpython-310.pyc +0 -0
  75. quarchpy/qps/__pycache__/qpsFuncs.cpython-310.pyc +0 -0
  76. quarchpy/qps/qpsFuncs.py +4 -0
  77. quarchpy/user_interface/__pycache__/__init__.cpython-310.pyc +0 -0
  78. quarchpy/user_interface/__pycache__/user_interface.cpython-310.pyc +0 -0
  79. quarchpy/utilities/__pycache__/TestCenter.cpython-310.pyc +0 -0
  80. quarchpy/utilities/__pycache__/TimeValue.cpython-310.pyc +0 -0
  81. quarchpy/utilities/__pycache__/__init__.cpython-310.pyc +0 -0
  82. {quarchpy-2.2.15.dist-info → quarchpy-2.2.16.dist-info}/METADATA +15 -2
  83. {quarchpy-2.2.15.dist-info → quarchpy-2.2.16.dist-info}/RECORD +85 -85
  84. {quarchpy-2.2.15.dist-info → quarchpy-2.2.16.dist-info}/WHEEL +1 -1
  85. {quarchpy-2.2.15.dist-info → quarchpy-2.2.16.dist-info}/top_level.txt +0 -0
quarchpy/docs/_build/html/source/quarchpy.connection_specific.html CHANGED
@@ -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">&#x2192;</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">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderFormat" title="Link to this definition">¶</a></dt>
quarchpy/docs/_build/html/source/quarchpy.device.html CHANGED
@@ -885,7 +885,7 @@ XLC modules), and then enables the power output if it’s off.</p>
885
885
 
886
886
  <dl class="py method">
887
887
  <dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.startStream">
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><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.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">&#x2192;</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>
889
889
  <dd><p>DEPRECATED: Use start_stream instead.</p>
890
890
  <p>Starts a data stream from the device.</p>
891
891
  <dl class="field-list simple">
@@ -893,11 +893,8 @@ XLC modules), and then enables the power output if it’s off.</p>
893
893
  <dd class="field-odd"><ul class="simple">
894
894
  <li><p><strong>fileName</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
895
895
  <li><p><strong>fileMaxMB</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
896
- <li><p><strong>streamName</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
897
896
  <li><p><strong>streamDuration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
898
897
  in seconds. Defaults to None (continuous).</p></li>
899
- <li><p><strong>streamAverage</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
900
- Defaults to None.</p></li>
901
898
  <li><p><strong>releaseOnData</strong> (<em>bool</em>) – If True, releases the connection on data
902
899
  reception.</p></li>
903
900
  <li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
@@ -907,6 +904,7 @@ streamed data in memory. Defaults to None.</p></li>
907
904
  stream data to. Defaults to None.</p></li>
908
905
  <li><p><strong>useGzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
909
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>
910
908
  </ul>
911
909
  </dd>
912
910
  <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -920,18 +918,15 @@ gzip. Defaults to None.</p></li>
920
918
 
921
919
  <dl class="py method">
922
920
  <dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.start_stream">
923
- <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">&#x2192;</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">&#x2192;</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>
924
922
  <dd><p>Starts a data stream from the device.</p>
925
923
  <dl class="field-list simple">
926
924
  <dt class="field-odd">Parameters<span class="colon">:</span></dt>
927
925
  <dd class="field-odd"><ul class="simple">
928
926
  <li><p><strong>file_name</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
929
927
  <li><p><strong>file_max_mb</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
930
- <li><p><strong>stream_name</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
931
928
  <li><p><strong>stream_duration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
932
929
  in seconds. Defaults to None (continuous).</p></li>
933
- <li><p><strong>stream_average</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
934
- Defaults to None.</p></li>
935
930
  <li><p><strong>release_on_data</strong> (<em>bool</em>) – If True, releases the connection on data
936
931
  reception.</p></li>
937
932
  <li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
@@ -941,6 +936,7 @@ streamed data in memory. Defaults to None.</p></li>
941
936
  stream data to. Defaults to None.</p></li>
942
937
  <li><p><strong>use_gzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
943
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>
944
940
  </ul>
945
941
  </dd>
946
942
  <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -2928,7 +2924,7 @@ XLC modules), and then enables the power output if it’s off.</p>
2928
2924
 
2929
2925
  <dl class="py method">
2930
2926
  <dt class="sig sig-object py" id="quarchpy.device.quarchPPM.startStream">
2931
- <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">&#x2192;</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">&#x2192;</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>
2932
2928
  <dd><p>DEPRECATED: Use start_stream instead.</p>
2933
2929
  <p>Starts a data stream from the device.</p>
2934
2930
  <dl class="field-list simple">
@@ -2936,11 +2932,8 @@ XLC modules), and then enables the power output if it’s off.</p>
2936
2932
  <dd class="field-odd"><ul class="simple">
2937
2933
  <li><p><strong>fileName</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
2938
2934
  <li><p><strong>fileMaxMB</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
2939
- <li><p><strong>streamName</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
2940
2935
  <li><p><strong>streamDuration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
2941
2936
  in seconds. Defaults to None (continuous).</p></li>
2942
- <li><p><strong>streamAverage</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
2943
- Defaults to None.</p></li>
2944
2937
  <li><p><strong>releaseOnData</strong> (<em>bool</em>) – If True, releases the connection on data
2945
2938
  reception.</p></li>
2946
2939
  <li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
@@ -2950,6 +2943,7 @@ streamed data in memory. Defaults to None.</p></li>
2950
2943
  stream data to. Defaults to None.</p></li>
2951
2944
  <li><p><strong>useGzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
2952
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>
2953
2947
  </ul>
2954
2948
  </dd>
2955
2949
  <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -2963,18 +2957,15 @@ gzip. Defaults to None.</p></li>
2963
2957
 
2964
2958
  <dl class="py method">
2965
2959
  <dt class="sig sig-object py" id="quarchpy.device.quarchPPM.start_stream">
2966
- <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">&#x2192;</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">&#x2192;</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>
2967
2961
  <dd><p>Starts a data stream from the device.</p>
2968
2962
  <dl class="field-list simple">
2969
2963
  <dt class="field-odd">Parameters<span class="colon">:</span></dt>
2970
2964
  <dd class="field-odd"><ul class="simple">
2971
2965
  <li><p><strong>file_name</strong> (<em>str</em>) – The name of the file to stream data to.</p></li>
2972
2966
  <li><p><strong>file_max_mb</strong> (<em>int</em>) – The maximum size of the output file in megabytes.</p></li>
2973
- <li><p><strong>stream_name</strong> (<em>str</em>) – A descriptive name for the stream.</p></li>
2974
2967
  <li><p><strong>stream_duration</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – The duration for the stream to run
2975
2968
  in seconds. Defaults to None (continuous).</p></li>
2976
- <li><p><strong>stream_average</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – The number of samples to average.
2977
- Defaults to None.</p></li>
2978
2969
  <li><p><strong>release_on_data</strong> (<em>bool</em>) – If True, releases the connection on data
2979
2970
  reception.</p></li>
2980
2971
  <li><p><strong>separator</strong> (<em>str</em>) – The separator character to use in the output file.</p></li>
@@ -2984,6 +2975,7 @@ streamed data in memory. Defaults to None.</p></li>
2984
2975
  stream data to. Defaults to None.</p></li>
2985
2976
  <li><p><strong>use_gzip</strong> (<em>Optional</em><em>[</em><em>bool</em><em>]</em>) – If True, compresses the output file using
2986
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>
2987
2979
  </ul>
2988
2980
  </dd>
2989
2981
  <dt class="field-even">Returns<span class="colon">:</span></dt>
quarchpy/docs/_build/html/source/quarchpy.html CHANGED
@@ -375,6 +375,7 @@
375
375
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.start_stream_thread"><code class="docutils literal notranslate"><span class="pre">QisInterface.start_stream_thread()</span></code></a></li>
376
376
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.stopStream"><code class="docutils literal notranslate"><span class="pre">QisInterface.stopStream()</span></code></a></li>
377
377
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.stop_stream"><code class="docutils literal notranslate"><span class="pre">QisInterface.stop_stream()</span></code></a></li>
378
+ <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.streamBufferStatus"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamBufferStatus()</span></code></a></li>
378
379
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.streamHeaderFormat"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamHeaderFormat()</span></code></a></li>
379
380
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.streamInterrupt"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamInterrupt()</span></code></a></li>
380
381
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.qis.html#quarchpy.qis.QisInterface.streamRunningStatus"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamRunningStatus()</span></code></a></li>
@@ -490,6 +491,7 @@
490
491
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.start_stream_thread"><code class="docutils literal notranslate"><span class="pre">QisInterface.start_stream_thread()</span></code></a></li>
491
492
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.stopStream"><code class="docutils literal notranslate"><span class="pre">QisInterface.stopStream()</span></code></a></li>
492
493
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.stop_stream"><code class="docutils literal notranslate"><span class="pre">QisInterface.stop_stream()</span></code></a></li>
494
+ <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.streamBufferStatus"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamBufferStatus()</span></code></a></li>
493
495
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.streamHeaderFormat"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamHeaderFormat()</span></code></a></li>
494
496
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.streamInterrupt"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamInterrupt()</span></code></a></li>
495
497
  <li class="toctree-l4"><a class="reference internal" href="quarchpy.connection_specific.html#quarchpy.connection_specific.connection_QIS.QisInterface.streamRunningStatus"><code class="docutils literal notranslate"><span class="pre">QisInterface.streamRunningStatus()</span></code></a></li>
quarchpy/docs/_build/html/source/quarchpy.qis.html CHANGED
@@ -528,14 +528,14 @@ on both USB and TCP will now only return with USB</p>
528
528
 
529
529
  <dl class="py method">
530
530
  <dt class="sig sig-object py" id="quarchpy.qis.QisInterface.startStream">
531
- <span class="sig-name descname"><span class="pre">startStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamDuration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inMemoryData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputFileHandle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.startStream" title="Link to this definition">¶</a></dt>
531
+ <span class="sig-name descname"><span class="pre">startStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileMaxMB</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">releaseOnData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">streamDuration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inMemoryData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputFileHandle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useGzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzipCompressLevel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.startStream" title="Link to this definition">¶</a></dt>
532
532
  <dd><p>deprecated:: 2.2.13
533
533
  Use <cite>start_stream</cite> instead.</p>
534
534
  </dd></dl>
535
535
 
536
536
  <dl class="py method">
537
537
  <dt class="sig sig-object py" id="quarchpy.qis.QisInterface.start_stream">
538
- <span class="sig-name descname"><span class="pre">start_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream" title="Link to this definition">¶</a></dt>
538
+ <span class="sig-name descname"><span class="pre">start_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">StringIO</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream" title="Link to this definition">¶</a></dt>
539
539
  <dd><p>Begins a stream process which will record data from the module to a CSV file or in memory CSV equivalent</p>
540
540
  <dl class="field-list simple">
541
541
  <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -559,7 +559,7 @@ Use <cite>start_stream</cite> instead.</p>
559
559
 
560
560
  <dl class="py method">
561
561
  <dt class="sig sig-object py" id="quarchpy.qis.QisInterface.start_stream_thread">
562
- <span class="sig-name descname"><span class="pre">start_stream_thread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream_thread" title="Link to this definition">¶</a></dt>
562
+ <span class="sig-name descname"><span class="pre">start_stream_thread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_file_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_on_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_memory_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file_handle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_gzip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gzip_compress_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">9</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.qis.QisInterface.start_stream_thread" title="Link to this definition">¶</a></dt>
563
563
  <dd><dl class="field-list simple">
564
564
  <dt class="field-odd">Parameters<span class="colon">:</span></dt>
565
565
  <dd class="field-odd"><ul class="simple">
@@ -576,6 +576,8 @@ indefinitely.</p></li>
576
576
  instead of a file.</p></li>
577
577
  <li><p><strong>output_file_handle</strong> – A pre-opened file handle where data will be written. If set, file_name is ignored.</p></li>
578
578
  <li><p><strong>use_gzip</strong> – If True, writes streamed data to a gzip-compressed file.</p></li>
579
+ <li><p><strong>gzip_compress_level</strong> – (Default: 9) The compression level (0-9) to use for gzip.
580
+ 1 is fastest with low compression. 9 is slowest with high compression.</p></li>
579
581
  </ul>
580
582
  </dd>
581
583
  </dl>
@@ -620,6 +622,13 @@ completely stopped streaming. Defaults to True.</p></li>
620
622
  </dl>
621
623
  </dd></dl>
622
624
 
625
+ <dl class="py method">
626
+ <dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamBufferStatus">
627
+ <span class="sig-name descname"><span class="pre">streamBufferStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.streamBufferStatus" title="Link to this definition">¶</a></dt>
628
+ <dd><p>deprecated:: 2.2.13
629
+ Use <cite>stream_buffer_status</cite> instead.</p>
630
+ </dd></dl>
631
+
623
632
  <dl class="py method">
624
633
  <dt class="sig sig-object py" id="quarchpy.qis.QisInterface.streamHeaderFormat">
625
634
  <span class="sig-name descname"><span class="pre">streamHeaderFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#quarchpy.qis.QisInterface.streamHeaderFormat" title="Link to this definition">¶</a></dt>