com.testoptimal.plugin

Class SikuliXPlugin

java.lang.Object

com.testoptimal.plugin.PluginAncestor

com.testoptimal.plugin.SikuliXPlugin

All Implemented Interfaces:

MScriptInterface

public class SikuliXPlugin
extends PluginAncestor

Sikulix (beta) plugin provides a set of mscript functions to perform image based automation using SikuliX (SikuliX). You must first set up/install SikuliX on your computer, see Getting started.

The first time that you use this pllugin you may need to restart TestOptimal server and logoff and re-login your computer for SikuliX to complete the installation.

This plugin is in BETA state. Please contact Support@testoptimal.com for additional information.

Locator: control is identified by the image file stored in uimap folder within the model folder. Only png files are supported.

Nested Class Summary

Nested classes/interfaces inherited from interface com.testoptimal.plugin.MScriptInterface

MScriptInterface.IGNORE_INHERITED_METHOD, MScriptInterface.NOT_MSCRIPT_METHOD, MScriptInterface.TO_PLUGIN

Constructor Summary

Constructors

Constructor and Description
SikuliXPlugin()

Method Summary

Modifier and Type	Method and Description
void	close() INTERNAL USE ONLY
org.sikuli.script.Match	find(String uiImgFile_p) attempts to find the UI element identified by the image passed in.
org.sikuli.script.Screen	getCurScreen() returns the current screen.
String	getPluginDesc() INTERNAL USE ONLY
String	getPluginID() INTERNAL USE ONLY
String	getText(int deltaX_p, int deltaY_p, int width_p, int height_p) performs OCR on the region specified.
void	initialize(MbtScriptExecutor scriptExec_p) INTERNAL USE ONLY
org.sikuli.script.Screen	selectMonitor(int monitorID_p) set the specified monitor to be the current monitor
void	setMinSimilarity(float minSimilarity_p) sets the sensitivity for matching the image.
void	setOCR(String onFlag_p) turns on or off OCR feature.
void	setSearchRegion(int x_p, int y_p, int w_p, int h_p) sets the screen region on the current screen to limit Siklul's search spacce for better performance.
String	snapScreen(int x_p, int y_p, int width_p, int height_p, String fileName_p) takes a screen shot of the specified region on the current screen/monitor and saves it to the file specified.
String	snapScreen(String fileName_p) takes a screen shot and saves it to the file specified.
void	start() INTERNAL USE ONLY
org.sikuli.script.Match	waitFor(String uiImgFile_p, int timeoutMillis_p) wait for the UI element up to the timeout in milliseconds.
boolean	waitForVanish(String uiImgFile_p, int timeoutMillis_p) wait for the UI element to vanish/disappear from the screen, up to the timeout in milliseconds specified.

Methods inherited from class com.testoptimal.plugin.PluginAncestor

enterInitialState, exitFinalState

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SikuliXPlugin

public SikuliXPlugin()

Method Detail

getPluginID

public String getPluginID()

INTERNAL USE ONLY

Specified by:

getPluginID in class PluginAncestor

initialize

public void initialize(MbtScriptExecutor scriptExec_p)

INTERNAL USE ONLY

this method is called at the beginning of model execution before MBT_start trigger is called. This is not a full initialization as it's missing mscriptexecutor object.

getPluginDesc

public String getPluginDesc()

INTERNAL USE ONLY

Specified by:

getPluginDesc in class PluginAncestor

start

public void start()
           throws Exception

INTERNAL USE ONLY

Specified by:

start in class PluginAncestor

Throws:

Exception

close

public void close()

INTERNAL USE ONLY

Specified by:

close in class PluginAncestor

snapScreen

public String snapScreen(String fileName_p)
                  throws Exception

takes a screen shot and saves it to the file specified.

Throws:

Exception

snapScreen

public String snapScreen(int x_p,
                         int y_p,
                         int width_p,
                         int height_p,
                         String fileName_p)
                  throws Exception

takes a screen shot of the specified region on the current screen/monitor and saves it to the file specified.

To capture screenshot of a specific screen/monitor, call $SIKULIX.selectMonitor('id') to switch to that screen/monitor before calling this function.

Throws:

Exception

getCurScreen

public org.sikuli.script.Screen getCurScreen()

returns the current screen.

Returns:

selectMonitor

public org.sikuli.script.Screen selectMonitor(int monitorID_p)

set the specified monitor to be the current monitor

Parameters:

monitorID_p -

Returns:

true if successful

find

public org.sikuli.script.Match find(String uiImgFile_p)

attempts to find the UI element identified by the image passed in. If UI element is found, it also sets the UI element found to be the current UI element on which future actions will be performed.

Parameters:

uiImgFile_p - name of the image file located in uimap folder in the model folder. You may also use absolute file path.

Returns:

Match element or null

waitFor

public org.sikuli.script.Match waitFor(String uiImgFile_p,
                                       int timeoutMillis_p)

wait for the UI element up to the timeout in milliseconds.

Parameters:

uiImgFile_p -

timeoutMillis_p -

Returns:

Match element or null if not found

waitForVanish

public boolean waitForVanish(String uiImgFile_p,
                             int timeoutMillis_p)

wait for the UI element to vanish/disappear from the screen, up to the timeout in milliseconds specified.

Parameters:

uiImgFile_p -

timeoutMillis_p -

Returns:

true if UI element vanishes before time out

setSearchRegion

public void setSearchRegion(int x_p,
                            int y_p,
                            int w_p,
                            int h_p)

sets the screen region on the current screen to limit Siklul's search spacce for better performance.

Parameters:

x_p -

y_p -

w_p -

h_p -

setMinSimilarity

public void setMinSimilarity(float minSimilarity_p)

sets the sensitivity for matching the image.

Parameters:

minSimilarity_p - float value between 0 and 1 with 1 being identical. Default is 0.75.

setOCR

public void setOCR(String onFlag_p)

turns on or off OCR feature. OCR feature is currently in experimental state. Use with caution.

Parameters:

onFlag_p - Y to turn on OCR, N to turn off OCR.

getText

public String getText(int deltaX_p,
                      int deltaY_p,
                      int width_p,
                      int height_p)
               throws MBTException

performs OCR on the region specified. The region specified is relative from the current UI element location and the specified width and height.

Experimental use only.

Parameters:

deltaX_p - relative x position from current UI element's x location.

deltaY_p - relative y position from current UI element's y location.

width_p - width of the target region

height_p - height of the target region

Throws:

MBTException