Node Documentation

Connect an upstream result, inspect coordinates, heading, validity and sampling information from a position, and pass the required fields to later nodes.

position.break

Break Path

Ordered points sharing a coordinate reference.

Connect an upstream result, inspect the coordinate reference and ordered points of a path, and pass the required fields to later nodes.

path.break

Break Path point

A stable point identity, coordinates and optional altitude.

Connect an upstream result, inspect a path point’s ID, coordinates and height, and pass the required fields to later nodes.

path-point.break

Break Path reference

Coordinate frame, units and axes; local references require explicit alignment.

Connect an upstream result, inspect the frame, unit and axes of a path coordinate reference, and pass the required fields to later nodes.

path-reference.break

Break point

Exposes typed X, Y, and unit outputs from a point.

Connect an upstream result, inspect X, Y and unit from a point, and pass the required fields to later nodes.

structure.break-point

Break region

Exposes typed position, size, and unit outputs from a region.

Connect an upstream result, inspect position, dimensions and unit from a region, and pass the required fields to later nodes.

structure.break-region

Break template match

Exposes score, center, and bounds from a template match.

Connect an upstream result, inspect score, center and bounds from a template match, and pass the required fields to later nodes.

structure.break-template-match

Build path

Operate on ordered points while preserving their reference and the input path.

Assemble a coordinate reference and an ordered point list into a path.

path.make

Ceil

Round X up: 3.2 gives 4, -3.7 gives -3.

For example, round 3.2 upward to 4, then connect the result to a numeric input.

math.ceiling

Ceil to integer

Rounds toward positive infinity and checks the safe integer range.

Convert 2.2 to integer 3 when calculating how many batches are needed.

conversion.ceiling-to-integer

Clamp

Limit X to the Min~Max range: below Min gives Min, above Max gives Max, otherwise X. Min/Max swap automatically if reversed.

For example, clamp 120 to 0–100 to get 100, then connect the result to a numeric input.

math.clamp

Clamp integer

Clamps an integer between minimum and maximum while preserving its type.

For example, clamp 120 to 0–100 to get 100; inputs and result remain integers for counts or indexes.

math.integer-clamp

Concatenate

Combine two strings into one value. This is a data function and has no control-flow output.

Join "File: " and a filename for logging.

text.concat

Contains

Tells whether one text value contains the requested substring. Both inputs must be text, and matching is case-sensitive.

Check whether returned text contains success, then branch on the result.

text.contains

Divide

Divides A by B. A zero divisor or a non-finite result fails explicitly.

For example, divide 10 by 2 to get 5, then connect the result to a numeric input.

math.divide

Ends With

Whether the text ends with Suffix. Empty Suffix is always true.

Check whether a filename ends in .png.

text.ends-with

Equals

Compares the canonical values of one exact type. It never silently turns different types into text.

Compare two values of the same type and branch on whether they are equal.

comparison.equal

Floor

Round X down: 3.7 gives 3, -3.2 gives -4.

For example, round 3.7 downward to 3, then connect the result to a numeric input.

math.floor

Floor to integer

Rounds toward negative infinity and checks the safe integer range.

Convert 3.8 to integer 3 for a list index.

conversion.floor-to-integer

Get path point

Operate on ordered points while preserving their reference and the input path.

Read a path point by index, then inspect its coordinates and ID.

path.point

Greater or equal

Tells whether A ≥ B, giving true/false.

Check whether the processed count has reached the target and end the branch when it has.

comparison.greater-or-equal

Greater than

Tells whether A > B, giving true/false.

Compare a recognition score with a threshold and continue when it is higher.

comparison.greater-than

Increment state

Atomically add to an Integer or Number while holding the Run State slot lock.

Increment a numeric state after each task without a read-modify-write race between branches.

state.increment

Index Of

Position of the first occurrence of Sub in the text (counting from 0, a CJK character counts as 1). -1 when not found. To just test "contains", use the Contains node.

Find the first colon and handle a result of -1 when none exists.

text.index-of

Inspect interactive component reference

A stable typed reference supplied by the panel manager.

