Aux Remote Helper Functions

Overview

auxEvent is the USB control center script module. It sends commands to the service built into EasyClick Cloud Test (standalone main app / ecauto) on the phone.

Unlike bleEvent, otgEvent, and imeApi, which you call directly from scripts running in EasyClick Cloud Test, auxEvent lets PC control center scripts operate the phone remotely over USB or WiFi.

Architecture

1
Control center script → EasyClick Cloud Test Aux service → Agent/Recording/BLE/OTG/IME/Device/Utils

Eight Categories Overview

Function Category Index

1. Session and Bridge (12)

USB/WiFi session setup, device discovery, connection preferences, health checks

scanWifiDevices, startAuxBridge, launchAppWithAuxEnv, setConnectType, getConnectType, ensureUsbSession, ensureWifiSession, ensureSession, closeSession, getWifiIp, sessionBaseUrl, health

2. Agent Automation (24)

Agent forwarded via Aux: environment, gestures, apps, nodes, screenshots

Environment and Service:agentIsServiceOk, agentStartEnv

Home Screen and Lock Screen:agentHome, agentHomeScreen, agentIsLocked, agentLockScreen, agentUnlockScreen

App Management:agentAppLaunch, agentCreateSession, agentAppKillByBundleId

Tap and Swipe:agentClickPoint, agentClickPointPressure, agentPress, agentLongClickPoint, agentDoubleClickPoint, agentSwipeToPoint, agentSwipeToPointPressure, agentMultiTouch, agentIoHIDEvent

Text Input:agentInputText

Nodes and Screenshots: agentSetFetchNodeParam, agentDumpXml, agentCaptureFullScreen, agentCaptureFullScreenEx (agentDumpXml with lockNodeFromXml enables getNodeInfo etc. on PC)

3. System Screen Recording (5)

Aux system screen recording broadcast and frame-buffer capture; no automation service required

screencapStatus, screencapStart, screencapStop, screencapConfig, screencapSnapshot

4. OTG Remote (22)

OTG HID forwarded via phone Aux (maps to otgEvent.js)

Connection and Config:otgIsConnect, otgGetMacAddress, otgRestart, otgSetScreenSize, otgSetScale

Mouse and Touch:otgResetZero, otgMouseMove, otgMouseMoveDistance, otgTouchDown, otgTouchMove, otgTouchUp, otgClickPoint, otgPress, otgDoubleClickPoint, otgSwipeToPoint, otgMultiTouch, otgPressMouseBtn

Keys and Other:otgSystemKey, otgToggleSoftKeyboard, otgKeyPressChar, otgKeyPress, otgLight

5. BLE Remote (32)

BLE HID forwarded via phone Aux (maps to bleEvent.js)

Connection and Config:bleStartConnect, bleStopConnect, bleIsConnect, bleSearchBleIp, bleGetConfigBleName, bleGetScale, bleSetScale, bleSetScreenSize, bleSetStep, bleSetWifiInfo, bleSendCmdType, bleResetBle, bleShowBleName, bleHideBleName

Mouse and Touch:bleResetZero, bleMouseMove, bleMouseMoveByDistance, bleMouseMoveDistance, bleTouchDown, bleTouchMove, bleTouchUp, bleClickPoint, blePress, bleDoubleClickPoint, bleSwipeToPoint, bleMultiTouch, blePressMouseBtn

Keys and Other:bleSystemKey, bleToggleSoftKeyboard, bleKeyPressChar, bleKeyPress, bleLight

6. Input Method (13)

Custom input method forwarded via Aux (maps to imeApi.js)

imeIsOk, imeInput, imePaste, imePressDel, imePressReturn, imeDismiss, imeCopyToClipboard, imeChangeKeyboard, imeRemoveAllContent, imeGetClipboard, imeSetClipboard, imeOpenUrl, imeGetText

7. Device Information (15)

Device info read via Aux from phone (maps to device.js)

Basic Info:deviceGetDeviceIdentifier, deviceGetDeviceId, deviceGetModel, deviceGetOSVersion, deviceGetBattery, deviceIsCharging, deviceGetScale

