Control Instruction Summary
Home ] Up ] [ Control Instruction Summary ] Macro Math Summary ] Drawing Instruction Summary ]


Control Instructions -- All instructions must begin with !
Executed, NOT saved in any manner for recall. Commands which affect the displayed plot will cause the plot to be re-drawn, take care when using them in macros.  

1 and 0 can be used in place of ON/OFF

Plot Control
Plot Configuration
Plotting Historical/Logged Data
Logging Control - Snapshots and Plot Saves
Logging Control - Data and Message Files
Logging Control - Printing
Macro Control
Interactive
Miscellaneous

Plot Control:

CLRQ Clear Queue: Clears all data presently in the Queue awaiting processing.
!CLRQ 
CONN ON/OFF Controls Connected state of the plot. Of course, in most cases from the micro, this will only cause a disconnect.  Connecting clears the queue!
!CONN ON 
CSUM ON/OFF Defines whether a checksum value will be sent when using binary data.
!CSUM ON 
DBLT Double the span of plot time.
!DBLT 
DBLA Double the span of plot analog values.
!DBLA 
ECHO ON/OFF  When echo is enabled (default), data sent to the micro will have appended a |Q|. If the micro echos the data back to SPP, this will indicate to SPP to not process the data.
!ECHO OFF 
!ERRT ON/OFF ASCII Error Trap (default is on). Normally, a string with ASCII values <13 (except 10) and > 127 are disregarded as bad data. Disabling this option will disable the error trapping.
!ERRT OFF
FAMT value in % Flush Amount
Selects the amount of data to be flushed when points reach max
!FAMT 75 
FLSH ON/OFF Flush old data: Enables/disables flushing of data from data point buffer
!FLUSH ON
HLVT Halves the span of plot time.
!HLVT 
HLVA Halves the span of plot analog values.
!HLVT 
MAXP Defines the maximum for MAXS and MAXR to be based on maximum plot points. See APNT and ATIM for autosaves/prints.
!MAXP 
MAXR Sets the plot to reset at maximum points or time depending on configuration.
!MAXR
MAXS Sets the plot up to stop at maximum points or time depending on configuration.
!MAXS 
MAXT Defines the maximum for MAXS and MAXR to be based on maximum plot time (if points is reached first, it will trigger the event). See APNT and ATIM for autosaves/prints.
!MAXT
NEWP New Plot. Returns plot values to default, resets the plot.  Plot Objects are NOT cleared.  Use !POBJ Clear to clear objects.
!NEWP
NUMB value
Defines the number of bytes per packet or data sent when using binary mode. This value DOES NOT include a checksum byte.
!NUMB 3 
PAMT value in % Position Plot Amount: Determines the amount a plot will shift on up, down, Left/Right. (25).
!PAMT 10
PLOT ON/OFF Enables/Disables plotting.
!PLOT ON
PNTS value Sets the number of maximum data points to collect. The plot will be reset. (500).
!PNTS 200
PORT port, baud, bits, parity, stopbits, Queue Size, DTR Enabled, RTS Enabled, RTS Always on

Configures the COM port for connection:
!PORT COM 2,19200,7,E,1,2000,0,1,0 

PORT TCP,IP address, port number, password.

Configures a connection using the Serial/TCP gateway:
!PORT TCP,120.0.0.1,9001

