$ Functions: System

$System.GetLED(ledIdx : Integer)
Returns

Boolean, indicating if the specified LED of the vision system is enabled or not.
Arguments
  • ledIdx: Integer, specifying the LED to check.
    • 0: The green Pass / Fail LED of the device.
    • 1: The red Pass / Fail LED of the device.
Description

Indicates whether the specified LED of the device is enabled (that is, turned on) or not.

 

$System.GetSysReport()
Returns

SysReport class member defined with the related tags.
Arguments N/A
Description

Returns the system information specified with the following tags:

  • HostName: String, returning the host name of the In-Sight 3D vision system.
  • IPAddress: String, returning the IP address of the vision system.
  • MacAddress: String, returning the MAC ID of the vision system.
  • Model: String, returning the model name of the vision system.
  • SerialNumber: String, returning the serial number of the vision system.
  • Version: String, returning the version of the vision system firmware.
Tip: The system information available with this $ function can also be checked with the System Info button of In-Sight Vision Suite. Refer to the System Info topic of the In-Sight Vision Suite Help for more information.
Example

The below example is a set of system checks:

$HostName = $System.GetSysReport().HostName;
$IP_Address = $System.GetSysReport().IPAddress;
$FWversion = $System.GetSysReport().Version;
$MAC_address = $System.GetSysReport().MacAddress;
$SerialNumber = $System.GetSysReport().SerialNumber;
$Model = $System.GetSysReport().Model;

You can then call the value of these checks, for example, in WebPage Labels by setting their Text property accordingly with the Expression Builder.

 

$System.GetUptimeMilliseconds()
Returns

Double, indicating controller uptime in milliseconds (but with microsecond accuracy, hence the fract-digits).
Arguments N/A
Description Returns the uptime of the vision system in milliseconds (but with microsecond accuracy).

 

$System.Log.Write(message : String, logLevel : Integer)
Returns N/A
Arguments
  • message : String, specifying the log message to record.
  • logLevel : Integer, specifying the severity of the log message. Its value must be between 0-3, corresponding to the following severity levels:
    • 0: Verbose
    • 1: Info
    • 2: Warning
    • 3: Error
    Note: Log messages set to Verbose severity (that is, 0) will not be shown in the IDE system log.
Description

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

 

$System.SetLED(ledIdx : Integer, enabled: Boolean)
Returns

N/A
Arguments
  • ledIdx: Integer, specifying the LED to enable or disable.
    • 0: The green Pass / Fail LED of the device.
    • 1: The red Pass / Fail LED of the device.
  • enabled: Boolean, used to enable or disable the specified LED. Setting this parameter to True turns on the specified LED, while setting it False turns it off.
Description Enables or disables (that is, turns on or off) the selected LED of the vision system.