Connect an upstream result, inspect identity and panel information from an event component reference, and pass the required fields to later nodes.

panel.ref.break-event

Inspect log component reference

A stable typed reference supplied by the panel manager.

Connect an upstream result, inspect identity and panel information from a log component reference, and pass the required fields to later nodes.

panel.ref.break-log

Inspect number component reference

A stable typed reference supplied by the panel manager.

Connect an upstream result, inspect identity and panel information from a numeric component reference, and pass the required fields to later nodes.

panel.ref.break-number

Inspect panel reference

A stable typed reference supplied by the panel manager.

Connect an upstream result, inspect identity, name and generation information from a panel reference, and pass the required fields to later nodes.

panel.ref.break-panel

Inspect text component reference

A stable typed reference supplied by the panel manager.

Connect an upstream result, inspect identity and panel information from a text component reference, and pass the required fields to later nodes.

panel.ref.break-string

Inspect toggle component reference

A stable typed reference supplied by the panel manager.

Connect an upstream result, inspect identity and panel information from a toggle component reference, and pass the required fields to later nodes.

panel.ref.break-boolean

Integer absolute

Returns an integer absolute value while preserving its type.

For example, take the absolute value of -3 to get 3; inputs and result remain integers for counts or indexes.

math.integer-absolute

Integer add

Adds two integers and preserves the integer type; overflow fails.

For example, add 2 and 3 to get 5; inputs and result remain integers for counts or indexes.

math.integer-add

Integer modulo

Computes an integer remainder; a zero divisor fails.

For example, take the remainder of 7 divided by 3 to get 1; inputs and result remain integers for counts or indexes.

math.integer-modulo

Integer multiply

Multiplies two integers and preserves the integer type; overflow fails.

For example, multiply 3 by 4 to get 12; inputs and result remain integers for counts or indexes.

math.integer-multiply

Integer negate

Flips an integer sign while preserving its type.

For example, negate 3 to get -3; inputs and result remain integers for counts or indexes.

math.integer-negate

Integer subtract

Subtracts integer B from A and preserves the integer type; overflow fails.

For example, subtract 2 from 7 to get 5; inputs and result remain integers for counts or indexes.

math.integer-subtract

Join

Join a list of text values with a separator. Non-text lists are not accepted.

Join ["red", "green", "blue"] with commas for display.

collection.join

Join paths

Operate on ordered points while preserving their reference and the input path.

Join two paths in the same coordinate reference into one ordered route.

path.join

JSON path

Extracts fields or array items using $, .field, [index], and [*]. A missing result is null; wildcard results preserve missing positions with null.

Use $.user.name to read the name from {"user":{"name":"Ada"}}.

json.path

Less or equal

Tells whether A ≤ B, giving true/false.

Check whether a distance is within the allowed tolerance.

comparison.less-or-equal

Less than

Tells whether A < B, giving true/false.

Check whether fewer than one attempt remains and stop further attempts.

comparison.less-than

List Append

Add one same-typed item and return a new list; the input list is never mutated.

Append a filename to a work list and use the returned new list.

collection.append

List Contains

Test whether a same-typed equatable value occurs in the list using canonical equality; no text coercion is performed.

Check whether a filename list already contains report.txt and branch to avoid processing it twice.

collection.contains

List Get

Return the item at a zero-based index. A negative or out-of-range index fails explicitly; use List Length when the index is uncertain.

Read the first recognition result at index 0; check the list length first to avoid an out-of-range access.

collection.get

List Length

Return the number of items in a strongly typed list.

Count a work list and send the total to a log or numeric panel.

collection.length

List Slice

Return a new list from Start for Count items. Negative Start clamps to 0; a negative Count takes the remainder; zero or an out-of-range Start returns an empty list.

Take 10 items starting at index 0 and pass the batch to For each.

collection.slice

Logical AND

Gives true only when both conditions are true, otherwise false. An unconnected input defaults to true so it does not affect the result.

Require both "window exists" and "text matches" before continuing.

logic.and

Logical NOT

Flips true/false: true becomes false and false becomes true.

