Vision

Compare Image (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
baseImage	image	The base image for comparison.	Yes	No
comparisonImage	image	The image to compare against the base image.	Yes	No

Outputs

Name	Type	Description
default	null

Detect Color (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
color	color	The color to detect.	Yes	No
frame	image	The image frame to search for the color.	Yes	No

Outputs

Name	Type	Description
default	null

Detect Image (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
image	image	The image to detect within the frame.	Yes	No
frame	image	The image frame to search within.	Yes	No

Outputs

Name	Type	Description
default	null

Detect Text (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
text	string	The text to detect.	Yes	No
frame	image	The image frame to search for the text.	Yes	No

Outputs

Name	Type	Description
default	null

Wait for Motion

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
type	enum	Wait until motion starts or ends.	Yes	No
timeout	duration	Timeout if motion is not detected or stopped after this period of time.	No	No
stableFrames	number	Number of stable frames required. A frame is considered stable if the percentage of pixels that have changed is below the threshold.	No	No
threshold	number	Minimum percentage of pixels that must change to detect motion.	No	No
includeAudio	boolean	When detecting motion take audio signals into consideration. Audio is detect at a rms (root-mean-square) above 70 dB.	No	No
ignore	region	Specify a region to ignore when detecting motion. This will apply a mask to the specified region, excluding it from motion detection.	No	No
only	region	Specify a region to focus on when detecting motion. This will crop the image to the specified region, only detecting motion within it.	No	No

Outputs

Name	Type	Description
default	image	Screen capture when motion was detected
time	number	The actual wait time (ms)

Wait for Region

Restrictions: "none"

Waits to match the intended content.

Inputs

Name	Type	Description	Required	Dynamic
matcher	region	Select a region to wait for to match.	Yes	No
timeout	duration	Maximum time in seconds waiting for the matcher to match the intended content.	Yes	No

Outputs

Name	Type	Description
default	null

Wait for Screen

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
screens	screen	The screen(s) to wait for. When multiple screens are selected, it will wait for any of the screens to appear. Screens are matched in order.	Yes	No
timeout	duration	The time to wait before continuing to the next step.	Yes	No
stableFrames	number	The number of stable frames required to continue to the next step.	No	No
continueOnError	boolean	Continue execution when no selected screen detected.	No	No

Outputs

Name	Type	Description
default	screen	Detected screen (if multiple are selected); nil when error and "Continue on Error" is checked
frame	image	Screen capture when screen was detected
time	number	The actual wait time (ms)

Wait for Text

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
text	string	The text to wait for.	Yes	No
timeout	duration	The time to wait before continuing to the next step.	Yes	No

Outputs

Name	Type	Description
default	boolean	Whether the text was detected or not
time	number	The actual wait time (ms)
frame	image	Screen capture when text was detected (or timed out)