# Quarch Power Studio Command Reference

Copyright (c) Quarch Ltd

QPS v1.52

Generated: May 12, 2026

This document lists the commands that can be sent to QPS over the TCP interface. By default QPS will open port 9822. Commands may be sent as UTF-8 text with the standard line terminator \r\n denoting the end of a command.

- $annotate
- $channels
- $chart channel hide
- $chart channel show
- $chart reposition
- $chart snapshot
- $comment
- $connect
- $connected
- $convert csv
- $create channel
- $debug list commands
- $echo
- $get custom stats range
- $get stats
- $help
- $hide channel
- $list
- $list -details
- $log
- $module connect
- $module disconnect
- $module list
- $module list details
- $module name
- $module scan
- $open recording
- $progress check
- $qis status
- $qps hide
- $qps show
- $read
- $save csv
- $scan
- $show channel
- $shutdown
- $start stream
- $stats to csv
- $stop stream
- $stream annotation add
- $stream annotations list
- $stream annotations table
- $stream auto annotation
- $stream channel add
- $stream channel add synthetic
- $stream channel clear synthetic
- $stream channel list
- $stream channel remove synthetic
- $stream channel table
- $stream channels
- $stream comment add
- $stream data add
- $stream export
- $stream export status
- $stream import
- $stream read
- $stream record
- $stream record duration
- $stream start time
- $stream state
- $stream stats export
- $stream stats export status
- $stream stats table
- $stream stop
- $stream stop time
- $take snapshot
- $version

## $annotate

Version 1

Adds an annotation

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `time` | `STRING` | Annotation time
`2` | `text` | `STRING` | Annotation string

Returns: OK if completed successfully, else Fail if the command did not process correctly or an invalid time is specified

Notes

Format of params string: time_specifier[space]text to be added, eg 123.456 hello world

Time specifier is of the form: for elapsed time relative to the recording: exxxDxxx:xxx:xxx.xxx for absolute time, pass the number of milliseconds since the epoch (midnight 1 January 1970 UTC, ie Unix time common to many environments): xxxxxxxxxxxx

The annotation text may be split over two or more lines by including \n in the string

Examples

`$annotate 0 Annotation1 --> adds an annotation at time 0 and so at record number 0`

See also

- $comment
- $stream annotation add
- $stream comment add

Back to index

## $channels

Version 1

Returns details of the current channels

Arguments

No arguments

Returns: A list of channels in the format: "channelName groupName baseUnits", such as "12V voltage mV"

Notes

Return details of current channels in the format: channelName groupName baseUnits

See also

- $stream channels

Back to index

## $chart channel hide

Version 2

Hides a channel

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channel` | `STRING` | Channel
`2` | `group` | `STRING` | Group

Returns: OK if successful, else Fail if an invalid group/channel name or the channel is already hidden

See also

- $hide channel

Back to index

## $chart channel show

Version 2

Shows a channel

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channel` | `STRING` | Channel
`2` | `group` | `STRING` | Group

Returns: OK if successful, else Fail if an invalid group/channel name or the channel is already shown

See also

- $show channel

Back to index

## $chart reposition

Version 2

Sets the chart main view to the specified start and end times

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `startTime` | `STRING` | Start time
`2` | `endTime` | `STRING` | End time

Returns: OK if successful, else Fail if no device connected or invalid start/end times are specifiied

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`

Back to index

## $chart snapshot

Version 2

Takes a snapshot of the chart, timeline and channels windows

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `type` | `STRING` | Type of snapshot to take consisting of a comma separated list of options: [all, chart, timeline, key] Default: `all` Acceptable Values `all` `chart` `timeline` `key`
`2` | `filePath` | `STRING` | Optional file path instead of using default archive path

Returns: OK if successful, else Fail if an invalid file path is specified

Examples

`$chart snapshot --> default and captures chart+timeline+key`

`$chart snapshot all --> same as default`

`$chart snapshot chart --> chart only`

`$chart snapshot chart,key --> chart+key`

`$chart snapshot chart,timeline --> chart+timeline`

See also

- $take snapshot

Back to index

## $comment

Version 1

Adds a comment

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `time` | `STRING` | Comment time
`2` | `text` | `STRING` | Comment string

Returns: OK if completed successfully, else Fail if the command did not process correctly or an invalid time is specified

Notes

Format of params string: time_specifier[space]text to be added, eg 123.456 hello world

Time specifier is of the form: for elapsed time relative to the recording: exxxDxxx:xxx:xxx.xxx for absolute time, pass the number of milliseconds since the epoch (midnight 1 January 1970 UTC, ie Unix time common to many environments): xxxxxxxxxxxx

The annotation text may be split over two or more lines by including \n in the string

Examples

`$comment e1 Comment1 --> adds a comment after an elapsed time of 1 second`

See also

- $annotate
- $stream annotation add
- $stream comment add

Back to index

## $connect

Version 1

Connects to a specified device

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `device` | `STRING` | Device ID

Returns: OK if successful, else Fail if an attempt is made to call this command while streaming, the device is not found, a QPS UI error occurred or a connection timeout occurred

Notes

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`

