Macro Handler

Macro Handler

Android Automation Platform

Object MethodTouch and ActionsComing soonv1.0.54

Navigation.readProfile(profileId)

Reads a saved setup as profileJson; edit it with JSON.parse. Returns ok/code, profileId and revision. Private calibration measurements are omitted.

Documented for app version 1.0.54 (not on Google Play yet)Updated:

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

Navigation is a global table: call its functions with a dot (Navigation.<method>(...)), not a colon. Requires Macro Handler 1.0.54 or later.

When To Use It

In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.

Parameters and Return

Required: profileId. Returns a Lua table.

Best Combined With

It works best together with wait(), Point, SwipeParam, ClickParam, and sometimes a Region result.

Example Usage

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

lua
Try in Editor →
local r = Navigation.readProfile(profileId)
if r.ok then local profile = JSON.parse(r.profileJson); print(profile.label) end

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 r = Navigation.readProfile(profileId)
if r.ok then local profile = JSON.parse(r.profileJson); print(profile.label) end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local r = Navigation.readProfile(profileId)
if r.ok then local profile = JSON.parse(r.profileJson); print(profile.label) end
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 r = Navigation.readProfile(profileId)
  if r.ok then local profile = JSON.parse(r.profileJson); print(profile.label) end
end)

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

Detailed

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

Detailed
lua
Try in Editor →
-- In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.
local function run_readprofile_step()
  local r = Navigation.readProfile(profileId)
  if r.ok then local profile = JSON.parse(r.profileJson); print(profile.label) end
end

local ok, err = pcall(run_readprofile_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 target = Point(540, 960)
quickTap(target)
wait(250)
local r = Navigation.readProfile(profileId)
if r.ok then local profile = JSON.parse(r.profileJson); print(profile.label) end
wait(250)
print("Automation chain completed")