Command and Script Functions List

Command Functions Table

Note: USBs must be formatted in FAT32 to be used with the eXT, nXT and eXT2 series.

Command Functions

Item	Description
Add Row to Data Log	Adds a row to the Data Log. It has the following parameters: Data Log Model: specifies which Data Log Model will have the vrow added.
Call Script	Toggles a Manual Script to be run when activated. It has the following parameters: Run on a separate thread: A toggle that will determine if each instance of the script being run will count as a separate script or the same one. Script Name: Specifies the script that will be called.
Close Page	Closes the current page. It has the following parameters: Method: Either calling the page by the name or by the index. Page: Depending on the Method, users will specifiy the page by name or page number. It is possible to close all pages in a project with this command. This function should only be used to close popup pages.
Enable/Disable Driver	Enables or Disabled Communication with the selected I/O Device. It has the following parameters: I/O Device: Selects which I/O Device will have their communication configuration will be altered. Operation: Sets the command only to Enable or Disable.
Enable/Disable Schedule	Sets a schedule to be turned on or off depending on the command specifications. It has the following parameters: Schedule: specifies which schedule to enable/disable. Operation: Sets the command only to Enable, Disable, or Toggle the schedule.
Enter Tag Value	Opens up a keypad to manually input a new tag value. It has the following parameters: Type: Sets the to-be input as either text or a Numeric input. Numeric will display a keypad; text will display a keyboard. Tag: Specifies the tag that will be changed. Header: Sets the text at the top of the keypad that will appear at the top left of the keypad window. Subheader: Sets the text below the header. It will appear also in the top left of the keypad. X: Sets the X position for the keypad Y: Sets the Y position for the keypad. The following parameters are for Numeric Keypads only. Decimal Places: Will set how many decimal places will show by default when opening the keypad. Leading Zeroes: Sets how many Zeroes will appear preceding the tag value when opening the keypad Base: Can be set to either Decimal or Hexadecimal. A numeric keypad will appear with standard numbering conventions of A-F, respectively. Use Thousands Separator(,): Adds a comma for every thousand places. Use Scaling: Enables the use of Raw Min / Raw Max for the keypad. Restrict Min/Max Input: Will enable the use of setting a Min / Max on the keypad. Raw Min: The lowest number that the tag will be scaled to. Raw Max: The highest number the tag will be scaled to. Min: Set the minimum value accepted for the keypad. No limit. Max: Set the maximum value accepted for the keypad. No limit.
Exit Project	Automatically closes the project. There are no parameters for this command.
Export Recipe CSV	Select a Recipe to export into the selected storage type. It has the following parameters: Recipe: Select the Recipe to have the CSV file exported from. Storage Type: Selection choice for where the CSV file will be exported to.
Import Recipe CSV	Select a CSV file to import into the selected recipe. It has the following parameters: Recipe: Select the Recipe to have the CSV file imported. Storage Type: Selection choice for where the CSV file will be searched from.
Insert Custom Script	Creates a script to run. Will be treated like a Manual Script. There are no parameters for this command. Previously sold CM-eXT07 and CM-nXT07 devices produced before November of 2024 do not support this feature.
Logout User	Automatically logs out the current user from the runtime. There are no parameters for this command.
Open Config Menu	Opens the configuration menu, usually opened via the 3-corner method. There are no parameters for this command.
Open Frame Monitor	Opens up the Frame Monitor. This only works on a physical Xpanel and is not supported in simulator mode. There are no parameters for this command.
Open Login Window	Opens the Login window for Identity and Access Management. It has the following parameters: Show User List: A toggle to show the list of all available users or to have the user type in the username.
Open PDF	Opens the PDF viewer with the specified file. It has the following parameters: Storage Type: Selection choice of where to search for valid PDF files. PDF File: Selects the PDF to open.
Open Page	Opens a new page. It has the following parameters: Method: Either calling the page by the name or by the index. Page: Depending on the Method, users will specifiy the page by name or page number. If the selected page is not a popup, it will close and replace the current base page.
Open Previous Page	Open the previous page that the current page was opened from. There are no parameters for this command.
Open Recipe Config	Opens a Recipe configuration window in runtime. It has the following parameters: Recipe: Select the Recipe that will have its config window open.
Play Library Audio	Plays the selected audio file. It has the following parameters: Audio File: The selected audio file that will be played. Async: Allows the playing of multiple audio files at once if selected. Previously sold CM-eXT07 and CM-nXT07 devices produced before November of 2024 do not support this feature.
Stop Library Audio	Stops playing the selected audio file. It has the following parameters: Audio File: The selected audio file that will be played. Previously sold CM-eXT07 and CM-nXT07 devices produced before November of 2024 do not support this feature.
Play Video	Plays the selected video file. It has the following parameters: Storage Type: Sets where the video file will be selected from. Has the options of Local, USB, SD Card, FTP and Project. Video File: Sets the video file that will be played. This will only work on the eXT2 series.
Press Key	Simulates a keystroke from a specified key on the keyboard. It has the following parameters: Key: Specifies which key will be simulated. I.E., Enter, tab, backspace, etc.
Receive Recipe Record	Receives tag values from the project and saves them to the recipe. It has the following parameters: Recipe Database: Sets the Recipe database to pull the info from. Use Record Tag ID: A Toggle to pull the tag connected to the record or just the ID number. Record ID: The ID number of the record to pull tag data from. Record Tag ID: The Tag connected to the record to pull tag data from.
Save Alarm CSV	Creates a CSV file based on the Alarm Summary data. It has the following parameters: Storage type sets where the CSV file will be stored. Has the options of Local, USB, SD Card, FTP, and Project. Label: This can be set only to record Alarms with a specific label or to grab all labels. Disclaimer: CIMON recommends exclusively using a USB or SD card for storage types. Saved CSV files to local memory are only accessible through an SSH connection.
Save Data Log CSV	Creates a CSV file based on the Data Logger data. It has the following parameters: Storage type sets where the CSV file will be stored. Has the options of Local, USB, SD Card, FTP, and Project. Data Log Model: Specifies which Data Log Model to grab the data from. Time Range: All by default. It can be configured to grab within a specific time frame only. Disclaimer: CIMON recommends exclusively using a USB or SD card for storage types. Saved CSV files to local memory are only accessible through an SSH connection.
Send Email	Sends an email from the project to the recipients. It has the following parameters: To: Select from Users or groups, or type in an email to send the message to. Cc: Carbon copy. Recipients in this will receive the email, but it will not be primarily addressed to them. Subject: Sets the subject line for the email. Message: Sets what the message within the email will be sent. For this command to work, emails must be configured to send. More information on how to do so will be found on our Email Feature Page.
Send Recipe Record	Sets tags to the values saved within the recipe. It has the following parameters: Recipe Database: Sets the Recipe database to pull the info from. Use Record Tag ID: A Toggle to pull the tag connected to the record or just the ID number. Record ID: The ID number of the record to pull tag data from. Record Tag ID: The Tag connected to the record to pull tag data from.
Send Screen Notification	Sends a notification to the bottom of the screen during runtime. It has the following parameters: Message: Set the message to be sent by the news. Automatically Dismiss: Toggle to turn on automatic dismissal. Dismiss Delay (ms): Set how long the project will wait before Dismissing the message.
Set Tag Value	Sets the tag value to the predetermined value. It has the following parameters: Tag: Specifies which tag will have its value changed. Value Type: Configuration for how the value will be set, copying from another tag or by a constant integer. Value: Depending on the configuration of the Value Type, it will require either an int or another tag to grab the value from.
Set Translation Language	Sets the Language. It has the following parameters: Language: Set the language, which must be in the translation editor.
Start/Stop Data Log	Sets a Data Log to be turned on or off depending on the command specifications. It has the following parameters: Schedule: specifies which Data Log Model to enable/disable. Operation: Sets the command only to Enable or Disable.
Start/Stop FTP Server	Toggles on or off an FTP server. It has the following parameters: Operation: Sets the power only to Start or Stop.
Toggle Tag Value	Toggles a tag to interchange between zero and one. It cannot go to any other value. Has the parameters: Tag: Sets the tag which is to be toggled.