See also

- $module connect

Back to index

## $connected

Version 1

Returns the connected device ID

Arguments

No arguments

Returns: The connected device if a valid connection is established, else "Device not found"

See also

- $module name

Back to index

## $convert csv

Version 2

Converts one or more CSV files [.csv] to a QPS recording [.qps]

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `from` | `STRING` | From .csv file(s)
`2` | `to` | `STRING` | To .qps file
`3` | `prefix` | `STRING` | Channel name prefix Default: `None`

Returns: OK if successful, else Fail if invalid from/to arguments or the conversion failed

Notes

For a "to" file such as "c:\recordings\rec1\rec1.qps" the base directory "c:\recordings" must exist, but the newly created recording directory "c:\recordings\rec1" must not already exist as this will be created as part of the conversion

All channels detected in the "from" file(s) are converted.

Multiple CSV files are comma-separated in the "from" argument.

Channel name prefixes are added by way of the "prefix" argument. For example, a prefix of "F" would apply prefix "F1" to the first CSV file, "F2" to the second CSV file, and so on. Prefixes are only necessary for two or more files and when channel name clashes will result from merging the CSV files.

Examples

`$convert csv from="c:\temp\rec1.csv" to="c:\recordings\rec1\rec.qps"`

`$convert csv from="c:\temp\rec1.csv,c:\temp\rec2.csv" to="c:\recordings\rec1\rec.qps"`

`$convert csv from="c:\temp\rec1.csv,c:\temp\rec2.csv" to="c:\recordings\rec1\rec.qps" prefix="F"`

See also

- $stream import

Back to index

## $create channel

Version 1

Creates a new channel

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channelName` | `STRING` | Channel name
`2` | `channelGroup` | `STRING` | Channel group
`3` | `baseUnits` | `STRING` | Base units
`4` | `usePrefix` | `STRING` | Indicates whether to use a prefix; acceptable values are yes/no

Returns: OK if successful, else Fail if the custom channel/group names already exist or an error occurred creating the new channel

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

See also

- $stream channel add

Back to index

## $debug list commands

Version 2

Returns a list of commands

Arguments

No arguments

Returns: List of all commands

Back to index

## $echo

Version 1

Echo command

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `string` | `STRING` | A string of text to simply echo back

Returns: A copy of the specified argument string

Back to index

## $get custom stats range

Version 1

Returns statistics for a specified range

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `startTime` | `STRING` | 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
`2` | `endTime_numRecords` | `STRING` | End time OR number of records of form: [endTime | lnumber of records] in which letter "l" denotes that number of records is being specified

Returns: Statistics for a specified range, or Fail if no device is connected or invalid start/end times specified

See also

- $stream stats table

Back to index

## $get stats

Version 1

Returns statistics

Arguments

No arguments

Returns: A table of statistics for all annotations

See also

- $stream stats table

Back to index

## $help

Version 1

Help command

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `type` | `STRING` | The type of help to return. Options: 1) None [same as "all"], 2) "all", 3) "internal", 4) help summary of another command; eg $help $echo Default: `all`

Returns: Help for all commands or a requested command

Examples

`$help --> returns a list of all supported commands, each with a brief description`

`$help all --> same as $help`

`$help $echo --> returns a help summary of the $echo command`

`$help $chart snapshot --> returns a help summary of the $chart snapshot command`

Back to index

## $hide channel

Version 1

Hides a channel

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channelInfo` | `STRING` | Channel information; a string split by : and assumed the following order: #0 = name, #1 = groupName, #2+ ignore

Returns: OK if successful, else Fail if an invalid group/channel name or the channel is already hidden

See also

- $chart channel hide

Back to index

## $list

Version 1

Lists available devices

Arguments

No arguments