Screen and Orientation:deviceGetScreenWidth, deviceGetScreenHeight, deviceGetScreenWidthHeight, deviceGetWidthNoAuto, deviceGetHeightNoAuto, deviceGetOrientation, deviceGetOrientationNoAuto, deviceSetOrientation

8. Utilities and Photo Album (8)

Clipboard, URL, album permissions, and image/video upload

Utility Functions:utilGetClipboardText, utilSetClipboardText, utilOpenUrl, utilRequestPhotoAuthorization, utilDeleteAllPhotos, utilDeleteAllVideos

Album Upload:auxInsertImageToAlbum, auxInsertVideoToAlbum

1. Session and Bridge

USB/WiFi session setup, device discovery, connection preferences, health checks

scanWifiDevices

• Scan LAN for Aux HTTP devices (WiFi ecauto discovery; results cached in bridge)
• Requires EC iOS USB 9.39.0+
• @param ipRange IP range, e.g. 192.168.2.1 - 192.168.2.255
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.scanWifiDevices("");
3
    if (!auxEvent.isAuxCallOk(r)) logw("scanWifiDevices failed: {}", r);
4
    else logd("scanWifiDevices succeeded");
5
}
6
main();

startAuxBridge

• Start Aux bridge and launch EasyClick Cloud Test
• Requires EC iOS USB 9.39.0+
• @param bundleId EasyClick Cloud Test bundleId
• @param opts Optional: connectType(usb/wifi), ipRange/wifiScanRange, startScreencap, screencapDelaySec, killExisting
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.startAuxBridge("com.ieasyclick.ecauto", {});
3
    if (!auxEvent.isAuxCallOk(r)) logw("startAuxBridge failed: {}", r);
4
    else logd("startAuxBridge succeeded");
5
}
6
main();

launchAppWithAuxEnv

• Launch EasyClick Cloud Test and inject Aux environment only
• Requires EC iOS USB 9.39.0+
• @param bundleId EasyClick Cloud Test bundleId
• @param opts Optional start params, same as startAuxBridge
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.launchAppWithAuxEnv("com.ieasyclick.ecauto", {});
3
    if (!auxEvent.isAuxCallOk(r)) logw("launchAppWithAuxEnv failed: {}", r);
4
    else logd("launchAppWithAuxEnv succeeded");
5
}
6
main();

setConnectType

• Set Aux connection preference (usb/wifi); empty clears; GetSession prefers USB then WiFi
• Requires EC iOS USB 9.39.0+
• Affects routing only; does not open/close session.
• @param connectType usb, wifi, or "" to clear

1
function main() {
2
    let r = auxEvent.setConnectType("usb");
3
    if (!auxEvent.isAuxCallOk(r)) logw("setConnectType failed: {}", r);
4
    else logd("setConnectType succeeded");
5
}
6
main();

getConnectType

• Get current Aux preference; empty if unset
• Requires EC iOS USB 9.39.0+
• @returns {string}

1
function main() {
2
    let r = auxEvent.getConnectType();
3
    logd("getConnectType: {}", r);
4
}
5
main();

ensureUsbSession

• Ensure USB session with EasyClick Cloud Test
• Requires EC iOS USB 9.39.0+
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.ensureUsbSession();
3
    if (!auxEvent.isAuxCallOk(r)) logw("ensureUsbSession failed: {}", r);
4
    else logd("ensureUsbSession succeeded");
5
}
6
main();

ensureWifiSession

• Ensure USB control center network session with EasyClick Cloud Test
• Requires EC iOS USB 9.39.0+
• @param ipRange IP range, e.g. 192.168.2.1 - 192.168.2.255
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.ensureWifiSession("");
3
    if (!auxEvent.isAuxCallOk(r)) logw("ensureWifiSession failed: {}", r);
4
    else logd("ensureWifiSession succeeded");
5
}
6
main();

ensureSession

• Ensure EasyClick Cloud Test session by connection type
• Requires EC iOS USB 9.39.0+
• @param connectType Connection type: usb or wifi
• @param ipRange WiFi scan IP range when connectType is wifi
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.ensureSession("usb", "");
3
    if (!auxEvent.isAuxCallOk(r)) logw("ensureSession failed: {}", r);
4
    else logd("ensureSession succeeded");
5
}
6
main();

closeSession

