quarchpy 2.1.13.dev1__py2.py3-none-any.whl → 2.1.14__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- quarchpy/.idea/.name +1 -1
- quarchpy/.idea/modules.xml +1 -0
- quarchpy/.idea/quarchpy.iml +4 -1
- quarchpy/.idea/workspace.xml +208 -11
- quarchpy/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/__pycache__/_version.cpython-311.pyc +0 -0
- quarchpy/__pycache__/connection.cpython-311.pyc +0 -0
- quarchpy/__pycache__/run.cpython-311.pyc +0 -0
- quarchpy/_version.py +1 -1
- quarchpy/config_files/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/config_files/__pycache__/quarch_config_parser.cpython-311.pyc +0 -0
- quarchpy/connection_specific/QPS/commandLineOptions.txt +12 -10
- quarchpy/connection_specific/QPS/qis/qis.jar +0 -0
- quarchpy/connection_specific/QPS/qis/qis_lib/{CInterface-1.7.03.jar → CInterface-1.7.04.jar} +0 -0
- quarchpy/connection_specific/QPS/qis/qis_lib/{QuarchCommon-0.2.5.jar → QuarchCommon-0.2.6.jar} +0 -0
- quarchpy/connection_specific/QPS/qis/qis_lib/commons-lang3-3.2.1.jar +0 -0
- quarchpy/connection_specific/QPS/qps.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/QuarchCommon-0.2.6.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/istack-commons-runtime-3.0.11.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/jakarta.activation-api-2.1.0.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/jakarta.xml.bind-api-3.0.0.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/jaxb-core-3.0.0.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/jaxb-impl-3.0.0.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/jaxb-runtime-3.0.0.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/qis-1.39.jar +0 -0
- quarchpy/connection_specific/QPS/qps_lib/txw2-3.0.0.jar +0 -0
- quarchpy/connection_specific/QPS/scriptCommands.txt +2 -2
- quarchpy/connection_specific/__pycache__/StreamChannels.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_QIS.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_QPS.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_ReST.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_Serial.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_TCP.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_Telnet.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_USB.cpython-311.pyc +0 -0
- quarchpy/connection_specific/__pycache__/connection_mDNS.cpython-311.pyc +0 -0
- quarchpy/connection_specific/connection_QIS.py +246 -331
- quarchpy/connection_specific/connection_QPS.py +1 -1
- quarchpy/connection_specific/connection_ReST.py +26 -16
- quarchpy/connection_specific/connection_TCP.py +1 -1
- quarchpy/connection_specific/connection_mDNS.py +46 -0
- quarchpy/connection_specific/serial/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/serialutil.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/serialwin32.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/__pycache__/win32.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_common.cpython-311.pyc +0 -0
- quarchpy/connection_specific/serial/tools/__pycache__/list_ports_windows.cpython-311.pyc +0 -0
- quarchpy/debug/__pycache__/SystemTest.cpython-311.pyc +0 -0
- quarchpy/debug/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/debug/__pycache__/module_debug.cpython-311.pyc +0 -0
- quarchpy/debug/__pycache__/simple_terminal.cpython-311.pyc +0 -0
- quarchpy/debug/__pycache__/upgrade_quarchpy.cpython-311.pyc +0 -0
- quarchpy/debug/__pycache__/versionCompare.cpython-311.pyc +0 -0
- quarchpy/device/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/device/__pycache__/device.cpython-311.pyc +0 -0
- quarchpy/device/__pycache__/quarchArray.cpython-311.pyc +0 -0
- quarchpy/device/__pycache__/quarchPPM.cpython-311.pyc +0 -0
- quarchpy/device/__pycache__/quarchQPS.cpython-311.pyc +0 -0
- quarchpy/device/__pycache__/scanDevices.cpython-311.pyc +0 -0
- quarchpy/device/device.py +2 -0
- quarchpy/device/quarchPPM.py +2 -2
- quarchpy/device/quarchQPS.py +95 -86
- quarchpy/device/scanDevices.py +13 -3
- quarchpy/disk_test/__pycache__/AbsDiskFinder.cpython-311.pyc +0 -0
- quarchpy/disk_test/__pycache__/DiskTargetSelection.cpython-311.pyc +0 -0
- quarchpy/disk_test/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/disk_test/__pycache__/iometerDiskFinder.cpython-311.pyc +0 -0
- quarchpy/docs/CHANGES.rst +11 -1
- quarchpy/docs/_build/doctrees/CHANGES.doctree +0 -0
- quarchpy/docs/_build/doctrees/environment.pickle +0 -0
- quarchpy/docs/_build/doctrees/index.doctree +0 -0
- quarchpy/docs/_build/doctrees/readme.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/changelog.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/licenses.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/modules.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.calibration.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.config_files.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.connection_specific.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.debug.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.device.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.disk_test.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.fio.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.iometer.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.qis.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.qps.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.user_interface.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/quarchpy.utilities.doctree +0 -0
- quarchpy/docs/_build/doctrees/source/readme.doctree +0 -0
- quarchpy/docs/_build/html/.buildinfo +1 -1
- quarchpy/docs/_build/html/CHANGES.html +198 -156
- quarchpy/docs/_build/html/_sources/CHANGES.rst.txt +30 -0
- quarchpy/docs/_build/html/_static/alabaster.css +3 -1
- quarchpy/docs/_build/html/_static/basic.css +47 -27
- quarchpy/docs/_build/html/_static/doctools.js +107 -274
- quarchpy/docs/_build/html/_static/documentation_options.js +5 -4
- quarchpy/docs/_build/html/_static/language_data.js +2 -100
- quarchpy/docs/_build/html/_static/pygments.css +1 -0
- quarchpy/docs/_build/html/_static/searchtools.js +440 -395
- quarchpy/docs/_build/html/_static/sphinx_highlight.js +154 -0
- quarchpy/docs/_build/html/genindex.html +263 -87
- quarchpy/docs/_build/html/index.html +68 -63
- quarchpy/docs/_build/html/objects.inv +0 -0
- quarchpy/docs/_build/html/py-modindex.html +9 -11
- quarchpy/docs/_build/html/readme.html +26 -27
- quarchpy/docs/_build/html/search.html +8 -10
- quarchpy/docs/_build/html/searchindex.js +1 -1
- quarchpy/docs/_build/html/source/changelog.html +249 -201
- quarchpy/docs/_build/html/source/licenses.html +23 -24
- quarchpy/docs/_build/html/source/modules.html +24 -17
- quarchpy/docs/_build/html/source/quarchpy.calibration.html +44 -45
- quarchpy/docs/_build/html/source/quarchpy.config_files.html +25 -26
- quarchpy/docs/_build/html/source/quarchpy.connection_specific.html +239 -133
- quarchpy/docs/_build/html/source/quarchpy.debug.html +57 -54
- quarchpy/docs/_build/html/source/quarchpy.device.html +245 -211
- quarchpy/docs/_build/html/source/quarchpy.disk_test.html +75 -76
- quarchpy/docs/_build/html/source/quarchpy.fio.html +33 -34
- quarchpy/docs/_build/html/source/quarchpy.html +518 -61
- quarchpy/docs/_build/html/source/quarchpy.iometer.html +130 -44
- quarchpy/docs/_build/html/source/quarchpy.qis.html +420 -44
- quarchpy/docs/_build/html/source/quarchpy.qps.html +44 -43
- quarchpy/docs/_build/html/source/quarchpy.user_interface.html +70 -120
- quarchpy/docs/_build/html/source/quarchpy.utilities.html +39 -40
- quarchpy/docs/_build/html/source/readme.html +26 -27
- quarchpy/fio/__pycache__/FIO_interface.cpython-311.pyc +0 -0
- quarchpy/fio/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/fio/__pycache__/fioDiskFinder.cpython-311.pyc +0 -0
- quarchpy/iometer/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/iometer/__pycache__/gen_iometer_template.cpython-311.pyc +0 -0
- quarchpy/iometer/__pycache__/iometerFuncs.cpython-311.pyc +0 -0
- quarchpy/qis/__pycache__/StreamHeaderInfo.cpython-311.pyc +0 -0
- quarchpy/qis/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/qis/__pycache__/qisFuncs.cpython-311.pyc +0 -0
- quarchpy/qis/qisFuncs.py +25 -42
- quarchpy/qps/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/qps/__pycache__/qpsFuncs.cpython-311.pyc +0 -0
- quarchpy/qps/qpsFuncs.py +18 -19
- quarchpy/user_interface/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/user_interface/__pycache__/user_interface.cpython-311.pyc +0 -0
- quarchpy/user_interface/user_interface.py +156 -137
- quarchpy/utilities/TestCenter.py +11 -16
- quarchpy/utilities/Version.py +50 -0
- quarchpy/utilities/__pycache__/TestCenter.cpython-311.pyc +0 -0
- quarchpy/utilities/__pycache__/TimeValue.cpython-311.pyc +0 -0
- quarchpy/utilities/__pycache__/Version.cpython-311.pyc +0 -0
- quarchpy/utilities/__pycache__/__init__.cpython-311.pyc +0 -0
- quarchpy/venv/.gitignore +2 -0
- quarchpy/venv/Include/Python-ast.h +535 -0
- quarchpy/venv/Include/Python.h +181 -0
- quarchpy/venv/Include/abstract.h +1396 -0
- quarchpy/venv/Include/asdl.h +45 -0
- quarchpy/venv/Include/ast.h +13 -0
- quarchpy/venv/Include/bitset.h +32 -0
- quarchpy/venv/Include/boolobject.h +36 -0
- quarchpy/venv/Include/bufferobject.h +33 -0
- quarchpy/venv/Include/bytearrayobject.h +57 -0
- quarchpy/venv/Include/bytes_methods.h +75 -0
- quarchpy/venv/Include/bytesobject.h +27 -0
- quarchpy/venv/Include/cStringIO.h +73 -0
- quarchpy/venv/Include/cellobject.h +28 -0
- quarchpy/venv/Include/ceval.h +154 -0
- quarchpy/venv/Include/classobject.h +83 -0
- quarchpy/venv/Include/cobject.h +89 -0
- quarchpy/venv/Include/code.h +116 -0
- quarchpy/venv/Include/codecs.h +212 -0
- quarchpy/venv/Include/compile.h +40 -0
- quarchpy/venv/Include/complexobject.h +66 -0
- quarchpy/venv/Include/datetime.h +239 -0
- quarchpy/venv/Include/descrobject.h +94 -0
- quarchpy/venv/Include/dictobject.h +160 -0
- quarchpy/venv/Include/dtoa.h +15 -0
- quarchpy/venv/Include/enumobject.h +17 -0
- quarchpy/venv/Include/errcode.h +37 -0
- quarchpy/venv/Include/eval.h +25 -0
- quarchpy/venv/Include/fileobject.h +97 -0
- quarchpy/venv/Include/floatobject.h +140 -0
- quarchpy/venv/Include/frameobject.h +89 -0
- quarchpy/venv/Include/funcobject.h +76 -0
- quarchpy/venv/Include/genobject.h +40 -0
- quarchpy/venv/Include/graminit.h +87 -0
- quarchpy/venv/Include/grammar.h +94 -0
- quarchpy/venv/Include/import.h +71 -0
- quarchpy/venv/Include/intobject.h +84 -0
- quarchpy/venv/Include/intrcheck.h +15 -0
- quarchpy/venv/Include/iterobject.h +23 -0
- quarchpy/venv/Include/listobject.h +68 -0
- quarchpy/venv/Include/longintrepr.h +103 -0
- quarchpy/venv/Include/longobject.h +135 -0
- quarchpy/venv/Include/marshal.h +25 -0
- quarchpy/venv/Include/memoryobject.h +74 -0
- quarchpy/venv/Include/metagrammar.h +18 -0
- quarchpy/venv/Include/methodobject.h +93 -0
- quarchpy/venv/Include/modsupport.h +134 -0
- quarchpy/venv/Include/moduleobject.h +24 -0
- quarchpy/venv/Include/node.h +41 -0
- quarchpy/venv/Include/object.h +1046 -0
- quarchpy/venv/Include/objimpl.h +369 -0
- quarchpy/venv/Include/opcode.h +171 -0
- quarchpy/venv/Include/osdefs.h +63 -0
- quarchpy/venv/Include/parsetok.h +64 -0
- quarchpy/venv/Include/patchlevel.h +43 -0
- quarchpy/venv/Include/pgen.h +18 -0
- quarchpy/venv/Include/pgenheaders.h +43 -0
- quarchpy/venv/Include/py_curses.h +177 -0
- quarchpy/venv/Include/pyarena.h +62 -0
- quarchpy/venv/Include/pycapsule.h +56 -0
- quarchpy/venv/Include/pyconfig.h +770 -0
- quarchpy/venv/Include/pyctype.h +31 -0
- quarchpy/venv/Include/pydebug.h +41 -0
- quarchpy/venv/Include/pyerrors.h +329 -0
- quarchpy/venv/Include/pyexpat.h +50 -0
- quarchpy/venv/Include/pyfpe.h +176 -0
- quarchpy/venv/Include/pygetopt.h +18 -0
- quarchpy/venv/Include/pymacconfig.h +102 -0
- quarchpy/venv/Include/pymactoolbox.h +232 -0
- quarchpy/venv/Include/pymath.h +214 -0
- quarchpy/venv/Include/pymem.h +122 -0
- quarchpy/venv/Include/pyport.h +950 -0
- quarchpy/venv/Include/pystate.h +200 -0
- quarchpy/venv/Include/pystrcmp.h +23 -0
- quarchpy/venv/Include/pystrtod.h +45 -0
- quarchpy/venv/Include/pythonrun.h +181 -0
- quarchpy/venv/Include/pythread.h +41 -0
- quarchpy/venv/Include/rangeobject.h +28 -0
- quarchpy/venv/Include/setobject.h +99 -0
- quarchpy/venv/Include/sliceobject.h +50 -0
- quarchpy/venv/Include/stringobject.h +210 -0
- quarchpy/venv/Include/structmember.h +99 -0
- quarchpy/venv/Include/structseq.h +41 -0
- quarchpy/venv/Include/symtable.h +98 -0
- quarchpy/venv/Include/sysmodule.h +31 -0
- quarchpy/venv/Include/timefuncs.h +26 -0
- quarchpy/venv/Include/token.h +85 -0
- quarchpy/venv/Include/traceback.h +31 -0
- quarchpy/venv/Include/tupleobject.h +61 -0
- quarchpy/venv/Include/ucnhash.h +33 -0
- quarchpy/venv/Include/unicodeobject.h +1413 -0
- quarchpy/venv/Include/warnings.h +23 -0
- quarchpy/venv/Include/weakrefobject.h +82 -0
- quarchpy/venv/Lib/os.py +742 -0
- quarchpy/venv/Lib/os.pyc +0 -0
- quarchpy/venv/Lib/site-packages/_virtualenv.pth +1 -0
- quarchpy/venv/Lib/site-packages/_virtualenv.py +130 -0
- quarchpy/venv/Lib/site-packages/_virtualenv.pyc +0 -0
- quarchpy/venv/Lib/site-packages/easy_install.py +5 -0
- quarchpy/venv/Lib/site-packages/pip/__init__.py +18 -0
- quarchpy/venv/Lib/site-packages/pip/__main__.py +26 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/__init__.py +17 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/build_env.py +242 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cache.py +346 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/__init__.py +4 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/autocompletion.py +164 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/base_command.py +260 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/cmdoptions.py +971 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/command_context.py +36 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/main.py +75 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/main_parser.py +96 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/parser.py +285 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/progress_bars.py +280 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/req_command.py +436 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/spinners.py +173 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/cli/status_codes.py +8 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/__init__.py +123 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/cache.py +234 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/check.py +51 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/completion.py +98 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/configuration.py +280 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/debug.py +230 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/download.py +143 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/freeze.py +116 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/hash.py +63 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/help.py +46 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/install.py +737 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/list.py +327 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/search.py +169 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/show.py +186 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/uninstall.py +95 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/commands/wheel.py +198 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/configuration.py +407 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/distributions/__init__.py +24 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/distributions/base.py +46 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/distributions/installed.py +25 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/distributions/sdist.py +105 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/distributions/wheel.py +37 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/exceptions.py +391 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/index/__init__.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/index/collector.py +667 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/index/package_finder.py +1015 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/locations.py +193 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/main.py +16 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/__init__.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/candidate.py +39 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/direct_url.py +243 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/format_control.py +92 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/index.py +34 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/link.py +246 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/scheme.py +31 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/search_scope.py +135 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/selection_prefs.py +50 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/target_python.py +117 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/models/wheel.py +78 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/__init__.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/auth.py +310 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/cache.py +79 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/download.py +202 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/lazy_wheel.py +231 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/session.py +428 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/utils.py +97 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/network/xmlrpc.py +53 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/build/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/build/metadata.py +38 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/build/metadata_legacy.py +77 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/build/wheel.py +47 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/build/wheel_legacy.py +113 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/check.py +155 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/freeze.py +277 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/install/__init__.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/install/editable_legacy.py +52 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/install/legacy.py +130 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/install/wheel.py +846 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/operations/prepare.py +608 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/pyproject.py +196 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/__init__.py +103 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/constructors.py +476 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/req_file.py +574 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/req_install.py +907 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/req_set.py +204 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/req_tracker.py +151 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/req/req_uninstall.py +657 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/base.py +21 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/legacy/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/legacy/resolver.py +473 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/base.py +156 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/candidates.py +604 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/factory.py +504 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/found_candidates.py +101 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/provider.py +174 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/reporter.py +84 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/requirements.py +201 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/resolution/resolvelib/resolver.py +296 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/self_outdated_check.py +197 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/appdirs.py +44 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/compat.py +293 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/compatibility_tags.py +178 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/datetime.py +14 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/deprecation.py +104 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/direct_url_helpers.py +126 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/distutils_args.py +48 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/encoding.py +41 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/entrypoints.py +31 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/filesystem.py +224 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/filetypes.py +26 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/glibc.py +98 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/hashes.py +169 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/inject_securetransport.py +36 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/logging.py +399 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/misc.py +962 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/models.py +44 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/packaging.py +95 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/parallel.py +107 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/pkg_resources.py +44 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/setuptools_build.py +181 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/subprocess.py +299 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/temp_dir.py +284 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/typing.py +38 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/unpacking.py +281 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/urls.py +55 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/virtualenv.py +119 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/utils/wheel.py +225 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/vcs/__init__.py +15 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/vcs/bazaar.py +123 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/vcs/git.py +454 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/vcs/mercurial.py +172 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/vcs/subversion.py +340 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/vcs/versioncontrol.py +735 -0
- quarchpy/venv/Lib/site-packages/pip/_internal/wheel_builder.py +362 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/__init__.py +114 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/appdirs.py +633 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/__init__.py +11 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/_cmd.py +57 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/adapter.py +133 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/cache.py +39 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/caches/__init__.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/caches/file_cache.py +146 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/caches/redis_cache.py +33 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/compat.py +29 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/controller.py +376 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/filewrapper.py +80 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/heuristics.py +135 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/serialize.py +188 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/cachecontrol/wrapper.py +29 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/certifi/__init__.py +3 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/certifi/__main__.py +12 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/certifi/cacert.pem +4606 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/certifi/core.py +60 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/__init__.py +39 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/big5freq.py +386 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/big5prober.py +47 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/chardistribution.py +233 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/charsetgroupprober.py +106 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/charsetprober.py +145 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/cli/__init__.py +1 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/cli/chardetect.py +85 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/codingstatemachine.py +88 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/compat.py +34 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/cp949prober.py +49 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/enums.py +76 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/escprober.py +101 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/escsm.py +246 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/eucjpprober.py +92 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/euckrfreq.py +195 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/euckrprober.py +47 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/euctwfreq.py +387 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/euctwprober.py +46 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/gb2312freq.py +283 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/gb2312prober.py +46 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/hebrewprober.py +292 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/jisfreq.py +325 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/jpcntx.py +233 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langbulgarianmodel.py +228 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langcyrillicmodel.py +333 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langgreekmodel.py +225 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langhebrewmodel.py +200 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langhungarianmodel.py +225 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langthaimodel.py +199 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/langturkishmodel.py +193 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/latin1prober.py +145 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/mbcharsetprober.py +91 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/mbcsgroupprober.py +54 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/mbcssm.py +572 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/sbcharsetprober.py +132 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/sbcsgroupprober.py +73 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/sjisprober.py +92 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/universaldetector.py +286 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/utf8prober.py +82 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/chardet/version.py +9 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/colorama/__init__.py +6 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/colorama/ansi.py +102 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/colorama/ansitowin32.py +258 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/colorama/initialise.py +80 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/colorama/win32.py +152 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/colorama/winterm.py +169 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/contextlib2.py +518 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/__init__.py +23 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/_backport/__init__.py +6 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/_backport/misc.py +41 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/_backport/shutil.py +764 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/_backport/sysconfig.cfg +84 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/_backport/sysconfig.py +786 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/_backport/tarfile.py +2607 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/compat.py +1120 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/database.py +1339 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/index.py +516 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/locators.py +1302 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/manifest.py +393 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/markers.py +131 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/metadata.py +1056 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/resources.py +355 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/scripts.py +419 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/t32.exe +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/t64.exe +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/util.py +1761 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/version.py +736 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/w32.exe +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/w64.exe +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distlib/wheel.py +1018 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/distro.py +1230 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/__init__.py +35 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_ihatexml.py +289 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_inputstream.py +918 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_tokenizer.py +1735 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_trie/__init__.py +5 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_trie/_base.py +40 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_trie/py.py +67 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/_utils.py +159 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/constants.py +2946 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/alphabeticalattributes.py +29 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/base.py +12 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/inject_meta_charset.py +73 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/lint.py +93 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/optionaltags.py +207 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/sanitizer.py +916 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/filters/whitespace.py +38 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/html5parser.py +2795 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/serializer.py +409 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treeadapters/__init__.py +30 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treeadapters/genshi.py +54 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treeadapters/sax.py +50 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treebuilders/__init__.py +88 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treebuilders/base.py +417 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treebuilders/dom.py +239 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treebuilders/etree.py +343 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treebuilders/etree_lxml.py +392 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treewalkers/__init__.py +154 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treewalkers/base.py +252 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treewalkers/dom.py +43 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treewalkers/etree.py +131 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treewalkers/etree_lxml.py +215 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/html5lib/treewalkers/genshi.py +69 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/__init__.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/codec.py +118 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/compat.py +12 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/core.py +400 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/idnadata.py +2050 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/intranges.py +53 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/package_data.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/idna/uts46data.py +8357 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/ipaddress.py +2420 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/msgpack/__init__.py +54 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/msgpack/_version.py +1 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/msgpack/exceptions.py +48 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/msgpack/ext.py +191 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/msgpack/fallback.py +1063 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/__about__.py +27 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/__init__.py +26 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/_compat.py +38 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/_structures.py +86 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/_typing.py +48 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/markers.py +328 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/requirements.py +151 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/specifiers.py +864 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/tags.py +852 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/utils.py +67 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/packaging/version.py +556 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/__init__.py +6 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/_in_process.py +280 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/build.py +124 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/check.py +203 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/colorlog.py +115 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/compat.py +34 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/dirtools.py +44 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/envbuild.py +167 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/meta.py +92 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pep517/wrappers.py +327 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pkg_resources/__init__.py +3296 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pkg_resources/py31compat.py +23 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/progress/__init__.py +177 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/progress/bar.py +91 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/progress/counter.py +41 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/progress/spinner.py +43 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/pyparsing.py +7107 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/__init__.py +144 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/__version__.py +14 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/_internal_utils.py +42 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/adapters.py +533 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/api.py +161 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/auth.py +305 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/certs.py +18 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/compat.py +76 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/cookies.py +549 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/exceptions.py +123 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/help.py +119 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/hooks.py +34 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/models.py +956 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/packages.py +16 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/sessions.py +781 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/status_codes.py +123 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/structures.py +105 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/requests/utils.py +988 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/__init__.py +26 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/compat/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/compat/collections_abc.py +6 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/providers.py +119 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/reporters.py +37 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/resolvers.py +454 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/resolvelib/structs.py +149 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/retrying.py +267 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/six.py +982 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/toml/__init__.py +25 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/toml/decoder.py +1057 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/toml/encoder.py +304 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/toml/ordered.py +15 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/toml/tz.py +24 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/__init__.py +85 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/_collections.py +337 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/_version.py +2 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/connection.py +535 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/connectionpool.py +1067 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/_appengine_environ.py +36 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/_securetransport/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/_securetransport/bindings.py +519 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/_securetransport/low_level.py +396 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/appengine.py +314 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/ntlmpool.py +121 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/pyopenssl.py +509 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/securetransport.py +920 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/contrib/socks.py +216 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/exceptions.py +313 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/fields.py +274 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/filepost.py +98 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/packages/__init__.py +5 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/packages/backports/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/packages/backports/makefile.py +51 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/packages/six.py +1021 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/packages/ssl_match_hostname/__init__.py +22 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/packages/ssl_match_hostname/_implementation.py +160 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/poolmanager.py +536 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/request.py +170 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/response.py +821 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/__init__.py +49 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/connection.py +150 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/proxy.py +56 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/queue.py +22 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/request.py +143 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/response.py +107 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/retry.py +601 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/ssl_.py +474 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/ssltransport.py +221 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/timeout.py +268 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/url.py +430 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/urllib3/util/wait.py +153 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/vendor.txt +24 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/webencodings/__init__.py +342 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/webencodings/labels.py +231 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/webencodings/mklabels.py +59 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/webencodings/tests.py +153 -0
- quarchpy/venv/Lib/site-packages/pip/_vendor/webencodings/x_user_defined.py +325 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/INSTALLER +1 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/LICENSE.txt +20 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/METADATA +94 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/RECORD +812 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/WHEEL +6 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/entry_points.txt +5 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.dist-info/top_level.txt +1 -0
- quarchpy/venv/Lib/site-packages/pip-20.3.4.virtualenv +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/__init__.py +3296 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/__init__.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/__init__.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/appdirs.py +608 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/appdirs.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/__about__.py +21 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/__about__.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/__init__.py +14 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/__init__.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/_compat.py +30 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/_compat.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/_structures.py +68 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/_structures.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/markers.py +301 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/markers.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/requirements.py +127 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/requirements.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/specifiers.py +774 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/specifiers.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/utils.py +14 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/version.py +393 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/packaging/version.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/pyparsing.py +5742 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/pyparsing.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/six.py +868 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/_vendor/six.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/extern/__init__.py +73 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/extern/__init__.pyc +0 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/py31compat.py +23 -0
- quarchpy/venv/Lib/site-packages/pkg_resources/py31compat.pyc +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/__init__.py +245 -0
- quarchpy/venv/Lib/site-packages/setuptools/_deprecation_warning.py +7 -0
- quarchpy/venv/Lib/site-packages/setuptools/_imp.py +73 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/ordered_set.py +488 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/__about__.py +27 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/__init__.py +26 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/_compat.py +31 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/_structures.py +68 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/markers.py +296 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/requirements.py +138 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/specifiers.py +749 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/tags.py +404 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/utils.py +57 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/packaging/version.py +420 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/pyparsing.py +5742 -0
- quarchpy/venv/Lib/site-packages/setuptools/_vendor/six.py +868 -0
- quarchpy/venv/Lib/site-packages/setuptools/archive_util.py +173 -0
- quarchpy/venv/Lib/site-packages/setuptools/build_meta.py +264 -0
- quarchpy/venv/Lib/site-packages/setuptools/cli-32.exe +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/cli-64.exe +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/cli.exe +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/__init__.py +17 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/alias.py +80 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/bdist_egg.py +502 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/bdist_rpm.py +43 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/bdist_wininst.py +21 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/build_clib.py +98 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/build_ext.py +327 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/build_py.py +270 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/develop.py +221 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/dist_info.py +36 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/easy_install.py +2347 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/egg_info.py +717 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/install.py +125 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/install_egg_info.py +62 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/install_lib.py +121 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/install_scripts.py +65 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/launcher manifest.xml +15 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/py36compat.py +136 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/register.py +18 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/rotate.py +66 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/saveopts.py +22 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/sdist.py +252 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/setopt.py +149 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/test.py +279 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/upload.py +17 -0
- quarchpy/venv/Lib/site-packages/setuptools/command/upload_docs.py +206 -0
- quarchpy/venv/Lib/site-packages/setuptools/config.py +659 -0
- quarchpy/venv/Lib/site-packages/setuptools/dep_util.py +23 -0
- quarchpy/venv/Lib/site-packages/setuptools/depends.py +176 -0
- quarchpy/venv/Lib/site-packages/setuptools/dist.py +1274 -0
- quarchpy/venv/Lib/site-packages/setuptools/errors.py +16 -0
- quarchpy/venv/Lib/site-packages/setuptools/extension.py +57 -0
- quarchpy/venv/Lib/site-packages/setuptools/extern/__init__.py +73 -0
- quarchpy/venv/Lib/site-packages/setuptools/glob.py +174 -0
- quarchpy/venv/Lib/site-packages/setuptools/gui-32.exe +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/gui-64.exe +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/gui.exe +0 -0
- quarchpy/venv/Lib/site-packages/setuptools/installer.py +150 -0
- quarchpy/venv/Lib/site-packages/setuptools/launch.py +35 -0
- quarchpy/venv/Lib/site-packages/setuptools/lib2to3_ex.py +62 -0
- quarchpy/venv/Lib/site-packages/setuptools/monkey.py +179 -0
- quarchpy/venv/Lib/site-packages/setuptools/msvc.py +1679 -0
- quarchpy/venv/Lib/site-packages/setuptools/namespaces.py +107 -0
- quarchpy/venv/Lib/site-packages/setuptools/package_index.py +1136 -0
- quarchpy/venv/Lib/site-packages/setuptools/py27compat.py +60 -0
- quarchpy/venv/Lib/site-packages/setuptools/py31compat.py +32 -0
- quarchpy/venv/Lib/site-packages/setuptools/py33compat.py +59 -0
- quarchpy/venv/Lib/site-packages/setuptools/py34compat.py +13 -0
- quarchpy/venv/Lib/site-packages/setuptools/sandbox.py +491 -0
- quarchpy/venv/Lib/site-packages/setuptools/script (dev).tmpl +6 -0
- quarchpy/venv/Lib/site-packages/setuptools/script.tmpl +3 -0
- quarchpy/venv/Lib/site-packages/setuptools/site-patch.py +74 -0
- quarchpy/venv/Lib/site-packages/setuptools/ssl_support.py +260 -0
- quarchpy/venv/Lib/site-packages/setuptools/unicode_utils.py +44 -0
- quarchpy/venv/Lib/site-packages/setuptools/version.py +6 -0
- quarchpy/venv/Lib/site-packages/setuptools/wheel.py +220 -0
- quarchpy/venv/Lib/site-packages/setuptools/windows_support.py +29 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/INSTALLER +1 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/LICENSE +19 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/METADATA +86 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/RECORD +207 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/WHEEL +6 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/dependency_links.txt +2 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/entry_points.txt +69 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/top_level.txt +3 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.dist-info/zip-safe +1 -0
- quarchpy/venv/Lib/site-packages/setuptools-44.1.1.virtualenv +0 -0
- quarchpy/venv/Lib/site-packages/wheel/__init__.py +1 -0
- quarchpy/venv/Lib/site-packages/wheel/__main__.py +19 -0
- quarchpy/venv/Lib/site-packages/wheel/bdist_wheel.py +492 -0
- quarchpy/venv/Lib/site-packages/wheel/cli/__init__.py +88 -0
- quarchpy/venv/Lib/site-packages/wheel/cli/convert.py +269 -0
- quarchpy/venv/Lib/site-packages/wheel/cli/pack.py +82 -0
- quarchpy/venv/Lib/site-packages/wheel/cli/unpack.py +25 -0
- quarchpy/venv/Lib/site-packages/wheel/macosx_libfile.py +428 -0
- quarchpy/venv/Lib/site-packages/wheel/metadata.py +133 -0
- quarchpy/venv/Lib/site-packages/wheel/pkginfo.py +43 -0
- quarchpy/venv/Lib/site-packages/wheel/util.py +46 -0
- quarchpy/venv/Lib/site-packages/wheel/vendored/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/wheel/vendored/packaging/__init__.py +0 -0
- quarchpy/venv/Lib/site-packages/wheel/vendored/packaging/_typing.py +48 -0
- quarchpy/venv/Lib/site-packages/wheel/vendored/packaging/tags.py +866 -0
- quarchpy/venv/Lib/site-packages/wheel/wheelfile.py +181 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/INSTALLER +1 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/LICENSE.txt +22 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/METADATA +69 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/RECORD +49 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/WHEEL +6 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/entry_points.txt +6 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.dist-info/top_level.txt +1 -0
- quarchpy/venv/Lib/site-packages/wheel-0.37.1.virtualenv +0 -0
- quarchpy/venv/Lib/site.py +190 -0
- quarchpy/venv/Lib/site.pyc +0 -0
- quarchpy/venv/Scripts/activate +83 -0
- quarchpy/venv/Scripts/activate.bat +39 -0
- quarchpy/venv/Scripts/activate.fish +100 -0
- quarchpy/venv/Scripts/activate.nu +41 -0
- quarchpy/venv/Scripts/activate.ps1 +60 -0
- quarchpy/venv/Scripts/activate_this.py +32 -0
- quarchpy/venv/Scripts/deactivate.bat +19 -0
- quarchpy/venv/Scripts/deactivate.nu +11 -0
- quarchpy/venv/Scripts/easy_install-2.7.exe +0 -0
- quarchpy/venv/Scripts/easy_install.exe +0 -0
- quarchpy/venv/Scripts/easy_install2.7.exe +0 -0
- quarchpy/venv/Scripts/easy_install2.exe +0 -0
- quarchpy/venv/Scripts/pip-2.7.exe +0 -0
- quarchpy/venv/Scripts/pip.exe +0 -0
- quarchpy/venv/Scripts/pip2.7.exe +0 -0
- quarchpy/venv/Scripts/pip2.exe +0 -0
- quarchpy/venv/Scripts/pydoc.bat +1 -0
- quarchpy/venv/Scripts/python.exe +0 -0
- quarchpy/venv/Scripts/python27.dll +0 -0
- quarchpy/venv/Scripts/pythonw.exe +0 -0
- quarchpy/venv/Scripts/wheel-2.7.exe +0 -0
- quarchpy/venv/Scripts/wheel.exe +0 -0
- quarchpy/venv/Scripts/wheel2.7.exe +0 -0
- quarchpy/venv/Scripts/wheel2.exe +0 -0
- quarchpy/venv/libs/_bsddb.lib +0 -0
- quarchpy/venv/libs/_ctypes.lib +0 -0
- quarchpy/venv/libs/_ctypes_test.lib +0 -0
- quarchpy/venv/libs/_elementtree.lib +0 -0
- quarchpy/venv/libs/_hashlib.lib +0 -0
- quarchpy/venv/libs/_msi.lib +0 -0
- quarchpy/venv/libs/_multiprocessing.lib +0 -0
- quarchpy/venv/libs/_socket.lib +0 -0
- quarchpy/venv/libs/_sqlite3.lib +0 -0
- quarchpy/venv/libs/_ssl.lib +0 -0
- quarchpy/venv/libs/_testcapi.lib +0 -0
- quarchpy/venv/libs/_tkinter.lib +0 -0
- quarchpy/venv/libs/bz2.lib +0 -0
- quarchpy/venv/libs/libpython27.a +0 -0
- quarchpy/venv/libs/pyexpat.lib +0 -0
- quarchpy/venv/libs/python27.lib +0 -0
- quarchpy/venv/libs/select.lib +0 -0
- quarchpy/venv/libs/unicodedata.lib +0 -0
- quarchpy/venv/libs/winsound.lib +0 -0
- quarchpy/venv/pyvenv.cfg +8 -0
- {quarchpy-2.1.13.dev1.dist-info → quarchpy-2.1.14.dist-info}/METADATA +12 -2
- quarchpy-2.1.14.dist-info/RECORD +1216 -0
- quarchpy/.idea/inspectionProfiles/Project_Default.xml +0 -26
- quarchpy/connection_specific/QPS/qps_lib/QuarchCommon-0.2.4.jar +0 -0
- quarchpy/connection_specific/connection_QIS.py.bak +0 -1821
- quarchpy/connection_specific/usb_libs/__pycache__/libusb1.cpython-311.pyc +0 -0
- quarchpy/connection_specific/usb_libs/__pycache__/usb1.cpython-311.pyc +0 -0
- quarchpy/debug/TextScanIP.py +0 -11
- quarchpy/device/device.py.bak +0 -504
- quarchpy/device/scanDevices.py.bak +0 -661
- quarchpy-2.1.13.dev1.dist-info/RECORD +0 -531
- {quarchpy-2.1.13.dev1.dist-info → quarchpy-2.1.14.dist-info}/WHEEL +0 -0
- {quarchpy-2.1.13.dev1.dist-info → quarchpy-2.1.14.dist-info}/top_level.txt +0 -0
|
@@ -1,17 +1,16 @@
|
|
|
1
|
-
|
|
2
1
|
<!DOCTYPE html>
|
|
3
2
|
|
|
4
|
-
<html>
|
|
3
|
+
<html lang="en" data-content_root="../">
|
|
5
4
|
<head>
|
|
6
5
|
<meta charset="utf-8" />
|
|
7
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
7
|
+
|
|
8
8
|
<title>quarchpy.device package — quarchpy documentation</title>
|
|
9
|
-
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
|
10
|
-
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
|
|
11
|
-
<script
|
|
12
|
-
<script src="../_static/
|
|
13
|
-
<script src="../_static/
|
|
14
|
-
<script src="../_static/doctools.js"></script>
|
|
9
|
+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b3523f8e" />
|
|
10
|
+
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
|
|
11
|
+
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
|
12
|
+
<script src="../_static/doctools.js?v=888ff710"></script>
|
|
13
|
+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
15
14
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
16
15
|
<link rel="search" title="Search" href="../search.html" />
|
|
17
16
|
<link rel="next" title="quarchpy.qis package" href="quarchpy.qis.html" />
|
|
@@ -32,44 +31,44 @@
|
|
|
32
31
|
|
|
33
32
|
<div class="body" role="main">
|
|
34
33
|
|
|
35
|
-
<
|
|
36
|
-
<h1>quarchpy.device package<a class="headerlink" href="#quarchpy-device-package" title="
|
|
37
|
-
<
|
|
38
|
-
<h2>Submodules<a class="headerlink" href="#submodules" title="
|
|
39
|
-
</
|
|
40
|
-
<
|
|
41
|
-
<span id="quarchpy-device-device-module"></span><h2>quarchpy.device.device module<a class="headerlink" href="#module-quarchpy.device.device" title="
|
|
34
|
+
<section id="quarchpy-device-package">
|
|
35
|
+
<h1>quarchpy.device package<a class="headerlink" href="#quarchpy-device-package" title="Link to this heading">¶</a></h1>
|
|
36
|
+
<section id="submodules">
|
|
37
|
+
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
|
|
38
|
+
</section>
|
|
39
|
+
<section id="module-quarchpy.device.device">
|
|
40
|
+
<span id="quarchpy-device-device-module"></span><h2>quarchpy.device.device module<a class="headerlink" href="#module-quarchpy.device.device" title="Link to this heading">¶</a></h2>
|
|
42
41
|
<dl class="py function">
|
|
43
42
|
<dt class="sig sig-object py" id="quarchpy.device.device.checkModuleFormat">
|
|
44
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.device.</span></span><span class="sig-name descname"><span class="pre">checkModuleFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConString</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.checkModuleFormat" title="
|
|
43
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.device.</span></span><span class="sig-name descname"><span class="pre">checkModuleFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConString</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.checkModuleFormat" title="Link to this definition">¶</a></dt>
|
|
45
44
|
<dd></dd></dl>
|
|
46
45
|
|
|
47
46
|
<dl class="py function">
|
|
48
47
|
<dt class="sig sig-object py" id="quarchpy.device.device.getQuarchDevice">
|
|
49
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.device.</span></span><span class="sig-name descname"><span class="pre">getQuarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.getQuarchDevice" title="
|
|
48
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.device.</span></span><span class="sig-name descname"><span class="pre">getQuarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.getQuarchDevice" title="Link to this definition">¶</a></dt>
|
|
50
49
|
<dd><p>creates a quarch device to be returned. Handles sub devices in quarch arrays.</p>
|
|
51
50
|
</dd></dl>
|
|
52
51
|
|
|
53
52
|
<dl class="py class">
|
|
54
53
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice">
|
|
55
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.device.</span></span><span class="sig-name descname"><span class="pre">quarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice" title="
|
|
54
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.device.</span></span><span class="sig-name descname"><span class="pre">quarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice" title="Link to this definition">¶</a></dt>
|
|
56
55
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
57
56
|
<p>Allows control over a Quarch device, over a wide range of underlying connection methods. This is the core class
|
|
58
57
|
used for control of all Quarch products.</p>
|
|
59
58
|
<dl class="py method">
|
|
60
59
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.closeConnection">
|
|
61
|
-
<span class="sig-name descname"><span class="pre">closeConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.closeConnection" title="
|
|
60
|
+
<span class="sig-name descname"><span class="pre">closeConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.closeConnection" title="Link to this definition">¶</a></dt>
|
|
62
61
|
<dd><p>Closes the connection to the module, freeing the module for other uses. This should always be called whern you are finished with a device.</p>
|
|
63
62
|
</dd></dl>
|
|
64
63
|
|
|
65
64
|
<dl class="py method">
|
|
66
65
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.getRuntime">
|
|
67
|
-
<span class="sig-name descname"><span class="pre">getRuntime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'conf:runtimes?'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.getRuntime" title="
|
|
66
|
+
<span class="sig-name descname"><span class="pre">getRuntime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'conf:runtimes?'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.getRuntime" title="Link to this definition">¶</a></dt>
|
|
68
67
|
<dd><dl class="field-list simple">
|
|
69
|
-
<dt class="field-odd">Parameters
|
|
68
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
70
69
|
<dd class="field-odd"><p><strong>command</strong> – can be overridden to ask for PAM fixture runtime</p>
|
|
71
70
|
</dd>
|
|
72
|
-
<dt class="field-even">Returns
|
|
71
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
73
72
|
<dd class="field-even"><p></p>
|
|
74
73
|
</dd>
|
|
75
74
|
</dl>
|
|
@@ -77,24 +76,24 @@ used for control of all Quarch products.</p>
|
|
|
77
76
|
|
|
78
77
|
<dl class="py method">
|
|
79
78
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.openConnection">
|
|
80
|
-
<span class="sig-name descname"><span class="pre">openConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.openConnection" title="
|
|
79
|
+
<span class="sig-name descname"><span class="pre">openConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.openConnection" title="Link to this definition">¶</a></dt>
|
|
81
80
|
<dd><p>Opens the connection to the module. This will be open by default on creation of quarchDevice but this
|
|
82
81
|
allows re-opening if required.</p>
|
|
83
82
|
</dd></dl>
|
|
84
83
|
|
|
85
84
|
<dl class="py method">
|
|
86
85
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.resetDevice">
|
|
87
|
-
<span class="sig-name descname"><span class="pre">resetDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.resetDevice" title="
|
|
86
|
+
<span class="sig-name descname"><span class="pre">resetDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.resetDevice" title="Link to this definition">¶</a></dt>
|
|
88
87
|
<dd><p>Issues a power-on-reset command to the device. Attempts to recover the connection to the module after reset.
|
|
89
88
|
Function halts until the timeout is complete or the module is found</p>
|
|
90
89
|
<dl class="field-list simple">
|
|
91
|
-
<dt class="field-odd">Parameters
|
|
90
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
92
91
|
<dd class="field-odd"><p><strong>timeout</strong> (<em>int</em>) – Number of seconds to wait for the module to re-enumerate and become available</p>
|
|
93
92
|
</dd>
|
|
94
|
-
<dt class="field-even">Returns
|
|
93
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
95
94
|
<dd class="field-even"><p><strong>result</strong> – True if the device was found and reconnected, false if it was not and we timed out</p>
|
|
96
95
|
</dd>
|
|
97
|
-
<dt class="field-odd">Return type
|
|
96
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
98
97
|
<dd class="field-odd"><p>bool</p>
|
|
99
98
|
</dd>
|
|
100
99
|
</dl>
|
|
@@ -102,24 +101,24 @@ Function halts until the timeout is complete or the module is found</p>
|
|
|
102
101
|
|
|
103
102
|
<dl class="py method">
|
|
104
103
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.sendAndVerifyCommand">
|
|
105
|
-
<span class="sig-name descname"><span class="pre">sendAndVerifyCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">responseExpected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'OK'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.sendAndVerifyCommand" title="
|
|
104
|
+
<span class="sig-name descname"><span class="pre">sendAndVerifyCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">responseExpected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'OK'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.sendAndVerifyCommand" title="Link to this definition">¶</a></dt>
|
|
106
105
|
<dd><p>Sends a command to the device and verifies the response is as expected. This is a simple
|
|
107
106
|
wrapper of sendCommand and helps write cleaner code in test scripts.</p>
|
|
108
107
|
<dl class="field-list simple">
|
|
109
|
-
<dt class="field-odd">Parameters
|
|
108
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
110
109
|
<dd class="field-odd"><ul class="simple">
|
|
111
110
|
<li><p><strong>commandString</strong> (<em>str</em><em>, </em><em>optional</em>) – The text command to send to the device</p></li>
|
|
112
111
|
<li><p><strong>commandString</strong> – The expected text response from the module.</p></li>
|
|
113
112
|
<li><p><strong>exception</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, an exception is raised on mismatch. If False, we just return False</p></li>
|
|
114
113
|
</ul>
|
|
115
114
|
</dd>
|
|
116
|
-
<dt class="field-even">Returns
|
|
115
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
117
116
|
<dd class="field-even"><p><strong>result</strong> – True if we matched the response, False if we did not</p>
|
|
118
117
|
</dd>
|
|
119
|
-
<dt class="field-odd">Return type
|
|
118
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
120
119
|
<dd class="field-odd"><p>bool</p>
|
|
121
120
|
</dd>
|
|
122
|
-
<dt class="field-even">Raises
|
|
121
|
+
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
123
122
|
<dd class="field-even"><p><strong>ValueError</strong> – If the response does not match AND the exception parameter is set to True</p>
|
|
124
123
|
</dd>
|
|
125
124
|
</dl>
|
|
@@ -127,23 +126,23 @@ wrapper of sendCommand and helps write cleaner code in test scripts.</p>
|
|
|
127
126
|
|
|
128
127
|
<dl class="py method">
|
|
129
128
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.sendBinaryCommand">
|
|
130
|
-
<span class="sig-name descname"><span class="pre">sendBinaryCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.sendBinaryCommand" title="
|
|
129
|
+
<span class="sig-name descname"><span class="pre">sendBinaryCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.sendBinaryCommand" title="Link to this definition">¶</a></dt>
|
|
131
130
|
<dd></dd></dl>
|
|
132
131
|
|
|
133
132
|
<dl class="py method">
|
|
134
133
|
<dt class="sig sig-object py" id="quarchpy.device.device.quarchDevice.sendCommand">
|
|
135
|
-
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.sendCommand" title="
|
|
134
|
+
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.device.quarchDevice.sendCommand" title="Link to this definition">¶</a></dt>
|
|
136
135
|
<dd><p>Executes a text based command on the device. This is the primary way of controlling a device. The full command set available to use
|
|
137
136
|
is found in the technical manual for the device.</p>
|
|
138
137
|
<dl class="field-list simple">
|
|
139
|
-
<dt class="field-odd">Parameters
|
|
138
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
140
139
|
<dd class="field-odd"><p><strong>CommandString</strong> (<em>str</em>) – The text based command string to send to the device</p>
|
|
141
140
|
</dd>
|
|
142
|
-
<dt class="field-even">Returns
|
|
141
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
143
142
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from the module. Multiline responses will be seperated with LF. Some commands
|
|
144
143
|
do not return a response and None will be returned</p>
|
|
145
144
|
</dd>
|
|
146
|
-
<dt class="field-odd">Return type
|
|
145
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
147
146
|
<dd class="field-odd"><p>str or None</p>
|
|
148
147
|
</dd>
|
|
149
148
|
</dl>
|
|
@@ -151,48 +150,48 @@ do not return a response and None will be returned</p>
|
|
|
151
150
|
|
|
152
151
|
</dd></dl>
|
|
153
152
|
|
|
154
|
-
</
|
|
155
|
-
<
|
|
156
|
-
<span id="quarchpy-device-quarcharray-module"></span><h2>quarchpy.device.quarchArray module<a class="headerlink" href="#module-quarchpy.device.quarchArray" title="
|
|
153
|
+
</section>
|
|
154
|
+
<section id="module-quarchpy.device.quarchArray">
|
|
155
|
+
<span id="quarchpy-device-quarcharray-module"></span><h2>quarchpy.device.quarchArray module<a class="headerlink" href="#module-quarchpy.device.quarchArray" title="Link to this heading">¶</a></h2>
|
|
157
156
|
<dl class="py function">
|
|
158
157
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.isThisAnArrayController">
|
|
159
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">isThisAnArrayController</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moduleString</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.isThisAnArrayController" title="
|
|
158
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">isThisAnArrayController</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moduleString</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.isThisAnArrayController" title="Link to this definition">¶</a></dt>
|
|
160
159
|
<dd></dd></dl>
|
|
161
160
|
|
|
162
161
|
<dl class="py class">
|
|
163
162
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.quarchArray">
|
|
164
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">quarchArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray" title="
|
|
165
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
163
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">quarchArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray" title="Link to this definition">¶</a></dt>
|
|
164
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
166
165
|
<dl class="py method">
|
|
167
166
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.quarchArray.getSubDevice">
|
|
168
|
-
<span class="sig-name descname"><span class="pre">getSubDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray.getSubDevice" title="
|
|
167
|
+
<span class="sig-name descname"><span class="pre">getSubDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray.getSubDevice" title="Link to this definition">¶</a></dt>
|
|
169
168
|
<dd></dd></dl>
|
|
170
169
|
|
|
171
170
|
<dl class="py method">
|
|
172
171
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.quarchArray.scanSubModules">
|
|
173
|
-
<span class="sig-name descname"><span class="pre">scanSubModules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray.scanSubModules" title="
|
|
172
|
+
<span class="sig-name descname"><span class="pre">scanSubModules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.quarchArray.scanSubModules" title="Link to this definition">¶</a></dt>
|
|
174
173
|
<dd></dd></dl>
|
|
175
174
|
|
|
176
175
|
</dd></dl>
|
|
177
176
|
|
|
178
177
|
<dl class="py class">
|
|
179
178
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.subDevice">
|
|
180
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">subDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.subDevice" title="
|
|
181
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
179
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchArray.</span></span><span class="sig-name descname"><span class="pre">subDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.subDevice" title="Link to this definition">¶</a></dt>
|
|
180
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
182
181
|
<dl class="py method">
|
|
183
182
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.subDevice.sendCommand">
|
|
184
|
-
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.subDevice.sendCommand" title="
|
|
183
|
+
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.subDevice.sendCommand" title="Link to this definition">¶</a></dt>
|
|
185
184
|
<dd><p>Executes a text based command on the device. This is the primary way of controlling a device. The full command set available to use
|
|
186
185
|
is found in the technical manual for the device.</p>
|
|
187
186
|
<dl class="field-list simple">
|
|
188
|
-
<dt class="field-odd">Parameters
|
|
187
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
189
188
|
<dd class="field-odd"><p><strong>CommandString</strong> (<em>str</em>) – The text based command string to send to the device</p>
|
|
190
189
|
</dd>
|
|
191
|
-
<dt class="field-even">Returns
|
|
190
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
192
191
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from the module. Multiline responses will be seperated with LF. Some commands
|
|
193
192
|
do not return a response and None will be returned</p>
|
|
194
193
|
</dd>
|
|
195
|
-
<dt class="field-odd">Return type
|
|
194
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
196
195
|
<dd class="field-odd"><p>str or None</p>
|
|
197
196
|
</dd>
|
|
198
197
|
</dl>
|
|
@@ -200,94 +199,96 @@ do not return a response and None will be returned</p>
|
|
|
200
199
|
|
|
201
200
|
</dd></dl>
|
|
202
201
|
|
|
203
|
-
</
|
|
204
|
-
<
|
|
205
|
-
<span id="quarchpy-device-quarchppm-module"></span><h2>quarchpy.device.quarchPPM module<a class="headerlink" href="#module-quarchpy.device.quarchPPM" title="
|
|
202
|
+
</section>
|
|
203
|
+
<section id="module-quarchpy.device.quarchPPM">
|
|
204
|
+
<span id="quarchpy-device-quarchppm-module"></span><h2>quarchpy.device.quarchPPM module<a class="headerlink" href="#module-quarchpy.device.quarchPPM" title="Link to this heading">¶</a></h2>
|
|
206
205
|
<dl class="py class">
|
|
207
206
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM">
|
|
208
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchPPM.</span></span><span class="sig-name descname"><span class="pre">quarchPPM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">originObj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM" title="
|
|
209
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
207
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchPPM.</span></span><span class="sig-name descname"><span class="pre">quarchPPM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">originObj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM" title="Link to this definition">¶</a></dt>
|
|
208
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
210
209
|
<dl class="py method">
|
|
211
210
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.setupPowerOutput">
|
|
212
|
-
<span class="sig-name descname"><span class="pre">setupPowerOutput</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.setupPowerOutput" title="
|
|
211
|
+
<span class="sig-name descname"><span class="pre">setupPowerOutput</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.setupPowerOutput" title="Link to this definition">¶</a></dt>
|
|
213
212
|
<dd></dd></dl>
|
|
214
213
|
|
|
215
214
|
<dl class="py method">
|
|
216
215
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.startStream">
|
|
217
|
-
<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="o"><span class="pre">=</span></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="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">
|
|
216
|
+
<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="o"><span class="pre">=</span></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="o"><span class="pre">=</span></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="o"><span class="pre">=</span></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="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">streamAverage</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">releaseOnData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">','</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inMemoryData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.startStream" title="Link to this definition">¶</a></dt>
|
|
218
217
|
<dd></dd></dl>
|
|
219
218
|
|
|
220
219
|
<dl class="py method">
|
|
221
220
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.stopStream">
|
|
222
|
-
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.stopStream" title="
|
|
221
|
+
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.stopStream" title="Link to this definition">¶</a></dt>
|
|
223
222
|
<dd></dd></dl>
|
|
224
223
|
|
|
225
224
|
<dl class="py method">
|
|
226
225
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.streamBufferStatus">
|
|
227
|
-
<span class="sig-name descname"><span class="pre">streamBufferStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamBufferStatus" title="
|
|
226
|
+
<span class="sig-name descname"><span class="pre">streamBufferStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamBufferStatus" title="Link to this definition">¶</a></dt>
|
|
228
227
|
<dd></dd></dl>
|
|
229
228
|
|
|
230
229
|
<dl class="py method">
|
|
231
230
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.streamInterrupt">
|
|
232
|
-
<span class="sig-name descname"><span class="pre">streamInterrupt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamInterrupt" title="
|
|
231
|
+
<span class="sig-name descname"><span class="pre">streamInterrupt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamInterrupt" title="Link to this definition">¶</a></dt>
|
|
233
232
|
<dd></dd></dl>
|
|
234
233
|
|
|
235
234
|
<dl class="py method">
|
|
236
235
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.streamResampleMode">
|
|
237
|
-
<span class="sig-name descname"><span class="pre">streamResampleMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">streamCom</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamResampleMode" title="
|
|
236
|
+
<span class="sig-name descname"><span class="pre">streamResampleMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">streamCom</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamResampleMode" title="Link to this definition">¶</a></dt>
|
|
238
237
|
<dd></dd></dl>
|
|
239
238
|
|
|
240
239
|
<dl class="py method">
|
|
241
240
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.streamRunningStatus">
|
|
242
|
-
<span class="sig-name descname"><span class="pre">streamRunningStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamRunningStatus" title="
|
|
241
|
+
<span class="sig-name descname"><span class="pre">streamRunningStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.streamRunningStatus" title="Link to this definition">¶</a></dt>
|
|
243
242
|
<dd></dd></dl>
|
|
244
243
|
|
|
245
244
|
<dl class="py method">
|
|
246
245
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.quarchPPM.waitStop">
|
|
247
|
-
<span class="sig-name descname"><span class="pre">waitStop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.waitStop" title="
|
|
246
|
+
<span class="sig-name descname"><span class="pre">waitStop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.quarchPPM.waitStop" title="Link to this definition">¶</a></dt>
|
|
248
247
|
<dd></dd></dl>
|
|
249
248
|
|
|
250
249
|
</dd></dl>
|
|
251
250
|
|
|
252
|
-
</
|
|
253
|
-
<
|
|
254
|
-
<span id="quarchpy-device-quarchqps-module"></span><h2>quarchpy.device.quarchQPS module<a class="headerlink" href="#module-quarchpy.device.quarchQPS" title="
|
|
251
|
+
</section>
|
|
252
|
+
<section id="module-quarchpy.device.quarchQPS">
|
|
253
|
+
<span id="quarchpy-device-quarchqps-module"></span><h2>quarchpy.device.quarchQPS module<a class="headerlink" href="#module-quarchpy.device.quarchQPS" title="Link to this heading">¶</a></h2>
|
|
255
254
|
<dl class="py function">
|
|
256
255
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.current_milli_time">
|
|
257
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">current_milli_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.current_milli_time" title="
|
|
256
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">current_milli_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.current_milli_time" title="Link to this definition">¶</a></dt>
|
|
258
257
|
<dd></dd></dl>
|
|
259
258
|
|
|
260
259
|
<dl class="py function">
|
|
261
260
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.current_second_time">
|
|
262
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">current_second_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.current_second_time" title="
|
|
261
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">current_second_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.current_second_time" title="Link to this definition">¶</a></dt>
|
|
263
262
|
<dd></dd></dl>
|
|
264
263
|
|
|
265
264
|
<dl class="py function">
|
|
266
265
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.qpsNowStr">
|
|
267
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">qpsNowStr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.qpsNowStr" title="
|
|
266
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">qpsNowStr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.qpsNowStr" title="Link to this definition">¶</a></dt>
|
|
268
267
|
<dd></dd></dl>
|
|
269
268
|
|
|
270
269
|
<dl class="py class">
|
|
271
270
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchQPS">
|
|
272
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">quarchQPS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchQPS" title="
|
|
273
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
271
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">quarchQPS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchQPS" title="Link to this definition">¶</a></dt>
|
|
272
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
274
273
|
<dl class="py method">
|
|
275
274
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchQPS.startStream">
|
|
276
|
-
<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">directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchQPS.startStream" title="
|
|
277
|
-
<dd
|
|
275
|
+
<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">directory</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unserInput</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchQPS.startStream" title="Link to this definition">¶</a></dt>
|
|
276
|
+
<dd><p>directory - str - desired stream dir
|
|
277
|
+
unserInput=True - if a failure occurs userInput=True allows user to rectify problem with user input. set to False if user interaction is not available (automating).</p>
|
|
278
|
+
</dd></dl>
|
|
278
279
|
|
|
279
280
|
</dd></dl>
|
|
280
281
|
|
|
281
282
|
<dl class="py class">
|
|
282
283
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream">
|
|
283
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">quarchStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchQPS</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream" title="
|
|
284
|
-
<dd><p>Bases: <
|
|
284
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.quarchQPS.</span></span><span class="sig-name descname"><span class="pre">quarchStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchQPS</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unserInput</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream" title="Link to this definition">¶</a></dt>
|
|
285
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
285
286
|
<dl class="py method">
|
|
286
287
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.addAnnotation">
|
|
287
|
-
<span class="sig-name descname"><span class="pre">addAnnotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.addAnnotation" title="
|
|
288
|
+
<span class="sig-name descname"><span class="pre">addAnnotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.addAnnotation" title="Link to this definition">¶</a></dt>
|
|
288
289
|
<dd><p>Adds a custom annotation to stream with given parameters.</p>
|
|
289
290
|
<dl class="field-list simple">
|
|
290
|
-
<dt class="field-odd">Parameters
|
|
291
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
291
292
|
<dd class="field-odd"><ul class="simple">
|
|
292
293
|
<li><p><strong>title=</strong> (<em>str</em>) – The title appears next to the annotation in the stream</p></li>
|
|
293
294
|
<li><p><strong>extraText=</strong> (<em>str</em><em>, </em><em>optional</em>) – The additional text that can be viewed when selecting the annotation</p></li>
|
|
@@ -298,10 +299,10 @@ do not return a response and None will be returned</p>
|
|
|
298
299
|
<li><p><strong>annotationTime</strong> (<em>int</em><em>, </em><em>optional</em>) – The time in milliseconds after the start of the stream at which the annotation should be placed. 0 will plot the annotation live at the most recent sample</p></li>
|
|
299
300
|
</ul>
|
|
300
301
|
</dd>
|
|
301
|
-
<dt class="field-even">Returns
|
|
302
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
302
303
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from QPS. “ok” if annotation successfully added</p>
|
|
303
304
|
</dd>
|
|
304
|
-
<dt class="field-odd">Return type
|
|
305
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
305
306
|
<dd class="field-odd"><p>str or None</p>
|
|
306
307
|
</dd>
|
|
307
308
|
</dl>
|
|
@@ -309,32 +310,38 @@ do not return a response and None will be returned</p>
|
|
|
309
310
|
|
|
310
311
|
<dl class="py method">
|
|
311
312
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.addComment">
|
|
312
|
-
<span class="sig-name descname"><span class="pre">addComment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.addComment" title="
|
|
313
|
+
<span class="sig-name descname"><span class="pre">addComment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.addComment" title="Link to this definition">¶</a></dt>
|
|
313
314
|
<dd></dd></dl>
|
|
314
315
|
|
|
315
316
|
<dl class="py method">
|
|
316
317
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.addDataPoint">
|
|
317
|
-
<span class="sig-name descname"><span class="pre">addDataPoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groupName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataValue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataPointTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.addDataPoint" title="
|
|
318
|
-
<dd
|
|
318
|
+
<span class="sig-name descname"><span class="pre">addDataPoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groupName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataValue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataPointTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeFormat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'unix'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.addDataPoint" title="Link to this definition">¶</a></dt>
|
|
319
|
+
<dd><p>channelName - str
|
|
320
|
+
groupName - str
|
|
321
|
+
dataValue - int/float value of the data point
|
|
322
|
+
dataPointTime=0 - time of the data point
|
|
323
|
+
timeFormat=”unix” - the format of the given time</p>
|
|
324
|
+
</dd></dl>
|
|
319
325
|
|
|
320
326
|
<dl class="py method">
|
|
321
327
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.channels">
|
|
322
|
-
<span class="sig-name descname"><span class="pre">channels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.channels" title="
|
|
328
|
+
<span class="sig-name descname"><span class="pre">channels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.channels" title="Link to this definition">¶</a></dt>
|
|
323
329
|
<dd></dd></dl>
|
|
324
330
|
|
|
325
331
|
<dl class="py method">
|
|
326
332
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.createChannel">
|
|
327
|
-
<span class="sig-name descname"><span class="pre">createChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channelGroup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseUnits</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usePrefix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.createChannel" title="
|
|
333
|
+
<span class="sig-name descname"><span class="pre">createChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channelGroup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseUnits</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usePrefix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.createChannel" title="Link to this definition">¶</a></dt>
|
|
328
334
|
<dd></dd></dl>
|
|
329
335
|
|
|
330
336
|
<dl class="py method">
|
|
331
337
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.failCheck">
|
|
332
|
-
<span class="sig-name descname"><span class="pre">failCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">
|
|
333
|
-
<dd
|
|
338
|
+
<span class="sig-name descname"><span class="pre">failCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.failCheck" title="Link to this definition">¶</a></dt>
|
|
339
|
+
<dd><p>handles failed starting of stream that requires input from user to fix.</p>
|
|
340
|
+
</dd></dl>
|
|
334
341
|
|
|
335
342
|
<dl class="py method">
|
|
336
343
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.getStreamState">
|
|
337
|
-
<span class="sig-name descname"><span class="pre">getStreamState</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.getStreamState" title="
|
|
344
|
+
<span class="sig-name descname"><span class="pre">getStreamState</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.getStreamState" title="Link to this definition">¶</a></dt>
|
|
338
345
|
<dd><p>Askes QPS for the stream status.
|
|
339
346
|
QPS stream state != Module stream state.
|
|
340
347
|
This is different from “rec stream?” cmd to the module as it will return “streaming” when the module is nolonger streaming but QPS is still receiveing stream data from the module.
|
|
@@ -343,15 +350,15 @@ ei the module has stopped streaming but is emptying the stream buffer.</p>
|
|
|
343
350
|
|
|
344
351
|
<dl class="py method">
|
|
345
352
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.get_custom_stats_range">
|
|
346
|
-
<span class="sig-name descname"><span class="pre">get_custom_stats_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.get_custom_stats_range" title="
|
|
353
|
+
<span class="sig-name descname"><span class="pre">get_custom_stats_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.get_custom_stats_range" title="Link to this definition">¶</a></dt>
|
|
347
354
|
<dd><p>Returns the QPS statistics information over a specific time ignoring any set annotations.</p>
|
|
348
355
|
<blockquote>
|
|
349
356
|
<div><dl class="simple">
|
|
350
|
-
<dt>start_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to start this can be in integer or
|
|
357
|
+
<dt>start_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to start this can be in integer or string format.
|
|
351
358
|
or using the following format to specify daysDhours:minutes:seconds.milliseconds
|
|
352
359
|
xxxDxx:xx:xx.xxxx</p>
|
|
353
360
|
</dd>
|
|
354
|
-
<dt>end_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to stop this can be in integer or
|
|
361
|
+
<dt>end_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to stop this can be in integer or string format
|
|
355
362
|
or using the following format to specify daysDhours:minutes:seconds.milliseconds
|
|
356
363
|
xxxDxx:xx:xx.xxxx</p>
|
|
357
364
|
</dd>
|
|
@@ -365,7 +372,7 @@ xxxDxx:xx:xx.xxxx</p>
|
|
|
365
372
|
|
|
366
373
|
<dl class="py method">
|
|
367
374
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.get_stats">
|
|
368
|
-
<span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'df'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.get_stats" title="
|
|
375
|
+
<span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'df'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.get_stats" title="Link to this definition">¶</a></dt>
|
|
369
376
|
<dd><p>Returns the QPS annotation statistics grid information as a pandas dataframe object</p>
|
|
370
377
|
<blockquote>
|
|
371
378
|
<div><dl class="simple">
|
|
@@ -377,36 +384,37 @@ xxxDxx:xx:xx.xxxx</p>
|
|
|
377
384
|
|
|
378
385
|
<dl class="py method">
|
|
379
386
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.hideAllDefaultChannels">
|
|
380
|
-
<span class="sig-name descname"><span class="pre">hideAllDefaultChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.hideAllDefaultChannels" title="
|
|
387
|
+
<span class="sig-name descname"><span class="pre">hideAllDefaultChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.hideAllDefaultChannels" title="Link to this definition">¶</a></dt>
|
|
381
388
|
<dd></dd></dl>
|
|
382
389
|
|
|
383
390
|
<dl class="py method">
|
|
384
391
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.hideChannel">
|
|
385
|
-
<span class="sig-name descname"><span class="pre">hideChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.hideChannel" title="
|
|
392
|
+
<span class="sig-name descname"><span class="pre">hideChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.hideChannel" title="Link to this definition">¶</a></dt>
|
|
386
393
|
<dd></dd></dl>
|
|
387
394
|
|
|
388
395
|
<dl class="py method">
|
|
389
396
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.myChannels">
|
|
390
|
-
<span class="sig-name descname"><span class="pre">myChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.myChannels" title="
|
|
397
|
+
<span class="sig-name descname"><span class="pre">myChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.myChannels" title="Link to this definition">¶</a></dt>
|
|
391
398
|
<dd></dd></dl>
|
|
392
399
|
|
|
393
400
|
<dl class="py method">
|
|
394
401
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.saveCSV">
|
|
395
|
-
<span class="sig-name descname"><span class="pre">saveCSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesPerFile</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">cr</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">delimiter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.saveCSV" title="
|
|
402
|
+
<span class="sig-name descname"><span class="pre">saveCSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesPerFile</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">cr</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">delimiter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">60</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.saveCSV" title="Link to this definition">¶</a></dt>
|
|
396
403
|
<dd><p>Saves the stream to csv file at specified location</p>
|
|
397
404
|
<dl class="field-list simple">
|
|
398
|
-
<dt class="field-odd">Parameters
|
|
405
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
399
406
|
<dd class="field-odd"><ul class="simple">
|
|
400
407
|
<li><p><strong>filePath=</strong> (<em>str</em>) – The file path that ou would like the CSV file saved to.</p></li>
|
|
401
408
|
<li><p><strong>linesPerFile=</strong> (<em>str</em><em>, </em><em>optional</em>) – The number of lines per CSV file. Can be any int number or “all”</p></li>
|
|
402
409
|
<li><p><strong>cr</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the end of line terminator should include a carriage return.</p></li>
|
|
403
410
|
<li><p><strong>delimiter</strong> (<em>str</em><em>, </em><em>optional</em>) – The delimiter to be used by the csv file.</p></li>
|
|
411
|
+
<li><p><strong>timeout</strong> (<em>str</em><em>, </em><em>otptional</em>) – The timeout to wait for a response from QPS</p></li>
|
|
404
412
|
</ul>
|
|
405
413
|
</dd>
|
|
406
|
-
<dt class="field-even">Returns
|
|
414
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
407
415
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from QPS. “ok” if command is successful or the stack trace if exception thrown</p>
|
|
408
416
|
</dd>
|
|
409
|
-
<dt class="field-odd">Return type
|
|
417
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
410
418
|
<dd class="field-odd"><p>str or None</p>
|
|
411
419
|
</dd>
|
|
412
420
|
</dl>
|
|
@@ -414,12 +422,18 @@ xxxDxx:xx:xx.xxxx</p>
|
|
|
414
422
|
|
|
415
423
|
<dl class="py method">
|
|
416
424
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.showChannel">
|
|
417
|
-
<span class="sig-name descname"><span class="pre">showChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.showChannel" title="
|
|
425
|
+
<span class="sig-name descname"><span class="pre">showChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.showChannel" title="Link to this definition">¶</a></dt>
|
|
418
426
|
<dd></dd></dl>
|
|
419
427
|
|
|
428
|
+
<dl class="py method">
|
|
429
|
+
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.startQPSStream">
|
|
430
|
+
<span class="sig-name descname"><span class="pre">startQPSStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">newDirectory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.startQPSStream" title="Link to this definition">¶</a></dt>
|
|
431
|
+
<dd><p>STARTS the stream</p>
|
|
432
|
+
</dd></dl>
|
|
433
|
+
|
|
420
434
|
<dl class="py method">
|
|
421
435
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.stats_to_CSV">
|
|
422
|
-
<span class="sig-name descname"><span class="pre">stats_to_CSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.stats_to_CSV" title="
|
|
436
|
+
<span class="sig-name descname"><span class="pre">stats_to_CSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.stats_to_CSV" title="Link to this definition">¶</a></dt>
|
|
423
437
|
<dd><p>Saves the statistics grid to a csv file</p>
|
|
424
438
|
<blockquote>
|
|
425
439
|
<div><dl class="simple">
|
|
@@ -436,38 +450,38 @@ Default location is the path of the executable.</p>
|
|
|
436
450
|
|
|
437
451
|
<dl class="py method">
|
|
438
452
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.stopStream">
|
|
439
|
-
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.stopStream" title="
|
|
453
|
+
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.stopStream" title="Link to this definition">¶</a></dt>
|
|
440
454
|
<dd></dd></dl>
|
|
441
455
|
|
|
442
456
|
<dl class="py method">
|
|
443
457
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.stopStreamAndAllowBufferToEmpty">
|
|
444
|
-
<span class="sig-name descname"><span class="pre">stopStreamAndAllowBufferToEmpty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checkInterval</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.stopStreamAndAllowBufferToEmpty" title="
|
|
458
|
+
<span class="sig-name descname"><span class="pre">stopStreamAndAllowBufferToEmpty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checkInterval</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.stopStreamAndAllowBufferToEmpty" title="Link to this definition">¶</a></dt>
|
|
445
459
|
<dd></dd></dl>
|
|
446
460
|
|
|
447
461
|
<dl class="py method">
|
|
448
462
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.quarchStream.takeSnapshot">
|
|
449
|
-
<span class="sig-name descname"><span class="pre">takeSnapshot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.takeSnapshot" title="
|
|
463
|
+
<span class="sig-name descname"><span class="pre">takeSnapshot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.quarchStream.takeSnapshot" title="Link to this definition">¶</a></dt>
|
|
450
464
|
<dd><p>Triggers QPS take snapshot function and saves it in the streams directory.</p>
|
|
451
465
|
</dd></dl>
|
|
452
466
|
|
|
453
467
|
</dd></dl>
|
|
454
468
|
|
|
455
|
-
</
|
|
456
|
-
<
|
|
457
|
-
<span id="quarchpy-device-scandevices-module"></span><h2>quarchpy.device.scanDevices module<a class="headerlink" href="#module-quarchpy.device.scanDevices" title="
|
|
469
|
+
</section>
|
|
470
|
+
<section id="module-quarchpy.device.scanDevices">
|
|
471
|
+
<span id="quarchpy-device-scandevices-module"></span><h2>quarchpy.device.scanDevices module<a class="headerlink" href="#module-quarchpy.device.scanDevices" title="Link to this heading">¶</a></h2>
|
|
458
472
|
<dl class="py function">
|
|
459
473
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.filter_module_type">
|
|
460
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">filter_module_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_type_filter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">found_devices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.filter_module_type" title="
|
|
474
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">filter_module_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_type_filter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">found_devices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.filter_module_type" title="Link to this definition">¶</a></dt>
|
|
461
475
|
<dd><p>Used in scandevices to filter modules by their type.
|
|
462
476
|
Uses config files.</p>
|
|
463
477
|
<dl class="field-list simple">
|
|
464
|
-
<dt class="field-odd">Parameters
|
|
478
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
465
479
|
<dd class="field-odd"><ul class="simple">
|
|
466
480
|
<li><p><strong>module_type_filter</strong> – Acceptable values are ‘Cable’, ‘Card’, ‘Drive’, ‘Power’, ‘Switch’</p></li>
|
|
467
481
|
<li><p><strong>found_devices</strong> – List of found devices passed from scan_devices</p></li>
|
|
468
482
|
</ul>
|
|
469
483
|
</dd>
|
|
470
|
-
<dt class="field-even">Returns
|
|
484
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
471
485
|
<dd class="field-even"><p>Returns all devices in found devices that are of ‘module filter type’</p>
|
|
472
486
|
</dd>
|
|
473
487
|
</dl>
|
|
@@ -475,124 +489,129 @@ Uses config files.</p>
|
|
|
475
489
|
|
|
476
490
|
<dl class="py function">
|
|
477
491
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.getSerialNumberFromConnectionTarget">
|
|
478
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">getSerialNumberFromConnectionTarget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.getSerialNumberFromConnectionTarget" title="
|
|
492
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">getSerialNumberFromConnectionTarget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.getSerialNumberFromConnectionTarget" title="Link to this definition">¶</a></dt>
|
|
479
493
|
<dd></dd></dl>
|
|
480
494
|
|
|
481
495
|
<dl class="py function">
|
|
482
496
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.get_connection_target">
|
|
483
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">get_connection_target</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan_dictionary</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">connection_preference</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">include_conn_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.get_connection_target" title="
|
|
497
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">get_connection_target</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan_dictionary</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">connection_preference</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">include_conn_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.get_connection_target" title="Link to this definition">¶</a></dt>
|
|
484
498
|
<dd></dd></dl>
|
|
485
499
|
|
|
486
500
|
<dl class="py function">
|
|
487
501
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.get_user_level_serial_number">
|
|
488
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">get_user_level_serial_number</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_modules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.get_user_level_serial_number" title="
|
|
502
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">get_user_level_serial_number</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_modules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.get_user_level_serial_number" title="Link to this definition">¶</a></dt>
|
|
489
503
|
<dd></dd></dl>
|
|
490
504
|
|
|
491
505
|
<dl class="py function">
|
|
492
506
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.listDevices">
|
|
493
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">listDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.listDevices" title="
|
|
507
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">listDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.listDevices" title="Link to this definition">¶</a></dt>
|
|
494
508
|
<dd></dd></dl>
|
|
495
509
|
|
|
496
510
|
<dl class="py function">
|
|
497
511
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.list_USB">
|
|
498
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">list_USB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">debuPrint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.list_USB" title="
|
|
512
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">list_USB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">debuPrint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.list_USB" title="Link to this definition">¶</a></dt>
|
|
499
513
|
<dd></dd></dl>
|
|
500
514
|
|
|
501
515
|
<dl class="py function">
|
|
502
516
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.list_network">
|
|
503
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">list_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debugPring</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lanTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipAddressLookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.list_network" title="
|
|
517
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">list_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debugPring</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lanTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipAddressLookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.list_network" title="Link to this definition">¶</a></dt>
|
|
504
518
|
<dd></dd></dl>
|
|
505
519
|
|
|
506
520
|
<dl class="py function">
|
|
507
521
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.list_serial">
|
|
508
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">list_serial</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">debuPrint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.list_serial" title="
|
|
522
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">list_serial</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">debuPrint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.list_serial" title="Link to this definition">¶</a></dt>
|
|
509
523
|
<dd></dd></dl>
|
|
510
524
|
|
|
511
525
|
<dl class="py function">
|
|
512
526
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.lookupDevice">
|
|
513
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">lookupDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ipAddressLookup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mySocket</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lan_modules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.lookupDevice" title="
|
|
527
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">lookupDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ipAddressLookup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mySocket</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lan_modules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.lookupDevice" title="Link to this definition">¶</a></dt>
|
|
514
528
|
<dd></dd></dl>
|
|
515
529
|
|
|
516
530
|
<dl class="py function">
|
|
517
531
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.mergeDict">
|
|
518
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">mergeDict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.mergeDict" title="
|
|
532
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">mergeDict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.mergeDict" title="Link to this definition">¶</a></dt>
|
|
519
533
|
<dd></dd></dl>
|
|
520
534
|
|
|
521
535
|
<dl class="py function">
|
|
522
536
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.scanDevices">
|
|
523
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">scanDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lanTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scanInArray</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filterStr</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">module_type_filter</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">ipAddressLookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.scanDevices" title="
|
|
537
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">scanDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lanTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scanInArray</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filterStr</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">module_type_filter</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">ipAddressLookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.scanDevices" title="Link to this definition">¶</a></dt>
|
|
538
|
+
<dd></dd></dl>
|
|
539
|
+
|
|
540
|
+
<dl class="py function">
|
|
541
|
+
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.scan_mDNS">
|
|
542
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">scan_mDNS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mdnsListener</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.scan_mDNS" title="Link to this definition">¶</a></dt>
|
|
524
543
|
<dd></dd></dl>
|
|
525
544
|
|
|
526
545
|
<dl class="py function">
|
|
527
546
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices.userSelectDevice">
|
|
528
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">userSelectDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</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">scanFilterStr</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">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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">title</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">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.userSelectDevice" title="
|
|
547
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.scanDevices.</span></span><span class="sig-name descname"><span class="pre">userSelectDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</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">scanFilterStr</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">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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">title</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">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices.userSelectDevice" title="Link to this definition">¶</a></dt>
|
|
529
548
|
<dd></dd></dl>
|
|
530
549
|
|
|
531
|
-
</
|
|
532
|
-
<
|
|
533
|
-
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.device" title="
|
|
550
|
+
</section>
|
|
551
|
+
<section id="module-quarchpy.device">
|
|
552
|
+
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.device" title="Link to this heading">¶</a></h2>
|
|
534
553
|
<dl class="py function">
|
|
535
554
|
<dt class="sig sig-object py" id="quarchpy.device.getQuarchDevice">
|
|
536
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">getQuarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.getQuarchDevice" title="
|
|
555
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">getQuarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.getQuarchDevice" title="Link to this definition">¶</a></dt>
|
|
537
556
|
<dd><p>creates a quarch device to be returned. Handles sub devices in quarch arrays.</p>
|
|
538
557
|
</dd></dl>
|
|
539
558
|
|
|
540
559
|
<dl class="py function">
|
|
541
560
|
<dt class="sig sig-object py" id="quarchpy.device.getSerialNumberFromConnectionTarget">
|
|
542
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">getSerialNumberFromConnectionTarget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.getSerialNumberFromConnectionTarget" title="
|
|
561
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">getSerialNumberFromConnectionTarget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connectionTarget</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.getSerialNumberFromConnectionTarget" title="Link to this definition">¶</a></dt>
|
|
543
562
|
<dd></dd></dl>
|
|
544
563
|
|
|
545
564
|
<dl class="py function">
|
|
546
565
|
<dt class="sig sig-object py" id="quarchpy.device.get_connection_target">
|
|
547
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">get_connection_target</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan_dictionary</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">connection_preference</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">include_conn_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.get_connection_target" title="
|
|
566
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">get_connection_target</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan_dictionary</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">connection_preference</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">include_conn_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.get_connection_target" title="Link to this definition">¶</a></dt>
|
|
548
567
|
<dd></dd></dl>
|
|
549
568
|
|
|
550
569
|
<dl class="py function">
|
|
551
570
|
<dt class="sig sig-object py" id="quarchpy.device.listDevices">
|
|
552
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">listDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.listDevices" title="
|
|
571
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">listDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.listDevices" title="Link to this definition">¶</a></dt>
|
|
553
572
|
<dd></dd></dl>
|
|
554
573
|
|
|
555
574
|
<dl class="py function">
|
|
556
575
|
<dt class="sig sig-object py" id="quarchpy.device.qpsNowStr">
|
|
557
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">qpsNowStr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.qpsNowStr" title="
|
|
576
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">qpsNowStr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.qpsNowStr" title="Link to this definition">¶</a></dt>
|
|
558
577
|
<dd></dd></dl>
|
|
559
578
|
|
|
560
579
|
<dl class="py class">
|
|
561
580
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray">
|
|
562
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray" title="
|
|
563
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
581
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray" title="Link to this definition">¶</a></dt>
|
|
582
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
564
583
|
<dl class="py method">
|
|
565
584
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.getSubDevice">
|
|
566
|
-
<span class="sig-name descname"><span class="pre">getSubDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.getSubDevice" title="
|
|
585
|
+
<span class="sig-name descname"><span class="pre">getSubDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.getSubDevice" title="Link to this definition">¶</a></dt>
|
|
567
586
|
<dd></dd></dl>
|
|
568
587
|
|
|
569
588
|
<dl class="py method">
|
|
570
589
|
<dt class="sig sig-object py" id="quarchpy.device.quarchArray.scanSubModules">
|
|
571
|
-
<span class="sig-name descname"><span class="pre">scanSubModules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.scanSubModules" title="
|
|
590
|
+
<span class="sig-name descname"><span class="pre">scanSubModules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchArray.scanSubModules" title="Link to this definition">¶</a></dt>
|
|
572
591
|
<dd></dd></dl>
|
|
573
592
|
|
|
574
593
|
</dd></dl>
|
|
575
594
|
|
|
576
595
|
<dl class="py class">
|
|
577
596
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice">
|
|
578
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice" title="
|
|
597
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ConString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ConType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PY'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice" title="Link to this definition">¶</a></dt>
|
|
579
598
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
580
599
|
<p>Allows control over a Quarch device, over a wide range of underlying connection methods. This is the core class
|
|
581
600
|
used for control of all Quarch products.</p>
|
|
582
601
|
<dl class="py method">
|
|
583
602
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.closeConnection">
|
|
584
|
-
<span class="sig-name descname"><span class="pre">closeConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.closeConnection" title="
|
|
603
|
+
<span class="sig-name descname"><span class="pre">closeConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.closeConnection" title="Link to this definition">¶</a></dt>
|
|
585
604
|
<dd><p>Closes the connection to the module, freeing the module for other uses. This should always be called whern you are finished with a device.</p>
|
|
586
605
|
</dd></dl>
|
|
587
606
|
|
|
588
607
|
<dl class="py method">
|
|
589
608
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.getRuntime">
|
|
590
|
-
<span class="sig-name descname"><span class="pre">getRuntime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'conf:runtimes?'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.getRuntime" title="
|
|
609
|
+
<span class="sig-name descname"><span class="pre">getRuntime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'conf:runtimes?'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.getRuntime" title="Link to this definition">¶</a></dt>
|
|
591
610
|
<dd><dl class="field-list simple">
|
|
592
|
-
<dt class="field-odd">Parameters
|
|
611
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
593
612
|
<dd class="field-odd"><p><strong>command</strong> – can be overridden to ask for PAM fixture runtime</p>
|
|
594
613
|
</dd>
|
|
595
|
-
<dt class="field-even">Returns
|
|
614
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
596
615
|
<dd class="field-even"><p></p>
|
|
597
616
|
</dd>
|
|
598
617
|
</dl>
|
|
@@ -600,24 +619,24 @@ used for control of all Quarch products.</p>
|
|
|
600
619
|
|
|
601
620
|
<dl class="py method">
|
|
602
621
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.openConnection">
|
|
603
|
-
<span class="sig-name descname"><span class="pre">openConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.openConnection" title="
|
|
622
|
+
<span class="sig-name descname"><span class="pre">openConnection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.openConnection" title="Link to this definition">¶</a></dt>
|
|
604
623
|
<dd><p>Opens the connection to the module. This will be open by default on creation of quarchDevice but this
|
|
605
624
|
allows re-opening if required.</p>
|
|
606
625
|
</dd></dl>
|
|
607
626
|
|
|
608
627
|
<dl class="py method">
|
|
609
628
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.resetDevice">
|
|
610
|
-
<span class="sig-name descname"><span class="pre">resetDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.resetDevice" title="
|
|
629
|
+
<span class="sig-name descname"><span class="pre">resetDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.resetDevice" title="Link to this definition">¶</a></dt>
|
|
611
630
|
<dd><p>Issues a power-on-reset command to the device. Attempts to recover the connection to the module after reset.
|
|
612
631
|
Function halts until the timeout is complete or the module is found</p>
|
|
613
632
|
<dl class="field-list simple">
|
|
614
|
-
<dt class="field-odd">Parameters
|
|
633
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
615
634
|
<dd class="field-odd"><p><strong>timeout</strong> (<em>int</em>) – Number of seconds to wait for the module to re-enumerate and become available</p>
|
|
616
635
|
</dd>
|
|
617
|
-
<dt class="field-even">Returns
|
|
636
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
618
637
|
<dd class="field-even"><p><strong>result</strong> – True if the device was found and reconnected, false if it was not and we timed out</p>
|
|
619
638
|
</dd>
|
|
620
|
-
<dt class="field-odd">Return type
|
|
639
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
621
640
|
<dd class="field-odd"><p>bool</p>
|
|
622
641
|
</dd>
|
|
623
642
|
</dl>
|
|
@@ -625,24 +644,24 @@ Function halts until the timeout is complete or the module is found</p>
|
|
|
625
644
|
|
|
626
645
|
<dl class="py method">
|
|
627
646
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.sendAndVerifyCommand">
|
|
628
|
-
<span class="sig-name descname"><span class="pre">sendAndVerifyCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">responseExpected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'OK'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.sendAndVerifyCommand" title="
|
|
647
|
+
<span class="sig-name descname"><span class="pre">sendAndVerifyCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">responseExpected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'OK'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.sendAndVerifyCommand" title="Link to this definition">¶</a></dt>
|
|
629
648
|
<dd><p>Sends a command to the device and verifies the response is as expected. This is a simple
|
|
630
649
|
wrapper of sendCommand and helps write cleaner code in test scripts.</p>
|
|
631
650
|
<dl class="field-list simple">
|
|
632
|
-
<dt class="field-odd">Parameters
|
|
651
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
633
652
|
<dd class="field-odd"><ul class="simple">
|
|
634
653
|
<li><p><strong>commandString</strong> (<em>str</em><em>, </em><em>optional</em>) – The text command to send to the device</p></li>
|
|
635
654
|
<li><p><strong>commandString</strong> – The expected text response from the module.</p></li>
|
|
636
655
|
<li><p><strong>exception</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, an exception is raised on mismatch. If False, we just return False</p></li>
|
|
637
656
|
</ul>
|
|
638
657
|
</dd>
|
|
639
|
-
<dt class="field-even">Returns
|
|
658
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
640
659
|
<dd class="field-even"><p><strong>result</strong> – True if we matched the response, False if we did not</p>
|
|
641
660
|
</dd>
|
|
642
|
-
<dt class="field-odd">Return type
|
|
661
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
643
662
|
<dd class="field-odd"><p>bool</p>
|
|
644
663
|
</dd>
|
|
645
|
-
<dt class="field-even">Raises
|
|
664
|
+
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
646
665
|
<dd class="field-even"><p><strong>ValueError</strong> – If the response does not match AND the exception parameter is set to True</p>
|
|
647
666
|
</dd>
|
|
648
667
|
</dl>
|
|
@@ -650,23 +669,23 @@ wrapper of sendCommand and helps write cleaner code in test scripts.</p>
|
|
|
650
669
|
|
|
651
670
|
<dl class="py method">
|
|
652
671
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.sendBinaryCommand">
|
|
653
|
-
<span class="sig-name descname"><span class="pre">sendBinaryCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.sendBinaryCommand" title="
|
|
672
|
+
<span class="sig-name descname"><span class="pre">sendBinaryCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.sendBinaryCommand" title="Link to this definition">¶</a></dt>
|
|
654
673
|
<dd></dd></dl>
|
|
655
674
|
|
|
656
675
|
<dl class="py method">
|
|
657
676
|
<dt class="sig sig-object py" id="quarchpy.device.quarchDevice.sendCommand">
|
|
658
|
-
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.sendCommand" title="
|
|
677
|
+
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchDevice.sendCommand" title="Link to this definition">¶</a></dt>
|
|
659
678
|
<dd><p>Executes a text based command on the device. This is the primary way of controlling a device. The full command set available to use
|
|
660
679
|
is found in the technical manual for the device.</p>
|
|
661
680
|
<dl class="field-list simple">
|
|
662
|
-
<dt class="field-odd">Parameters
|
|
681
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
663
682
|
<dd class="field-odd"><p><strong>CommandString</strong> (<em>str</em>) – The text based command string to send to the device</p>
|
|
664
683
|
</dd>
|
|
665
|
-
<dt class="field-even">Returns
|
|
684
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
666
685
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from the module. Multiline responses will be seperated with LF. Some commands
|
|
667
686
|
do not return a response and None will be returned</p>
|
|
668
687
|
</dd>
|
|
669
|
-
<dt class="field-odd">Return type
|
|
688
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
670
689
|
<dd class="field-odd"><p>str or None</p>
|
|
671
690
|
</dd>
|
|
672
691
|
</dl>
|
|
@@ -676,71 +695,73 @@ do not return a response and None will be returned</p>
|
|
|
676
695
|
|
|
677
696
|
<dl class="py class">
|
|
678
697
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM">
|
|
679
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchPPM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">originObj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM" title="
|
|
680
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
698
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchPPM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">originObj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM" title="Link to this definition">¶</a></dt>
|
|
699
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
681
700
|
<dl class="py method">
|
|
682
701
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.setupPowerOutput">
|
|
683
|
-
<span class="sig-name descname"><span class="pre">setupPowerOutput</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.setupPowerOutput" title="
|
|
702
|
+
<span class="sig-name descname"><span class="pre">setupPowerOutput</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.setupPowerOutput" title="Link to this definition">¶</a></dt>
|
|
684
703
|
<dd></dd></dl>
|
|
685
704
|
|
|
686
705
|
<dl class="py method">
|
|
687
706
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.startStream">
|
|
688
|
-
<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="o"><span class="pre">=</span></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="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">
|
|
707
|
+
<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="o"><span class="pre">=</span></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="o"><span class="pre">=</span></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="o"><span class="pre">=</span></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="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">streamAverage</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">releaseOnData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">','</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inMemoryData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.startStream" title="Link to this definition">¶</a></dt>
|
|
689
708
|
<dd></dd></dl>
|
|
690
709
|
|
|
691
710
|
<dl class="py method">
|
|
692
711
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.stopStream">
|
|
693
|
-
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.stopStream" title="
|
|
712
|
+
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.stopStream" title="Link to this definition">¶</a></dt>
|
|
694
713
|
<dd></dd></dl>
|
|
695
714
|
|
|
696
715
|
<dl class="py method">
|
|
697
716
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.streamBufferStatus">
|
|
698
|
-
<span class="sig-name descname"><span class="pre">streamBufferStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamBufferStatus" title="
|
|
717
|
+
<span class="sig-name descname"><span class="pre">streamBufferStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamBufferStatus" title="Link to this definition">¶</a></dt>
|
|
699
718
|
<dd></dd></dl>
|
|
700
719
|
|
|
701
720
|
<dl class="py method">
|
|
702
721
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.streamInterrupt">
|
|
703
|
-
<span class="sig-name descname"><span class="pre">streamInterrupt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamInterrupt" title="
|
|
722
|
+
<span class="sig-name descname"><span class="pre">streamInterrupt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamInterrupt" title="Link to this definition">¶</a></dt>
|
|
704
723
|
<dd></dd></dl>
|
|
705
724
|
|
|
706
725
|
<dl class="py method">
|
|
707
726
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.streamResampleMode">
|
|
708
|
-
<span class="sig-name descname"><span class="pre">streamResampleMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">streamCom</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamResampleMode" title="
|
|
727
|
+
<span class="sig-name descname"><span class="pre">streamResampleMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">streamCom</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamResampleMode" title="Link to this definition">¶</a></dt>
|
|
709
728
|
<dd></dd></dl>
|
|
710
729
|
|
|
711
730
|
<dl class="py method">
|
|
712
731
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.streamRunningStatus">
|
|
713
|
-
<span class="sig-name descname"><span class="pre">streamRunningStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamRunningStatus" title="
|
|
732
|
+
<span class="sig-name descname"><span class="pre">streamRunningStatus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.streamRunningStatus" title="Link to this definition">¶</a></dt>
|
|
714
733
|
<dd></dd></dl>
|
|
715
734
|
|
|
716
735
|
<dl class="py method">
|
|
717
736
|
<dt class="sig sig-object py" id="quarchpy.device.quarchPPM.waitStop">
|
|
718
|
-
<span class="sig-name descname"><span class="pre">waitStop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.waitStop" title="
|
|
737
|
+
<span class="sig-name descname"><span class="pre">waitStop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchPPM.waitStop" title="Link to this definition">¶</a></dt>
|
|
719
738
|
<dd></dd></dl>
|
|
720
739
|
|
|
721
740
|
</dd></dl>
|
|
722
741
|
|
|
723
742
|
<dl class="py class">
|
|
724
743
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS">
|
|
725
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchQPS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS" title="
|
|
726
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
744
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchQPS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchDevice</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS" title="Link to this definition">¶</a></dt>
|
|
745
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
727
746
|
<dl class="py method">
|
|
728
747
|
<dt class="sig sig-object py" id="quarchpy.device.quarchQPS.startStream">
|
|
729
|
-
<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">directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.startStream" title="
|
|
730
|
-
<dd
|
|
748
|
+
<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">directory</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unserInput</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchQPS.startStream" title="Link to this definition">¶</a></dt>
|
|
749
|
+
<dd><p>directory - str - desired stream dir
|
|
750
|
+
unserInput=True - if a failure occurs userInput=True allows user to rectify problem with user input. set to False if user interaction is not available (automating).</p>
|
|
751
|
+
</dd></dl>
|
|
731
752
|
|
|
732
753
|
</dd></dl>
|
|
733
754
|
|
|
734
755
|
<dl class="py class">
|
|
735
756
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream">
|
|
736
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchQPS</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream" title="
|
|
737
|
-
<dd><p>Bases: <
|
|
757
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">quarchStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quarchQPS</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unserInput</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream" title="Link to this definition">¶</a></dt>
|
|
758
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
738
759
|
<dl class="py method">
|
|
739
760
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.addAnnotation">
|
|
740
|
-
<span class="sig-name descname"><span class="pre">addAnnotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.addAnnotation" title="
|
|
761
|
+
<span class="sig-name descname"><span class="pre">addAnnotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.addAnnotation" title="Link to this definition">¶</a></dt>
|
|
741
762
|
<dd><p>Adds a custom annotation to stream with given parameters.</p>
|
|
742
763
|
<dl class="field-list simple">
|
|
743
|
-
<dt class="field-odd">Parameters
|
|
764
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
744
765
|
<dd class="field-odd"><ul class="simple">
|
|
745
766
|
<li><p><strong>title=</strong> (<em>str</em>) – The title appears next to the annotation in the stream</p></li>
|
|
746
767
|
<li><p><strong>extraText=</strong> (<em>str</em><em>, </em><em>optional</em>) – The additional text that can be viewed when selecting the annotation</p></li>
|
|
@@ -751,10 +772,10 @@ do not return a response and None will be returned</p>
|
|
|
751
772
|
<li><p><strong>annotationTime</strong> (<em>int</em><em>, </em><em>optional</em>) – The time in milliseconds after the start of the stream at which the annotation should be placed. 0 will plot the annotation live at the most recent sample</p></li>
|
|
752
773
|
</ul>
|
|
753
774
|
</dd>
|
|
754
|
-
<dt class="field-even">Returns
|
|
775
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
755
776
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from QPS. “ok” if annotation successfully added</p>
|
|
756
777
|
</dd>
|
|
757
|
-
<dt class="field-odd">Return type
|
|
778
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
758
779
|
<dd class="field-odd"><p>str or None</p>
|
|
759
780
|
</dd>
|
|
760
781
|
</dl>
|
|
@@ -762,32 +783,38 @@ do not return a response and None will be returned</p>
|
|
|
762
783
|
|
|
763
784
|
<dl class="py method">
|
|
764
785
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.addComment">
|
|
765
|
-
<span class="sig-name descname"><span class="pre">addComment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.addComment" title="
|
|
786
|
+
<span class="sig-name descname"><span class="pre">addComment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yPos</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">titleColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commentColor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotationGroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.addComment" title="Link to this definition">¶</a></dt>
|
|
766
787
|
<dd></dd></dl>
|
|
767
788
|
|
|
768
789
|
<dl class="py method">
|
|
769
790
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.addDataPoint">
|
|
770
|
-
<span class="sig-name descname"><span class="pre">addDataPoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groupName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataValue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataPointTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.addDataPoint" title="
|
|
771
|
-
<dd
|
|
791
|
+
<span class="sig-name descname"><span class="pre">addDataPoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groupName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataValue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataPointTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeFormat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'unix'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.addDataPoint" title="Link to this definition">¶</a></dt>
|
|
792
|
+
<dd><p>channelName - str
|
|
793
|
+
groupName - str
|
|
794
|
+
dataValue - int/float value of the data point
|
|
795
|
+
dataPointTime=0 - time of the data point
|
|
796
|
+
timeFormat=”unix” - the format of the given time</p>
|
|
797
|
+
</dd></dl>
|
|
772
798
|
|
|
773
799
|
<dl class="py method">
|
|
774
800
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.channels">
|
|
775
|
-
<span class="sig-name descname"><span class="pre">channels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.channels" title="
|
|
801
|
+
<span class="sig-name descname"><span class="pre">channels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.channels" title="Link to this definition">¶</a></dt>
|
|
776
802
|
<dd></dd></dl>
|
|
777
803
|
|
|
778
804
|
<dl class="py method">
|
|
779
805
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.createChannel">
|
|
780
|
-
<span class="sig-name descname"><span class="pre">createChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channelGroup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseUnits</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usePrefix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.createChannel" title="
|
|
806
|
+
<span class="sig-name descname"><span class="pre">createChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channelGroup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseUnits</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usePrefix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.createChannel" title="Link to this definition">¶</a></dt>
|
|
781
807
|
<dd></dd></dl>
|
|
782
808
|
|
|
783
809
|
<dl class="py method">
|
|
784
810
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.failCheck">
|
|
785
|
-
<span class="sig-name descname"><span class="pre">failCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">
|
|
786
|
-
<dd
|
|
811
|
+
<span class="sig-name descname"><span class="pre">failCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.failCheck" title="Link to this definition">¶</a></dt>
|
|
812
|
+
<dd><p>handles failed starting of stream that requires input from user to fix.</p>
|
|
813
|
+
</dd></dl>
|
|
787
814
|
|
|
788
815
|
<dl class="py method">
|
|
789
816
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.getStreamState">
|
|
790
|
-
<span class="sig-name descname"><span class="pre">getStreamState</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.getStreamState" title="
|
|
817
|
+
<span class="sig-name descname"><span class="pre">getStreamState</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.getStreamState" title="Link to this definition">¶</a></dt>
|
|
791
818
|
<dd><p>Askes QPS for the stream status.
|
|
792
819
|
QPS stream state != Module stream state.
|
|
793
820
|
This is different from “rec stream?” cmd to the module as it will return “streaming” when the module is nolonger streaming but QPS is still receiveing stream data from the module.
|
|
@@ -796,15 +823,15 @@ ei the module has stopped streaming but is emptying the stream buffer.</p>
|
|
|
796
823
|
|
|
797
824
|
<dl class="py method">
|
|
798
825
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.get_custom_stats_range">
|
|
799
|
-
<span class="sig-name descname"><span class="pre">get_custom_stats_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.get_custom_stats_range" title="
|
|
826
|
+
<span class="sig-name descname"><span class="pre">get_custom_stats_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.get_custom_stats_range" title="Link to this definition">¶</a></dt>
|
|
800
827
|
<dd><p>Returns the QPS statistics information over a specific time ignoring any set annotations.</p>
|
|
801
828
|
<blockquote>
|
|
802
829
|
<div><dl class="simple">
|
|
803
|
-
<dt>start_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to start this can be in integer or
|
|
830
|
+
<dt>start_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to start this can be in integer or string format.
|
|
804
831
|
or using the following format to specify daysDhours:minutes:seconds.milliseconds
|
|
805
832
|
xxxDxx:xx:xx.xxxx</p>
|
|
806
833
|
</dd>
|
|
807
|
-
<dt>end_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to stop this can be in integer or
|
|
834
|
+
<dt>end_time =<span class="classifier">str</span></dt><dd><p>The time in seconds you would like the stats to stop this can be in integer or string format
|
|
808
835
|
or using the following format to specify daysDhours:minutes:seconds.milliseconds
|
|
809
836
|
xxxDxx:xx:xx.xxxx</p>
|
|
810
837
|
</dd>
|
|
@@ -818,7 +845,7 @@ xxxDxx:xx:xx.xxxx</p>
|
|
|
818
845
|
|
|
819
846
|
<dl class="py method">
|
|
820
847
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.get_stats">
|
|
821
|
-
<span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'df'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.get_stats" title="
|
|
848
|
+
<span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'df'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.get_stats" title="Link to this definition">¶</a></dt>
|
|
822
849
|
<dd><p>Returns the QPS annotation statistics grid information as a pandas dataframe object</p>
|
|
823
850
|
<blockquote>
|
|
824
851
|
<div><dl class="simple">
|
|
@@ -830,36 +857,37 @@ xxxDxx:xx:xx.xxxx</p>
|
|
|
830
857
|
|
|
831
858
|
<dl class="py method">
|
|
832
859
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.hideAllDefaultChannels">
|
|
833
|
-
<span class="sig-name descname"><span class="pre">hideAllDefaultChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.hideAllDefaultChannels" title="
|
|
860
|
+
<span class="sig-name descname"><span class="pre">hideAllDefaultChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.hideAllDefaultChannels" title="Link to this definition">¶</a></dt>
|
|
834
861
|
<dd></dd></dl>
|
|
835
862
|
|
|
836
863
|
<dl class="py method">
|
|
837
864
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.hideChannel">
|
|
838
|
-
<span class="sig-name descname"><span class="pre">hideChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.hideChannel" title="
|
|
865
|
+
<span class="sig-name descname"><span class="pre">hideChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.hideChannel" title="Link to this definition">¶</a></dt>
|
|
839
866
|
<dd></dd></dl>
|
|
840
867
|
|
|
841
868
|
<dl class="py method">
|
|
842
869
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.myChannels">
|
|
843
|
-
<span class="sig-name descname"><span class="pre">myChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.myChannels" title="
|
|
870
|
+
<span class="sig-name descname"><span class="pre">myChannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.myChannels" title="Link to this definition">¶</a></dt>
|
|
844
871
|
<dd></dd></dl>
|
|
845
872
|
|
|
846
873
|
<dl class="py method">
|
|
847
874
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.saveCSV">
|
|
848
|
-
<span class="sig-name descname"><span class="pre">saveCSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesPerFile</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">cr</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">delimiter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.saveCSV" title="
|
|
875
|
+
<span class="sig-name descname"><span class="pre">saveCSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filePath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesPerFile</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">cr</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">delimiter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">60</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.saveCSV" title="Link to this definition">¶</a></dt>
|
|
849
876
|
<dd><p>Saves the stream to csv file at specified location</p>
|
|
850
877
|
<dl class="field-list simple">
|
|
851
|
-
<dt class="field-odd">Parameters
|
|
878
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
852
879
|
<dd class="field-odd"><ul class="simple">
|
|
853
880
|
<li><p><strong>filePath=</strong> (<em>str</em>) – The file path that ou would like the CSV file saved to.</p></li>
|
|
854
881
|
<li><p><strong>linesPerFile=</strong> (<em>str</em><em>, </em><em>optional</em>) – The number of lines per CSV file. Can be any int number or “all”</p></li>
|
|
855
882
|
<li><p><strong>cr</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the end of line terminator should include a carriage return.</p></li>
|
|
856
883
|
<li><p><strong>delimiter</strong> (<em>str</em><em>, </em><em>optional</em>) – The delimiter to be used by the csv file.</p></li>
|
|
884
|
+
<li><p><strong>timeout</strong> (<em>str</em><em>, </em><em>otptional</em>) – The timeout to wait for a response from QPS</p></li>
|
|
857
885
|
</ul>
|
|
858
886
|
</dd>
|
|
859
|
-
<dt class="field-even">Returns
|
|
887
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
860
888
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from QPS. “ok” if command is successful or the stack trace if exception thrown</p>
|
|
861
889
|
</dd>
|
|
862
|
-
<dt class="field-odd">Return type
|
|
890
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
863
891
|
<dd class="field-odd"><p>str or None</p>
|
|
864
892
|
</dd>
|
|
865
893
|
</dl>
|
|
@@ -867,12 +895,18 @@ xxxDxx:xx:xx.xxxx</p>
|
|
|
867
895
|
|
|
868
896
|
<dl class="py method">
|
|
869
897
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.showChannel">
|
|
870
|
-
<span class="sig-name descname"><span class="pre">showChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.showChannel" title="
|
|
898
|
+
<span class="sig-name descname"><span class="pre">showChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channelSpecifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.showChannel" title="Link to this definition">¶</a></dt>
|
|
871
899
|
<dd></dd></dl>
|
|
872
900
|
|
|
901
|
+
<dl class="py method">
|
|
902
|
+
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.startQPSStream">
|
|
903
|
+
<span class="sig-name descname"><span class="pre">startQPSStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">newDirectory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.startQPSStream" title="Link to this definition">¶</a></dt>
|
|
904
|
+
<dd><p>STARTS the stream</p>
|
|
905
|
+
</dd></dl>
|
|
906
|
+
|
|
873
907
|
<dl class="py method">
|
|
874
908
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.stats_to_CSV">
|
|
875
|
-
<span class="sig-name descname"><span class="pre">stats_to_CSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.stats_to_CSV" title="
|
|
909
|
+
<span class="sig-name descname"><span class="pre">stats_to_CSV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.stats_to_CSV" title="Link to this definition">¶</a></dt>
|
|
876
910
|
<dd><p>Saves the statistics grid to a csv file</p>
|
|
877
911
|
<blockquote>
|
|
878
912
|
<div><dl class="simple">
|
|
@@ -889,17 +923,17 @@ Default location is the path of the executable.</p>
|
|
|
889
923
|
|
|
890
924
|
<dl class="py method">
|
|
891
925
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.stopStream">
|
|
892
|
-
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.stopStream" title="
|
|
926
|
+
<span class="sig-name descname"><span class="pre">stopStream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.stopStream" title="Link to this definition">¶</a></dt>
|
|
893
927
|
<dd></dd></dl>
|
|
894
928
|
|
|
895
929
|
<dl class="py method">
|
|
896
930
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.stopStreamAndAllowBufferToEmpty">
|
|
897
|
-
<span class="sig-name descname"><span class="pre">stopStreamAndAllowBufferToEmpty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checkInterval</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.stopStreamAndAllowBufferToEmpty" title="
|
|
931
|
+
<span class="sig-name descname"><span class="pre">stopStreamAndAllowBufferToEmpty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checkInterval</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.stopStreamAndAllowBufferToEmpty" title="Link to this definition">¶</a></dt>
|
|
898
932
|
<dd></dd></dl>
|
|
899
933
|
|
|
900
934
|
<dl class="py method">
|
|
901
935
|
<dt class="sig sig-object py" id="quarchpy.device.quarchStream.takeSnapshot">
|
|
902
|
-
<span class="sig-name descname"><span class="pre">takeSnapshot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.takeSnapshot" title="
|
|
936
|
+
<span class="sig-name descname"><span class="pre">takeSnapshot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.quarchStream.takeSnapshot" title="Link to this definition">¶</a></dt>
|
|
903
937
|
<dd><p>Triggers QPS take snapshot function and saves it in the streams directory.</p>
|
|
904
938
|
</dd></dl>
|
|
905
939
|
|
|
@@ -907,27 +941,27 @@ Default location is the path of the executable.</p>
|
|
|
907
941
|
|
|
908
942
|
<dl class="py function">
|
|
909
943
|
<dt class="sig sig-object py" id="quarchpy.device.scanDevices">
|
|
910
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">scanDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lanTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scanInArray</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filterStr</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">module_type_filter</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">ipAddressLookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices" title="
|
|
944
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">scanDevices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lanTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scanInArray</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filterStr</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">module_type_filter</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">ipAddressLookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.scanDevices" title="Link to this definition">¶</a></dt>
|
|
911
945
|
<dd></dd></dl>
|
|
912
946
|
|
|
913
947
|
<dl class="py class">
|
|
914
948
|
<dt class="sig sig-object py" id="quarchpy.device.subDevice">
|
|
915
|
-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">subDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.subDevice" title="
|
|
916
|
-
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">
|
|
949
|
+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">subDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseDevice</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.subDevice" title="Link to this definition">¶</a></dt>
|
|
950
|
+
<dd><p>Bases: <a class="reference internal" href="#quarchpy.device.device.quarchDevice" title="quarchpy.device.device.quarchDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">quarchDevice</span></code></a></p>
|
|
917
951
|
<dl class="py method">
|
|
918
952
|
<dt class="sig sig-object py" id="quarchpy.device.subDevice.sendCommand">
|
|
919
|
-
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.subDevice.sendCommand" title="
|
|
953
|
+
<span class="sig-name descname"><span class="pre">sendCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">CommandString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expectedResponse</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.subDevice.sendCommand" title="Link to this definition">¶</a></dt>
|
|
920
954
|
<dd><p>Executes a text based command on the device. This is the primary way of controlling a device. The full command set available to use
|
|
921
955
|
is found in the technical manual for the device.</p>
|
|
922
956
|
<dl class="field-list simple">
|
|
923
|
-
<dt class="field-odd">Parameters
|
|
957
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
924
958
|
<dd class="field-odd"><p><strong>CommandString</strong> (<em>str</em>) – The text based command string to send to the device</p>
|
|
925
959
|
</dd>
|
|
926
|
-
<dt class="field-even">Returns
|
|
960
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
927
961
|
<dd class="field-even"><p><strong>command_response</strong> – The response text from the module. Multiline responses will be seperated with LF. Some commands
|
|
928
962
|
do not return a response and None will be returned</p>
|
|
929
963
|
</dd>
|
|
930
|
-
<dt class="field-odd">Return type
|
|
964
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
931
965
|
<dd class="field-odd"><p>str or None</p>
|
|
932
966
|
</dd>
|
|
933
967
|
</dl>
|
|
@@ -937,11 +971,11 @@ do not return a response and None will be returned</p>
|
|
|
937
971
|
|
|
938
972
|
<dl class="py function">
|
|
939
973
|
<dt class="sig sig-object py" id="quarchpy.device.userSelectDevice">
|
|
940
|
-
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">userSelectDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</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">scanFilterStr</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">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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">title</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">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.userSelectDevice" title="
|
|
974
|
+
<span class="sig-prename descclassname"><span class="pre">quarchpy.device.</span></span><span class="sig-name descname"><span class="pre">userSelectDevice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scanDictionary</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">scanFilterStr</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">favouriteOnly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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">title</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">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_conn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'all'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.device.userSelectDevice" title="Link to this definition">¶</a></dt>
|
|
941
975
|
<dd></dd></dl>
|
|
942
976
|
|
|
943
|
-
</
|
|
944
|
-
</
|
|
977
|
+
</section>
|
|
978
|
+
</section>
|
|
945
979
|
|
|
946
980
|
|
|
947
981
|
</div>
|
|
@@ -993,7 +1027,7 @@ do not return a response and None will be returned</p>
|
|
|
993
1027
|
</form>
|
|
994
1028
|
</div>
|
|
995
1029
|
</div>
|
|
996
|
-
<script
|
|
1030
|
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
|
997
1031
|
|
|
998
1032
|
|
|
999
1033
|
|
|
@@ -1010,8 +1044,8 @@ do not return a response and None will be returned</p>
|
|
|
1010
1044
|
©2020, Quarch Technology Ltd.
|
|
1011
1045
|
|
|
1012
1046
|
|
|
|
1013
|
-
Powered by <a href="http://sphinx-doc.org/">Sphinx
|
|
1014
|
-
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.
|
|
1047
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
|
|
1048
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
|
1015
1049
|
|
|
1016
1050
|
|
|
|
1017
1051
|
<a href="../_sources/source/quarchpy.device.rst.txt"
|