Returns: A list of connected devices if devices found, else "No Devices Found"

See also

- $module list

Back to index

## $list -details

Version 1

Lists available device details

Arguments

No arguments

Returns: A list of connected devices with additional information if devices found, else "No Devices Found"

See also

- $module list details

Back to index

## $log

Version 1

Adds a channel/group value at a specified time

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channel` | `STRING` | Channel name
`2` | `group` | `STRING` | Group name
`3` | `time` | `INT` | Time
`4` | `value` | `FLOAT` | Value

Returns: OK if successful, else Fail if an invalid group/channel or time are specified

Notes

Format: channelName channelGroup time value

Time format: UNIX time in mS or exxxDxx:xx:xx.xxxx for daysDhours:minutes:seconds.xxx

To indicate the end marker of an interval then set the value to 'endSeq'; eg : myStream.addDataPoint(channelName, groupName, 'endSeq')

See also

- $stream data add

Back to index

## $module connect

Version 2

Connects to a specified device

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `device` | `STRING` | Device ID

Returns: OK if successful, else Fail if the specified device cannot be found or if currently streaming

Notes

$module connect supports both device names and IP addresses

Examples

`$module connect usb::QTL1999-02-999`

`$module connect tcp::81.187.174.46`

See also

- $connect
- $module disconnect

Back to index

## $module disconnect

Version 2

Disconnects the current connection

Arguments

No arguments

Returns: OK if successful, else Fail if no currently connected to a device

See also

- $connect
- $module connect

Back to index

## $module list

Version 2

Lists available devices

Arguments

No arguments

Returns: A list of connected devices if devices found, else "No Devices Found"

See also

- $list

Back to index

## $module list details

Version 2

Lists available device details

Arguments

No arguments

Returns: A list of connected devices with additional information if devices found, else "No Devices Found"

See also

- $list -details

Back to index

## $module name

Version 2

Returns the connected device ID

Arguments

No arguments

Returns: The connected device if a valid connection is established, else "Device not found"

See also

- $connected

Back to index

## $module scan

Version 2

Scans for available devices

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `deviceSpecifier` | `STRING` | TCP/IP address to scan for devices

Returns: "Started network scan" if scanning for all devices. "Located Device: IP" if the specified device is found, else "No Quarch Device Found at: IP"

Examples

`$module scan tcp::192.168.1.90`

See also

- $scan

Back to index

## $open recording

Version 2

Opens a recording

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `qpsFile` | `STRING` | .qps file

Returns: OK if successful, else Fail if an invalid .qps file argument

Examples

`$open recording qpsFile="C:\quarch\recordings\AC\AC_Gen_test\AC_Gen_Test.qps"`

Back to index

## $progress check

Version 2

Checks the progress of a specific QPS task

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `task` | `STRING` | The task to be checked Acceptable Values `open recording`

Returns: Percentage complete, or Fail if no task has been specified

Examples

`$progress check task="open recording"`

Back to index

## $qis status

Version 1

Reports the connection status of QIS

Arguments

No arguments

Returns: "Connected" or "Not Connected"

Back to index

## $qps hide

Version 2

Hides the QPS application

Arguments

No arguments

Returns: OK if successful, else Fail if failed to hide the application

See also

- $qps show

Back to index

## $qps show

Version 2

Shows the QPS application

Arguments

No arguments

Returns: OK if successful, else Fail if failed to show the application

See also

- $qps hide

Back to index

## $read

Version 1

Reads data between a given start time and either end time or number of records

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `startTime` | `INT` | Start time
`2` | `endTime_numRecords` | `STRING` | Number of records of form: [endTime | lnumber of records], in which the letter "l" denotes that the number of records is being specified

Returns: Read data if successful, else Fail if no connected device, or an invalid time argument

Notes

Times are xxxDxx:xx:xx.xxxx for daysDhours:minutes:seconds.xxx, number of records is exactly what you'd expect

Returns corresponding (long) sample time and all columns in raw format separated by ' ' spaces.

Examples

`$read 0 l100`

See also

- $stream read

Back to index

## $save csv

Version 1

Saves to CSV format

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | The optional file to save the CSV data. If the file does not have a .csv extension then one is added.
`2` | `maxLines` | `INT` | Maximum number of lines; -l[ALL|Max lines per file] Default: `-lall`
`3` | `lineTerminator` | `STRING` | Indicates whether a line terminator; acceptable values: -c[yes/no] Default: `-cyes`
`4` | `delimiter` | `STRING` | Value separator; acceptable values: -s[",", "\t", ";", " "] Default: `-s,`

Returns: OK if successful, else Fail if an error occurred saving, an invalid file or argument was specified

Notes

Format: $save csv "file path/file name" -l[ALL|Max lines per file] -c[yes/no] -s[",", "\t", ";", " "]

If no .csv file is specified then the following is assigned: .../path to recording directory/csvExport+yyyyMMddHHmmss.csv

Examples

`$save csv filePath -11000 -cyes -s,`

See also

- $stream export

Back to index

## $scan

Version 1

Scans for available devices

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `deviceSpecifier` | `STRING` | TCP/IP address to scan for devices

Returns: "Started network scan" if scanning for all devices. "Located Device: IP" if the specified device is found, else "No Quarch Device Found at: IP"

Examples

`$scan`

`$scan tcp::192.168.1.90`

See also

- $module scan

Back to index

## $show channel

Version 1

Shows a channel

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channelInfo` | `STRING` | Channel information

