quarchpy 2.2.8__py2.py3-none-any.whl → 2.2.9.dev1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (195) hide show
  1. quarchpy/__pycache__/__init__.cpython-311.pyc +0 -0
  2. quarchpy/__pycache__/__init__.cpython-313.pyc +0 -0
  3. quarchpy/__pycache__/_version.cpython-311.pyc +0 -0
  4. quarchpy/__pycache__/_version.cpython-313.pyc +0 -0
  5. quarchpy/__pycache__/connection.cpython-311.pyc +0 -0
  6. quarchpy/__pycache__/connection.cpython-313.pyc +0 -0
  7. quarchpy/_version.py +1 -1
  8. quarchpy/config_files/__pycache__/__init__.cpython-311.pyc +0 -0
  9. quarchpy/config_files/__pycache__/__init__.cpython-313.pyc +0 -0
  10. quarchpy/config_files/__pycache__/quarch_config_parser.cpython-311.pyc +0 -0
  11. quarchpy/config_files/__pycache__/quarch_config_parser.cpython-313.pyc +0 -0
  12. quarchpy/connection_specific/QPS/win-amd64/License/Netty-license.txt +143 -0
  13. quarchpy/connection_specific/QPS/win-amd64/{3rdPartyLicenses/argparse4j-LICENSE.txt → License/argparse4j-license.txt} +25 -23
  14. quarchpy/connection_specific/QPS/win-amd64/License/controlsfx-license.txt +26 -0
  15. quarchpy/connection_specific/QPS/win-amd64/License/usb4java-license.txt +167 -0
  16. quarchpy/connection_specific/QPS/win-amd64/app.jar +0 -0
  17. quarchpy/connection_specific/QPS/win-amd64/launchQPSJ21.bat +4 -0
  18. quarchpy/connection_specific/QPS/win-amd64/launchQPSJ21.sh +4 -0
  19. quarchpy/connection_specific/QPS/win-amd64/qis/qis.jar +0 -0
  20. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/CInterface-2.3.jar +0 -0
  21. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/CInterface-2.5.jar +0 -0
  22. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/QuarchCommon-2.0.jar +0 -0
  23. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/{TorridonCommon-1.1.jar → TorridonCommon-1.0.jar} +0 -0
  24. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/TorridonCommon-1.3.jar +0 -0
  25. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/usb4java-1.3.1.jar +0 -0
  26. quarchpy/connection_specific/QPS/win-amd64/qps-command-reference.html +104 -104
  27. quarchpy/connection_specific/QPS/win-amd64/qps.jar +0 -0
  28. quarchpy/connection_specific/QPS/win-amd64/qps_lib/JFXUtilities-1.0.jar +0 -0
  29. quarchpy/connection_specific/QPS/win-amd64/qps_lib/QuarchCommon-2.0.jar +0 -0
  30. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-x64/{javafx-base-21.0.6-linux.jar → javafx-base-21.0.5-linux.jar} +0 -0
  31. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-x64/{javafx-controls-21.0.6-linux.jar → javafx-controls-21.0.5-linux.jar} +0 -0
  32. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-x64/{javafx-fxml-21.0.6-linux.jar → javafx-fxml-21.0.5-linux.jar} +0 -0
  33. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-x64/{javafx-graphics-21.0.6-linux.jar → javafx-graphics-21.0.5-linux.jar} +0 -0
  34. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-x64/{javafx-swing-21.0.6-linux.jar → javafx-swing-21.0.5-linux.jar} +0 -0
  35. quarchpy/connection_specific/QPS/win-amd64/qps_lib/{mac-x64/javafx-base-21.0.6-mac.jar → mac-arm64/javafx-base-21.0.5-mac-aarch64.jar} +0 -0
  36. quarchpy/connection_specific/QPS/win-amd64/qps_lib/mac-arm64/{javafx-controls-21.0.6-mac-aarch64.jar → javafx-controls-21.0.5-mac-aarch64.jar} +0 -0
  37. quarchpy/connection_specific/QPS/win-amd64/qps_lib/{mac-x64/javafx-fxml-21.0.6-mac.jar → mac-arm64/javafx-fxml-21.0.5-mac-aarch64.jar} +0 -0
  38. quarchpy/connection_specific/QPS/win-amd64/qps_lib/mac-arm64/{javafx-graphics-21.0.6-mac-aarch64.jar → javafx-graphics-21.0.5-mac-aarch64.jar} +0 -0
  39. quarchpy/connection_specific/QPS/win-amd64/qps_lib/{mac-x64/javafx-swing-21.0.6-mac.jar → mac-arm64/javafx-swing-21.0.5-mac-aarch64.jar} +0 -0
  40. quarchpy/connection_specific/QPS/win-amd64/qps_lib/{mac-arm64/javafx-base-21.0.6-mac-aarch64.jar → mac-x64/javafx-base-21.0.5-mac.jar} +0 -0
  41. quarchpy/connection_specific/QPS/win-amd64/qps_lib/mac-x64/{javafx-controls-21.0.6-mac.jar → javafx-controls-21.0.5-mac.jar} +0 -0
  42. quarchpy/connection_specific/QPS/win-amd64/qps_lib/{mac-arm64/javafx-fxml-21.0.6-mac-aarch64.jar → mac-x64/javafx-fxml-21.0.5-mac.jar} +0 -0
  43. quarchpy/connection_specific/QPS/win-amd64/qps_lib/mac-x64/{javafx-graphics-21.0.6-mac.jar → javafx-graphics-21.0.5-mac.jar} +0 -0
  44. quarchpy/connection_specific/QPS/win-amd64/qps_lib/{mac-arm64/javafx-swing-21.0.6-mac-aarch64.jar → mac-x64/javafx-swing-21.0.5-mac.jar} +0 -0
  45. quarchpy/connection_specific/QPS/win-amd64/qps_lib/win-x64/{javafx-base-21.0.6-win.jar → javafx-base-21.0.5-win.jar} +0 -0
  46. quarchpy/connection_specific/QPS/win-amd64/qps_lib/win-x64/{javafx-controls-21.0.6-win.jar → javafx-controls-21.0.5-win.jar} +0 -0
  47. quarchpy/connection_specific/QPS/win-amd64/qps_lib/win-x64/{javafx-fxml-21.0.6-win.jar → javafx-fxml-21.0.5-win.jar} +0 -0
  48. quarchpy/connection_specific/QPS/win-amd64/qps_lib/win-x64/{javafx-graphics-21.0.6-win.jar → javafx-graphics-21.0.5-win.jar} +0 -0
  49. quarchpy/connection_specific/QPS/win-amd64/qps_lib/win-x64/{javafx-swing-21.0.6-win.jar → javafx-swing-21.0.5-win.jar} +0 -0
  50. quarchpy/connection_specific/QPS/win-amd64/scriptCommands.txt +4 -4
  51. quarchpy/connection_specific/QPS/win-amd64/whats-new.txt +12 -20
  52. quarchpy/connection_specific/__pycache__/StreamChannels.cpython-311.pyc +0 -0
  53. quarchpy/connection_specific/__pycache__/StreamChannels.cpython-313.pyc +0 -0
  54. quarchpy/connection_specific/__pycache__/__init__.cpython-311.pyc +0 -0
  55. quarchpy/connection_specific/__pycache__/__init__.cpython-313.pyc +0 -0
  56. quarchpy/connection_specific/__pycache__/connection_QIS.cpython-311.pyc +0 -0
  57. quarchpy/connection_specific/__pycache__/connection_QIS.cpython-313.pyc +0 -0
  58. quarchpy/connection_specific/__pycache__/connection_QPS.cpython-311.pyc +0 -0
  59. quarchpy/connection_specific/__pycache__/connection_QPS.cpython-313.pyc +0 -0
  60. quarchpy/connection_specific/__pycache__/connection_ReST.cpython-311.pyc +0 -0
  61. quarchpy/connection_specific/__pycache__/connection_ReST.cpython-313.pyc +0 -0
  62. quarchpy/connection_specific/__pycache__/connection_Serial.cpython-311.pyc +0 -0
  63. quarchpy/connection_specific/__pycache__/connection_Serial.cpython-313.pyc +0 -0
  64. quarchpy/connection_specific/__pycache__/connection_TCP.cpython-311.pyc +0 -0
  65. quarchpy/connection_specific/__pycache__/connection_TCP.cpython-313.pyc +0 -0
  66. quarchpy/connection_specific/__pycache__/connection_USB.cpython-311.pyc +0 -0
  67. quarchpy/connection_specific/__pycache__/connection_USB.cpython-313.pyc +0 -0
  68. quarchpy/connection_specific/__pycache__/mDNS.cpython-311.pyc +0 -0
  69. quarchpy/connection_specific/__pycache__/mDNS.cpython-313.pyc +0 -0
  70. quarchpy/connection_specific/jdk_j21_jres/__pycache__/__init__.cpython-311.pyc +0 -0
  71. quarchpy/connection_specific/jdk_j21_jres/__pycache__/__init__.cpython-313.pyc +0 -0
  72. quarchpy/connection_specific/jdk_j21_jres/__pycache__/fix_permissions.cpython-311.pyc +0 -0
  73. quarchpy/connection_specific/jdk_j21_jres/__pycache__/fix_permissions.cpython-313.pyc +0 -0
  74. quarchpy/connection_specific/serial/__pycache__/__init__.cpython-311.pyc +0 -0
  75. quarchpy/connection_specific/serial/__pycache__/__init__.cpython-313.pyc +0 -0
  76. quarchpy/connection_specific/serial/__pycache__/serialutil.cpython-311.pyc +0 -0
  77. quarchpy/connection_specific/serial/__pycache__/serialutil.cpython-313.pyc +0 -0
  78. quarchpy/connection_specific/serial/__pycache__/serialwin32.cpython-311.pyc +0 -0
  79. quarchpy/connection_specific/serial/__pycache__/serialwin32.cpython-313.pyc +0 -0
  80. quarchpy/connection_specific/serial/__pycache__/win32.cpython-311.pyc +0 -0
  81. quarchpy/connection_specific/serial/__pycache__/win32.cpython-313.pyc +0 -0
  82. quarchpy/connection_specific/serial/tools/__pycache__/__init__.cpython-311.pyc +0 -0
  83. quarchpy/connection_specific/serial/tools/__pycache__/__init__.cpython-313.pyc +0 -0
  84. quarchpy/connection_specific/serial/tools/__pycache__/list_ports.cpython-311.pyc +0 -0
  85. quarchpy/connection_specific/serial/tools/__pycache__/list_ports.cpython-313.pyc +0 -0
  86. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_common.cpython-311.pyc +0 -0
  87. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_common.cpython-313.pyc +0 -0
  88. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_windows.cpython-311.pyc +0 -0
  89. quarchpy/connection_specific/serial/tools/__pycache__/list_ports_windows.cpython-313.pyc +0 -0
  90. quarchpy/connection_specific/usb_libs/__pycache__/libusb1.cpython-311.pyc +0 -0
  91. quarchpy/connection_specific/usb_libs/__pycache__/usb1.cpython-311.pyc +0 -0
  92. quarchpy/connection_specific/usb_libs/usb1.py +2360 -2360
  93. quarchpy/debug/SystemTest.py +8 -1
  94. quarchpy/debug/__pycache__/SystemTest.cpython-311.pyc +0 -0
  95. quarchpy/debug/__pycache__/SystemTest.cpython-313.pyc +0 -0
  96. quarchpy/debug/__pycache__/__init__.cpython-311.pyc +0 -0
  97. quarchpy/debug/__pycache__/__init__.cpython-313.pyc +0 -0
  98. quarchpy/debug/__pycache__/module_debug.cpython-313.pyc +0 -0
  99. quarchpy/debug/__pycache__/simple_terminal.cpython-313.pyc +0 -0
  100. quarchpy/debug/__pycache__/upgrade_quarchpy.cpython-313.pyc +0 -0
  101. quarchpy/debug/__pycache__/versionCompare.cpython-311.pyc +0 -0
  102. quarchpy/debug/__pycache__/versionCompare.cpython-313.pyc +0 -0
  103. quarchpy/device/__pycache__/__init__.cpython-311.pyc +0 -0
  104. quarchpy/device/__pycache__/__init__.cpython-313.pyc +0 -0
  105. quarchpy/device/__pycache__/device.cpython-311.pyc +0 -0
  106. quarchpy/device/__pycache__/device.cpython-313.pyc +0 -0
  107. quarchpy/device/__pycache__/quarchArray.cpython-311.pyc +0 -0
  108. quarchpy/device/__pycache__/quarchArray.cpython-313.pyc +0 -0
  109. quarchpy/device/__pycache__/quarchPPM.cpython-311.pyc +0 -0
  110. quarchpy/device/__pycache__/quarchPPM.cpython-313.pyc +0 -0
  111. quarchpy/device/__pycache__/quarchQPS.cpython-311.pyc +0 -0
  112. quarchpy/device/__pycache__/quarchQPS.cpython-313.pyc +0 -0
  113. quarchpy/device/__pycache__/scanDevices.cpython-311.pyc +0 -0
  114. quarchpy/device/__pycache__/scanDevices.cpython-313.pyc +0 -0
  115. quarchpy/device/quarchQPS.py +20 -17
  116. quarchpy/disk_test/__pycache__/AbsDiskFinder.cpython-311.pyc +0 -0
  117. quarchpy/disk_test/__pycache__/AbsDiskFinder.cpython-313.pyc +0 -0
  118. quarchpy/disk_test/__pycache__/DiskTargetSelection.cpython-311.pyc +0 -0
  119. quarchpy/disk_test/__pycache__/DiskTargetSelection.cpython-313.pyc +0 -0
  120. quarchpy/disk_test/__pycache__/__init__.cpython-311.pyc +0 -0
  121. quarchpy/disk_test/__pycache__/__init__.cpython-313.pyc +0 -0
  122. quarchpy/disk_test/__pycache__/iometerDiskFinder.cpython-311.pyc +0 -0
  123. quarchpy/disk_test/__pycache__/iometerDiskFinder.cpython-313.pyc +0 -0
  124. quarchpy/docs/Makefile +20 -20
  125. quarchpy/docs/_build/html/_static/custom.css +1 -1
  126. quarchpy/docs/_build/html/_static/doctools.js +149 -149
  127. quarchpy/docs/_build/html/_static/jquery-3.4.1.js +10598 -10598
  128. quarchpy/docs/_build/html/_static/jquery.js +2 -2
  129. quarchpy/docs/_build/html/_static/searchtools.js +632 -632
  130. quarchpy/docs/_build/html/_static/sphinx_highlight.js +154 -154
  131. quarchpy/docs/_build/html/_static/underscore-1.3.1.js +999 -999
  132. quarchpy/docs/_build/html/_static/underscore.js +5 -5
  133. quarchpy/fio/HIDEtest_performance_class.py +1 -1
  134. quarchpy/fio/__pycache__/FIO_interface.cpython-311.pyc +0 -0
  135. quarchpy/fio/__pycache__/FIO_interface.cpython-313.pyc +0 -0
  136. quarchpy/fio/__pycache__/__init__.cpython-311.pyc +0 -0
  137. quarchpy/fio/__pycache__/__init__.cpython-313.pyc +0 -0
  138. quarchpy/iometer/__pycache__/__init__.cpython-311.pyc +0 -0
  139. quarchpy/iometer/__pycache__/__init__.cpython-313.pyc +0 -0
  140. quarchpy/iometer/__pycache__/gen_iometer_template.cpython-311.pyc +0 -0
  141. quarchpy/iometer/__pycache__/gen_iometer_template.cpython-313.pyc +0 -0
  142. quarchpy/iometer/__pycache__/iometerFuncs.cpython-311.pyc +0 -0
  143. quarchpy/iometer/__pycache__/iometerFuncs.cpython-313.pyc +0 -0
  144. quarchpy/qis/__pycache__/StreamHeaderInfo.cpython-311.pyc +0 -0
  145. quarchpy/qis/__pycache__/StreamHeaderInfo.cpython-313.pyc +0 -0
  146. quarchpy/qis/__pycache__/__init__.cpython-311.pyc +0 -0
  147. quarchpy/qis/__pycache__/__init__.cpython-313.pyc +0 -0
  148. quarchpy/qis/__pycache__/qisFuncs.cpython-311.pyc +0 -0
  149. quarchpy/qis/__pycache__/qisFuncs.cpython-313.pyc +0 -0
  150. quarchpy/qis/qisFuncs.py +2 -0
  151. quarchpy/qps/__pycache__/__init__.cpython-311.pyc +0 -0
  152. quarchpy/qps/__pycache__/__init__.cpython-313.pyc +0 -0
  153. quarchpy/qps/__pycache__/qpsFuncs.cpython-311.pyc +0 -0
  154. quarchpy/qps/__pycache__/qpsFuncs.cpython-313.pyc +0 -0
  155. quarchpy/user_interface/__pycache__/__init__.cpython-311.pyc +0 -0
  156. quarchpy/user_interface/__pycache__/__init__.cpython-313.pyc +0 -0
  157. quarchpy/user_interface/__pycache__/user_interface.cpython-311.pyc +0 -0
  158. quarchpy/user_interface/__pycache__/user_interface.cpython-313.pyc +0 -0
  159. quarchpy/utilities/__pycache__/TestCenter.cpython-311.pyc +0 -0
  160. quarchpy/utilities/__pycache__/TestCenter.cpython-313.pyc +0 -0
  161. quarchpy/utilities/__pycache__/TimeValue.cpython-311.pyc +0 -0
  162. quarchpy/utilities/__pycache__/TimeValue.cpython-313.pyc +0 -0
  163. quarchpy/utilities/__pycache__/Version.cpython-311.pyc +0 -0
  164. quarchpy/utilities/__pycache__/Version.cpython-313.pyc +0 -0
  165. quarchpy/utilities/__pycache__/__init__.cpython-311.pyc +0 -0
  166. quarchpy/utilities/__pycache__/__init__.cpython-313.pyc +0 -0
  167. {quarchpy-2.2.8.dist-info → quarchpy-2.2.9.dev1.dist-info}/METADATA +3 -12
  168. {quarchpy-2.2.8.dist-info → quarchpy-2.2.9.dev1.dist-info}/RECORD +174 -77
  169. {quarchpy-2.2.8.dist-info → quarchpy-2.2.9.dev1.dist-info}/WHEEL +1 -1
  170. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/com.sun.istack-license.html +0 -59
  171. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/commons-io-LICENSE-2.0.txt +0 -202
  172. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/controlsfx-license.txt +0 -29
  173. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/jakarta.activation-license.html +0 -59
  174. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/jakarta.xml.bind-api-license.html +0 -59
  175. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/netty-LICENSE.txt +0 -202
  176. quarchpy/connection_specific/QPS/win-amd64/3rdPartyLicenses/netty-NOTICE.txt +0 -239
  177. quarchpy/connection_specific/QPS/win-amd64/InstallType.dat +0 -1
  178. quarchpy/connection_specific/QPS/win-amd64/app.properties +0 -6
  179. quarchpy/connection_specific/QPS/win-amd64/license.txt +0 -1
  180. quarchpy/connection_specific/QPS/win-amd64/qis/qis_lib/jmdns-3.5.9.jar +0 -0
  181. quarchpy/connection_specific/QPS/win-amd64/qps_lib/commons-io-2.18.0.jar +0 -0
  182. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-arm64/javafx-base-21.0.6-linux-aarch64.jar +0 -0
  183. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-arm64/javafx-controls-21.0.6-linux-aarch64.jar +0 -0
  184. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-arm64/javafx-fxml-21.0.6-linux-aarch64.jar +0 -0
  185. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-arm64/javafx-graphics-21.0.6-linux-aarch64.jar +0 -0
  186. quarchpy/connection_specific/QPS/win-amd64/qps_lib/lin-arm64/javafx-swing-21.0.6-linux-aarch64.jar +0 -0
  187. quarchpy/connection_specific/QPS/win-amd64/qps_lib/qutils-1.0.jar +0 -0
  188. quarchpy/fio_tests_file.fio +0 -1
  189. quarchpy/tests/test_device/test_scanDevices.py +0 -21
  190. quarchpy/utilities/utils.py +0 -64
  191. /quarchpy/connection_specific/QPS/win-amd64/DeviceConfig/{QTL1995-02.xml → QTL1995-02.XML} +0 -0
  192. /quarchpy/connection_specific/QPS/win-amd64/DeviceConfig/{QTL1999-02.xml → QTL1999-02.XML} +0 -0
  193. /quarchpy/connection_specific/QPS/win-amd64/DeviceConfig/{QTL2312-01.xml → QTL2312-01.XML} +0 -0
  194. /quarchpy/connection_specific/QPS/win-amd64/{3rdPartyLicenses → License}/Material-Icons-license.txt +0 -0
  195. {quarchpy-2.2.8.dist-info → quarchpy-2.2.9.dev1.dist-info}/top_level.txt +0 -0
