Canvas also includes an easy-to-use feature that allows the user to create lists of actions to be completed without the use of scripting. These action lists can be tied to the change in a tag value, opening and closing the page, and other actions, similar to a script.

Global Commands: This command type can be created using the Script Editor or Command Editor in the Action Property in property for an object, and can be used in by any object in the project.
Local Commands:This command type can only be created using the Command Editor in for an object Action Property property and can only be used in an by the object where the command is being created.

Global Commands

Method #1

Click Tools > Script Editor… > click + icon > Create New Commands > + Add New Command.

...

Click an object > Action tab > click Action drop-down menu > select Create New Commands. In the Command Editor, click Local Commands drop-down > select Global Commands > click + Add New Command.

...

Local Commands

Click an object > Action tab > click Action drop-down menu > select Create New Commands. In the Command Editor, click Local Commands drop-down > select Global Commands > click + Add New Command.

...

Commands

Functions

Description

Open Page

Code Block

language	js

page.open("Page Name");

Opens the selected page. Users can select the page by name or by its unique index.

Close Page

Code Block

language	js

page.close("Page Name");

Closes the selected page. Users can select the page by name or by its unique index.

Set Tag Value

Code Block

language	js

tag.write("Tag Name");

Sets the selected tag to a specified value. Users can select a constant value to write to the tag, or write another tag’s value to the selected tag.

Toggle Tag Value

Code Block

language	js

tag.write(“Tag Name”, !tag.read(“Tag Name”));

Toggles the selected tags' value between 1 and 0. Only ‘BOOL’ type tags can be used with this action.

Enter Tag Value

Code Block

language	js

keyboard.launchKeypad("ANA", {
    "header": "Header Title",
    "subheader": "Subheader Title",
    "x": 0,
    "y": 0,
    "min": 0.0,
    "max": 100.0,
    "format": "H,HHH"
});

Open a pop-up keyboard that allows the user to enter a value to be written to the selected tag. Users can write numeric or string values to a tag, though the tag must be the correct type to support the entered data. Ex: The tag must be a ‘STRING’ type for a text entry.

Lines 1-3: Launch keypad requesting for a user input that will be stored to the “ANA” tag. Keypad will have a header and subheader title if assigned.

Lines 4-5: Set the location for the keypad on the Xpanel screen.

Lines 6-7: Set the minimum and maximum values a user can enter.

Line 8: The value entered will appear in a chosen format. “H,HHH” is for the hexadecimal formatting, and “#,###” is for the decimal formatting.

Call Script

Code Block

language	js

system.importScript("Script Name");
system.runScript("Script Name");

The Runs the selected script.

If the “Run on separate thread options:

Image Removed

thread” options is selected, the script will be run on a separate thread (system.runScript). If the option is unselected, the script will be run on the same thread (system.importScript).

Image Added

Leave the “Run on separate thread” option unchecked if you want scripts to execute in the specified order.

Line 1: When the box is unchecked, the selected script will run in the current thread. This will interrupt any currently running scripts pause the calling script until the imported scripts has completed. The order of execution is guaranteed.

Line 2: When the box is checked, the selected script will run in a new thread. This will not interrupt the operation of currently running scripts. The order of execution is not guaranteed.

Enable/Disable Schedule

Code Block

language	js

schedule.setEnable("Schedule Name", true);
schedule.setEnable("Schedule Name", false);

Enables or disables the selected runtime schedule.

Line 1: Enabled the selected schedule.

Line 2: Disables the selected schedule.

Save Alarm CSV

Code Block
alarm.createAllCsv(Storage.Local);

Saves the Alarm Summary


alarm.createCsv("Group A", Storage.Local);

Saves a log of all alarm events to a CSV. Users can select to save the file locally on the Xpanel, to a USB, or to a an SD card.

You may choose where the CSV will be stored to: Local (on the device’s hard drive), USB, or SD Card.

The default CSV locations are as follows:
/run/media/mmcblk3p4/cimon/gateway/alarm_csv/ (Local)
<root directory>/alarm_csv/ (USB/SD Card)

Users can also delegate a specific alarm label to be saved in the CSV, in which case all other labels will not be included in the CSV.

Line 1: Saves a CSV for all alarm labels.

Line 2: Saves a CSV for alarms that have the specified label.

Save Data Log CSV

Code Block

language	js

datalog.createCsv("Data Logger Name", Storage.Local);

Saves the selected Data Log in a selected Storage Type.

Image Removed

to a CSV file.

You may choose where the CSV will be stored to: Local (on the device’s hard drive), USB, or SD Card.

The default CSV locations are as follows:
/run/media/mmcblk3p4/cimon/gateway/datalogger_csv/ (Local)
<root directory>/datalogger_csv/ (USB/SD Card)

You may also choose how far back in time the CSV should cover. Options include (All, Past Hour, Past Day, Past Week, Past Month, and Past Year).

Start/Stop Data Log

Code Block

language	js

datalog.start("Data Logger Name");
datalog.stop("Data Logger Name");

Starts or stops a data log model. This function does not directly create an entry into the log; it only enables entries to be added via other triggers.

Line 1: Start the Data Logging actions

Line 1: Stop the Data Loggers action

Add Row to Data Log

Code Block

language	js

datalog.addRow("Data Logger Name");

Adds a new entry to the Data Log.

Open Login Window

Code Block
system.openLoginWindow();

Opens the built-in IAM login window for the user when an object associated to this command is pressed.

Logout User

Code Block

language	js

system.logout();

Log a user out of account when an object associated to this command is pressedLogs out the current user from the IAM system.

Press Key

Code Block
keyboard.sendKeyEvent(0x01000004);

Enters the user specified keystroke. Function codes are used to enter specific key strokes, those key codes can be found at the following link:

Qt Namespace | Qt Core 5.15.10

Send Screen Notification

Code Block

language	js

notification.send("Welcome to CIMON!");

In the runtime, notification window will appear on the Xpanel screen.

Image Removed

Image Added

Exit Project

Code Block

language	js

system.exit();

Exits the project and canvas runtime.

Open Config Menu

Code Block

language	js

system.openConfig();

Opens the Xpanel Settings menu.

Set Translation Language

Code Block

language	js

system.setLanguage("English");

Sets the language according to the one specified in the Action List.

...

Version	Old Version 7	New Version 8
Changes made by	Scott Fredericks (Unlicensed)	Scott Fredericks (Unlicensed)
Saved on	Mar 10, 2023	Mar 10, 2023

Page Comparison

Versions Compared

Key

Global Commands

Method #1

Local Commands