Returns: OK if successful, else Fail if an invalid group/channel name or the channel is already shown

Notes

Channel is a string split by ":" and assumed the following order: #0 = name, #1 = groupName, #2+ ignore

See also

- $chart channel show

Back to index

## $shutdown

Version 1

Shuts down QPS

Arguments

No arguments

Returns: OK if successful, else Fail if any arguments are specified

Back to index

## $start stream

Version 1

Starts streaming

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | File specifier is of the form /dir/dir/dir/recordingName. Any '\' characters are replaced with '/' character
`2` | `duration` | `INT` | Specifies the stream duration in seconds.

Returns: OK if successful, else Fail if no connected device is found, if a stream is already running, a stream did not start or an invalid recording directory is specified

See also

- $stream record

Back to index

## $stats to csv

Version 1

Saves the statistics to CSV format

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | A single argument string specifying file path of form: *STREAM_DIR*+"statsGrid"+yyyyMMddHHmmss+".csv" - Path for data to be saved to.

Returns: OK if successful, else if an error occurred creating the CSV file parent directory

See also

- $stream stats export

Back to index

## $stop stream

Version 1

Stops streaming

Arguments

No arguments

Returns: OK if successful, else Fail if no stream is currently running

See also

- $stream stop

Back to index

## $stream annotation add

Version 2

Adds an annotation

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `time` | `STRING` | Annotation time
`2` | `text` | `STRING` | Annotation string
`3` | `extraText` | `STRING` | Additional annotation text
`4` | `yPosition` | `INT` | y position percentage on screen; range: [0:100] Default: `100`
`5` | `type` | `STRING` | Type string used when assigning colour and text colour Default: `Type1`
`6` | `colour` | `STRING` | Colour in hex format. The default is #FF0000, which equates to red Default: `#FF0000`
`7` | `textColour` | `STRING` | Text colour in hex format. The default is #FF0000, which equates to red Default: `#FF0000`
`8` | `timeFormat` | `STRING` | Time format ["elapsed", "unix"]. The default is "elapsed" Default: `elapsed` Acceptable Values `elapsed` `unix`

Returns: OK if completed successfully, else Fail if the command did not process correctly or an invalid time is specified

Notes

Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default

Examples

`$stream annotation add 7S Annotation1`

`$stream annotation add 7500mS Annotation2`

`$stream annotation add 00:00:08 Annotation3`

See also

- $stream comment add
- $annotate
- $comment

Back to index

## $stream annotations list

Version 2

Returns a list of all annotations

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `type` | `STRING` | Specifies the type of annotations. Options: [all, annotations, comments]. The default is "all" Default: `all` Acceptable Values `all` `annotations` `comments`

Returns: A list of annotations if successful, else Fail if an invalid "type" argument or no annotations are available

Notes

If the annotation text is empty then "Annotation ?" or "Comment ?" is used for annotations and comments respectively

Annotations are ordered by time since the start of recording

See also

- $stream annotations table

Back to index

## $stream annotations table

Version 2

Returns a table of all annotations

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `type` | `STRING` | Specifies the type of annotations. Options: [all, annotations, comments]. The default is "all" Default: `all` Acceptable Values `all` `annotations` `comments`
`2` | `timeFormat` | `STRING` | Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S" Default: `S` Acceptable Values `nS` `uS` `mS` `S` `HMS`