Negate "already complete" to continue while work remains.

logic.not

Logical OR

Gives true when at least one condition is true, and false only when both are false.

Continue when either of two recognition methods succeeds.

logic.or

Make Point

Build a typed coordinate from X, Y, and either ratio or px units. Ratio coordinates use the 0–1 frame space.

Use X=0.5, Y=0.5 and unit ratio for the center of the target image.

geometry.make-point

Max

The larger of two numbers.

For example, take the maximum of 3 and 7 to get 7, then connect the result to a numeric input.

math.maximum

Maximum integer

Returns the larger integer and preserves the integer type.

For example, take the maximum of 3 and 7 to get 7; inputs and result remain integers for counts or indexes.

math.integer-maximum

Min

The smaller of two numbers.

For example, take the minimum of 3 and 7 to get 3, then connect the result to a numeric input.

math.minimum

Minimum integer

Returns the smaller integer and preserves the integer type.

For example, take the minimum of 3 and 7 to get 3; inputs and result remain integers for counts or indexes.

math.integer-minimum

Modulo

Gives the remainder of A divided by B; decimals are supported and a zero divisor fails.

For example, take the remainder of 7 divided by 3 to get 1, then connect the result to a numeric input.

math.modulo

Multiply

Multiplies two numbers and gives the product.

For example, multiply 3 by 4 to get 12, then connect the result to a numeric input.

math.multiply

Negate

Flips the sign of a number: positive becomes negative and vice versa.

For example, negate 3 to get -3, then connect the result to a numeric input.

math.negate

Not equal

Reports whether the canonical values of one exact type differ, without cross-type text coercion.

Compare newly recognized text with the previous value and update only when they differ.

comparison.not-equal

Observe time

Capture the host-provided invocation time as Unix milliseconds and persist it in the Run record.

Record the current Unix-millisecond time at a key step for duration calculations.

time.observe

Offset Point

Add horizontal and vertical offsets to a coordinate. Ratio points are clamped inside the screen; pixel points keep their pixel unit.

Offset a template-match center horizontally to click an adjacent control.

geometry.offset-point

Parse JSON

Parses and canonicalizes one JSON document. Trailing values, negative zero, and numbers outside the interoperable profile are rejected.

Parse JSON text from an HTTP response before reading its fields.

json.parse

Point Distance

Calculate straight-line distance between two points with the same unit; the result uses that unit and mixed units fail.

Measure the distance from the current position to a target point using matching units.

geometry.point-distance

Pow

Raises Base to Exp. Fractional powers of a negative base report a domain error, non-finite results fail, and 0^0 is 1.

For example, raise 2 to the third power to get 8, then connect the result to a numeric input.

math.power

Random boolean

Observe a true/false sample using an explicit probability from zero to one.

Generate a boolean sample with probability 0.5 to choose between two test paths.

random.boolean

Random choice

Observe one unbiased item from a non-empty typed list and persist the result.

Choose one item randomly from a nonempty list of candidate strings.

random.choice

Random integer

Observe a cryptographically seeded integer sample and persist it in the Run record.

Sample an integer within configured bounds for a test-data identifier.

random.integer

Random number

Observe a finite number sample and persist it in the Run record.

Sample a number within configured bounds for test data or an offset.

random.number

Read path

Load pinned path content as a typed path value.

Read a selected saved path version and pass its path data onward.

path.read

Read state

Read the current value of a typed Run-local state slot. This is a recorded data effect with no control-flow output.

Select a workflow state variable and connect its current value to a data input.

state.read

Read stopwatch

Read elapsed milliseconds from an explicit start instant without ambient process timers.

Read elapsed milliseconds from a stopwatch start time while the task continues.

time.stopwatch-read

Regex Extract

Extract the first regular-expression match; with capture groups, group 1 is taken. No match gives an empty string, while an invalid pattern fails the run.

Use a regular expression to extract digits from "Order: 12345".

text.regex-extract

Regex Match

Whether any part of the text matches the regular expression (search semantics: b matches abc). For a full match wrap the pattern in ^ and $. An invalid pattern fails the run.