@@ -55,7 +55,7 @@ th {
55
55
  <body>
56
56
  <div class="outer-container">
57
57
  <h1><a name="index">Quarch Power Studio Command Reference</a></h1>
58
- <p>Copyright (c) Quarch Ltd</p><p>QPS v1.46</p><p>Generated:10 Apr 2025</p><p>This document lists the commands that can be sent to QPS over the TCP interface. By default
58
+ <p>Copyright (c) Quarch Ltd</p><p>QPS v1.44.2</p><p>Generated:14 Jan 2025</p><p>This document lists the commands that can be sent to QPS over the TCP interface. By default
59
59
  QPS will open port 9822. Commands may be sent as UTF-8 text with the standard line terminator \r\n
60
60
  denoting the end of a command.
61
61
  </p><ul>
@@ -64,14 +64,6 @@ QPS will open port 9822. Commands may be sent as UTF-8 text with the standard li
64
64
  <li>
65
65
  <a href="#channels">$channels</a></li>
66
66
  <li>
67
- <a href="#chartchannelhide">$chart channel hide</a></li>
68
- <li>
69
- <a href="#chartchannelshow">$chart channel show</a></li>
70
- <li>
71
- <a href="#chartreposition">$chart reposition</a></li>
72
- <li>
73
- <a href="#chartsnapshot">$chart snapshot</a></li>
74
- <li>
75
67
  <a href="#comment">$comment</a></li>
76
68
  <li>
77
69
  <a href="#connect">$connect</a></li>
@@ -80,8 +72,6 @@ QPS will open port 9822. Commands may be sent as UTF-8 text with the standard li
80
72
  <li>
81
73
  <a href="#createchannel">$create channel</a></li>
82
74
  <li>
83
- <a href="#debuglistcommands">$debug list commands</a></li>
84
- <li>
85
75
  <a href="#echo">$echo</a></li>
86
76
  <li>
87
77
  <a href="#getcustomstatsrange">$get custom stats range</a></li>
@@ -98,32 +88,8 @@ QPS will open port 9822. Commands may be sent as UTF-8 text with the standard li
98
88
  <li>
99
89
  <a href="#log">$log</a></li>
100
90
  <li>
101
- <a href="#moduleconnect">$module connect</a></li>
102
- <li>
103
- <a href="#moduledisconnect">$module disconnect</a></li>
104
- <li>
105
- <a href="#modulelist">$module list</a></li>
106
- <li>
107
- <a href="#modulelistdetails">$module list details</a></li>
108
- <li>
109
- <a href="#modulename">$module name</a></li>
110
- <li>
111
- <a href="#modulescan">$module scan</a></li>
112
- <li>
113
- <a href="#openrecording">$open recording</a></li>
114
- <li>
115
- <a href="#progresscheck">$progress check</a></li>
116
- <li>
117
- <a href="#qislaunch">$qis launch</a></li>
118
- <li>
119
- <a href="#qisshutdown">$qis shutdown</a></li>
120
- <li>
121
91
  <a href="#qisstatus">$qis status</a></li>
122
92
  <li>
123
- <a href="#qpshide">$qps hide</a></li>
124
- <li>
125
- <a href="#qpsshow">$qps show</a></li>
126
- <li>
127
93
  <a href="#read">$read</a></li>
128
94
  <li>
129
95
  <a href="#savecsv">$save csv</a></li>
@@ -140,23 +106,33 @@ QPS will open port 9822. Commands may be sent as UTF-8 text with the standard li
140
106
  <li>
141
107
  <a href="#stopstream">$stop stream</a></li>
142
108
  <li>
143
- <a href="#streamannotationadd">$stream annotation add</a></li>
109
+ <a href="#streamstate">$stream state</a></li>
144
110
  <li>
145
- <a href="#streamannotationslist">$stream annotations list</a></li>
111
+ <a href="#takesnapshot">$take snapshot</a></li>
146
112
  <li>
147
- <a href="#streamannotationstable">$stream annotations table</a></li>
113
+ <a href="#version">$version</a></li>
148
114
  <li>
149
- <a href="#streamchanneladd">$stream channel add</a></li>
115
+ <a href="#chartchannelhide">$chart channel hide</a></li>
150
116
  <li>
151
- <a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li>
117
+ <a href="#chartchannelshow">$chart channel show</a></li>
152
118
  <li>
153
- <a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li>
119
+ <a href="#chartsnapshot">$chart snapshot</a></li>
154
120
  <li>
155
- <a href="#streamchannellist">$stream channel list</a></li>
121
+ <a href="#debuglistcommands">$debug list commands</a></li>
156
122
  <li>
157
- <a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li>
123
+ <a href="#moduleconnect">$module connect</a></li>
158
124
  <li>
159
- <a href="#streamchanneltable">$stream channel table</a></li>
125
+ <a href="#modulelist">$module list</a></li>
126
+ <li>
127
+ <a href="#modulelistdetails">$module list details</a></li>
128
+ <li>
129
+ <a href="#modulename">$module name</a></li>
130
+ <li>
131
+ <a href="#modulescan">$module scan</a></li>
132
+ <li>
133
+ <a href="#streamannotationadd">$stream annotation add</a></li>
134
+ <li>
135
+ <a href="#streamchanneladd">$stream channel add</a></li>
160
136
  <li>
161
137
  <a href="#streamchannels">$stream channels</a></li>
162
138
  <li>
@@ -172,23 +148,47 @@ QPS will open port 9822. Commands may be sent as UTF-8 text with the standard li
172
148
  <li>
173
149
  <a href="#streamrecord">$stream record</a></li>
174
150
  <li>
175
- <a href="#streamrecordduration">$stream record duration</a></li>
176
- <li>
177
- <a href="#streamstarttime">$stream start time</a></li>
178
- <li>
179
- <a href="#streamstate">$stream state</a></li>
180
- <li>
181
151
  <a href="#streamstatsexport">$stream stats export</a></li>
182
152
  <li>
183
153
  <a href="#streamstatstable">$stream stats table</a></li>
184
154
  <li>
185
155
  <a href="#streamstop">$stream stop</a></li>
186
156
  <li>
157
+ <a href="#chartreposition">$chart reposition</a></li>
158
+ <li>
159
+ <a href="#moduledisconnect">$module disconnect</a></li>
160
+ <li>
161
+ <a href="#openrecording">$open recording</a></li>
162
+ <li>
163
+ <a href="#progresscheck">$progress check</a></li>
164
+ <li>
165
+ <a href="#qisshutdown">$qis shutdown</a></li>
166
+ <li>
167
+ <a href="#qislaunch">$qis launch</a></li>
168
+ <li>
169
+ <a href="#qpshide">$qps hide</a></li>
170
+ <li>
171
+ <a href="#qpsshow">$qps show</a></li>
172
+ <li>
173
+ <a href="#streamannotationslist">$stream annotations list</a></li>
174
+ <li>
175
+ <a href="#streamannotationstable">$stream annotations table</a></li>
176
+ <li>
177
+ <a href="#streamstarttime">$stream start time</a></li>
178
+ <li>
187
179
  <a href="#streamstoptime">$stream stop time</a></li>
188
180
  <li>
189
- <a href="#takesnapshot">$take snapshot</a></li>
181
+ <a href="#streamrecordduration">$stream record duration</a></li>
190
182
  <li>
191
- <a href="#version">$version</a></li>
183
+ <a href="#streamchannellist">$stream channel list</a></li>
184
+ <li>
185
+ <a href="#streamchanneltable">$stream channel table</a></li>
186
+ <li>
187
+ <a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li>
188
+ <li>
189
+ <a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li>
190
+ <li>
191
+ <a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li>
192
192
  </ul>
193
193
  <hr/>
194
194
  <div class="content-item"><h2><a name="annotate">$annotate</a></h2><p class="version">Version 1</p><p>Adds an annotation</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>time</code></td><td><code>STRING</code></td><td>Annotation time</td></tr><tr><td><code>2</code></td><td><code>text</code></td><td><code>STRING</code></td><td>Annotation string</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Format of params string: time_specifier[space]text to be added, eg 123.456 hello world</p><p>Time specifier is of the form:
@@ -197,14 +197,6 @@ for absolute time, pass the number of milliseconds since the epoch (midnight 1 J
197
197
  <hr/>
198
198
  <div class="content-item"><h2><a name="channels">$channels</a></h2><p class="version">Version 1</p><p>Returns details of the current channels</p><p>No arguments</p><p><span class="notes-title">Notes:&nbsp;</span>Return details of current channels in the format: channelName groupName baseUnits</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannels">$stream channels</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
199
199
  <hr/>
200
- <div class="content-item"><h2><a name="chartchannelhide">$chart channel hide</a></h2><p class="version">Version 2</p><p>Hides a channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Channel</td></tr><tr><td><code>2</code></td><td><code>group</code></td><td><code>STRING</code></td><td>Group</td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#hidechannel">$hide channel</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
201
- <hr/>
202
- <div class="content-item"><h2><a name="chartchannelshow">$chart channel show</a></h2><p class="version">Version 2</p><p>Shows a channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Channel</td></tr><tr><td><code>2</code></td><td><code>group</code></td><td><code>STRING</code></td><td>Group</td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#showchannel">$show channel</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
203
- <hr/>
204
- <div class="content-item"><h2><a name="chartreposition">$chart reposition</a></h2><p class="version">Version 2</p><p>Sets the chart main view to the specified start and end times</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>startTime</code></td><td><code>STRING</code></td><td>Start time</td></tr><tr><td><code>2</code></td><td><code>endTime</code></td><td><code>STRING</code></td><td>End time</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Both the start and end times are specified as a time-unit pair; for example: 100mS</p><p>startTime &gt; 0, endTime &gt; 0 and startTime &lt; endTime</p><div class="examples-title">Examples</div><p><code>$chart reposition 10S 20S</code></p><p class="backlink"><a href="#index">Back to index</a></p></div>
205
- <hr/>
206
- <div class="content-item"><h2><a name="chartsnapshot">$chart snapshot</a></h2><p class="version">Version 2</p><p>Takes a snapshot of the chart, timeline and channels windows</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Type of snapshot to take consisting of a comma separated list of options: [all, chart, timeline, key]<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>chart</code></li><li><code>timeline</code></li><li><code>key</code></li></ul></p></td></tr><tr><td><code>2</code></td><td><code>filePath</code></td><td><code>STRING</code></td><td>Optional file path instead of using default archive path</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$chart snapshot --&gt; default and captures chart+timeline+key</code></p><p><code>$chart snapshot all --&gt; same as default</code></p><p><code>$chart snapshot chart --&gt; chart only</code></p><p><code>$chart snapshot chart,key --&gt; chart+key</code></p><p><code>$chart snapshot chart,timeline --&gt; chart+timeline</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#takesnapshot">$take snapshot</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
207
- <hr/>
208
200
  <div class="content-item"><h2><a name="comment">$comment</a></h2><p class="version">Version 1</p><p>Adds a comment</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>time</code></td><td><code>STRING</code></td><td>Comment time</td></tr><tr><td><code>2</code></td><td><code>text</code></td><td><code>STRING</code></td><td>Comment string</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Format of params string: time_specifier[space]text to be added, eg 123.456 hello world</p><p>Time specifier is of the form:
209
201
  for elapsed time relative to the recording: exxxDxxx:xxx:xxx.xxx
210
202
  for absolute time, pass the number of milliseconds since the epoch (midnight 1 January 1970 UTC, ie Unix time common to many environments): xxxxxxxxxxxx</p><p>The annotation text may be split over two or more lines by including \n in the string</p><div class="examples-title">Examples</div><p><code>$comment e1 Comment1 --&gt; adds a comment after an elapsed time of 1 second</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#annotate">$annotate</a></li><li><a href="#streamannotationadd">$stream annotation add</a></li><li><a href="#streamcommentadd">$stream comment add</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
@@ -216,8 +208,6 @@ or the reason for connection failure. If connection is successful, the CCS and f
216
208
  <hr/>
217
209
  <div class="content-item"><h2><a name="createchannel">$create channel</a></h2><p class="version">Version 1</p><p>Creates a new channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelName</code></td><td><code>STRING</code></td><td>Channel name</td></tr><tr><td><code>2</code></td><td><code>channelGroup</code></td><td><code>STRING</code></td><td>Channel group</td></tr><tr><td><code>3</code></td><td><code>baseUnits</code></td><td><code>STRING</code></td><td>Base units</td></tr><tr><td><code>4</code></td><td><code>usePrefix</code></td><td><code>STRING</code></td><td>Indicates whether or not using a prefix; values either yes/no</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Format: channelName channelGroup baseUnits yes/no(usePrefix)</p><p>usePrefix [yes/no] option 'no' disables the application of metric prefixes u, m, k, M etc</p><p>A custom channel group name must be distinct from device group names</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchanneladd">$stream channel add</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
218
210
  <hr/>
219
- <div class="content-item"><h2><a name="debuglistcommands">$debug list commands</a></h2><p class="version">Version 2</p><p>Returns a list of commands</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
220
- <hr/>
221
211
  <div class="content-item"><h2><a name="echo">$echo</a></h2><p class="version">Version 1</p><p>Echo command</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>string</code></td><td><code>STRING</code></td><td>A string of text to simply echo back</td></tr></tbody></table><br/><p class="backlink"><a href="#index">Back to index</a></p></div>
222
212
  <hr/>
223
213
  <div class="content-item"><h2><a name="getcustomstatsrange">$get custom stats range</a></h2><p class="version">Version 1</p><p>Returns statistics for a specified range</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>startTime</code></td><td><code>STRING</code></td><td>Start time. For example: 5432.1 is 5432.1 seconds, 17d5432.1 is 17 days 5432.1 seconds, 17d200:5432.1 is 17 days 200 minutes and 5432.1 seconds etc</td></tr><tr><td><code>2</code></td><td><code>endTime_numRecords</code></td><td><code>STRING</code></td><td>End time OR number of records of form: [endTime | lnumber of records] in which letter "l" denotes that number of records is being specified</td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstatstable">$stream stats table</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
@@ -234,33 +224,9 @@ or the reason for connection failure. If connection is successful, the CCS and f
234
224
  <hr/>
235
225
  <div class="content-item"><h2><a name="log">$log</a></h2><p class="version">Version 1</p><p>Adds a channel/group value at a specified time</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Channel name</td></tr><tr><td><code>2</code></td><td><code>group</code></td><td><code>STRING</code></td><td>Group name</td></tr><tr><td><code>3</code></td><td><code>time</code></td><td><code>INT</code></td><td>Time</td></tr><tr><td><code>4</code></td><td><code>value</code></td><td><code>FLOAT</code></td><td>Value</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Format: channelName channelGroup time value</p><p>Time format: UNIX time in mS or exxxDxx:xx:xx.xxxx for daysDhours:minutes:seconds.xxx</p><p>To indicate the end marker of an interval then set the value to 'endSeq'; eg : myStream.addDataPoint(channelName, groupName, 'endSeq')</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamdataadd">$stream data add</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
236
226
  <hr/>
237
- <div class="content-item"><h2><a name="moduleconnect">$module connect</a></h2><p class="version">Version 2</p><p>Connects to a specified device</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>device</code></td><td><code>STRING</code></td><td>Device ID</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>$module connect supports both device names and IP addresses</p><div class="examples-title">Examples</div><p><code>$module connect usb::QTL1999-02-999</code></p><p><code>$module connect tcp::81.187.174.46</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#connect">$connect</a></li><li><a href="#moduledisconnect">$module disconnect</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
238
- <hr/>
239
- <div class="content-item"><h2><a name="moduledisconnect">$module disconnect</a></h2><p class="version">Version 2</p><p>Disconnects the current connection</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#connect">$connect</a></li><li><a href="#moduleconnect">$module connect</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
240
- <hr/>
241
- <div class="content-item"><h2><a name="modulelist">$module list</a></h2><p class="version">Version 2</p><p>Lists available devices</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#list">$list</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
242
- <hr/>
243
- <div class="content-item"><h2><a name="modulelistdetails">$module list details</a></h2><p class="version">Version 2</p><p>Lists available device details</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#list-details">$list -details</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
244
- <hr/>
245
- <div class="content-item"><h2><a name="modulename">$module name</a></h2><p class="version">Version 2</p><p>Returns the connected device ID</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#connected">$connected</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
246
- <hr/>
247
- <div class="content-item"><h2><a name="modulescan">$module scan</a></h2><p class="version">Version 2</p><p>Scans for available devices</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>deviceSpecifier</code></td><td><code>STRING</code></td><td>TCP/IP address to scan for devices</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$module scan tcp::192.168.1.90</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#scan">$scan</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
248
- <hr/>
249
- <div class="content-item"><h2><a name="openrecording">$open recording</a></h2><p class="version">Version 2</p><p>Opens a recording</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>qpsFile</code></td><td><code>STRING</code></td><td>.qps file</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$open recording qpsFile="C:\quarch\recordings\AC\AC_Gen_test\AC_Gen_Test.qps"</code></p><p class="backlink"><a href="#index">Back to index</a></p></div>
250
- <hr/>
251
- <div class="content-item"><h2><a name="progresscheck">$progress check</a></h2><p class="version">Version 2</p><p>Checks the progress of a specific QPS task</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>task</code></td><td><code>STRING</code></td><td>The task to be checked<p><span class="acceptable-title">Acceptable Values</span><ul><li><code>open&nbsp;recording</code></li></ul></p></td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$progress check task="open recording"</code></p><p class="backlink"><a href="#index">Back to index</a></p></div>
252
- <hr/>
253
- <div class="content-item"><h2><a name="qislaunch">$qis launch</a></h2><p class="version">Version 2</p><p>Launches new QIS instance</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qisshutdown">$qis shutdown</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
254
- <hr/>
255
- <div class="content-item"><h2><a name="qisshutdown">$qis shutdown</a></h2><p class="version">Version 2</p><p>Shuts down current QIS instance</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qislaunch">$qis launch</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
256
- <hr/>
257
227
  <div class="content-item"><h2><a name="qisstatus">$qis status</a></h2><p class="version">Version 1</p><p>Reports the connection status of QIS</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
258
228
  <hr/>
259
- <div class="content-item"><h2><a name="qpshide">$qps hide</a></h2><p class="version">Version 2</p><p>Hides the QPS application</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qpsshow">$qps show</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
260
- <hr/>
261
- <div class="content-item"><h2><a name="qpsshow">$qps show</a></h2><p class="version">Version 2</p><p>Shows the QPS application</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qpshide">$qps hide</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
262
- <hr/>
263
- <div class="content-item"><h2><a name="read">$read</a></h2><p class="version">Version 1</p><p>Reads data between a given start time and either end time or number of records</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>startTime</code></td><td><code>INT</code></td><td>Start time</td></tr><tr><td><code>2</code></td><td><code>endTime_numRecords</code></td><td><code>STRING</code></td><td>Number of records of form: [endTime | lnumber of records], in which the letter "l" denotes that the number of records is being specified</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Times are xxxDxx:xx:xx.xxxx for daysDhours:minutes:seconds.xxx, number of records is exactly what you'd expect</p><p>Returns corresponding (long) sample time and all columns in raw format separated by ' ' spaces.</p><div class="examples-title">Examples</div><p><code>$read 0 l100</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamread">$stream read</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
229
+ <div class="content-item"><h2><a name="read">$read</a></h2><p class="version">Version 1</p><p>Reads data between from a given start time and either end time or number of records</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>startTime</code></td><td><code>INT</code></td><td>Start time</td></tr><tr><td><code>2</code></td><td><code>endTime_numRecords</code></td><td><code>STRING</code></td><td>Number of records of form: [endTime | lnumber of records], in which the letter "l" denotes that the number of records is being specified</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Times are xxxDxx:xx:xx.xxxx for daysDhours:minutes:seconds.xxx, number of records is exactly what you'd expect</p><p>Returns corresponding (long) sample time and all columns in raw format separated by ' ' spaces.</p><div class="examples-title">Examples</div><p><code>$read 0 l100</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamread">$stream read</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
264
230
  <hr/>
265
231
  <div class="content-item"><h2><a name="savecsv">$save csv</a></h2><p class="version">Version 1</p><p>Saves to CSV format</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>file</code></td><td><code>STRING</code></td><td>The optional file to save the CSV data. If the file does not have a .csv extension then one is added.</td></tr><tr><td><code>2</code></td><td><code>maxLines</code></td><td><code>INT</code></td><td>Maximum number of lines; -l[ALL|Max lines per file]<p><span class="default-title">Default:&nbsp;</span><code>-lall</code></p></td></tr><tr><td><code>3</code></td><td><code>lineTerminator</code></td><td><code>STRING</code></td><td>Indicates whether a line terminator; acceptable values: -c[yes/no]<p><span class="default-title">Default:&nbsp;</span><code>-cyes</code></p></td></tr><tr><td><code>4</code></td><td><code>delimiter</code></td><td><code>STRING</code></td><td>Value separator; acceptable values: -s[",", "\t", ";", " "]<p><span class="default-title">Default:&nbsp;</span><code>-s,</code></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Format: $save csv "file path/file name" -l[ALL|Max lines per file] -c[yes/no] -s[",", "\t", ";", " "]</p><p>If no .csv file is specified then the following is assigned: .../path to recording directory/csvExport+yyyyMMddHHmmss.csv</p><div class="examples-title">Examples</div><p><code>$save csv filePath -11000 -cyes -s,</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamexport">$stream export</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
266
232
  <hr/>
@@ -276,23 +242,33 @@ or the reason for connection failure. If connection is successful, the CCS and f
276
242
  <hr/>
277
243
  <div class="content-item"><h2><a name="stopstream">$stop stream</a></h2><p class="version">Version 1</p><p>Stops streaming</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstop">$stream stop</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
278
244
  <hr/>
279
- <div class="content-item"><h2><a name="streamannotationadd">$stream annotation add</a></h2><p class="version">Version 2</p><p>Adds an annotation</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>time</code></td><td><code>STRING</code></td><td>Annotation time</td></tr><tr><td><code>2</code></td><td><code>text</code></td><td><code>STRING</code></td><td>Annotation string</td></tr><tr><td><code>3</code></td><td><code>extraText</code></td><td><code>STRING</code></td><td>Additional annotation text</td></tr><tr><td><code>4</code></td><td><code>yPosition</code></td><td><code>INT</code></td><td>y position percentage on screen; range: [0:100]<p><span class="default-title">Default:&nbsp;</span><code>100</code></p></td></tr><tr><td><code>5</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Type string used when assigning colour and text colour<p><span class="default-title">Default:&nbsp;</span><code>Type1</code></p></td></tr><tr><td><code>6</code></td><td><code>colour</code></td><td><code>STRING</code></td><td>Colour in hex format. The default is #FF0000, which equates to red<p><span class="default-title">Default:&nbsp;</span><code>#FF0000</code></p></td></tr><tr><td><code>7</code></td><td><code>textColour</code></td><td><code>STRING</code></td><td>Text colour in hex format. The default is #FF0000, which equates to red<p><span class="default-title">Default:&nbsp;</span><code>#FF0000</code></p></td></tr><tr><td><code>8</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Time format ["elapsed", "unix"]. The default is "elapsed"<p><span class="default-title">Default:&nbsp;</span><code>elapsed</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>elapsed</code></li><li><code>unix</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default</p><div class="examples-title">Examples</div><p><code>$stream annotation add 7S Annotation1</code></p><p><code>$stream annotation add 7500mS Annotation2</code></p><p><code>$stream annotation add 00:00:08 Annotation3</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamcommentadd">$stream comment add</a></li><li><a href="#annotate">$annotate</a></li><li><a href="#comment">$comment</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
245
+ <div class="content-item"><h2><a name="streamstate">$stream state</a></h2><p class="version">Version 1</p><p>The current state of streaming</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
280
246
  <hr/>
281
- <div class="content-item"><h2><a name="streamannotationslist">$stream annotations list</a></h2><p class="version">Version 2</p><p>Returns a list of all annotations</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Specifies the type of annotations. Options: [all, annotations, comments]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>annotations</code></li><li><code>comments</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>If the annotation text is empty then "Annotation ?" or "Comment ?" is used for annotations and comments respectively</p><p>Annotations are ordered by time since the start of recording</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamannotationstable">$stream annotations table</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
247
+ <div class="content-item"><h2><a name="takesnapshot">$take snapshot</a></h2><p class="version">Version 1</p><p>Takes a snapshot of the chart, timeline and channels windows</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Type of snapshot to take consisting of a comma separated list of options: [all, chart, timeline, key]<p><span class="default-title">Default:&nbsp;</span><code>all</code></p></td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$take snapshot --&gt; default and captures chart+timeline+key</code></p><p><code>$take snapshot all --&gt; same as default</code></p><p><code>$take snapshot chart --&gt; chart only</code></p><p><code>$take snapshot chart,key --&gt; chart+key</code></p><p><code>$take snapshot chart,timeline --&gt; chart+timeline</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#chartsnapshot">$chart snapshot</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
282
248
  <hr/>
283
- <div class="content-item"><h2><a name="streamannotationstable">$stream annotations table</a></h2><p class="version">Version 2</p><p>Returns a table of all annotations</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Specifies the type of annotations. Options: [all, annotations, comments]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>annotations</code></li><li><code>comments</code></li></ul></p></td></tr><tr><td><code>2</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>If the annotation text is empty then "Annotation ?" or "Comment ?" is used for annotations and comments respectively</p><p>Annotations are ordered by time since the start of recording</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamannotationslist">$stream annotations list</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
249
+ <div class="content-item"><h2><a name="version">$version</a></h2><p class="version">Version 1</p><p>Version number</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
284
250
  <hr/>
285
- <div class="content-item"><h2><a name="streamchanneladd">$stream channel add</a></h2><p class="version">Version 2</p><p>Creates a new channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelName</code></td><td><code>STRING</code></td><td>Channel name</td></tr><tr><td><code>2</code></td><td><code>channelGroup</code></td><td><code>STRING</code></td><td>Channel group</td></tr><tr><td><code>3</code></td><td><code>baseUnits</code></td><td><code>STRING</code></td><td>Base units</td></tr><tr><td><code>4</code></td><td><code>usePrefix</code></td><td><code>STRING</code></td><td>Indicates whether or not using a prefix; values either yes/no<p><span class="acceptable-title">Acceptable Values</span><ul><li><code>yes</code></li><li><code>no</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A custom channel group name must be distinct from device group names</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#createchannel">$create channel</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
251
+ <div class="content-item"><h2><a name="chartchannelhide">$chart channel hide</a></h2><p class="version">Version 2</p><p>Hides a channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Channel</td></tr><tr><td><code>2</code></td><td><code>group</code></td><td><code>STRING</code></td><td>Group</td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#hidechannel">$hide channel</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
286
252
  <hr/>
287
- <div class="content-item"><h2><a name="streamchanneladdsynthetic">$stream channel add synthetic</a></h2><p class="version">Version 2</p><p>Defines a new channel function</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Defines the synthetic channel</td></tr><tr><td><code>2</code></td><td><code>function</code></td><td><code>STRING</code></td><td>Specifies the synthetic function</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$stream channel add synthetic channel="chan(L1_RMS,V)" function="rms(100ms, chan(L1,V))"</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
253
+ <div class="content-item"><h2><a name="chartchannelshow">$chart channel show</a></h2><p class="version">Version 2</p><p>Shows a channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Channel</td></tr><tr><td><code>2</code></td><td><code>group</code></td><td><code>STRING</code></td><td>Group</td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#showchannel">$show channel</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
288
254
  <hr/>
289
- <div class="content-item"><h2><a name="streamchannelclearsynthetic">$stream channel clear synthetic</a></h2><p class="version">Version 2</p><p>Clears all created functions</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
255
+ <div class="content-item"><h2><a name="chartsnapshot">$chart snapshot</a></h2><p class="version">Version 2</p><p>Takes a snapshot of the chart, timeline and channels windows</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Type of snapshot to take consisting of a comma separated list of options: [all, chart, timeline, key]<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>chart</code></li><li><code>timeline</code></li><li><code>key</code></li></ul></p></td></tr><tr><td><code>2</code></td><td><code>filePath</code></td><td><code>STRING</code></td><td>Optional file path instead of using default archive path</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$chart snapshot --&gt; default and captures chart+timeline+key</code></p><p><code>$chart snapshot all --&gt; same as default</code></p><p><code>$chart snapshot chart --&gt; chart only</code></p><p><code>$chart snapshot chart,key --&gt; chart+key</code></p><p><code>$chart snapshot chart,timeline --&gt; chart+timeline</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#takesnapshot">$take snapshot</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
290
256
  <hr/>
291
- <div class="content-item"><h2><a name="streamchannellist">$stream channel list</a></h2><p class="version">Version 2</p><p>Returns a list of created channels</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelType</code></td><td><code>STRING</code></td><td>Defines the user or synthetic channel. Options: [all, user, synthetic]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>user</code></li><li><code>synthetic</code></li></ul></p></td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
257
+ <div class="content-item"><h2><a name="debuglistcommands">$debug list commands</a></h2><p class="version">Version 2</p><p>Returns a list of commands</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
292
258
  <hr/>
293
- <div class="content-item"><h2><a name="streamchannelremovesynthetic">$stream channel remove synthetic</a></h2><p class="version">Version 2</p><p>Deletes a previously created channel function</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Specifies the synthetic channel</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$stream channel remove synthetic channel="chan(L1_RMS,V)"</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
259
+ <div class="content-item"><h2><a name="moduleconnect">$module connect</a></h2><p class="version">Version 2</p><p>Connects to a specified device</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>device</code></td><td><code>STRING</code></td><td>Device ID</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>$module connect supports both device names and IP addresses</p><div class="examples-title">Examples</div><p><code>$module connect usb::QTL1999-02-999</code></p><p><code>$module connect tcp::81.187.174.46</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#connect">$connect</a></li><li><a href="#moduledisconnect">$module disconnect</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
294
260
  <hr/>
295
- <div class="content-item"><h2><a name="streamchanneltable">$stream channel table</a></h2><p class="version">Version 2</p><p>Returns XML of function definitions</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelType</code></td><td><code>STRING</code></td><td>Defines the user or synthetic channel. Options: [all, user, synthetic]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>user</code></li><li><code>synthetic</code></li></ul></p></td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
261
+ <div class="content-item"><h2><a name="modulelist">$module list</a></h2><p class="version">Version 2</p><p>Lists available devices</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#list">$list</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
262
+ <hr/>
263
+ <div class="content-item"><h2><a name="modulelistdetails">$module list details</a></h2><p class="version">Version 2</p><p>Lists available device details</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#list-details">$list -details</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
264
+ <hr/>
265
+ <div class="content-item"><h2><a name="modulename">$module name</a></h2><p class="version">Version 2</p><p>Returns the connected device ID</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#connected">$connected</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
266
+ <hr/>
267
+ <div class="content-item"><h2><a name="modulescan">$module scan</a></h2><p class="version">Version 2</p><p>Scans for available devices</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>deviceSpecifier</code></td><td><code>STRING</code></td><td>TCP/IP address to scan for devices</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$module scan tcp::192.168.1.90</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#scan">$scan</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
268
+ <hr/>
269
+ <div class="content-item"><h2><a name="streamannotationadd">$stream annotation add</a></h2><p class="version">Version 2</p><p>Adds an annotation</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>time</code></td><td><code>STRING</code></td><td>Annotation time</td></tr><tr><td><code>2</code></td><td><code>text</code></td><td><code>STRING</code></td><td>Annotation string</td></tr><tr><td><code>3</code></td><td><code>extraText</code></td><td><code>STRING</code></td><td>Additional annotation text</td></tr><tr><td><code>4</code></td><td><code>yPosition</code></td><td><code>INT</code></td><td>y position percentage on screen; range: [0:100]<p><span class="default-title">Default:&nbsp;</span><code>100</code></p></td></tr><tr><td><code>5</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Type string used when assigning colour and text colour<p><span class="default-title">Default:&nbsp;</span><code>Type1</code></p></td></tr><tr><td><code>6</code></td><td><code>colour</code></td><td><code>STRING</code></td><td>Colour in hex format. The default is #FF0000, which equates to red<p><span class="default-title">Default:&nbsp;</span><code>#FF0000</code></p></td></tr><tr><td><code>7</code></td><td><code>textColour</code></td><td><code>STRING</code></td><td>Text colour in hex format. The default is #FF0000, which equates to red<p><span class="default-title">Default:&nbsp;</span><code>#FF0000</code></p></td></tr><tr><td><code>8</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Time format ["elapsed", "unix"]. The default is "elapsed"<p><span class="default-title">Default:&nbsp;</span><code>elapsed</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>elapsed</code></li><li><code>unix</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default</p><div class="examples-title">Examples</div><p><code>$stream annotation add 7S Annotation1</code></p><p><code>$stream annotation add 7500mS Annotation2</code></p><p><code>$stream annotation add 00:00:08 Annotation3</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamcommentadd">$stream comment add</a></li><li><a href="#annotate">$annotate</a></li><li><a href="#comment">$comment</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
270
+ <hr/>
271
+ <div class="content-item"><h2><a name="streamchanneladd">$stream channel add</a></h2><p class="version">Version 2</p><p>Creates a new channel</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelName</code></td><td><code>STRING</code></td><td>Channel name</td></tr><tr><td><code>2</code></td><td><code>channelGroup</code></td><td><code>STRING</code></td><td>Channel group</td></tr><tr><td><code>3</code></td><td><code>baseUnits</code></td><td><code>STRING</code></td><td>Base units</td></tr><tr><td><code>4</code></td><td><code>usePrefix</code></td><td><code>STRING</code></td><td>Indicates whether or not using a prefix; values either yes/no<p><span class="acceptable-title">Acceptable Values</span><ul><li><code>yes</code></li><li><code>no</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A custom channel group name must be distinct from device group names</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#createchannel">$create channel</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
296
272
  <hr/>
297
273
  <div class="content-item"><h2><a name="streamchannels">$stream channels</a></h2><p class="version">Version 2</p><p>Returns details of the current channels</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#channels">$channels</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
298
274
  <hr/>
@@ -308,23 +284,47 @@ or the reason for connection failure. If connection is successful, the CCS and f
308
284
  <hr/>
309
285
  <div class="content-item"><h2><a name="streamrecord">$stream record</a></h2><p class="version">Version 2</p><p>Starts streaming</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>file</code></td><td><code>STRING</code></td><td>File specifier of the form /dir/dir/dir/recordingName. Any '\' characters are replaced with '/' character</td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#startstream">$start stream</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
310
286
  <hr/>
311
- <div class="content-item"><h2><a name="streamrecordduration">$stream record duration</a></h2><p class="version">Version 2</p><p>Returns the total recording time</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A value of -1 is returned if streaming has not commenced</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstarttime">$stream start time</a></li><li><a href="#streamstoptime">$stream stop time</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
312
- <hr/>
313
- <div class="content-item"><h2><a name="streamstarttime">$stream start time</a></h2><p class="version">Version 2</p><p>Returns the time that streaming started</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A value of -1 is returned if streaming has not commenced</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstoptime">$stream stop time</a></li><li><a href="#streamrecordduration">$stream record duration</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
314
- <hr/>
315
- <div class="content-item"><h2><a name="streamstate">$stream state</a></h2><p class="version">Version 1</p><p>The current state of streaming</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
316
- <hr/>
317
287
  <div class="content-item"><h2><a name="streamstatsexport">$stream stats export</a></h2><p class="version">Version 2</p><p>Saves the statistics to a given format</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>file</code></td><td><code>STRING</code></td><td>Single argument string specifying file path of form: *STREAM_DIR*+"statsGrid"+yyyyMMddHHmmss+".csv" - Path for data to be saved to.</td></tr><tr><td><code>2</code></td><td><code>fileType</code></td><td><code>STRING</code></td><td>Type of export file; eg .csv<p><span class="default-title">Default:&nbsp;</span><code>csv</code></p></td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#statstocsv">$stats to csv</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
318
288
  <hr/>
319
289
  <div class="content-item"><h2><a name="streamstatstable">$stream stats table</a></h2><p class="version">Version 2</p><p>Returns statistics</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>startTime</code></td><td><code>INT</code></td><td>Start time. Time format either a HMS or (time,unit) pair; eg 100mS</td></tr><tr><td><code>2</code></td><td><code>endTime</code></td><td><code>INT</code></td><td>End time. Time format either a HMS or (time,unit) pair; eg 100mS</td></tr><tr><td><code>3</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Time format ["elapsed", "unix"]. The default is "elapsed"<p><span class="default-title">Default:&nbsp;</span><code>elapsed</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>elapsed</code></li><li><code>unix</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#getstats">$get stats</a></li><li><a href="#getcustomstatsrange">$get custom stats range</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
320
290
  <hr/>
321
291
  <div class="content-item"><h2><a name="streamstop">$stream stop</a></h2><p class="version">Version 2</p><p>Stops streaming</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#stopstream">$stop stream</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
322
292
  <hr/>
293
+ <div class="content-item"><h2><a name="chartreposition">$chart reposition</a></h2><p class="version">Version 2</p><p>Sets the chart main view to the specified start and end times</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>startTime</code></td><td><code>STRING</code></td><td>Start time</td></tr><tr><td><code>2</code></td><td><code>endTime</code></td><td><code>STRING</code></td><td>End time</td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>Both the start and end times are specified as a time-unit pair; for example: 100mS</p><p>startTime &gt; 0, endTime &gt; 0 and startTime &lt; endTime</p><div class="examples-title">Examples</div><p><code>$chart reposition 10S 20S</code></p><p class="backlink"><a href="#index">Back to index</a></p></div>
294
+ <hr/>
295
+ <div class="content-item"><h2><a name="moduledisconnect">$module disconnect</a></h2><p class="version">Version 2</p><p>Disconnects the current connection</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#connect">$connect</a></li><li><a href="#moduleconnect">$module connect</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
296
+ <hr/>
297
+ <div class="content-item"><h2><a name="openrecording">$open recording</a></h2><p class="version">Version 2</p><p>Opens a recording</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>qpsFile</code></td><td><code>STRING</code></td><td>.qps file</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$open recording qpsFile="C:\quarch\recordings\AC\AC_Gen_test\AC_Gen_Test.qps"</code></p><p class="backlink"><a href="#index">Back to index</a></p></div>
298
+ <hr/>
299
+ <div class="content-item"><h2><a name="progresscheck">$progress check</a></h2><p class="version">Version 2</p><p>Checks the progress of a specific QPS task</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>task</code></td><td><code>STRING</code></td><td>The task to be checked<p><span class="acceptable-title">Acceptable Values</span><ul><li><code>open&nbsp;recording</code></li></ul></p></td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$progress check task="open recording"</code></p><p class="backlink"><a href="#index">Back to index</a></p></div>
300
+ <hr/>
301
+ <div class="content-item"><h2><a name="qisshutdown">$qis shutdown</a></h2><p class="version">Version 2</p><p>Shuts down current QIS instance</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qislaunch">$qis launch</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
302
+ <hr/>
303
+ <div class="content-item"><h2><a name="qislaunch">$qis launch</a></h2><p class="version">Version 2</p><p>Launches new QIS instance</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qisshutdown">$qis shutdown</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
304
+ <hr/>
305
+ <div class="content-item"><h2><a name="qpshide">$qps hide</a></h2><p class="version">Version 2</p><p>Hides the QPS application</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qpsshow">$qps show</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
306
+ <hr/>
307
+ <div class="content-item"><h2><a name="qpsshow">$qps show</a></h2><p class="version">Version 2</p><p>Shows the QPS application</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#qpshide">$qps hide</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
308
+ <hr/>
309
+ <div class="content-item"><h2><a name="streamannotationslist">$stream annotations list</a></h2><p class="version">Version 2</p><p>Returns a list of all annotations</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Specifies the type of annotations. Options: [all, annotations, comments]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>annotations</code></li><li><code>comments</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>If the annotation text is empty then "Annotation ?" or "Comment ?" is used for annotations and comments respectively</p><p>Annotations are ordered by time since the start of recording</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamannotationstable">$stream annotations table</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
310
+ <hr/>
311
+ <div class="content-item"><h2><a name="streamannotationstable">$stream annotations table</a></h2><p class="version">Version 2</p><p>Returns a table of all annotations</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Specifies the type of annotations. Options: [all, annotations, comments]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>annotations</code></li><li><code>comments</code></li></ul></p></td></tr><tr><td><code>2</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>If the annotation text is empty then "Annotation ?" or "Comment ?" is used for annotations and comments respectively</p><p>Annotations are ordered by time since the start of recording</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamannotationslist">$stream annotations list</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
312
+ <hr/>
313
+ <div class="content-item"><h2><a name="streamstarttime">$stream start time</a></h2><p class="version">Version 2</p><p>Returns the time that streaming started</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A value of -1 is returned if streaming has not commenced</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstoptime">$stream stop time</a></li><li><a href="#streamrecordduration">$stream record duration</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
314
+ <hr/>
323
315
  <div class="content-item"><h2><a name="streamstoptime">$stream stop time</a></h2><p class="version">Version 2</p><p>Returns the time that streaming stopped</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A value of -1 is returned if streaming has not commenced</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstarttime">$stream start time</a></li><li><a href="#streamrecordduration">$stream record duration</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
324
316
  <hr/>
325
- <div class="content-item"><h2><a name="takesnapshot">$take snapshot</a></h2><p class="version">Version 1</p><p>Takes a snapshot of the chart, timeline and channels windows</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>type</code></td><td><code>STRING</code></td><td>Type of snapshot to take consisting of a comma separated list of options: [all, chart, timeline, key]<p><span class="default-title">Default:&nbsp;</span><code>all</code></p></td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$take snapshot --&gt; default and captures chart+timeline+key</code></p><p><code>$take snapshot all --&gt; same as default</code></p><p><code>$take snapshot chart --&gt; chart only</code></p><p><code>$take snapshot chart,key --&gt; chart+key</code></p><p><code>$take snapshot chart,timeline --&gt; chart+timeline</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#chartsnapshot">$chart snapshot</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
317
+ <div class="content-item"><h2><a name="streamrecordduration">$stream record duration</a></h2><p class="version">Version 2</p><p>Returns the total recording time</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>timeFormat</code></td><td><code>STRING</code></td><td>Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S"<p><span class="default-title">Default:&nbsp;</span><code>S</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>nS</code></li><li><code>uS</code></li><li><code>mS</code></li><li><code>S</code></li><li><code>HMS</code></li></ul></p></td></tr></tbody></table><br/><p><span class="notes-title">Notes:&nbsp;</span>A value of -1 is returned if streaming has not commenced</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamstarttime">$stream start time</a></li><li><a href="#streamstoptime">$stream stop time</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
326
318
  <hr/>
327
- <div class="content-item"><h2><a name="version">$version</a></h2><p class="version">Version 1</p><p>Version number</p><p>No arguments</p><p class="backlink"><a href="#index">Back to index</a></p></div>
319
+ <div class="content-item"><h2><a name="streamchannellist">$stream channel list</a></h2><p class="version">Version 2</p><p>Returns a list of created channels</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelType</code></td><td><code>STRING</code></td><td>Defines the user or synthetic channel. Options: [all, user, synthetic]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>user</code></li><li><code>synthetic</code></li></ul></p></td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
320
+ <hr/>
321
+ <div class="content-item"><h2><a name="streamchanneltable">$stream channel table</a></h2><p class="version">Version 2</p><p>Returns XML of function definitions</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channelType</code></td><td><code>STRING</code></td><td>Defines the user or synthetic channel. Options: [all, user, synthetic]. The default is "all"<p><span class="default-title">Default:&nbsp;</span><code>all</code></p><p><span class="acceptable-title">Acceptable Values</span><ul><li><code>all</code></li><li><code>user</code></li><li><code>synthetic</code></li></ul></p></td></tr></tbody></table><br/><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
322
+ <hr/>
323
+ <div class="content-item"><h2><a name="streamchannelclearsynthetic">$stream channel clear synthetic</a></h2><p class="version">Version 2</p><p>Clears all created functions</p><p>No arguments</p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
324
+ <hr/>
325
+ <div class="content-item"><h2><a name="streamchanneladdsynthetic">$stream channel add synthetic</a></h2><p class="version">Version 2</p><p>Defines a new channel function</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Defines the synthetic channel</td></tr><tr><td><code>2</code></td><td><code>function</code></td><td><code>STRING</code></td><td>Specifies the synthetic function</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$stream channel add synthetic channel="chan(L1_RMS,V)" function="rms(100ms, chan(L1,V))"</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchannelremovesynthetic">$stream channel remove synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
326
+ <hr/>
327
+ <div class="content-item"><h2><a name="streamchannelremovesynthetic">$stream channel remove synthetic</a></h2><p class="version">Version 2</p><p>Deletes a previously created channel function</p><table><thead><tr><th>#</th><th>Argument</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>1</code></td><td><code>channel</code></td><td><code>STRING</code></td><td>Specifies the synthetic channel</td></tr></tbody></table><br/><div class="examples-title">Examples</div><p><code>$stream channel remove synthetic channel="chan(L1_RMS,V)"</code></p><div class="see-also-title">See also</div><div class="see-also"><ul><li><a href="#streamchannellist">$stream channel list</a></li><li><a href="#streamchanneltable">$stream channel table</a></li><li><a href="#streamchannelclearsynthetic">$stream channel clear synthetic</a></li><li><a href="#streamchanneladdsynthetic">$stream channel add synthetic</a></li></ul></div><p class="backlink"><a href="#index">Back to index</a></p></div>
328
328
  <hr/>
329
329
  </div>
330
330
  </body>