quarchpy 2.1.11.dev8__py3-none-any.whl → 2.2.17.dev1__py3-none-any.whl

quarchpy/connection_specific/QPS/scriptCommands.txt

@@ -1,11 +1,11 @@
 QPS Command Summary
 Copyright (c) Quarch Ltd
-QPS v1.31.02
-Generated: 31-Mar-2023
+QPS v1.49.1-SNAPSHOT
+Generated: 31 Oct 2025
+
+
+*** Commands ***
 
-
-*** Commands ***
-
 Command: $annotate
 Description: Adds an annotation
 Version: 1
@@ -86,6 +86,8 @@ Default value: NONE
 Notes:
 Both the start and end times are specified as a time-unit pair; for example: 100mS
 startTime > 0, endTime > 0 and startTime < endTime
+Examples:
+$chart reposition 10S 20S
 
 Command: $chart snapshot
 Description: Takes a snapshot of the chart, timeline and channels windows
@@ -145,11 +147,13 @@ Index: 0
 Type: STRING
 Default value: NONE
 Notes:
-Command is passed to QIS which will test the connection availability and suitability for streaming data returning a status of OK
-or the reason for connection failure if connection is successful, ccs and file dialogs should close and the chart window connected to the device should display
+The command is passed to QIS which will test the connection availability and suitability for streaming data returning a status of OK
+or the reason for connection failure. If connection is successful, the CCS and file dialogs should close and the chart window connected to the device should display.
+$connect supports both device names and IP addresses
 Examples:
 $connect usb::QTL1999-02-999
 $connect tcp::QTL1999-02-999
+$connect tcp::81.187.174.46
 
 Command: $connected
 Description: Returns the connected device ID
@@ -184,6 +188,7 @@ Default value: NONE
 Notes:
 Format: channelName channelGroup baseUnits yes/no(usePrefix)
 usePrefix [yes/no] option 'no' disables the application of metric prefixes u, m, k, M etc
+A custom channel group name must be distinct from device group names
 
 Command: $debug list commands
 Description: Returns a list of commands
@@ -287,15 +292,20 @@ Time format: UNIX time in mS or exxxDxx:xx:xx.xxxx for daysDhours:minutes:second
 To indicate the end marker of an interval then set the value to 'endSeq'; eg : myStream.addDataPoint(channelName, groupName, 'endSeq')
 
 Command: $module connect
-Description: Device ID
+Description: Connects to a specified device
 Version: 2
-See also: $connect
+See also: $connect, $module disconnect
 Arguments
 Argument: device
-Description: 
+Description: Device ID
 Index: 0
 Type: STRING
 Default value: NONE
+Notes:
+$module connect supports both device names and IP addresses
+Examples:
+$module connect usb::QTL1999-02-999
+$module connect tcp::81.187.174.46
 
 Command: $module disconnect
 Description: Disconnects the current connection
@@ -330,13 +340,38 @@ Default value: NONE
 Examples:
 $module scan tcp::192.168.1.90
 
+Command: $open recording
+Description: Opens a recording
+Version: 2
+Arguments
+Argument: qpsFile
+Description: .qps file
+Index: 0
+Type: STRING
+Default value: NONE
+Examples:
+$open recording qpsFile="C:\quarch\recordings\AC\AC_Gen_test\AC_Gen_Test.qps"
+
+Command: $progress check
+Description: Checks the progress of a specific QPS task
+Version: 2
+Arguments
+Argument: task
+Description: The task to be checked
+Index: 0
+Type: STRING
+Default value: NONE
+Acceptable values: [open recording]
+Examples:
+$progress check task="open recording"
+
 Command: $qis launch
 Description: Launches new QIS instance
 Version: 2
 See also: $qis shutdown
 
 Command: $qis shutdown
-Description: Shutsdown current QIS instance
+Description: Shuts down current QIS instance
 Version: 2
 See also: $qis launch
 
@@ -355,7 +390,7 @@ Version: 2
 See also: $qps hide
 
 Command: $read
-Description: Reads data between from a given start time and either end time or number of records
+Description: Reads data between a given start time and either end time or number of records
 Version: 1
 See also: $stream read
 Arguments