Returns: A table of annotations if successful, else Fail if an invalid "type" or time argument or no annotations are available

Notes

If the annotation text is empty then "Annotation ?" or "Comment ?" is used for annotations and comments respectively

Annotations are ordered by time since the start of recording

See also

- $stream annotations list

Back to index

## $stream auto annotation

Version 2

Automatically adds an annotation

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `group` | `STRING` | Channel group
`2` | `channel` | `STRING` | Channel name
`3` | `digitalCondition` | `STRING` | For digital trigger conditions and either "On Rising" or "On Falling" Default: `Not Specified` Acceptable Values `On Rising` `On Falling` `Not Specified`
`4` | `analogCondition` | `INT` | For analog conditions and either ">=" or "<=" Default: `Not Specified` Acceptable Values `>=` `<=` `Not Specified`
`5` | `analogConditionValue` | `STRING` | For analog conditions, specifies the condition value such as 220000 for annotation triggering at 220,000mV
`6` | `countType` | `STRING` | The count type and set to one of the following: "Once", "Count" or "No Limit" Default: `Once` Acceptable Values `Once` `Count` `No Limit`
`7` | `countValue` | `STRING` | For count types set to "Count" this argument specifies the maximum number of times the annotation is to be triggered such as 1 or 10 times Default: `1`
`8` | `annotation` | `STRING` | Annotation text. Options {COUNTER} and {VALUE} insert annotation counter and signal value. Limit to 200 characters Default: `Annotation = {COUNTER}`

Returns: OK if completed successfully, else Fail if group, channel, condition type/value, count type/value or annotation text not specified,

Examples

`$stream auto annotation group="Voltage" channel="L1" analogCondition=">=" analogConditionValue="220000" countType="Count" countValue="10" annotation="Annotation {COUNTER}"`

See also

- $stream comment add
- $annotate
- $comment

Back to index

## $stream channel add

Version 2

Creates a new channel

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channelName` | `STRING` | Channel name
`2` | `channelGroup` | `STRING` | Channel group
`3` | `baseUnits` | `STRING` | Base units
`4` | `usePrefix` | `STRING` | Indicates whether to use a prefix; acceptable values are yes/no Acceptable Values `yes` `no`

Returns: OK if successful, else Fail if the custom channel/group names already exist or an error occurred creating the new channel

Notes

A custom channel group name must be distinct from device group names

See also

- $create channel

Back to index

## $stream channel add synthetic

Version 2

Defines a new channel function

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channel` | `STRING` | Defines the synthetic channel
`2` | `function` | `STRING` | Specifies the synthetic function

Returns: OK if successful, else Fail if no connected device, streaming in progress or an invalid channel/function specified

Examples

`$stream channel add synthetic channel="chan(L1_RMS,V)" function="rms(100ms, chan(L1,V))"`

See also

- $stream channel list
- $stream channel table
- $stream channel clear synthetic
- $stream channel remove synthetic

Back to index

## $stream channel clear synthetic

Version 2

Clears all created functions

Arguments

No arguments

Returns: OK if successful, else Fail if no connected device or streaming in progress

See also

- $stream channel list
- $stream channel table
- $stream channel add synthetic
- $stream channel remove synthetic

Back to index

## $stream channel list

Version 2

Returns a list of created channels

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channelType` | `STRING` | Defines the user or synthetic channel. Options: [all, user, synthetic]. The default is "all" Default: `all` Acceptable Values `all` `user` `synthetic`

Returns: List of channels, else Fail if no connected device

See also

- $stream channel table
- $stream channel clear synthetic
- $stream channel add synthetic
- $stream channel remove synthetic

Back to index

## $stream channel remove synthetic

Version 2

Deletes a previously created channel function

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channel` | `STRING` | Specifies the synthetic channel

Returns: OK if successful, or Fail if no device connected, streaming in progress or an invalid channel specified

Examples

`$stream channel remove synthetic channel="chan(L1_RMS,V)"`

See also

- $stream channel list
- $stream channel table
- $stream channel clear synthetic
- $stream channel add synthetic

Back to index

## $stream channel table

Version 2

