Table of Contents

Reference Commands (Dewesoft NET Protocol Version 4)

IMPORTANT: When writing a command over telnet, you only have one try to type it correctly. Even if you backspace the error and continue writing the command, it will fail to execute. Most likely, you will get a + ERR Command not processed error message. You can copy and paste commands to the terminal.

Each command has to have a new line suffix (0x13 + 0x10).

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 the measurement unit
Parameters None
Example GETDATETIME
+OK 12.02.2026 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 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 acquisition
Parameters None
Example STARTACQ
+OK Acquiring
Syntax STOP
Description Stops the acquisition
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 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 Enters or exits 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 full screen setup mode.
Parameters None
Example SETUP DISCONNECT
+OK
Syntax DISPLAY START
Description Sets Dewesoft to display 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 SAVESETUP 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
Syntax CANCONTROL
Description Returns Yes or No if the client can be in Control mode.
Parameters None
Example CANCONTROL
+OK Yes
Syntax GETSETUPSAMPLERATE
Description Returns the sample rate of the measurement unit.
Parameters None
Example GETSETUPSAMPLERATE
+OK 20000
Syntax SETTIMEOUT
Description Changes the timeout before the telnet connection is automaticly disconnected.
Parameters Newtimeout [Integer]
Example SETTIMEOUT 50
+OK Timeout set to 50 ms
Syntax GETNETMODE
Description Returns the mode of the NET system (Master/Slave).
Parameters None
Example GETNETMODE
+OK Slave Client
Syntax GETTIMING
Description Returns the name of device that is providing the clock.
Parameters None
Example GETTIMING
+OK Plugin
Syntax EXIT
Description Disconnects from telnet communication.
Parameters None
Example EXIT
Syntax LISTSETUPFILES
Description Lists setup files present on the unit.
Parameters None
Example LISTSETUPFILES
+STX listing setup files
Setup.dxs
+ETX end list
Syntax LISTDATAFILES
Description Lists datafiles present on the unit.
Parameters None
Example LISTDATAFILES
+STX listing setup files
Data.dxd
+ETX end list
Syntax GETSETUP
Description Returns the setup in XML format.
Parameters None
Example GETSETUP
+STARTXMLCODE SETUP
<XML of the setup file>
+ENDXMLCODE
Syntax SETSETUP
Description Sends the setup in XML format and loads it.
Parameters SetupInXMLFormat [String]
Example SETSETUP <XML of the setup file>
+OK
Syntax STOPTRANSFER
Description Stops data transfer.
Parameters None
Example STOPTRANSFER
+OK Transfer stopped
Syntax GETMINSAMPLINGRATE
Description Returns minimal possible sample rate.
Parameters None
Example GETMINSAMPLINGRATE
+OK 100
Syntax GETMAXSAMPLINGRATE
Description Returns maximal possible sample rate.
Parameters None
Example GETMAXSAMPLINGRATE
+OK 25000
Syntax GETTRIGGERSTATUS
Description Get the status of trigger. In case Dewesoft is storing is returns the information of the last trigger
Parameters None
Example GETTRIGGERSTATUS
+OK Armed
Syntax CURRENTLOADEDFILE
Description Returns the name of current loaded datafile
Parameters None
Example CURRENTLOADEDFILE
+OK File Data.dxd
Syntax GETSTOREFILENAME
Description Returns the name of going to be stored datafile
Parameters None
Example GETSTOREFILENAME
+OK File Data.dxd
Syntax CANSTARTACQ
Description Returned is you can start the aqusition as hex value
Parameters None
Example CANSTARTACQ
+OK $1
Syntax TOUCH
Description Refreshes the telnet connection
Parameters None
Example TOUCH
+OK
Syntax SETDATAPORT
Description Changes the port from which we can pull the data when the storing starts
Parameters Port [Integer]
Example SETDATAPORT 7337
+OK Data port set to 7337
Syntax SETASYNCTIMESTAMPS
Description If you want to receive timestamps with asynchronous channels
Parameters State [String]
Example SETASYNCTIMESTAMPS OFF
+OK Async timestamps off
Syntax SETDOWNLOADFILE
Description Sets the name of file that will be dowloaded
Parameters Path [String]
Example SETDOWNLOADFILE D:Dewesoft\Data\Data.dxd
+OK
Syntax SETUPLOADFILE
Description Sets the name of file that will be uploaded
Parameters Path [String]
Example SETUPLOADFILE D:Dewesoft\Data\Data.dxd
+OK
Syntax DOWNLOAD [port_number]
Description Downloads the file
Parameters port_number [Integer]
TCP port number on client computer
Example DOWNLOAD 8001
+OK Downloading <125> bytes
Syntax UPLOAD
Description Uploads the file
Parameters Port [Integer]
FileSize [Integer]
Example UPLOAD 7337 123
+OK Uploading
Syntax LASTUPLOADSTATUS
Description Returns the last status of uploading
Parameters None
Example LASTUPLOADSTATUS
+OK Success
Syntax GETSCALETABLE
Description Returnes the scaling table of the channel
Parameters ChannelIndex [Integer]
Example GETSCALETABLE 5
0: -32768
1: -32768
2: -32768
3: -32768
4: -32768
5: -32768<br7: -32768<br10: -32768
Shift: 4
Remainder: 15
+ETX
Syntax RELAYCMD:
Description Sends cmd command to slave computer
Parameters ComandIn [String]
Example RELAYCMD:10.2.10.12 GETNETMODE
+OK Slave Client
Syntax GETSTATUSWITHERRORLOG
Description Get status logs with errors
Parameters None
Example GETSTATUSWITHERRORLOG
+OK Mode: Measure; Clock mode: Standalone&000
Syntax GETSTATUSEX
Description Returns NET statuses
Parameters None
Example GETSTATUSEX
+STX listing status
Mode Slave measurement unit
Acquisition Off
Controled by master client No
View clients connected 1
Storing Off
Total space (kB) 243418432
Total free space (kB) 6235156
Write speed (kB/s) N/A
Minutes left (s) N/A
Entries in error log 0
SyncLost N/A
TimeTracking N/A
SyncOVL N/A
CPU Ave (%) 18
CPU Max (%) 28
CPU Temp (degC) N/A
FAN speed (%) N/A
+ETX end of list
Syntax STOPSTORE
Description Stops the storing
Parameters None
Example STOPSTORE
+OK Storing stopped
Syntax MANUALTRIG
Description Adds manual trigger
Parameters None
Example MANUALTRIG
+OK
Syntax SETZERO
Description Sets the channel to zero
Parameters None
Example SETZERO
+OK
Syntax SEQLOAD
Description Loads the sequence
Parameters Path [String]
Example SEQLOAD "D:\Dewesoft\Sequences\Sequence.dxt"
+OK Sequence loaded
Syntax SETDISABLEMK
Description This disables or enables mouse and keyboard on connected computer
Parameters State [String]
Example SETDISABLEMK ON
+OK
Syntax ADDEVENT
Description Adds an event to the measurement
Parameters EventInXML [String]
Example ADDEVENT <Event EventType=3></Event>
+OK
Syntax ACCEPTSEVENTS
Description Returns information if master accepts events from the clients
Parameters None
Example ACCEPTSEVENTS
+OK 0
Syntax SETCTRLCHANNELVALUES
Description Writes values to control channels with ID. The ID of a channel is visible under Channel settings -> Outputs and in the Connection descriptor tab: I[1100000;0;1] -> ID = 1100000;0;1
Parameters index:value\
Example SETCTRLCHANNELVALUES 0:0\
+OK Control channel values set