The main xml tag that holds all devices and scripts. It requires either all or none of the following attributes. Including no attributes will result in the profile executing once.
Command used to configure an email account. Email command is used to send messages.
Configures a serial (Com port) device or tcp (internet) device connection.
Serial attributes when type="serial"
TCP/IP attributes when type="tcp"
A set of commands that run as a single piece of code. You can place scripts in external files within a profile directory and include them in the profile using the Import command (see below).
A script named "main" is required for the profile to execute. It is called everytime the profile iterates. The Run command below can be used to call other scripts from within the "main" script.
Tags uss to indicate the start and end of a subscript page (external to the profile.xml file).
A file named config.xml located in the specific profile folder is used to configure the variables that appear in the Data Interface. It is loaded into the running profile with the loadvars command (described below) in the "startup" script.
Checks a directory or file path and stores True or False in a profile variable.
Creates a file.
Creates a directory.
Deletes a file.
Deletes a directory.
Renames a file.
Copies a file.
Appends the contents of a file to another file.
The folllowing attributes can be used in any of the commands
Most attributes allow for profile variables and ascii codes to be included in the arguments. Use square braces [ ] for variables and curly braces { } for ascii codes.
Breaks out of the inner-most loop of the executing script
Attempts to connect to a device. Sets variable to True if connection is successful, False otherwise.
Closes the serial or TCP connection to the specified device
Connects to the last set device and collects data based on the following attributes. The collect and send commands are central to ComScript and can be configured in numerous ways to allow data collection from various types of devices. Please refer to the Device Communication section of the manual and the examples for more information
To collect 8 characters (e.g. "ABCDEFGH") from the device:
Stores the current date and time in a variable
Send a message to a specific email address
Gets the elapsed time since the profile has started. Can be restarted at zero with the reset attribute.
Allows different sets of commands to be executed based on a condition
Includes a Command Script stored in an external file in the profile. The file can be located anywhere within the current profile's directory
Stops profile execution.
Loads variables from an xml or text file
Logs a string to the profile's log file. Ascii codes wrapped in { } and variables wrapped in [ ] will be substituted.
Evaluates a math expression and saves the result to a variable.
Executes a set of commands wihle continuing profile execution. Caution: Switching Devices during a MultiTask command in a profile that uses device connections outside of the MultiTask command can result in the incorrect device being used.
Parses a hex string into a list of variables or a list of variables into a hex string
Pauses profile execution for a specified ammount of time.
Reads individual lines of a file into a variable until it reaches the end of the file. Readfile is structured as a loop to allow a command or sequence of commands to operate on (e.g. loadvars command) the line read from the file befroe the next line is loaded.
Runs a subscript or an external executable file
Saves the current state of all profile variables to a file
Extends the collect class to include the ability to send a string to the device before collecting data
Sends a file to a remote server via FTP using an ip address or hostname
The set command is used to declare a variable(s) with an initial value, to configure general ComScript functions and to define binary data types
Sets the current device to be used for data transmission
Calculates the size of a variables contents and stores the result in another variable.
Executes different sets of commands based on the value of a variable
Checks if a variable can be parsed into certain data type and stores True or False in another variable
Executes a set of commands while a condition is true
Creates a file if it doesn't exist and appends a string to the end of it