• Close EasyClick Cloud Test session
• Requires EC iOS USB 9.39.0+
• @param connectType Optional usb/wifi; empty closes all USB and WiFi sessions
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.closeSession("usb");
3
    if (!auxEvent.isAuxCallOk(r)) logw("closeSession failed: {}", r);
4
    else logd("closeSession succeeded");
5
}
6
main();

getWifiIp

• Get device EasyClick Cloud Test WiFi IP
• Requires EC iOS USB 9.39.0+
• @returns {string|null} WiFi IP or null

1
function main() {
2
    let r = auxEvent.getWifiIp();
3
    logd("getWifiIp: {}", r);
4
}
5
main();

sessionBaseUrl

• Get current EasyClick Cloud Test session HTTP baseUrl
• Requires EC iOS USB 9.39.0+
• @returns {string} baseUrl or empty on failure

1
function main() {
2
    let r = auxEvent.sessionBaseUrl();
3
    logd("sessionBaseUrl: {}", r);
4
}
5
main();

health

• EasyClick Cloud Test HTTP gateway health check
• Requires EC iOS USB 9.39.0+
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    let r = auxEvent.health();
3
    if (!auxEvent.isAuxCallOk(r)) logw("health failed: {}", r);
4
    else logd("health succeeded");
5
}
6
main();

2. Agent Automation

Agent forwarded via Aux: environment, gestures, apps, nodes, screenshots

Environment and Service

agentIsServiceOk

• Whether automation service is OK (maps to EcImporter.isServiceOk / basic.isServiceOk)
• Requires EC iOS USB 9.39.0+
• Forwarded via Aux HTTP to standalone Agent API
• @returns {boolean} true if healthy

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentIsServiceOk();
5
    logd("agentIsServiceOk: {}", ok);
6
}
7
main();

agentStartEnv

• Start automation environment (maps to EcImporter.startEnv / basic.startEnv)
• Requires EC iOS USB 9.39.0+
• Forwarded via Aux HTTP to standalone Agent API
• @returns {boolean} true if start succeeded

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentStartEnv();
5
    logd("agentStartEnv: {}", ok);
6
}
7
main();

Home Screen and Lock Screen

agentHome

• Go to home screen (maps to agentEvent.home)
• Requires EC iOS USB 9.39.0+
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentHome();
5
    logd("agentHome: {}", ok);
6
}
7
main();

agentHomeScreen

• Force home screen, unlike home (maps to agentEvent.homeScreen)
• Requires EC iOS USB 9.39.0+
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentHomeScreen();
5
    logd("agentHomeScreen: {}", ok);
6
}
7
main();

agentIsLocked

• Whether screen is locked (maps to agentEvent.isLocked)
• Requires EC iOS USB 9.39.0+
• @returns {boolean} true if locked

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentIsLocked();
5
    logd("agentIsLocked: {}", ok);
6
}
7
main();

agentLockScreen

• Lock screen (maps to agentEvent.lockScreen)
• Requires EC iOS USB 9.39.0+
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentLockScreen();
5
    logd("agentLockScreen: {}", ok);
6
}
7
main();

agentUnlockScreen

• Unlock screen (maps to agentEvent.unlockScreen)
• Requires EC iOS USB 9.39.0+
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentUnlockScreen();
5
    logd("agentUnlockScreen: {}", ok);
6
}
7
main();

App Management

agentAppLaunch

• Open app (maps to AgentApi.appLaunch / agentEvent.appLaunchEx)
• Requires EC iOS USB 9.39.0+
• @param bundleId App bundleId
• @param ignoreState 1=ignore previous open state; else ""
• @returns {boolean} true on success

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentAppLaunch("com.ieasyclick.ecauto", "");
5
    logd("agentAppLaunch: {}", ok);
6
}
7
main();

agentCreateSession

• Create automation session (maps to AgentApi.createSession)
• Requires EC iOS USB 9.39.0+
• @param bundleId Optional; empty binds current foreground app
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentCreateSession("com.ieasyclick.ecauto");
5
    logd("agentCreateSession: {}", ok);
6
}
7
main();

agentAppKillByBundleId

