Macro Handler

Macro Handler

Android Automation Platform

Object MethodData and Files

Str.compareOcr(left, right, mode, operator, tolerance)

Compares two OCR strings using text_exact, text_normalized, text_contains, text_similar or number. Returns status, score and matched. Empty input never matches; limit 1024 characters. Numeric mode requires one decimal and a nonnegative tolerance.

Documented for app version 1.0.55Updated:

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

How To Call It

Str is a global table: call its functions with a dot (Str.<method>(...)), not a colon.

When To Use It

In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.

Parameters and Return

Required: left, right, mode, operator, tolerance. Returns a Lua table.

Best Combined With

When combined with Str, JSON, Regex, Array, Map, and File, data transformation becomes much more readable in script flow.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

lua
Try in Editor →
local result = Str.compareOcr(" Level   12 ", "level 12", "text_normalized", "==", 0)

Copyable Progressive Examples

From foundation to combined usage, each level is provided as a separate code block so you can copy the level you need and adapt it directly.

Foundation

Shows the shortest direct way to call the API.

Foundation
lua
Try in Editor →
local result = Str.compareOcr(" Level   12 ", "level 12", "text_normalized", "==", 0)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local result = Str.compareOcr(" Level   12 ", "level 12", "text_normalized", "==", 0)
if stepOk then
  wait(200)
end

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
lua
Try in Editor →
local ok, err = pcall(function()
  local result = Str.compareOcr(" Level   12 ", "level 12", "text_normalized", "==", 0)
end)

if not ok then
  print("API step failed: Str.compareOcr: " .. tostring(err))
  requestStop()
end

Detailed

This level packages the API into a reusable helper with error reporting.

Detailed
lua
Try in Editor →
-- In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.
local function run_compareocr_step()
  local result = Str.compareOcr(" Level   12 ", "level 12", "text_normalized", "==", 0)
end

local ok, err = pcall(run_compareocr_step)
if not ok then
  toast("Step failed")
  print(err)
end

Combined

Combines the API with related structures to form a more realistic workflow.

Combined
lua
Try in Editor →
local result = Str.compareOcr(" Level   12 ", "level 12", "text_normalized", "==", 0)
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)