Macro Handler

Macro Handler

Android Automation Platform

Global ObjectSystem ControlSingleton Global

System

Device and app operations: messages and logging, global actions (Back, Home), opening apps, timers and scheduled runs, and screen information.

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

System is a singleton global table: call its functions with a dot (System.<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

System offers 77 methods; each method page lists its parameters and return value.

Options and Limits

Rate limit: System calls are limited to 60 per second; pure reads such as currentTime, elapsedTime, width, height, getWidth, getHeight, screenWidth, screenHeight, getScreenWidth, getScreenHeight and resolution do not count. Past the limit the call raises an error that stops the macro unless it runs inside pcall. lockScreen, screenOff, powerDialog and reboot are blocked by ScriptPolicyGuard. System.err() stops the macro after showing its message.

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 →
System.toast("Starting")
local width, height = System.width(), System.height()
System.log("Screen: " .. width .. "x" .. height)

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 →
System.toast("Starting")
local width, height = System.width(), System.height()
System.log("Screen: " .. width .. "x" .. height)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
System.toast("Starting")
local width, height = System.width(), System.height()
System.log("Screen: " .. width .. "x" .. height)

-- 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 →
System.toast("Starting")
local width, height = System.width(), System.height()
System.log("Screen: " .. width .. "x" .. height)
local note = "System 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_system_step()
  System.toast("Starting")
  local width, height = System.width(), System.height()
  System.log("Screen: " .. width .. "x" .. height)
end

local ok, err = pcall(run_system_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 →
System.toast("Starting")
local width, height = System.width(), System.height()
System.log("Screen: " .. width .. "x" .. height)
wait(200)
print("Combined with logging and flow control")