• Kill process by bundleId (maps to AgentApi.appKillByBundleId / agentEvent.appKillByBundleIdEx)
• Requires EC iOS USB 9.39.0+
• @param bundleId App bundleId
• @param ignoreState 1=ignore previous state; else ""
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentAppKillByBundleId("com.ieasyclick.ecauto", "");
5
    logd("agentAppKillByBundleId: {}", ok);
6
}
7
main();

Tap and Swipe

agentClickPoint

• Click point (maps to agentEvent.clickPoint)
• Requires EC iOS USB 9.39.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {boolean} true if click succeeded

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentClickPoint(300, 400);
5
    logd("agentClickPoint: {}", ok);
6
}
7
main();

agentClickPointPressure

• Click point with pressure (maps to agentEvent.clickPointPressure)
• Requires EC iOS USB 9.39.0+
• @param x X coordinate
• @param y Y coordinate
• @param pressure Pressure 0–1
• @returns {boolean} true if click succeeded

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentClickPointPressure(300, 400, 0.5);
5
    logd("agentClickPointPressure: {}", ok);
6
}
7
main();

agentPress

• Press coordinate (maps to agentEvent.press)
• Requires EC iOS USB 9.39.0+
• @param x X coordinate
• @param y Y coordinate
• @param delay Duration in ms
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentPress(300, 400, 1000);
5
    logd("agentPress: {}", ok);
6
}
7
main();

agentLongClickPoint

• Long-press coordinate (maps to agentEvent.longClickPoint)
• Requires EC iOS USB 9.39.0+
• @param x X coordinate
• @param y Y coordinate
• @param delay Duration in ms
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentLongClickPoint(300, 400, 1000);
5
    logd("agentLongClickPoint: {}", ok);
6
}
7
main();

agentDoubleClickPoint

• Double-click coordinate (maps to agentEvent.doubleClickPoint)
• Requires EC iOS USB 9.39.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentDoubleClickPoint(300, 400);
5
    logd("agentDoubleClickPoint: {}", ok);
6
}
7
main();

agentSwipeToPoint

• Swipe to coordinate (maps to agentEvent.swipeToPoint)
• Requires EC iOS USB 9.39.0+
• @param startX Start X
• @param startY Start Y
• @param endX End X
• @param endY End Y
• @param duration Duration in ms
• @returns {boolean} true if swipe succeeded

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentSwipeToPoint(300, 400, 500, 600, 1000);
5
    logd("agentSwipeToPoint: {}", ok);
6
}
7
main();

agentSwipeToPointPressure

• Swipe to coordinate with pressure (maps to agentEvent.swipeToPointPressure)
• Requires EC iOS USB 9.39.0+
• @param startX Start X
• @param startY Start Y
• @param endX End X
• @param endY End Y
• @param duration Duration in ms
• @param pressure Pressure 0–1
• @returns {boolean} true if swipe succeeded

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentSwipeToPointPressure(300, 400, 500, 600, 1000, 0.5);
5
    logd("agentSwipeToPointPressure: {}", ok);
6
}
7
main();

agentMultiTouch

• Multi-touch (maps to agentEvent.multiTouch)
• Requires EC iOS USB 9.39.0+
• @param touch1 Touch point array or JSON string
• @param timeout Total timeout in ms
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let touch1 = [{"action":0,"x":300,"y":400,"pointer":1,"delay":20},{"action":1,"x":300,"y":400,"pointer":1,"delay":20}];
5
    let r = auxEvent.agentMultiTouch(touch1, 1000);
6
    logd("agentMultiTouch: {}", r);
7
}
8
main();

agentIoHIDEvent

• Simulate HID event (maps to agentEvent.ioHIDEvent)
• Requires EC iOS USB 9.39.0+
• @param eventPageID HID event page ID
• @param eventUsageID HID event usage ID
• @param delay Duration; 0.2 is usually enough
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentIoHIDEvent("11", "1", 1000);
5
    logd("agentIoHIDEvent: {}", ok);
6
}
7
main();

Text Input

agentInputText

• Input text (maps to agentEvent.inputText)
• Requires EC iOS USB 9.39.0+
• @param content Content
• @param duration Execution time in ms
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentInputText("test content", 1000);
5
    logd("agentInputText: {}", ok);
6
}
7
main();

Nodes and Screenshots