@@ -410,6 +445,15 @@ Command: $scan
 Description: Scans for available devices
 Version: 1
 See also: $module scan
+Arguments
+Argument: deviceSpecifier
+Description: TCP/IP address to scan for devices
+Index: 0
+Type: STRING
+Default value: NONE
+Examples:
+$scan
+$scan tcp::192.168.1.90
 
 Command: $show channel
 Description: Shows a channel
@@ -438,6 +482,11 @@ Description: File specifier is of the form /dir/dir/dir/recordingName. Any '\' c
 Index: 0
 Type: STRING
 Default value: NONE
+Argument: duration
+Description: Specifies the stream duration in seconds.
+Index: 1
+Type: INT
+Default value: NONE
 
 Command: $stats to csv
 Description: Saves the statistics to CSV format
@@ -570,6 +619,8 @@ Index: 3
 Type: STRING
 Default value: NONE
 Acceptable values: [yes, no]
+Notes:
+A custom channel group name must be distinct from device group names
 
 Command: $stream channel add synthetic
 Description: Defines a new channel function
@@ -728,7 +779,7 @@ To indicate the end marker of an interval then set the value to 'endSeq'; eg : m
 Command: $stream export
 Description: Saves to a given format
 Version: 2
-See also: $save csv
+See also: $save csv, $stream import
 Arguments
 Argument: file
 Description: The file path to save the export
@@ -751,16 +802,85 @@ Description: Value separator; eg ,
 Index: 3
 Type: STRING
 Default value: ,
-Acceptable values: [TAB, ;, ,, SPACE, EMPTY SPACE]
+Acceptable values: ["\t", ";", ",", " "]
 Argument: fileType
 Description: File type; eg CSV
 Index: 4
 Type: STRING
 Default value: csv
+Argument: channels
+Description: List of channels to export; eg "voltage:5v,current:12v" with the default set to "all"
+Index: 5
+Type: STRING
+Default value: all
+Argument: defaultDirectory
+Description: Sets the default csv file directory to save all exported files
+Index: 6
+Type: STRING
+Default value: NONE
 Notes:
 Format: $save csv file path/file name ALL|Max lines per file yes/no ",", "\t", ";", " "
 Argument file is optional and if not specified then a file name is assigned and of the form: 
 If no fileType file is specified then the following is assigned: .../path to recording directory/fileType+Export+yyyyMMddHHmmss.fileType
+By default all channels are exported but can be filtered using argument "channel"
+
+Command: $stream export status
+Description: Checks the status of export operation.
+Version: 2
+
+Command: $stream import
+Description: Imports from a given format
+Version: 2
+See also: $stream export
+Arguments
+Argument: file
+Description: The file path to be imported
+Index: 0
+Type: STRING
+Default value: NONE
+Argument: fileType
+Description: File type; eg CSV
+Index: 1
+Type: STRING
+Default value: csv
+Argument: delimiter
+Description: Value separator; eg ,
+Index: 2
+Type: STRING
+Default value: ,
+Acceptable values: ["\t", ";", ",", " "]
+Argument: minTime
+Description: The minimum time value; eg 100mS. The default value of 0nS indicates reading from the start
+Index: 3
+Type: STRING
+Default value: 0nS
+Argument: maxTime
+Description: The maximum time value; eg 800mS. The default value of -1nS indicates reading to the end
+Index: 4
+Type: STRING
+Default value: -1nS
+Argument: offsetTime
+Description: The offset time value; eg 10mS. The default value of 0nS indicates there is no offset
+Index: 5
+Type: STRING
+Default value: 0nS
+Argument: channels
+Description: List of channels to import; eg "voltage:5v,current:12v" with the default set to "all"
+Index: 6
+Type: STRING
+Default value: all
+Argument: timeFormat
+Description: Time format ["elapsed", "unix"]. The default is "elapsed"
+Index: 7
+Type: STRING
+Default value: elapsed
+Acceptable values: [elapsed, unix]
+Notes:
+The file must contain an extension that matches the one specified in fileType. This is used as a check.
+Examples:
+$stream import file="C:\Temp\data.csv"
+$stream import file="C:\Temp\data.csv" channels="voltage:12v,current:12v"
+$stream import file="C:\Temp\data.csv" channels="voltage:12v,current:12v" minTime=1S maxTime=10S
 
 Command: $stream read
 Description: Reads data between from a given start time and either end time or number of records