QSIZ value Sets the size of the queue in bytes or characters.
!QSIZE 10000 
REFR Refreshes (redraws) the plot. 
!REFR
!SDTR ON/OFF* Manually Set the DTR line.  Set after !CONN, ensure DTR enable is NOT selected in configuration or it will reset to on.
!SDTR ON
!SRTS ON/OFF* Manually set the RTS Line.  Set after !CONN.
!SRTS ON
RSET
Resets the plot clearing all stored data and returning to time 0.
!RSET
SQRD ON/OFF Default-ON: Defines whether squaring of digital plot lines is on or off.
!SQRD OFF
SHFT ON/OFF Defines whether to shift the plot when the maximum time value is reached for analog and digital data.
!SHFT ON 
SAMT value in % Shift Amount:Selects the amount of plot to shift when data reaches max time. Shifting must be on. (50)
!SAMT 2 
SFTU Shift Plot Up by PAMT amount.
!SFTU 
SFTD Shift Plot down by PAMT amount.
!SFTD 
SFTL Shift Plot left by PAMT amount
!SFTL 
SFTR Shift Plot right by PAMT amount.
!SFTR 
USEB ON/OFF Defines when on that data arriving will be in binary and not ASCII format.
!USEB ON 


  
Plot Configuration: 
AMAX value Sets the maximum analog scale value. (250)
!AMAX 1000 
AMIN value Sets the minimum analog scale value. (0)
!AMIN -200 
AMUL value Sets the analog multiplier. (1)
!AMUL .1
AMSK maskstring Provides a mask for displaying values for the the analog Scale. (0.0)
0.00 - Two decimals
$0.00 - Two decimals with leading $
0.0mA - One decimal with mA suffix
!AMSK 0.0000 
APER X%,Y% Sets the percentage of the desktop screen the application should use.  Godd for setting a defined rectangle for specialized configurations.
!APER 80,50
ASCL Auto scales the Y axis based on min/max since reset on ALL channels plotted.
!ASCL 
BIMG X1,Y1,X2,Y2,image name Set background image.  Coordinates may be omitted for full plot background. 
!BIMG 0a,0a,100a,100a,plotback.jpg
CLRC Clears Constant drawings from the plot.
!CLRC
COLR Letters and color values B = Background, G = Grid (major), A = Analog, S = Scales value, D = Digital
Allows the setting of one or more plot colors.
!COLR B10,A12 
DISP Letters and color values  G = Grid (major), A = Analog, S = Scales value, D = Digital, R = Drawing
Sets what is enabled to be displayed. If the letter is listed, that item will be enabled. Any not listed will not be drawn.
Optionally may use numbers to specify colors. (see COLR)
!DISP D10 A12 G
GRID X-amount,Y-amount Defines the number of grid lines on the X and Y axis. (10,10)
!GRID 20,50 
MENU Enable/disable the menu choice (except the macro-defined menu buttons) from being shown.
!MENU OFF
PMOD 0/1 Plot Mode
Defines whether absolute plotting coordinates are 0,0 to 100,100 as defined by the grid area (mode 0), or 0,0 to 255,255 as defines by the entire plot area.
!PMOD 1 
PPER X%,Y% Sets the percentage the main plot should use in the application to allow room for objects.
!PPER 80,50
RGAP ON/OFF Right Gap
!RGAP ON
RTIM ON/OFF Real Time
Enables/disables real time values for X coordinates
!RTIM ON 
SPAN Analog min, analog max Sets the span of the plot and adds the values to the drop-down.
!SPAN -50, 250
STAT message Same as USRS
!STAT The Heater cycled off 
TBAR ON/OFF Enable/disable the toolbar from being shown
!TBAR OFF
TGAP ON/OFF Turn on/OFF Top Gap
!TGAP ON
TITL title Displays the title on the plot window caption.
!TITL My First Plot 
TMAX value Sets the maximum time of the plot scale in seconds, adds to drop down. (120)
!TMAX 360 
LOGY ON/OFF Logarithmic Y scales
Enables/Disables Logarithmic Y coordinate values
!LOGY ON 
UMSG Time in seconds, message string Displays a message to the user for the time given.
!UMSG 10, This Heater is ON!
USRS message
Displays the message in the User Status box.
!USRS The Heater Cycled On
WAVS ON/OFF Enables/displays playing WAV files.
!WAVS OFF 
XLBL units message Labels the X axis with the units provided.
!XLBL TIme into run (min)
YLBL units message Labels the Y axis vertically with the units provided.
!YLBL Temp F 

Plotting Historical/Logged data
HISS date time Enables historical or logged data plotting. If the date and/or time is omitted, the current date time wil be used.
!HISS 01/01/07 15:00
!HISS 
HISD date and time or interval, data,data,... When Historical data is enabled (See HISS), data will be plotted at the specified data time, or at the specified interval in seconds.
!HISD 01/01/07 16:00.10,20
!HISD 3600,10,20