For WiFi with Node functions selectors (label().getNodeInfo(), etc.): agentSetFetchNodeParam → agentDumpXml → lockNodeFromXml → search. For remote phone-side matching use nodeAgent.

agentSetFetchNodeParam

• Set node fetch base params (maps to agentEvent.setFetchNodeParam)
• Requires EC iOS USB 9.39.0+
• visibleFilter: 1 = fetch regardless of visible; 2 = only visible=true nodes
• labelFilter: 1 = fetch regardless of label; 2 = only nodes with a label value
• maxDepth: tree depth; recommended 1–500
• maxChildCount: max child nodes; smaller=fewer; 0=unlimited
• excludedAttributes: Comma-separated attributes to exclude for faster fetching, e.g. visible,selected,enable
• @param ext Config map with visibleFilter, labelFilter, etc.
• @returns {boolean} true on success, false on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    let ok = auxEvent.agentSetFetchNodeParam({maxDepth:20,excludedAttributes:"visible,selected,enable,accessible"});
5
    logd("agentSetFetchNodeParam: {}", ok);
6
}
7
main();

agentDumpXml

• Export node tree as XML (maps to agentEvent.dumpXml)
• Requires EC iOS USB 9.39.0+
• Forwarded via Aux HTTP to phone Agent for XML string; does not auto-write PC node cache
• To keep using Node functions selectors (label().getNodeInfo(), etc.), use lockNodeFromXml then search
• @returns {string} XML or empty on failure

1
function main() {
2
    auxEvent.ensureWifiSession("");
3
    auxEvent.agentStartEnv();
4
    auxEvent.agentSetFetchNodeParam({
5
        labelFilter: "2",
6
        maxDepth: "20",
7
        visibleFilter: "2",
8
        excludedAttributes:"visible,selected,enable,accessible"
9
    });
10

11
    let xml = auxEvent.agentDumpXml();
12
    logd("xml length: {}", xml ? xml.length : 0);
13
    if (!xml) {
14
        logd("agentDumpXml failed");
15
        return;
16
    }
17

18
    releaseNode();
19
    let ok = lockNodeFromXml(xml);
20
    logd("lockNodeFromXml: {}", ok);
21
    if (!ok) {
22
        return;
23
    }
24

25
    let nd = label("Settings").getOneNodeInfo(0);
26
    logd("node: {}", nd ? JSON.stringify(nd) : "null");
27
}
28
main();

See Node functions — lockNodeFromXml; object form: agentEvent.lockNodeFromXml(xml). Remote phone-side selection: nodeAgent.

agentCaptureFullScreen

• Capture full-screen JPG (maps to AgentCall.captureFullScreenData / image.captureFullScreen)
• Requires EC iOS USB 9.39.0+
• Forwarded via Aux HTTP; returns AutoImage from image binary
• @returns {null|AutoImage}

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let img = auxEvent.agentCaptureFullScreen();
4
    if (img) { logd("image {}x{}", img.getWidth(), img.getHeight()); img.recycle(); }
5
}
6
main();

agentCaptureFullScreenEx

• Capture full screen with format/quality (maps to AgentCall.captureFullScreenDataEx / image.captureFullScreenEx)
• Requires EC iOS USB 9.39.0+
• Forwarded via Aux HTTP; returns AutoImage from image binary
• type: 0/1=JPG mode 1, 2=JPG mode 2, 3=PNG
• quality: 1-100
• @param ext Extended params, e.g. {type: "1", quality: 99}
• @returns {null|AutoImage}

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let img = auxEvent.agentCaptureFullScreenEx({type:"1",quality:90});
4
    if (img) { logd("image {}x{}", img.getWidth(), img.getHeight()); img.recycle(); }
5
}
6
main();

3. System Screen Recording

Aux system screen recording broadcast and frame-buffer capture

screencapStatus

• Query recording broadcast and frame-buffer status (Aux-specific; like image.isSystemScreenCapBroadcasting with buffer)
• Requires EC iOS USB 9.39.0+ (maps to standalone image system recording 6.6.0+)
• Start recording receiver first; or from app Settings → System Screen Recording
• @returns {string|null} null/empty=recording ready

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let r = auxEvent.screencapStatus();
4
    if (!auxEvent.isAuxCallOk(r)) logw("screencapStatus failed: {}", r);
