Command reference (Dewesoft NET protocol version 4)

Each command has to have a new line suffix (0x13 + 0x10). Commands in the red color only can only be sent in control mode.

Syntax GETVERSION
Description Returns the Dewesoft version
Parameters None
Example GETVERSION
+OK X3 SP7 (64-bit)
Syntax GETINTFVERSION
Description Returns the Dewesoft NET protocol version
Parameters None
Example GETINTFVERSION
+OK 1500
Syntax GETDATETIME
Description Returns the current time on measurement unit
Parameters None
Example GETDATETIME
+OK 12.06.2019 12:46:12
Syntax GETMODE
Description Returns the current operation mode control (1) or view (0)
Parameters None
Example GETMODE
+OK Mode 0 (view)
Syntax SETMODE [mode]
Description Returns the current operation mode: control (1) or view (0)
Parameters Mode [Integer]
0 – View mode
1 – Control mode
Example SETMODE 1
+OK Mode 1 (control) selected
Syntax SETMASTERMODE [mode]
Description Sets the clock mode of the devices used to synchronize several devices together
Parameters Mode [Integer]
0 – Standalone (if only one system is used)
1 – Clock master system (the clock is outputted from this system to the slaves – only one!)
2 – Clock slave mode (clock will be received from a master system)
Example SETMASTERMODE 0
+OK Master mode changed to 0
Syntax SETSAMPLERATE [samplerate]
Description Sets the sampling rate
Parameters samplerate [Double]
Sample rate in Hz
Example SETSAMPLERATE 5000
+OK Samplerate set to <5000> Hz
Syntax GETSAMPLERATE
Description Reads the current sample rate
Parameters None
Example GETSAMPLERATE
+OK 4000
Syntax LISTUSEDCHS
Description Lists all used channels
Parameters None
Example LISTUSEDCHS
+STX listing channels
CH 7000 0 Formula 1 - - 1 100 0 5 100000 1 0 1 0 Formula 1 (Formula) noise -1 1 OvlNo 0 0 -0,999822 0,999619 -0,0012934
+ETX end list
Syntax PREPARETRANSFER [used_channels]
Description Sends a list of channels for live capture. Only used channels can be selected
Parameters used_channels [List of Integer]
List of channel indexes we want to prepare
Example PREPARETRANSFER 0 1 2
+OK
Syntax STARTTRANSFER [port_number]
Description Requests Dewesoft to connect to the port »portno« and feed data to client
Parameters port_number [Integer]
TCP port number on client computer
Example STARTTRANSFER 8001
+OK
Syntax STOPTRANSFER
Description Stops the transfer
Parameters None
Example STOPTRANSFER
+OK
Syntax STARTTRIGTRANSFER [port_number]
Description Requests DEWESoft to connect to port »portno« and feeds the last trigger data to client
Parameters port_number [Integer]
TCP port number on client computer
Example STARTTRIGTRANSFER 8001
+OK
Syntax STARTACQ
Description Starts the acquisition – measure
Parameters None
Example STARTACQ
+OK Acquiring
Syntax STOP
Description Stops the acquisition / leaves the measure mode and goes to the setup screen
Parameters None
Example STOP
+OK Stopped
Syntax STARTSTORE [filename]
Description Starts storing / Starts acquisition if not yet started and starts storing data
Parameters filename [String]
Name of the datafile
Example STARTSTORE test
+OK Storing
Syntax SETSTORING [status]
Description Sets the remote storing property
Parameters Status [String]
ON – Remote storing on
OFF – Remote storing off
Example SETSTORING ON
+OK Storing is on
Syntax ENTERSETUP
Description Enters the setup mode
Parameters None
Example ENTERSETUP
+OK In channel setup
Syntax ISACQUIRING
Description Returns »Yes« if acquisition is in progress (measure or setup), otherwise »No«
Parameters None
Example ISACQUIRING
+OK Yes
Syntax ISSETUPMODE
Description Returns »Yes« if in setup mode, otherwise »No«
Parameters None
Example ISSETUPMODE
+OK Yes
Syntax ISSTORING
Description Returns »Yes« if storing is in progress, otherwise »No«
Parameters None
Example ISSTORING
+OK Yes
Syntax ISMEASURING
Description Returns »Yes« if acquisition is in progress (measure), otherwise »No«
Parameters None
Example ISMEASURING
+OK Yes
Syntax GETSTATUS
Description Returns Dewesoft status (measure/analyse mode, clock mode)
Parameters None
Example GETSTATUS
+OK Mode: Measure, Setup; Clock mode: Standalone
Syntax SETFULLSCREEN [status]
Description Sets or clears full screen mode of Dewesoft
Parameters Status [Integer]
1 – Full screen on
0 – Full screen off
Example SETFULLSCREEN 1
+OK Fullscreen mode on
Syntax SETUP CONNECT
Description Sets Dewesoft to full screen setup mode. Suitable for VNC remote setup of Dewesoft
Parameters None
Example SETUP CONNECT
+OK
Syntax SETUP DISCONNECT
Description Cancels setup full screen mode
Parameters None
Example SETUP DISCONNECT
+OK
Syntax DISPLAY START
Description Sets Dewesoft to full screen setup mode. Suitable for VNC remote setup of Dewesoft
Parameters None
Example DISPLAY START
+OK
Syntax DISPLAY STOP
Description Cancels display setup mode
Parameters None
Example DISPLAY STOP
+OK
Syntax LOADSETUP [filename]
Description Loads the setup
Parameters Filename [String]
Setup file stored on the measurement unit
Example LOADSETUP C:\Dewesoft\Setups\CrossTrigger1.dxs
+OK Setup loaded
Syntax SAVESETUP [filename]
Description Saves the setup
Parameters Filename [String]
Setup file to be stored on measurement unit
Example LOADSETUP C:\Dewesoft\Setups\CrossTrigger1.dxs
+OK Setup saved
Syntax NEWSETUP
Description Clears the current DEWESoft setup
Parameters None
Example NEWSETUP
+OK New setup
Syntax SETSCREENSIZE [screensize]
Description Sets Dewesoft window size in pixels
Parameters Screensize [String]
XsizexYsize – sets window size to Xsize x Ysize (i.e. 640x480)
MAX – maximizes window size
Example SETSCREENSIZE 640x480
+OK Screen size changed