Macro Handler

Macro Handler

Android Automation Platform

Global ObjectSystem ControlSingleton Global

Metrics

Collects and summarises runtime metrics (scan and OCR counters).

Documented for app version 1.0.51Updated:

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

Metrics is a singleton global table: call its functions with a dot (Metrics.<method>(...)).

When To Use It

In system flow, design steps as observe first and act second when the API can affect device state.

Parameters and Return

Metrics offers 4 methods; each method page lists its parameters and return value.

Best Combined With

Using this API with logging, error handling, and next-step control produces much more professional results than calling it in isolation.

Example Usage

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

lua
Try in Editor →
Metrics.enable()
-- ... run the scans ...
print(Metrics.summary())

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 →
Metrics.enable()
-- ... run the scans ...
print(Metrics.summary())

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
Metrics.enable()
-- ... run the scans ...
print(Metrics.summary())

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
lua
Try in Editor →
Metrics.enable()
-- ... run the scans ...
print(Metrics.summary())
local note = "Metrics overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- In system flow, design steps as observe first and act second when the API can affect device state.
local function run_metrics_step()
  Metrics.enable()
  -- ... run the scans ...
  print(Metrics.summary())
end

local ok, err = pcall(run_metrics_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 →
Metrics.enable()
-- ... run the scans ...
print(Metrics.summary())
wait(200)
print("Combined with logging and flow control")