5
    else logd("screencapStatus succeeded");
6
}
7
main();

screencapStart

• Start system screen recording broadcast (maps to image.startSystemScreenCapBroadcast)
• Requires EC iOS USB 9.39.0+ (maps to standalone image system recording 6.6.0+)
• App must be foreground, or start from Settings → System Screen Recording (Broadcast Picker requires user tap)
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let r = auxEvent.screencapStart();
4
    if (!auxEvent.isAuxCallOk(r)) logw("screencapStart failed: {}", r);
5
    else logd("screencapStart succeeded");
6
}
7
main();

screencapStop

• Stop system screen recording broadcast (maps to image.stopSystemScreenCapServer)
• Requires EC iOS USB 9.39.0+ (maps to standalone image system recording 6.6.0+)
• @returns {string|null} null/empty=stopped; else error/broadcasting

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let r = auxEvent.screencapStop();
4
    if (!auxEvent.isAuxCallOk(r)) logw("screencapStop failed: {}", r);
5
    else logd("screencapStop succeeded");
6
}
7
main();

screencapConfig

• Configure recording FPS and JPEG quality (maps to image.setSystemScreenCapFps / setSystemScreenCapJpegQuality)
• Requires EC iOS USB 9.39.0+ (maps to standalone image system recording 6.6.0+)
• fps = frames per second (e.g. 10/sec); don’t set too high; config read on each broadcast start
• jpegQuality is JPEG quality 1–100; higher = clearer, more resources
• @param config Config object, e.g. {frameRate, jpegQuality}
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let r = auxEvent.screencapConfig({frameRate:10,jpegQuality:80});
4
    if (!auxEvent.isAuxCallOk(r)) logw("screencapConfig failed: {}", r);
5
    else logd("screencapConfig succeeded");
6
}
7
main();

screencapSnapshot

• Get current screen JPEG snapshot (maps to image.getSystemScreenCapImage)
• Requires EC iOS USB 9.39.0+ (maps to standalone image system recording 6.6.0+)
• @returns {null|AutoImage} capture; null if no frame/instance

1
function main() {
2
    auxEvent.ensureUsbSession();
3
    let img = auxEvent.screencapSnapshot();
4
    if (img) { logd("image {}x{}", img.getWidth(), img.getHeight()); img.recycle(); }
5
}
6
main();

4. OTG Remote

OTG HID forwarded via phone Aux (maps to otgEvent.js)

Connection and Config

otgIsConnect

• Query OTG connection status (maps to otgEvent.isConnect)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @returns {string|null} null/empty=connected; else error

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgIsConnect();
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgIsConnect failed: {}", r);
5
    else logd("otgIsConnect succeeded");
6
}
7
main();

otgGetMacAddress

• Get OTG board MAC address (maps to otgEvent.getMacAddress)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @returns {string} MAC or error

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgGetMacAddress();
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgGetMacAddress failed: {}", r);
5
    else logd("otgGetMacAddress succeeded");
6
}
7
main();

otgRestart

• Restart OTG board (like RST) (maps to otgEvent.restart)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgRestart();
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgRestart failed: {}", r);
5
    else logd("otgRestart succeeded");
6
}
7
main();

otgSetScreenSize

• Set OTG screen size (prevent cursor leaving screen) (maps to otgEvent.setScreenSize)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param w Screen width
• @param h Screen height
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgSetScreenSize(390, 844);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgSetScreenSize failed: {}", r);
5
    else logd("otgSetScreenSize succeeded");
6
}
7
main();

otgSetScale

• Set OTG mouse scale (maps to otgEvent.setScale)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x_scale X scale compensation
• @param y_scale Y scale compensation
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgSetScale(2.0, 2.0);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgSetScale failed: {}", r);
5
    else logd("otgSetScale succeeded");
6
}
7
main();

Mouse and Touch

otgResetZero

• OTG mouse reset to zero (maps to otgEvent.resetZero)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgResetZero();
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgResetZero failed: {}", r);
5
    else logd("otgResetZero succeeded");
6
}
7
main();

otgMouseMove

