OTG HID Events

Overview

• All OTG HID event module functions require hardware to use
• See OTG HID setup in Advanced — OTG HID Hardware: OTGHID Hardware
• The module object prefix is otgEvent, e.g. otgEvent.click()

init Initialize OTG Serial Port

• Initialize the OTG serial port
• Requires EC Android 11.40.0+
• @return {null|string} null on success; otherwise an error message

1
// Test example for reference
2
var OTG_STEP_DELAY_MS = 2000;
3

4
/** Whether to run navigation tests: home / back / recents / systemKey */
5
var OTG_TEST_RUN_NAV_KEYS = false;
6

7
/** Touch test coordinates (adjust for target resolution) */
8
var OTG_TEST_X = 200;
9
var OTG_TEST_Y = 200;
10
var OTG_TEST_X2 = 400;
11
var OTG_TEST_Y2 = 400;
12

13
function _ok(name, err) {
14
    if (err == null || err === "" || err === undefined) {
15
        logd("[OTG-TEST] OK " + name);
16
        return true;
17
    }
18
    loge("[OTG-TEST] FAIL " + name + " -> " + err);
19
    return false;
20
}
21

22
function runOtgEventTests() {
23
    logd("[OTG-TEST] ========== start ==========");
24

25
    _ok("init", otgEvent.init());
26
    sleep(OTG_STEP_DELAY_MS);
27

28
    _ok("connectFirst", otgEvent.connectFirst());
29
    sleep(OTG_STEP_DELAY_MS);
30

31
    logd("[OTG-TEST] isConnected = " + otgEvent.isConnected());
32

33

34
    // If unavailable, sleep 3s and retry
35
    logd("mac "+otgEvent.getMacAddress())
36

37
    _ok("setTimeouts(800,1500,2500)", otgEvent.setTimeouts(2000, 2000, 3000));
38
    sleep(OTG_STEP_DELAY_MS);
39

40
    _ok("clickPoint", otgEvent.clickPoint(200, 300));
41
    sleep(OTG_STEP_DELAY_MS);
42

43
    _ok("doubleClickPoint", otgEvent.doubleClickPoint(400, 500));
44
    sleep(OTG_STEP_DELAY_MS);
45

46
    _ok("press(600ms)", otgEvent.press(600, 700, 5000));
47
    sleep(OTG_STEP_DELAY_MS);
48

49
    _ok("swipe", otgEvent.swipe(OTG_TEST_X, OTG_TEST_Y, OTG_TEST_X2, OTG_TEST_Y2, 400));
50
    sleep(OTG_STEP_DELAY_MS);
51

52
    _ok("touchDown", otgEvent.touchDown(OTG_TEST_X, OTG_TEST_Y));
53
    sleep(OTG_STEP_DELAY_MS);
54
    _ok("touchMove(pressed=true)", otgEvent.touchMove(OTG_TEST_X + 30, OTG_TEST_Y + 30));
55
    sleep(OTG_STEP_DELAY_MS);
56
    _ok("touchMove(pressed=false)", otgEvent.touchMove(OTG_TEST_X + 60, OTG_TEST_Y + 60));
57
    sleep(OTG_STEP_DELAY_MS);
58
    _ok("touchUp", otgEvent.touchUp(OTG_TEST_X + 60, OTG_TEST_Y + 60));
59
    sleep(OTG_STEP_DELAY_MS);
60

61
    if (OTG_TEST_RUN_NAV_KEYS) {
62
        _ok("systemKey(home)", otgEvent.systemKey("home"));
63
        sleep(OTG_STEP_DELAY_MS);
64
        _ok("systemKey(back)", otgEvent.systemKey("back"));
65
        sleep(OTG_STEP_DELAY_MS);
66
        _ok("systemKey(recents)", otgEvent.systemKey("recents"));
67
        sleep(OTG_STEP_DELAY_MS);
68

69
        _ok("recents()", otgEvent.recents());
70
        sleep(OTG_STEP_DELAY_MS);
71
        _ok("back()", otgEvent.back());
72
        sleep(OTG_STEP_DELAY_MS);
73
        _ok("home()", otgEvent.home());
74
        sleep(OTG_STEP_DELAY_MS);
75
    } else {
76
        logd("[OTG-TEST] skip systemKey / recents / back / home (set OTG_TEST_RUN_NAV_KEYS = true to run)");
77
    }
78

79
    _ok("keyPressChar a", otgEvent.keyPressChar("", "a"));
80
    sleep(OTG_STEP_DELAY_MS);
81
    _ok("keyPress 97 (a)", otgEvent.keyPress("", 97));
82
    sleep(OTG_STEP_DELAY_MS);
83

84
    var seq = [
85
        {"action": 0, "x": OTG_TEST_X, "y": OTG_TEST_Y, "pointer": 1, "delay": 40},
86
        {"action": 2, "x": OTG_TEST_X + 50, "y": OTG_TEST_Y + 50, "pointer": 1, "delay": 40},
87
        {"action": 2, "x": OTG_TEST_X + 100, "y": OTG_TEST_Y + 100, "pointer": 1, "delay": 40},
88
        {"action": 1, "x": OTG_TEST_X + 100, "y": OTG_TEST_Y + 100, "pointer": 1, "delay": 40}
89
    ];
90
    _ok("multiTouch", otgEvent.multiTouch(seq, 5000));
91
    sleep(OTG_STEP_DELAY_MS);
92

93
    _ok("close", otgEvent.close());
94
    sleep(OTG_STEP_DELAY_MS);
95

96
    logd("[OTG-TEST] ========== end ==========");
97
}
98