Logging Control - Snapshots and Plot Saves
ASNP ON/OFF Defines whether auto-saving snap shots at maximum is on or off.
!ASNP ON
!APDT ON/OFF Normally ON, off disables appending date & time to snapshots and plot names.
!APDT OFF
ASAV ON/OFF Auto-Save
Defines whether auto-saving of plot at maximum is on or off.
!ASAV ON 
AUTT Auto based on Time
Defines that auto-saves/prints should occur when maximum plot time is reached. If max points is reached first, and flushing is NOT enabled, points will trigger the event.
!AUTT 
AUTP Auto based on points
Defines that auto-saves/prints should occur when the maximum data points are reached. If data flushing is enabled, the actions will be performed prior to each data flush.
!AUTP
FORM ON/OFF Enables/Disables the entire application being used for snapshots, prints and saves.  For prints and snapshots the application must be visible on the desktop.
!FORM ON
JPGQ value Sets the quality of the jpg snapshot. High is better quality, but less compression. 80 is default.
!JPGQ 50
NAMA filename Name Auto-save
Provides a filename for Auto-saved plots. File name will be appended with date & time & .plt. 
!NAMA HeaterControl 
NAMS filename Name of Snapshots
Provides a filename for Auto Snapshots. Filename will be appended with date & time & .jpg (ASav)
!NAMS HeaterControl 
SAVP filename Save Plot File
Saves the plot to the specified file name. If no filename is given the default name with data/time will be used.
!SAVP Current Conditions
SNAP filename Takes a snapshot of the plot (JPG). If the filename is not omitted, the plot title will be used.  If there is no plot title, the NAMS value will be used (ASav).  Date/Time and .jpg are appended.
!SNAP myPlot

Logging
DELD Deletes the data file. If saving is enabled, the file will be re-created.
!DELD 
DELM Deletes the message file. If saving is enabled, the file will be re-created.
!DELM 
LOGD string Manually Add a string to the data log.
!LOGD (RTIME),(AINVAL0) with a maximum of (AINMAXVAL0)
NAMD filename Provides a filename for saved analog and digital data. (SDat.txt)
!NAMD Heater Data.txt 
NAMM filename Provides a filename saving messages to the file. (SMsg.txt)
!NAMM Heater Msgs.txt 
SAVD ON/OFF Enables/disables saving analog and digital data to a file.
!SAVD ON 
SAVM ON/OFF Enables/disables saving of messages to a file.
!SAVM ON
TSMP ON/OFF Enables/Disables time stamping of data and messages to files and in message window.
!TSMP OFF

Logging Control - Printing:
APRN ON/OFF Auto Print at Max
Enables/disables auto printing at Max
!APRN ON 
MPRN ON/OFF Multiple Plot Print
Selects multiple plots per printer page. DO NOT change this once a multi-plot page is begun.
!MPRN ON 
PRNT Print Plot Now
Prints the current plot to the default printer
!PRNT
PSIZ value in % Print Size
Scales the size of the from printed plot from 100%. Default is 100. Once a multiple plot is started, changing PSIZ is NOT recommended.
!PSIZ 50

Macros:
DEFS macro path\name Defines the start-up macro to be used. 
!DEFS \sws\v2\vectors.txt 
IFTH value1, comparison, value2,statement Typically used in macros.
If-Then. If the comparison is true, the statement will be performed. The statement may be a macro call, another IFTH, or any other operation besides a MATH operation. See Macro Math for more information.
!IFTH %m0,>,100,!BELL
!IFTH 20,>,10,~PWAV BOING.WAV 
IFXY X1,Y1,X2,Y2,statement Typically used in macro.
If the last screen click was within the boundaries of X1,Y1 to X2,Y2, the statement will be performed. The statement may be a macro call, or any other operation besides a MATH operation. The coordinates may be any valid mode.
!IFXY 20a,30a,60a,80a,~PWAV BOING.WAV 
INTT value Set the interval timer between 0-30 seconds
!INTT 15 
MACR name.routine,data1,data2,.... Call the named macro, routine name and data values passed are optional.
!MACR wizards\xyplot
MACS Run the Start-up Macro
!MACS
MATH  Macros ONLY. Specifies a macro math operation to be performed. Please see Macro Math for more information. 
!MATH %m0=%m0,*,10
MREQ default value, time to display in seconds, request string, data marker number 

Similar to REQD, but for used to accept a value and assign to a data marker. Requests data from the user for use in a macro. See Interactive Controls. 
!MREQ 80,10,Lowest temperature,5 

MVAR name=value  Used only in macros, assigns a name to a data marker, and optionally a value. Names are assigned to data markers %m0-%m99 in the order they are declared.
!MVAR INDATA 
!MVAR PI_VALUE=3.14
NPSU ON/OFF Run Start-Up Macro on New Plot
Runs the startup.txt macro (see above) every time a new plot is begun through the menu or !NEWP. This setting is NOT saved with the plot configuration on exit.
!NPSU ON/OFF 
PARS ON/OFF Perform specialized parsing of incoming data based on the PCHR parse character.  Data is parsed into mac values PARSE0 - PARSExx
!PARS ON
PCHR ; Defines the character to use fo parsing special data.
!PCHR ;
USEA ON/OFF Defines whether analog data should be used for the default macro routine only if on, or both if off.
!USEA ON 
USEC On/Off Use .dblclick (double-click) routine of the start-up macro for double-click events.
!USEC ON 
USED ON/OFF Use '.Default' Macro Routine: Analog data (single or comma-separated) is automatically passed to the startup.txt macro, routine Default for macro processing.
!USED ON/OFF
!USEM ON/OFF Enabling this option allows data received that does NOT begin with an analog value to be accepted by the default routine of the macro. This was added to support VOMs which have serial data output.
!USEM ON
USER On/Off Use the .Reset routine of the macro for plot reset events.
!USEA ON 
USET On/Off Use .Timer routine in start-up macro for interval timing events.
!USET ON 

