Droidline

Installed packages Example: apps()

Back Example: back()

Run several commands on the phone in one go, even while it is offline. Steps are [cmd, args...] lists or {cmd, ...} objects. The step sleep(ms) only exists inside batch. When the steps turn off the phone's network, for example Wi-Fi off and on again, pass cuts_network: the phone answers accepted first, runs the steps while offline, and the result arrives after it reconnects. Example: batch([("home",), ("sleep", 500), ("recents",)])

Battery level and charging state Example: battery()["level"] < 20

true if a switch or checkbox is on Example: checked("id", "com.kakao.talk:id/auto_login")

Open a URL in Chrome Example: chrome.go("naver.com")

Empty a text field Example: clear("id", "com.kakao.talk:id/email")

Clear an app's data in device owner mode. Optional, and only in device owner mode, where the phone wipes the app directly without opening Settings. Without it the answer is NO_PERMISSION; the docs have a recipe that goes through Settings instead. Example: clear_data("com.android.chrome")

Write the clipboard, or read it when called without text. Reading on Android 10+ needs the Droidline keyboard to be the current input method. Example: clipboard("복사할 글")

Pixel color at a coordinate as #RRGGBB. For screens without accessibility nodes, such as games. Example: color(540, 1200)

Number of matching elements Example: count("class", "android.widget.CheckBox")

Foreground package and activity Example: current()

Paired devices with online state and route Example: devices()

Return the current screen as a node tree Example: dump("screen.json")

true if the element can be pressed Example: enabled("text", "다음")

Whether an element is on screen right now. Never waits Example: exists("text", "광고 닫기")

Wait for an element and return it. The SDKs return an element object with click, input, find and the node fields. The node comes without children. Example: find("text", "로그인")

Every element that matches right now. Answers at once, with an empty list when nothing matches, unless timeout is set. Directional queries come back nearest first. Example: find_all("id", "title")

Find a picture on the screen. Optional, and runs on the PC: the server takes a screenshot and compares. Cut the image from a screenshot of the same phone; for a phone with another screen density, pass scales. On Android 9 and 10 screenshots need screen capture permission. Example: find_image("ok-button.png")

Every place a picture appears on the screen. Answers at once, with an empty list when nothing matches, unless timeout is set. Best matches come first and never overlap. Runs on the PC; for a phone with another screen density, pass scales. Example: find_images("coin.png")

Text of an element, or an empty string Example: get_text("id", "com.example:id/balance")

true if a showing notification matches Example: has_notification("textContains", "배송")

Home screen Example: home()

Whether a picture is on the screen right now. Never waits. Optional, and runs on the PC: the server takes a screenshot and compares. Cut the image from a screenshot of the same phone; for a phone with another screen density, pass scales. On Android 9 and 10 screenshots need screen capture permission. Example: image_exists("coin.png")

true if that app is in the foreground Example: in_app("com.kakao.talk")

Model, Android version, screen size and permission readiness Example: info()

Wait for a field and set its text. Uses the accessibility set-text action. Fields that ignore it fall back to the Droidline keyboard when it is selected. Example: input("id", "com.kakao.talk:id/email", "knife")

Version name if installed, empty string if not Example: installed("com.kakao.talk")

Open a screen by its intent action, such as a Settings page. Opens any screen other apps are allowed to open, for example android.settings.WIFI_SETTINGS, or android.settings.APPLICATION_DETAILS_SETTINGS with data package:com.example. The screen opens fresh, closing other screens of the same app. What to tap after that differs by phone maker and language, so Wi-Fi, airplane mode, force stop and clearing data are recipes in the docs rather than commands. Example: intent("android.settings.WIFI_SETTINGS")

true if a soft keyboard is showing Example: keyboard_shown()

Text of the most recent toast, or an empty string Example: last_toast()

Start an app, optionally at a specific activity Example: launch("com.kakao.talk")

Turn the screen off and lock Example: lock()

true if the lock screen is showing Example: locked()

Press and hold a coordinate Example: long_tap(540, 1200, 800)

Wait for an element and press and hold it Example: long_touch("text", "메시지")

Connection type (wifi, mobile, none) and airplane mode Example: network()["type"] == "wifi"

Open a notification Example: notification_click(key)

Dismiss a notification Example: notification_dismiss(key)

Reply inline to a notification that has a reply action Example: notification_reply(key, "확인했습니다")

Notifications currently showing Example: notifications()

Choose which apps' notifications are sent to the PC. Default is none Example: notify_filter(["com.kakao.talk"])

Read the text on the screen with OCR. Optional, and runs on the PC with Tesseract, which you install yourself along with the language data you need. Nothing is installed for you. On Android 9 and 10 screenshots need screen capture permission. Example: ocr("kor+eng")

Wait until OCR reads some text on the screen and return where it is. Optional, and runs on the PC with Tesseract, which you install yourself along with the language data you need. Nothing is installed for you. On Android 9 and 10 screenshots need screen capture permission. Example: ocr_find("확인", "kor")

Wait until OCR reads some text on the screen and tap it. Optional, and runs on the PC with Tesseract, which you install yourself along with the language data you need. Nothing is installed for you. On Android 9 and 10 screenshots need screen capture permission. Example: ocr_tap("확인", "kor")

Pull down the notification shade Example: open_notifications()

Open a URL or deep link Example: open_url("myapp://orders/42")

portrait or landscape Example: orientation() == "landscape"

Route chosen apps through an upstream proxy with a per-app VPN. Supports http:// (CONNECT) and socks5:// with user:pass. Pass null or "off" to stop. One upstream at a time. Apps that ignore the proxy setting lose network access instead of leaking. Example: proxy("socks5://user:pass@1.2.3.4:1080", app="com.android.chrome")

Per-app proxy state and the IP the outside world sees Example: proxy_check("com.android.chrome")["ip"]