@@ -798,6 +918,11 @@ Description: File specifier of the form /dir/dir/dir/recordingName. Any '\' char
 Index: 0
 Type: STRING
 Default value: NONE
+Argument: duration
+Description: Specifies the stream duration in seconds.
+Index: 1
+Type: INT
+Default value: NONE
 
 Command: $stream record duration
 Description: Returns the total recording time
@@ -847,6 +972,10 @@ Index: 1
 Type: STRING
 Default value: csv
 
+Command: $stream stats export status
+Description: Checks the status of the stats export operation.
+Version: 2
+
 Command: $stream stats table
 Description: Returns statistics
 Version: 2
@@ -910,10 +1039,10 @@ $take snapshot chart,timeline --> chart+timeline
 Command: $version
 Description: Version number
 Version: 1
-
-
-*** Command Index ***
-
+
+
+*** Command Index ***
+
 $annotate ~ Adds an annotation
 
 $channels ~ Returns details of the current channels
@@ -952,7 +1081,7 @@ $list -details ~ Lists available device details
 
 $log ~ Adds a channel/group value at a specified time
 
-$module connect ~ Device ID
+$module connect ~ Connects to a specified device
 
 $module disconnect ~ Disconnects the current connection
 
@@ -964,9 +1093,13 @@ $module name ~ Returns the connected device ID
 
 $module scan ~ Scans for available devices
 
+$open recording ~ Opens a recording
+
+$progress check ~ Checks the progress of a specific QPS task
+
 $qis launch ~ Launches new QIS instance
 
-$qis shutdown ~ Shutsdown current QIS instance
+$qis shutdown ~ Shuts down current QIS instance
 
 $qis status ~ Reports the connection status of QIS
 
@@ -974,7 +1107,7 @@ $qps hide ~ Hides the QPS application
 
 $qps show ~ Shows the QPS application
 
-$read ~ Reads data between from a given start time and either end time or number of records
+$read ~ Reads data between a given start time and either end time or number of records
 
 $save csv ~ Saves to CSV format
 
@@ -1016,6 +1149,10 @@ $stream data add ~ Adds a channel/group value at a specified time
 
 $stream export ~ Saves to a given format
 
+$stream export status ~ Checks the status of export operation.
+
+$stream import ~ Imports from a given format
+
 $stream read ~ Reads data between from a given start time and either end time or number of records
 
 $stream record ~ Starts streaming
@@ -1028,6 +1165,8 @@ $stream state ~ The current state of streaming
 
 $stream stats export ~ Saves the statistics to a given format
 
+$stream stats export status ~ Checks the status of the stats export operation.
+
 $stream stats table ~ Returns statistics
 
 $stream stop ~ Stops streaming
@@ -1037,4 +1176,4 @@ $stream stop time ~ Returns the time that streaming stopped
 $take snapshot ~ Takes a snapshot of the chart, timeline and channels windows
 
 $version ~ Version number
-
+

quarchpy/connection_specific/QPS/whats-new.txt

@@ -0,0 +1,27 @@
+*** What's New In Quarch Power Studio ***
+
+21st November 2025
+
+QPS version 1.50
+QIS version 1.52
+
+
+*** New Features ***
+
+Added expression editor for more customizable synthetic channels
+Two or more QPS instances can be open at the same time, and stream in parallel
+A CSV file can now be imported in full, to create a QPS analysis file
+Custom instrument profiles can be loaded from default locations quickly
+Cursors can now be positioned at a set time, or by right-click menu
+Statistics on main chart can be hidden, to focus on the key ones you need
+
+
+*** Major Fixes ***
+
+Upgraded to Java 25, partly due to memory leak in J24
+AC frequency now calculates to full resolution (was limited to integer)
+Synthetic channels all now round (some were trimming the final value)
+Incorrect 'host time' was shown after the first stream
+Inconsistent measurement points could be read (cursors Vs CSV, Vs summary data)
+Recording limit control was broken in the previous release, now fixed
+Apple menus were not consistent with best practice on other apps