• OTG move mouse (relative) (maps to otgEvent.mouseMove)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X displacement
• @param y Y displacement
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgMouseMove(300, 400);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgMouseMove failed: {}", r);
5
    else logd("otgMouseMove succeeded");
6
}
7
main();

otgMouseMoveDistance

• OTG move mouse by pixel distance (maps to otgEvent.mouseMoveDistance)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x_dis X displacement
• @param y_dis Y displacement
• @param press Whether pressed while moving
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgMouseMoveDistance(10, 10, false);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgMouseMoveDistance failed: {}", r);
5
    else logd("otgMouseMoveDistance succeeded");
6
}
7
main();

otgTouchDown

• OTG touch down (maps to otgEvent.touchDown)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgTouchDown(300, 400);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgTouchDown failed: {}", r);
5
    else logd("otgTouchDown succeeded");
6
}
7
main();

otgTouchMove

• OTG touch move (maps to otgEvent.touchMove)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgTouchMove(300, 400);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgTouchMove failed: {}", r);
5
    else logd("otgTouchMove succeeded");
6
}
7
main();

otgTouchUp

• OTG touch up (maps to otgEvent.touchUp)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgTouchUp(300, 400);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgTouchUp failed: {}", r);
5
    else logd("otgTouchUp succeeded");
6
}
7
main();

otgClickPoint

• OTG click point (maps to otgEvent.clickPoint)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgClickPoint(300, 400);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgClickPoint failed: {}", r);
5
    else logd("otgClickPoint succeeded");
6
}
7
main();

otgPress

• OTG long-press point (maps to otgEvent.press)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X coordinate
• @param y Y coordinate
• @param delay Long-press duration in ms
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgPress(300, 400, 1000);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgPress failed: {}", r);
5
    else logd("otgPress succeeded");
6
}
7
main();

otgDoubleClickPoint

• OTG double-click point (maps to otgEvent.doubleClickPoint)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgDoubleClickPoint(300, 400);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgDoubleClickPoint failed: {}", r);
5
    else logd("otgDoubleClickPoint succeeded");
6
}
7
main();

otgSwipeToPoint

• OTG swipe to point (maps to otgEvent.swipeToPoint)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param startX Start X
• @param startY Start Y
• @param endX End X
• @param endY End Y
• @param duration Duration in ms
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgSwipeToPoint(300, 400, 500, 600, 1000);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgSwipeToPoint failed: {}", r);
5
    else logd("otgSwipeToPoint succeeded");
6
}
7
main();

otgMultiTouch

• OTG multi-touch (maps to otgEvent.multiTouch)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• Touch params: action 0=down, 1=up, 2=move; pointer=finger index; delay=ms
• @param touch1 Touch array, e.g. [{"action":0,"x":1,"y":1,"pointer":1,"delay":20}]
• @param timeout Multi-touch total timeout in ms
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let touch1 = [{"action":0,"x":300,"y":400,"pointer":1,"delay":20},{"action":1,"x":300,"y":400,"pointer":1,"delay":20}];
4
    let r = auxEvent.otgMultiTouch(touch1, 1000);
5
    if (!auxEvent.isAuxCallOk(r)) logw("otgMultiTouch failed: {}", r); else logd("otgMultiTouch succeeded");
6
}
7
main();

otgPressMouseBtn

• OTG mouse button click (AssistiveTouch custom button, etc.) (maps to otgEvent.pressMouseBtn)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param btn 1=left, 2=right, 3=scroll, 4-8=custom
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgPressMouseBtn(1);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgPressMouseBtn failed: {}", r);
5
    else logd("otgPressMouseBtn succeeded");
6
}
7
main();

Keys and Other

otgSystemKey

• OTG system key (maps to otgEvent.systemKey)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param key e.g. home, recents
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgSystemKey("home");
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgSystemKey failed: {}", r);
5
    else logd("otgSystemKey succeeded");
6
}
7
main();

otgToggleSoftKeyboard

• OTG toggle soft keyboard (maps to otgEvent.toggleSoftKeyboard)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgToggleSoftKeyboard();
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgToggleSoftKeyboard failed: {}", r);
5
    else logd("otgToggleSoftKeyboard succeeded");
6
}
7
main();

otgKeyPressChar