99
runOtgEventTests();

connectFirst Connect First Serial Device

• Connect to the first serial device
• Requires EC Android 11.40.0+
• Note: If not authorized, a permission dialog appears and an error is returned; call again after granting permission
• @return {null|string} null on success; otherwise an error message

1
    // See init function example

isConnected Connection Status

• Connection status
• Requires EC Android 11.40.0+
• @return {boolean} true when connected

1
    // See init function example

setTimeouts Set Timeouts

• Set timeouts (global)
• Requires EC Android 11.40.0+
• @param writeTimeoutMs Write timeout (ms); default 1000
• @param replyTimeoutMs Reply wait timeout (ms); default 2000
• @param durationExtraTimeoutMs Extra wait for press/swipe actions with duration (ms); default 3000
• @return {null|string} null or empty on success; otherwise an error message

1
    // See init function example

clickPoint Click

• Click
• Requires EC Android 11.40.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

press Long Press

• Long press
• Requires EC Android 11.40.0+
• @param x X coordinate
• @param y Y coordinate
• @param holdMs Hold duration in milliseconds
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

doubleClick Double Click

• Double click
• Requires EC Android 11.40.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

touchDown Touch Down

• Touch down
• Requires EC Android 11.40.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

touchMove Touch Move

• Touch move
• Requires EC Android 11.40.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

touchUp Touch Up

• Touch up
• Requires EC Android 11.40.0+
• @param x X coordinate
• @param y Y coordinate
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

swipe Swipe

• Swipe
• Requires EC Android 11.40.0+
• @param x Start X coordinate
• @param y Start Y coordinate
• @param ex End X coordinate
• @param ey End Y coordinate
• @param delay Total swipe duration in milliseconds
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

multiTouch Multi-Touch

• Multi-touch
• Touch parameters: action — 0 = down, 1 = up, 2 = move
• x: X coordinate
• y: Y coordinate
• pointer: Finger index 1, 2, 3, etc.
• delay: Delay before this action in ms; use >40ms to avoid coordinate drift
• @param touch1 Touch point array for finger 1, e.g.: [{"action":0,"x":1,"y":1,"pointer":1,"delay":30},{"action":2,"x":1,"y":1,"pointer":1,"delay":30}]
• @param timeout Multi-touch execution timeout in milliseconds
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

systemKey System Key

• System key
• Requires EC Android 11.40.0+
• @param key Values: home, back, recents
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

recents Recents

• Recents / task list
• May not work on all devices (non-standard key)
• Requires EC Android 11.40.0+
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

back Back

• Back
• Requires EC Android 11.40.0+
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

home Home

• Home
• Requires EC Android 11.40.0+
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

keyPress Keyboard Key

• Keyboard key
• Requires EC Android 11.40.0+
• @param prefix Modifier prefix; omit or null for normal key: alt, ctrl, gui (Win), r_ctrl (right Ctrl), r_shift (right Shift), shift
• @param code ASCII code
• @returns {string|null} null or empty on success; otherwise an error message

1
    // See init function example

keyPressChar Keyboard Character

• Keyboard character key
• Requires EC Android 11.40.0+
• @param prefix Modifier prefix; omit or null for normal key: alt, ctrl, gui (Win), r_ctrl (right Ctrl), r_shift (right Shift), shift
• @param c Single character, e.g. a; converted to ASCII internally. See https://tool.oschina.net/commons?type=4
• @returns {string|null} null or empty on success; otherwise an error message

1
// See init function example

getMacAddress Firmware MAC Address

• Read firmware MAC address
• Requires EC Android 11.41.0+
• @returns {string|null} aa:bb:cc:dd:ee:ff on success; null on failure

1
// See init function example