Use ^[0-9]+$ to check whether an entire string consists of digits.

text.regex-match

Replace

Replace Old with New in the text. With "Replace all" on it replaces every occurrence, off only the first. Empty Old returns the text unchanged.

Replace an old separator with commas, optionally replacing every occurrence.

text.replace

Reverse path

Operate on ordered points while preserving their reference and the input path.

Reverse a route for travel in the opposite direction.

path.reverse

ROI Around Point

Create a centered ROI in the center point’s unit. Ratio regions are clamped inside the frame; px regions preserve pixel dimensions.

Create a small region around a detected center to narrow the next recognition search.

geometry.region-around-point

Round

Round X. Digits=0 rounds to integer; 2 keeps two decimals; -2 rounds to hundreds (12345 gives 12300). Digits is capped at +/-15 (beyond float precision).

For example, round 3.14159 to two decimal places to get 3.14, then connect the result to a numeric input.

math.round

Round to integer

Rounds to the nearest integer, ties away from zero, and checks the safe range.

Convert 2.6 to the nearest integer, 3, for an integer input.

conversion.round-to-integer

Select (ternary)

Outputs When True or When False according to the condition. Both branches must use the same observable inline JSON type.

Choose between the strings "Success" and "Failure" according to a boolean condition.

logic.select

Slice path

Operate on ordered points while preserving their reference and the input path.

Select a section of a route using start and end indexes.

path.slice

Split

Split text into a list by a separator. Empty text gives an empty list; an empty separator splits into individual characters (CJK-safe).

Split newline-separated filenames into a string list for item-by-item processing.

collection.split

Sqrt

Square root of X. Negative values report a domain error (wire an Abs node first if needed).

For example, take the square root of 9 to get 3, then connect the result to a numeric input.

math.square-root

Start stopwatch

Record this invocation as an explicit typed start instant.

Record a start time before an operation and pass it to Read or Stop stopwatch.

time.stopwatch-start

Starts With

Whether the text starts with Prefix. Empty Prefix is always true.

Check whether a line starts with ERROR.

text.starts-with

State last change

Read the Unix-millisecond instant of the state slot’s last successful update.

Read when a state was last changed to determine how long it has gone without an update.

state.last-change

State metadata

Read a state slot revision and last-change time without exposing an untyped value.

Read a state revision and modification time to detect changes during observation.

state.metadata

Stop stopwatch

Record final elapsed milliseconds from an explicit start instant, then continue.

Record the final elapsed duration from the original start time and continue through Done.

time.stopwatch-stop

Stream to blob

Consume a leased stream from the current run and commit it as durable binary content.

Collect a stream into a persistent Blob and specify its media type.

conversion.stream-to-blob

String length

Counts how long a piece of text is and gives the character count. A CJK character counts as 1, matching the position semantics of Substring and Index Of.

Count characters to check whether text was supplied.

text.length

Substring

Take Length characters starting at Start (a CJK character counts as 1). Length -1 (default) takes to the end, 0 gives an empty string. Out-of-range Start gives an empty string.

Take 4 characters from index 0; use length -1 to read to the end.

text.substring

Subtract

Subtracts B from A and gives the difference.

For example, subtract 2 from 7 to get 5, then connect the result to a numeric input.

math.subtract

Text to integer

Strictly parses a safe integer. Decimals, whitespace, and out-of-range values fail.

Convert the string "12" to an integer for a repeat count.

conversion.string-to-integer

To bool

Strictly parses lowercase true or false; every other value fails.

Convert the lowercase string true from a text setting into a boolean condition.

conversion.string-to-boolean

To JSON text

Canonically serializes an observable inline JSON value. Blobs, images, and runtime streams are not accepted directly.

Serialize a structured result as JSON text for a log or text display.

json.stringify

To Lower

Convert letters to lowercase.

Lowercase a file extension before comparing it.

text.lowercase

To number

Strictly parses a finite JSON decimal number. Whitespace, non-numeric text, and out-of-range values fail.

Convert "12.5" to a number for an amount or distance calculation.