Returns XML of function definitions

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channelType` | `STRING` | Defines the user or synthetic channel. Options: [all, user, synthetic]. The default is "all" Default: `all` Acceptable Values `all` `user` `synthetic`

Returns: Table of channels, else Fail if no connected device

See also

- $stream channel list
- $stream channel clear synthetic
- $stream channel add synthetic
- $stream channel remove synthetic

Back to index

## $stream channels

Version 2

Returns details of the current channels

Arguments

No arguments

Returns: A list of channels in the format: "channelName groupName baseUnits", such as "12V voltage mV"

See also

- $channels

Back to index

## $stream comment add

Version 2

Adds a comment

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `time` | `STRING` | Comment time
`2` | `text` | `STRING` | Comment string
`3` | `extraText` | `STRING` | Additional comment text
`4` | `yPosition` | `INT` | y position percentage on screen; range: [0:100] Default: `100`
`5` | `type` | `STRING` | Type string used when assigning colour and text colour Default: `Type2`
`6` | `colour` | `STRING` | Colour in hex format. The default is #FFFF00, which equates to yellow Default: `#FFFF00`
`7` | `textColour` | `STRING` | Text colour in hex format. The default is #FFFF00, which equates to yellow Default: `#FFFF00`
`8` | `timeFormat` | `STRING` | Time format ["elapsed", "unix"]. The default is "elapsed" Default: `elapsed` Acceptable Values `elapsed` `unix`

Returns: OK if completed successfully, else Fail if the command did not process correctly or an invalid time is specified

Notes

Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default

Examples

`$stream comment add 10.25S Comment1`

`$stream comment add 11000mS Comment2`

`$stream comment add 00:00:12 Comment3`

See also

- $stream annotation add
- $annotate
- $comment

Back to index

## $stream data add

Version 2

Adds a channel/group value at a specified time

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `channel` | `STRING` | Channel
`2` | `group` | `STRING` | Group
`3` | `time` | `INT` | Time
`4` | `value` | `FLOAT` | Value
`5` | `timeFormat` | `STRING` | Time format ["elapsed", "unix"]. The default is "elapsed" Default: `elapsed` Acceptable Values `elapsed` `unix`

Returns: OK if successful, else Fail if an invalid group/channel or time are specified

Notes

Format: channel group time value timeFormat

Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default

To indicate the end marker of an interval then set the value to 'endSeq'; eg : myStream.addDataPoint(channelName, groupName, 'endSeq')

See also

- $log

Back to index

## $stream export

Version 2

Saves to a given format

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | The file path to save the export
`2` | `maxLines` | `STRING` | Maximum number of lines Default: `all`
`3` | `lineTerminator` | `STRING` | Indicates whether a line terminator; acceptable values: [yes/no] Default: `yes` Acceptable Values `yes` `no`
`4` | `delimiter` | `STRING` | Value separator; eg , Default: `,` Acceptable Values `\t` `;` `,` ``
`5` | `fileType` | `STRING` | File type; eg CSV Default: `csv`
`6` | `channels` | `STRING` | List of channels to export; eg "voltage:5v,current:12v" with the default set to "all" Default: `all`
`7` | `defaultDirectory` | `STRING` | Sets the default csv file directory to save all exported files

Returns: OK if successful, else Fail if an error occurred saving, an invalid file or argument was specified

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"

See also

- $save csv
- $stream import

Back to index

## $stream export status

Version 2

Checks the status of export operation.

Arguments

No arguments

Returns: "COMPLETE" if complete or "IN PROGRESS" if in progress

Notes

Returns "COMPLETE" if the export is complete, otherwise returns "IN PROGRESS".

Back to index

## $stream import

Version 2

Imports from a given format

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | The file path to be imported
`2` | `fileType` | `STRING` | File type; eg CSV Default: `csv`
`3` | `delimiter` | `STRING` | Value separator; eg , Default: `,` Acceptable Values `\t` `;` `,` ``
`4` | `minTime` | `STRING` | The minimum time value; eg 100mS. The default value of 0nS indicates reading from the start Default: `0nS`
`5` | `maxTime` | `STRING` | The maximum time value; eg 800mS. The default value of -1nS indicates reading to the end Default: `-1nS`
`6` | `offsetTime` | `STRING` | The offset time value; eg 10mS. The default value of 0nS indicates there is no offset Default: `0nS`
`7` | `channels` | `STRING` | List of channels to import; eg "voltage:5v,current:12v" with the default set to "all" Default: `all`
`8` | `timeFormat` | `STRING` | Time format ["elapsed", "unix"]. The default is "elapsed" Default: `elapsed` Acceptable Values `elapsed` `unix`