Interactive: 
APPA filename Open filename by Application Association: Opens a specified file using its associated Windows program. The full path needs to be provided.
!APPA (FPATH)\test.htm

The Send key to application instruction cannot be used for control- APPS

Unless the File menu has "Request before starting Applications" unchecked, a message box will open to ask user permission to start the application.

Regular interval use of the APPA instruction is NOT recommended. To have a web page that auto-refreshes, it is recommended to use a JavaScript time (the Web page example macro has code included). On some browsers, the plot image may not refresh unless the name of the image is changed periodically.

APPE path\appname.exe Execute external application.
!APPE notepad.exe 
APPS keystroke string send string of keystrokes to the external application
!APPS Hello world! 
BELL Rings the computers bell (beeps)
!BELL 
BSND data Sends the BINARY value of the data.  If the data is numbric (0-255) the binary value will be sent. If the value is non-numberic (A-Z, etc), the ASCII value will be sent.  Useful for controllers that can't accept ASCII string values easily.
!BSND 128
CLXY Clear XY
Sets the X, Y coordinates of a screen click to 255 (clears).
!CLXY 
GETD Get Data Value
Returns the value in the 'data-box' in the upper-left hand corner.
!GETD   
Version 2 added a total of 10 (0-9) data holders. These may be specified with their numbers.   
!GETD 5 
GETT Get Current Time since reset
Returns the numbers of seconds since the last plot reset
!GETT
GETX Get X-value
If the mouse was clicked on the screen since the last CLXY, the X-position in absolute terms will be returned. If no click occurred since the last clear, 255 will be returned. 
!GETX
 If R is specified, the coordinates will be relative to scales. If no click occurred since the last clear, 0 will be returned.
!GETX R 
GETY If the mouse was clicked on the screen since the last CLXY, the Y-position in absolute terms will be returned. If no click occurred since the last clear, 255 will be returned. 
!GETY
 If R is specified, the coordinates will be relative to scales. If no click occurred since the last clear, 0 will be returned.
!GETY R 
LBLD data number, string Labels the data holders on the values window. 
  
!LBLD 5,My data! 
READ data Sends the specified ASCII string to the micro. If binary mode is enabled, the ASCII Character will be sent for values from 0-255.  Typically used by controller to request a value from StampPlot.
!READ (sldBar) 
Note that math may be used to scale data
!READ [(sldBar),/,100]
REQD Default value, Time to display in seconds, Request String Request the user to enter a value via a timed pop-up msg box.
!REQD 120,5,High Temp set point
SEND data Sends the specified ASCII string to the micro. If binary mode is enabled, the ASCII Character will be sent for values from 0-255.
Typically used in macros. 
!SEND 50
SETD Set Data Value: Sets the value of the 'data box' in the upper left corner.
!SETD 80
Version 2 added a total of 10 (0-9) data holders. These may be specified with their numbers.   
!SETD 5,80 


Miscellaneous:
ADDQ data Adds the defined data to the beginning of the queue for processing. 
!ADDQ 10,20,30
CLMM Clears the min/max/ave analog values recorded
!CLMM 
CMMR ON/OFF Defines whether to clear the min/max/ave values on a reset.
!CMMR ON 
CLRM Clears the messages in the message text box.
!CLRM 
CVAR Clears all data marker variables from memory.
!CVAR
DELL Deletes the last constant (@) instruction from the constant's bin.
!DELL
DUMP Dumps data markers/variables to the log window.
!DUMP
MVAR name [=value] Creates a data marker variable name.  Names are assigned to data markers 0-99 from 0 up as each is defined.
!MVAR pi=3.145
!MVAR value_1
TMPL source_file[,dest_file] Creates a new file  from a template file.  All datamarker, variables and mac values are replaced when the destination file is created.  Usefull for creating a report or webpage from a template.  Unless specified, the source file resides in the macro directory and the destination file go to the data directory.  If the destination name is omitted, the source files name will be used.
!TMPL source.htm,index.htm