conversion.string-to-number

To string

Turns an observable inline JSON value into text. Strings keep their contents; other values use canonical JSON. Blobs, images, and runtime streams are not accepted.

Convert a numeric count to text and prepend "Processed: " for display.

conversion.to-string

To Upper

Convert letters to uppercase.

Uppercase an identifier for display.

text.uppercase

Trim

Remove spaces, newlines and tabs from both ends of the text.

Trim surrounding whitespace before comparing user input.

text.trim

Truncate to integer

Drops the fractional part and checks the safe integer range; -1.9 becomes -1.

Discard the fractional part of -1.9 to get integer -1.

conversion.truncate-to-integer

Write state

Write one exactly typed value to a Run-local state slot, then continue through Done.

Write a recognition result to a state variable of the same type for other branches to read.

state.write

Files

7 nodes

HTTP GET

Read UTF-8 text from a configured HTTP base URL using a relative path.

Read /status from an HTTP target with a configured base URL, then parse the returned JSON text.

http.get

Inspect workspace file

Read canonical metadata without exposing an ambient host filesystem path.

Inspect file size and modification time before deciding whether to load it.

file.stat

Load workspace image

Read a PNG in chunks from managed workflow files and commit a durable Image BlobRef.

Load templates/button.png from workflow files for use as a template image.

file.load-image

Read workspace JSON

Read and strictly parse one UTF-8 JSON document from the workflow file workspace.

Read settings.json from workflow files, then extract a field with JSON path.

file.read-json

Read workspace text

Read bounded text from the Yotta-managed workflow file workspace.

Read names.txt from workflow files, split it on newlines and process each line.

file.read-text

Save image to workspace

Write a durable Image BlobRef in chunks to the managed workflow file workspace.

Save a window capture to captures/result.png in workflow files for later review.

file.save-image

Write log

Write one bounded, Run-attributed message and record only its digest in the action journal.

Log "File read complete" after a key step and select an appropriate severity.

log.write

Vision

5 nodes

Analyze color

Count pixels inside one explicit RGB or HSV range.

Measure the fraction of red pixels in an image region to detect a color indicator.

vision.analyze-color

Compare images

Measure visual difference between two explicit images on the same logical region.

Compare the same region before and after an action to measure visual change.

vision.compare-images

Find color blobs

Extract deterministic four-connected components from an RGB or HSV mask.

Find connected blobs in a color range, then inspect their areas or centers.

vision.find-color-blobs

Find template matches

Return all local template matches after deterministic non-maximum suppression.

Find all matching icons in an image and iterate over the returned list.

vision.find-template-matches

Match template

Find the best location of one immutable template image inside an explicit source image.

Find the best button-template match in an image and inspect its score and center.

vision.match-template

AI

2 nodes

Extract structured AI data

Extracts the fields you choose from text or an image and returns connectable structured data.

Connect a receipt image and a prompt to extract date, merchant and amount; configure those fields and pass the structured result onward.

ai.extract

Generate AI text

Generates text from a prompt and optional image, including captured windows.

Connect a window capture and ask for a summary of the page using a configured AI target.

ai.generate

Other

5 nodes

Break QR code

Exposes decoded text and the list of location points.

Connect an upstream result, inspect text and location points from a QR result, and pass the required fields to later nodes.

qr.break

Control dual color bar

Capture a small region, track a dual color bar, and send left or right keys in one high-frequency node invocation.

Configure the target region, inner/outer color ranges and left/right keys to keep a narrow pointer near the wide target bar.

dual-color-bar.control

Decode QR codes

Decode every QR code found in an explicit image region.

Connect an image and QR region to obtain a list of decoded QR codes.

qr.decode

Run script

Execute JavaScript in a one-shot isolated worker with canonical JSON input and output.

Reshape structured input with an isolated JavaScript script and return a JSON result.

script.execute

Track dual-color bar

Track a narrow cursor relative to a wide target bar using column clusters in an explicit image region.

Detect the two-color bar in an image and use pointer position, target width and confidence for later control decisions.

dual-color-bar.track