Button Click Command - System
The Click Command property can be associated with the following System interactions:
- These interactions can also be called via a script. For more information, see the WebPages HMI Scripting topic.
- See $ Functions: System for more information on the System functions listed below.
Click Command | Description | Arguments (with Data Type) | Return Type |
---|---|---|---|
System.DateTime.GetNtpEnabled |
Checks if NTP servers are used to set the system time of the vision system. |
N/A | Boolean value, returning true if NTP servers are used to set the system time. |
System.DateTime.GetNtpServers | Fetches the list of NTP servers configured for use in the vision system. | N/A |
Array of strings, listing the configured NTP servers. |
System.DateTime.GetNtpUseDhcp |
Checks if DHCP is used to locate NTP servers that are used to set the system time. |
N/A |
Boolean, returning true if DHCP is used to locate NTP servers. |
System.DateTime.GetSupportedTimeZones | Returns a list of timezones supported by the vision system. The contents of the returned list depend on the value of the tzFilter argument. |
tzFilter: Hexadecimal number, specifying the filter used to fetch the list of timezones. Its available values are as follows:
|
Array of strings, listing the timezones supported by the system. |
System.DateTime.GetTimeZone |
Returns the timezone setting of the vision system. |
N/A |
String, indicating the current timezone of the vision system. |
System.DateTime.Now |
Returns the current date, stored as milliseconds since 1970 in UTC. |
N/A |
Date, indicating the current date stored as milliseconds since 1970 in UTC. Note: This is the same internal representation that is used by the javascript Date object.
|
System.DateTime.SetNtpEnabled |
Enables or disables the usage of NTP servers to configure the system time of the vision system. |
enabled: Boolean, can be true or false. True enables the usage of NTP servers. | N/A |
System.DateTime.SetNtpServers |
Sets the list of NTP servers used by the system to configure date and time. |
servers: Array of strings, specifying the IP address or URL of the configured NTP server(s). |
N/A |
System.DateTime.SetNtpUseDhcp |
Sets whether DHCP is used to locate NTP servers that are used to set the system time. |
enabled: Boolean, can be true or false. True enables the usage of DHCP. |
N/A |
System.DateTime.SetSystemClock |
Sets the current date on the vision system. |
date: The date, stored as milliseconds since 1970 in UTC. Note: This is the same internal representation that is used by the javascript Date object.
|
N/A |
System.DateTime.SetTimeZone |
Sets the specified timezone to be used on the vision system. |
zone: String, specifying the name of the configured timezone (as listed in the list of timezones). Note: Use the System.DateTime.GetSupportedTimeZones function to fetch the list of supported timezones.
|
N/A |
System.GetUpTimeMilliseconds |
Returns the uptime of the vision system in milliseconds (but with microsecond accuracy). |
N/A |
Double, indicating controller uptime in milliseconds (but with microsecond accuracy, hence the fract-digits). |
System.File.AppendText |
Creates a file at the path specified with the filepath argument (relative to the public file system root), and writes the text specified with the text argument in that file. If a file with the specified filename already exists at the specified location, the specified text will be appended to the end of the existing file. Note:
|
|
N/A |
System.File.Delete |
Deletes the file specified with the filepath argument. Note:
|
filepath: String, specifying the path and filename of the file to delete. | N/A |
System.File.WriteText |
Creates a file at the path specified with the filepath argument (relative to the public file system root), and writes the text specified with the text argument in that file. If a file with the specified filename already exists at the specified location, the function overwrites it upon execution. Note:
|
|
N/A |
System.Log.Write |
Records a log message on the vision system, which is read and displayed by the output window dialog of In-Sight 3D. The recorded log - presuming that the IDE is running - will be recorded to the system log output file as well, available in the following location by default: \Documents\In-Sight Vision Suite\Logs |
|
N/A |
System.Recipes.Products.Load |
Loads the specified |
configurationName: String, specifying the name of the recipe configuration to load. |
N/A |
System.Recipes.Products.Remove |
Removes the specified |
configurationName: String, specifying the name of the recipe configuration to remove. |
N/A |
System.Recipes.Products.Save |
Saves the specified Note: If a configuration with the same name already exists, execution of this function overwrites that existing configuration.
|
|
N/A |