• OTG character key (maps to otgEvent.keyPressChar)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param prefix Modifiers: alt, ctrl, gui, shift, r_ctrl, r_shift; may be empty
• @param code Character, e.g. a, Enter, BS=delete
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgKeyPressChar("", "a");
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgKeyPressChar failed: {}", r);
5
    else logd("otgKeyPressChar succeeded");
6
}
7
main();

otgKeyPress

• OTG key press (ASCII) (maps to otgEvent.keyPress)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param prefix Modifier key; may be empty
• @param code Integer ASCII code; see https://tool.oschina.net/commons?type=4
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgKeyPress("", 65);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgKeyPress failed: {}", r);
5
    else logd("otgKeyPress succeeded");
6
}
7
main();

otgLight

• OTG board LED blink (maps to otgEvent.light)
• Requires EC iOS USB 9.39.0+ (maps to standalone otgEvent 6.6.0+)
• @param num Blink count
• @param lightToOff On-to-off interval in ms
• @param offToLight Off-to-on interval in ms
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.otgLight(3, 200, 200);
4
    if (!auxEvent.isAuxCallOk(r)) logw("otgLight failed: {}", r);
5
    else logd("otgLight succeeded");
6
}
7
main();

5. BLE Remote

BLE HID forwarded via phone Aux (maps to bleEvent.js)

Connection and Config

bleStartConnect

• Scan and connect BLE board (maps to bleEvent.startConnect)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.6.0+)
• @param bleDeviceName BLE device name
• @param save Save connection info
• @param timeout Timeout in ms
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.bleStartConnect("", false, 1000);
4
    if (!auxEvent.isAuxCallOk(r)) logw("bleStartConnect failed: {}", r);
5
    else logd("bleStartConnect succeeded");
6
}
7
main();

bleStopConnect

• Disconnect BLE (maps to bleEvent.stopConnect)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.6.0+)
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.bleStopConnect();
4
    if (!auxEvent.isAuxCallOk(r)) logw("bleStopConnect failed: {}", r);
5
    else logd("bleStopConnect succeeded");
6
}
7
main();

bleIsConnect

• Query BLE connection status (maps to bleEvent.isConnected)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.6.0+)
• @returns {boolean} true if connected

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let ok = auxEvent.bleIsConnect();
4
    logd("bleIsConnect: {}", ok);
5
}
6
main();

bleSearchBleIp

• Search BLE board IP (maps to bleEvent.searchBleIp)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.6.0+)
• @param force Force re-search
• @param timeout Timeout in ms
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.bleSearchBleIp(false, 1000);
4
    if (!auxEvent.isAuxCallOk(r)) logw("bleSearchBleIp failed: {}", r);
5
    else logd("bleSearchBleIp succeeded");
6
}
7
main();

bleGetConfigBleName

• Get app-configured BLE name (maps to bleEvent.getConfigBleName)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.5.0+)
• @returns {string} Configured BLE name or empty

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.bleGetConfigBleName();
4
    if (!auxEvent.isAuxCallOk(r)) logw("bleGetConfigBleName failed: {}", r);
5
    else logd("bleGetConfigBleName succeeded");
6
}
7
main();

bleGetScale

• Get current BLE mouse scale (maps to bleEvent.getScale)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.6.0+)
• @returns {string} Scale JSON or error

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.bleGetScale();
4
    if (!auxEvent.isAuxCallOk(r)) logw("bleGetScale failed: {}", r);
5
    else logd("bleGetScale succeeded");
6
}
7
main();

bleSetScale

• Set BLE mouse scale (maps to bleEvent.setScale)
• Requires EC iOS USB 9.39.0+ (maps to standalone bleEvent 6.6.0+)
• @param x_scale X scale float; default ~2.0
• @param y_scale Y scale float; default ~2.0
• @returns {string|null} null or empty string means success; else error message

1
function main() {
2
    if (!auxEvent.isAuxCallOk(auxEvent.ensureWifiSession(""))) return;
3
    let r = auxEvent.bleSetScale(2.0, 2.0);
4
    if (!auxEvent.isAuxCallOk(r)) logw("bleSetScale failed: {}", r);
5
    else logd("bleSetScale succeeded");
6
}
7
main();