Skip to main content

Wait Image

Waits for a specified image to appear on the screen within a given timeout period.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.

Inputs​

This node does not have direct inputs. It uses a reference image for matching.

Options​

  • Confidence - Confidence level for image recognition (default: 0.95).
  • Timeout (sec) - Maximum time to wait for the image to appear (default: 30 seconds).

Outputs​

This node does not have outputs.

How It Works​

The Wait Image node pauses execution until a specified image appears on screen. When executed, the node:

  1. Downloads and prepares the reference image if needed
  2. Continuously takes screenshots of the screen at regular intervals
  3. Uses OpenCV template matching to search for the image on each screenshot
  4. Continues looping until either:
    • The image is found with the specified confidence level
    • The timeout period is exceeded
  5. Proceeds with the workflow if the image is found, or raises an error if timeout is reached

Requirements​

  • Valid reference image for matching
  • Confidence value between 0 and 1
  • Valid timeout value (positive number)

Error Handling​

The node will return specific errors in the following cases:

  • Empty image - "Empty Image"
  • Could not read image - "Could not read image"
  • Missing confidence - "Confidence can not be empty"
  • Invalid confidence format - "Confidence is not valid"
  • Confidence out of range - "Confidence must be between 0 and 1"
  • Invalid timeout format - "Timeout is not valid"
  • Timeout exceeded - "Image not found"

Usage Notes​

  • This node is useful for synchronizing automation workflows with dynamic UI elements
  • The confidence level affects the accuracy of image matching
  • Higher confidence values require more precise image matching
  • Lower confidence values may result in false positives but can handle variations better
  • The timeout value determines the maximum wait time before giving up
  • Uses a polling mechanism with 0.2 second intervals between checks
  • Useful for waiting for loading indicators, popups, or other UI elements to appear
  • Can help make automation workflows more robust by ensuring elements are ready before interacting with them
  • Works best with static images that appear consistently on screen