Returns: OK if successful, else Fail if an invalid file

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`

See also

- $stream export
- $convert csv

Back to index

## $stream read

Version 2

Reads data between from a given start time and either end time or number of records

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `startTime` | `INT` | Start time
`2` | `endTime` | `STRING` | End time
`3` | `timeFormat` | `STRING` | Time format ["elapsed", "unix"]. The default is "elapsed" Default: `elapsed` Acceptable Values `elapsed` `unix`

Returns: Read data if successful, else Fail if no connected device, or an invalid time argument

Notes

Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default

Examples

`$stream read 0 l100`

See also

- $read

Back to index

## $stream record

Version 2

Starts streaming

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | File specifier of the form /dir/dir/dir/recordingName. Any '\' characters are replaced with '/' character
`2` | `duration` | `INT` | Specifies the stream duration in seconds.

Returns: OK if successful, else Fail if no connected device is found, if a stream is already running, a stream did not start or an invalid recording directory is specified

See also

- $start stream

Back to index

## $stream record duration

Version 2

Returns the total recording time

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `timeFormat` | `STRING` | Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S" Default: `S` Acceptable Values `nS` `uS` `mS` `S` `HMS`

Returns: Recording duration, else Fail if not connected to a device

Notes

A value of -1 is returned if streaming has not commenced

See also

- $stream start time
- $stream stop time

Back to index

## $stream start time

Version 2

Returns the time that streaming started

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `timeFormat` | `STRING` | Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S" Default: `S` Acceptable Values `nS` `uS` `mS` `S` `HMS`

Returns: Time stream started, else Fail if not connected to a device

Notes

A value of -1 is returned if streaming has not commenced

See also

- $stream stop time
- $stream record duration

Back to index

## $stream state

Version 1

The current state of streaming

Arguments

No arguments

Returns: One of the following: Stopped, Starting, Recording or Stopping

Back to index

## $stream stats export

Version 2

Saves the statistics to a given format

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `file` | `STRING` | Single argument string specifying file path of form: *STREAM_DIR*+"statsGrid"+yyyyMMddHHmmss+".csv" - Path for data to be saved to.
`2` | `fileType` | `STRING` | Type of export file; eg .csv Default: `csv`

Returns: OK if successful, else if an error occurred creating the file parent directory

See also

- $stats to csv

Back to index

## $stream stats export status

Version 2

Checks the status of the stats export operation.

Arguments

No arguments

Returns: "COMPLETE" if completed, or "IN PROGRESS" if in progress

Back to index

## $stream stats table

Version 2

Returns statistics

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `startTime` | `INT` | Start time. Time format is either HMS or a (time,unit) pair; eg 100mS
`2` | `endTime` | `INT` | End time. Time format is either HMS or a (time,unit) pair; eg 100mS
`3` | `timeFormat` | `STRING` | Time format ["elapsed", "unix"]. The default is "elapsed" Default: `elapsed` Acceptable Values `elapsed` `unix`

Returns: Table of statistics, or Fail of no device connected or an invalid time argument

Notes

Time can be either an elapsed time or Unix time, determined by the timeFormat argument which is set to elapsed time by default

See also

- $get stats
- $get custom stats range

Back to index

## $stream stop

Version 2

Stops streaming

Arguments

No arguments

Returns: OK if successful, else Fail if not currently streaming

See also

- $stop stream

Back to index

## $stream stop time

Version 2

Returns the time that streaming stopped

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `timeFormat` | `STRING` | Specifies the time format. Options: [nS, uS, mS, S, HMS]. The default is "S" Default: `S` Acceptable Values `nS` `uS` `mS` `S` `HMS`

Returns: Time stream stopped, else Fail if not connected to a device

Notes

A value of -1 is returned if streaming has not commenced

See also

- $stream start time
- $stream record duration

Back to index

## $take snapshot

Version 1

Takes a snapshot of the chart, timeline and channels windows

Arguments

# | Argument | Type | Description
--- | --- | --- | ---
`1` | `type` | `STRING` | Type of snapshot to take consisting of a comma separated list of options: [all, chart, timeline, key] Default: `all`

Returns: OK if successful, else Fail if an invalid type is specified

Examples

`$take snapshot --> default and captures chart+timeline+key`

`$take snapshot all --> same as default`

`$take snapshot chart --> chart only`

`$take snapshot chart,key --> chart+key`

`$take snapshot chart,timeline --> chart+timeline`

See also

- $chart snapshot

Back to index

## $version

Version 1

Version number

Arguments

No arguments

Returns: Version number

Back to index