uiautodev 0.6.0__py3-none-any.whl → 0.7.1__py3-none-any.whl

uiautodev/__init__.py

@@ -5,4 +5,4 @@
 """
 
 # version is auto managed by poetry
-__version__ = "0.6.0"
+__version__ = "0.7.1"

uiautodev/app.py

@@ -11,16 +11,20 @@ import signal
 from pathlib import Path
 from typing import List
 
+import adbutils
 import uvicorn
-from fastapi import FastAPI, File, UploadFile
+from fastapi import FastAPI, File, UploadFile, WebSocket
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import FileResponse, JSONResponse, RedirectResponse
 from pydantic import BaseModel
+from rich.logging import RichHandler
+from starlette.websockets import WebSocketDisconnect
 
 from uiautodev import __version__
 from uiautodev.common import convert_bytes_to_image, get_webpage_url, ocr_image
 from uiautodev.model import Node
 from uiautodev.provider import AndroidProvider, HarmonyProvider, IOSProvider, MockProvider
+from uiautodev.remote.scrcpy import ScrcpyServer
 from uiautodev.router.device import make_router
 from uiautodev.router.xml import router as xml_router
 from uiautodev.utils.envutils import Environment
@@ -29,6 +33,16 @@ logger = logging.getLogger(__name__)
 
 app = FastAPI()
 
+
+def enable_logger_to_console():
+    _logger = logging.getLogger("uiautodev")
+    _logger.setLevel(logging.DEBUG)
+    _logger.addHandler(RichHandler(enable_link_path=False))
+
+
+if os.getenv("UIAUTODEV_DEBUG"):
+    enable_logger_to_console()
+
 app.add_middleware(
     CORSMiddleware,
     allow_origins=["*"],
@@ -109,5 +123,36 @@ def index_redirect():
     return RedirectResponse(url)
 
 
+def get_scrcpy_server(serial: str):
+    # 这里主要是为了避免两次websocket建立建立，启动两个scrcpy进程
+    logger.info("create scrcpy server for %s", serial)
+    device = adbutils.device(serial)
+    return ScrcpyServer(device)
+
+
+@app.websocket("/ws/android/scrcpy/{serial}")
+async def unified_ws(websocket: WebSocket, serial: str):
+    """
+    Args:
+        serial: device serial
+        websocket: WebSocket
+    """
+    await websocket.accept()
+
+    try:
+        logger.info(f"WebSocket serial: {serial}")
+
+        # 获取 ScrcpyServer 实例
+        server = get_scrcpy_server(serial)
+        await server.handle_unified_websocket(websocket, serial)
+    except WebSocketDisconnect:
+        logger.info(f"WebSocket disconnected by client.")
+    except Exception as e:
+        logger.exception(f"WebSocket error for serial={serial}: {e}")
+        await websocket.close(code=1000, reason=str(e))
+    finally:
+        logger.info(f"WebSocket closed for serial={serial}")
+
+
 if __name__ == '__main__':
     uvicorn.run("uiautodev.app:app", port=4000, reload=True, use_colors=True)

uiautodev/cli.py

@@ -7,6 +7,7 @@
 from __future__ import annotations
 
 import logging
+import os
 import platform
 import subprocess
 import sys
@@ -29,30 +30,12 @@ logger = logging.getLogger(__name__)
 
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
+
 @click.group(context_settings=CONTEXT_SETTINGS)
 @click.option("--verbose", "-v", is_flag=True, default=False, help="verbose mode")
 def cli(verbose: bool):
     if verbose:
-        # try to enable logger is not very easy
-        # you have to setup logHandler(logFormatter) for the root logger
-        # and set all children logger to DEBUG
-        # that's why it is not easy to use it with logging
-        root_logger = logging.getLogger(__name__.split(".")[0])
-        root_logger.setLevel(logging.DEBUG)
-
-        console_handler = logging.StreamHandler()
-        console_handler.setLevel(logging.DEBUG)
-        
-        formatter = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
-        console_handler.setFormatter(formatter)
-
-        root_logger.addHandler(console_handler)
-
-        # set all children logger to DEBUG
-        for k in root_logger.manager.loggerDict.keys():
-            if k.startswith(root_logger.name+"."):
-                logging.getLogger(k).setLevel(logging.DEBUG)
-        
+        os.environ['UIAUTODEV_DEBUG'] = '1'
         logger.debug("Verbose mode enabled")
 
 
@@ -113,7 +96,7 @@ def case():
 def appium(command: Command, params: list[str] = None):
     from uiautodev.driver.appium import AppiumProvider
     from uiautodev.exceptions import AppiumDriverException
-    
+
     provider = AppiumProvider()
     try:
         run_driver_command(provider, command, params)
@@ -150,7 +133,7 @@ def server(port: int, host: str, reload: bool, force: bool, no_browser: bool):
     use_color = True
     if platform.system() == 'Windows':
         use_color = False
-    
+
     if not no_browser:
         th = threading.Thread(target=open_browser_when_server_start, args=(f"http://{host}:{port}",))
         th.daemon = True
@@ -171,6 +154,7 @@ def open_browser_when_server_start(server_url: str):
     logger.info("open browser: %s", web_url)
     webbrowser.open(web_url)
 
+
 def main():
     # set logger level to INFO
     # logging.basicConfig(level=logging.INFO)

uiautodev/driver/android.py

@@ -71,8 +71,7 @@ class AndroidDriver(BaseDriver):
         try:
             return self.ud.dump_hierarchy()
         except Exception as e:
-            logger.exception("unexpected dump error: %s", e)
-            raise AndroidDriverException("Failed to dump hierarchy")
+            raise AndroidDriverException(f"Failed to dump hierarchy: {str(e)}")
     
     def tap(self, x: int, y: int):
         self.adb_device.click(x, y)

uiautodev/provider.py

@@ -12,7 +12,7 @@ import adbutils
 
 from uiautodev.driver.android import AndroidDriver
 from uiautodev.driver.base_driver import BaseDriver
-from uiautodev.driver.harmony import HarmonyDriver, HDC
+from uiautodev.driver.harmony import HDC, HarmonyDriver
 from uiautodev.driver.ios import IOSDriver
 from uiautodev.driver.mock import MockDriver
 from uiautodev.exceptions import UiautoException

uiautodev/remote/android_input.py

@@ -0,0 +1,74 @@
+# Ref
+# https://github.com/Genymobile/scrcpy/blob/master/app/src/android/input.h
+from enum import IntEnum
+
+
+class MetaState(IntEnum):
+    """Android meta state flags ported from Android's KeyEvent class
+    
+    These flags represent the state of meta keys such as ALT, SHIFT, CTRL, etc.
+    They can be combined using bitwise OR operations to represent multiple
+    meta keys being pressed simultaneously.
+    
+    The values and comments are taken directly from the Android source code
+    to maintain compatibility and provide accurate descriptions.
+    """
+    # No meta keys are pressed
+    NONE = 0x0
+    
+    # This mask is used to check whether one of the SHIFT meta keys is pressed
+    SHIFT_ON = 0x1
+    
+    # This mask is used to check whether one of the ALT meta keys is pressed
+    ALT_ON = 0x2
+    
+    # This mask is used to check whether the SYM meta key is pressed
+    SYM_ON = 0x4
+    
+    # This mask is used to check whether the FUNCTION meta key is pressed
+    FUNCTION_ON = 0x8
+    
+    # This mask is used to check whether the left ALT meta key is pressed
+    ALT_LEFT_ON = 0x10
+    
+    # This mask is used to check whether the right ALT meta key is pressed
+    ALT_RIGHT_ON = 0x20
+    
+    # This mask is used to check whether the left SHIFT meta key is pressed
+    SHIFT_LEFT_ON = 0x40
+    
+    # This mask is used to check whether the right SHIFT meta key is pressed
+    SHIFT_RIGHT_ON = 0x80
+    
+    # This mask is used to check whether the CAPS LOCK meta key is on
+    CAPS_LOCK_ON = 0x100000
+    
+    # This mask is used to check whether the NUM LOCK meta key is on
+    NUM_LOCK_ON = 0x200000
+    
+    # This mask is used to check whether the SCROLL LOCK meta key is on
+    SCROLL_LOCK_ON = 0x400000
+    
+    # This mask is used to check whether one of the CTRL meta keys is pressed
+    CTRL_ON = 0x1000
+    
+    # This mask is used to check whether the left CTRL meta key is pressed
+    CTRL_LEFT_ON = 0x2000
+    
+    # This mask is used to check whether the right CTRL meta key is pressed
+    CTRL_RIGHT_ON = 0x4000
+    
+    # This mask is used to check whether one of the META meta keys is pressed
+    META_ON = 0x10000
+    
+    # This mask is used to check whether the left META meta key is pressed
+    META_LEFT_ON = 0x20000
+    
+    # This mask is used to check whether the right META meta key is pressed
+    META_RIGHT_ON = 0x40000
+
+
+class KeyeventAction(IntEnum):
+    DOWN = 0
+    UP = 1
+    MULTIPLE = 2

uiautodev/remote/keycode.py

@@ -0,0 +1,350 @@
+from enum import IntEnum
+
+
+class KeyCode(IntEnum):
+    """Android key codes ported from Android's KeyEvent class
+    
+    This enum contains all the key codes defined in Android's KeyEvent class,
+    which are used for sending key events to Android devices through scrcpy.
+    
+    The comments for each key code are taken directly from the Android source code
+    to maintain compatibility and provide accurate descriptions.
+    """
+    # Unknown key code
+    UNKNOWN = 0
+    # Soft Left key - Usually situated below the display on phones
+    SOFT_LEFT = 1
+    # Soft Right key - Usually situated below the display on phones
+    SOFT_RIGHT = 2
+    # Home key - This key is handled by the framework and is never delivered to applications
+    HOME = 3
+    # Back key
+    BACK = 4
+    # Call key
+    CALL = 5
+    # End Call key
+    ENDCALL = 6
+    # '0' key
+    KEY_0 = 7
+    # '1' key
+    KEY_1 = 8
+    # '2' key
+    KEY_2 = 9
+    # '3' key
+    KEY_3 = 10
+    # '4' key
+    KEY_4 = 11
+    # '5' key
+    KEY_5 = 12
+    # '6' key
+    KEY_6 = 13
+    # '7' key
+    KEY_7 = 14
+    # '8' key
+    KEY_8 = 15
+    # '9' key
+    KEY_9 = 16
+    # '*' key
+    STAR = 17
+    # '#' key
+    POUND = 18
+    # Directional Pad Up key - May also be synthesized from trackball motions
+    DPAD_UP = 19
+    # Directional Pad Down key - May also be synthesized from trackball motions
+    DPAD_DOWN = 20
+    # Directional Pad Left key - May also be synthesized from trackball motions
+    DPAD_LEFT = 21
+    # Directional Pad Right key - May also be synthesized from trackball motions
+    DPAD_RIGHT = 22
+    # Directional Pad Center key - May also be synthesized from trackball motions
+    DPAD_CENTER = 23
+    # Volume Up key - Adjusts the speaker volume up
+    VOLUME_UP = 24
+    # Volume Down key - Adjusts the speaker volume down
+    VOLUME_DOWN = 25
+    # Power key
+    POWER = 26
+    # Camera key - Used to launch a camera application or take pictures
+    CAMERA = 27
+    # Clear key
+    CLEAR = 28
+    A = 29
+    B = 30
+    C = 31
+    D = 32
+    E = 33
+    F = 34
+    G = 35
+    H = 36
+    I = 37
+    J = 38
+    K = 39
+    L = 40
+    M = 41
+    N = 42
+    O = 43
+    P = 44
+    Q = 45
+    R = 46
+    S = 47
+    T = 48
+    U = 49
+    V = 50
+    W = 51
+    X = 52
+    Y = 53
+    Z = 54
+    COMMA = 55
+    PERIOD = 56
+    ALT_LEFT = 57
+    ALT_RIGHT = 58
+    SHIFT_LEFT = 59
+    SHIFT_RIGHT = 60
+    TAB = 61
+    SPACE = 62
+    SYM = 63
+    EXPLORER = 64
+    ENVELOPE = 65
+    # Enter key
+    ENTER = 66
+    # Backspace key - Deletes characters before the insertion point
+    DEL = 67
+    GRAVE = 68
+    MINUS = 69
+    EQUALS = 70
+    LEFT_BRACKET = 71
+    RIGHT_BRACKET = 72
+    BACKSLASH = 73
+    SEMICOLON = 74
+    APOSTROPHE = 75
+    SLASH = 76
+    AT = 77
+    NUM = 78
+    HEADSETHOOK = 79
+    FOCUS = 80
+    PLUS = 81
+    # Menu key
+    MENU = 82
+    NOTIFICATION = 83
+    SEARCH = 84
+    MEDIA_PLAY_PAUSE = 85
+    MEDIA_STOP = 86
+    MEDIA_NEXT = 87
+    MEDIA_PREVIOUS = 88
+    MEDIA_REWIND = 89
+    MEDIA_FAST_FORWARD = 90
+    MUTE = 91
+    PAGE_UP = 92
+    PAGE_DOWN = 93
+    PICTSYMBOLS = 94
+    SWITCH_CHARSET = 95
+    BUTTON_A = 96
+    BUTTON_B = 97
+    BUTTON_C = 98
+    BUTTON_X = 99
+    BUTTON_Y = 100
+    BUTTON_Z = 101
+    BUTTON_L1 = 102
+    BUTTON_R1 = 103
+    BUTTON_L2 = 104
+    BUTTON_R2 = 105
+    BUTTON_THUMBL = 106
+    BUTTON_THUMBR = 107
+    BUTTON_START = 108
+    BUTTON_SELECT = 109
+    BUTTON_MODE = 110
+    ESCAPE = 111
+    FORWARD_DEL = 112
+    CTRL_LEFT = 113
+    CTRL_RIGHT = 114
+    CAPS_LOCK = 115
+    SCROLL_LOCK = 116
+    META_LEFT = 117
+    META_RIGHT = 118
+    FUNCTION = 119
+    SYSRQ = 120
+    BREAK = 121
+    MOVE_HOME = 122
+    MOVE_END = 123
+    INSERT = 124
+    FORWARD = 125
+    MEDIA_PLAY = 126
+    MEDIA_PAUSE = 127
+    MEDIA_CLOSE = 128
+    MEDIA_EJECT = 129
+    MEDIA_RECORD = 130
+    F1 = 131
+    F2 = 132
+    F3 = 133
+    F4 = 134
+    F5 = 135
+    F6 = 136
+    F7 = 137
+    F8 = 138
+    F9 = 139
+    F10 = 140
+    F11 = 141
+    F12 = 142
+    NUM_LOCK = 143
+    NUMPAD_0 = 144
+    NUMPAD_1 = 145
+    NUMPAD_2 = 146
+    NUMPAD_3 = 147
+    NUMPAD_4 = 148
+    NUMPAD_5 = 149
+    NUMPAD_6 = 150
+    NUMPAD_7 = 151
+    NUMPAD_8 = 152
+    NUMPAD_9 = 153
+    NUMPAD_DIVIDE = 154
+    NUMPAD_MULTIPLY = 155
+    NUMPAD_SUBTRACT = 156
+    NUMPAD_ADD = 157
+    NUMPAD_DOT = 158
+    NUMPAD_COMMA = 159
+    NUMPAD_ENTER = 160
+    NUMPAD_EQUALS = 161
+    NUMPAD_LEFT_PAREN = 162
+    NUMPAD_RIGHT_PAREN = 163
+    VOLUME_MUTE = 164
+    INFO = 165
+    CHANNEL_UP = 166
+    CHANNEL_DOWN = 167
+    ZOOM_IN = 168
+    ZOOM_OUT = 169
+    TV = 170
+    WINDOW = 171
+    GUIDE = 172
+    DVR = 173
+    BOOKMARK = 174
+    CAPTIONS = 175
+    SETTINGS = 176
+    TV_POWER = 177
+    TV_INPUT = 178
+    STB_POWER = 179
+    STB_INPUT = 180
+    AVR_POWER = 181
+    AVR_INPUT = 182
+    PROG_RED = 183
+    PROG_GREEN = 184
+    PROG_YELLOW = 185
+    PROG_BLUE = 186
+    APP_SWITCH = 187
+    BUTTON_1 = 188
+    BUTTON_2 = 189
+    BUTTON_3 = 190
+    BUTTON_4 = 191
+    BUTTON_5 = 192
+    BUTTON_6 = 193
+    BUTTON_7 = 194
+    BUTTON_8 = 195
+    BUTTON_9 = 196
+    BUTTON_10 = 197
+    BUTTON_11 = 198
+    BUTTON_12 = 199
+    BUTTON_13 = 200
+    BUTTON_14 = 201
+    BUTTON_15 = 202
+    BUTTON_16 = 203
+    LANGUAGE_SWITCH = 204
+    MANNER_MODE = 205
+    MODE_3D = 206
+    CONTACTS = 207
+    CALENDAR = 208
+    MUSIC = 209
+    CALCULATOR = 210
+    ZENKAKU_HANKAKU = 211
+    EISU = 212
+    MUHENKAN = 213
+    HENKAN = 214
+    KATAKANA_HIRAGANA = 215
+    YEN = 216
+    RO = 217
+    KANA = 218
+    ASSIST = 219
+    BRIGHTNESS_DOWN = 220
+    BRIGHTNESS_UP = 221
+    MEDIA_AUDIO_TRACK = 222
+    SLEEP = 223
+    WAKEUP = 224
+    PAIRING = 225
+    MEDIA_TOP_MENU = 226
+    KEY_11 = 227
+    KEY_12 = 228
+    LAST_CHANNEL = 229
+    TV_DATA_SERVICE = 230
+    VOICE_ASSIST = 231
+    TV_RADIO_SERVICE = 232
+    TV_TELETEXT = 233
+    TV_NUMBER_ENTRY = 234
+    TV_TERRESTRIAL_ANALOG = 235
+    TV_TERRESTRIAL_DIGITAL = 236
+    TV_SATELLITE = 237
+    TV_SATELLITE_BS = 238
+    TV_SATELLITE_CS = 239
+    TV_SATELLITE_SERVICE = 240
+    TV_NETWORK = 241
+    TV_ANTENNA_CABLE = 242
+    TV_INPUT_HDMI_1 = 243
+    TV_INPUT_HDMI_2 = 244
+    TV_INPUT_HDMI_3 = 245
+    TV_INPUT_HDMI_4 = 246
+    TV_INPUT_COMPOSITE_1 = 247
+    TV_INPUT_COMPOSITE_2 = 248
+    TV_INPUT_COMPONENT_1 = 249
+    TV_INPUT_COMPONENT_2 = 250
+    TV_INPUT_VGA_1 = 251
+    TV_AUDIO_DESCRIPTION = 252
+    TV_AUDIO_DESCRIPTION_MIX_UP = 253
+    TV_AUDIO_DESCRIPTION_MIX_DOWN = 254
+    TV_ZOOM_MODE = 255
+    TV_CONTENTS_MENU = 256
+    TV_MEDIA_CONTEXT_MENU = 257
+    TV_TIMER_PROGRAMMING = 258
+    HELP = 259
+    NAVIGATE_PREVIOUS = 260
+    NAVIGATE_NEXT = 261
+    NAVIGATE_IN = 262
+    NAVIGATE_OUT = 263
+    STEM_PRIMARY = 264
+    STEM_1 = 265
+    STEM_2 = 266
+    STEM_3 = 267
+    DPAD_UP_LEFT = 268
+    DPAD_DOWN_LEFT = 269
+    DPAD_UP_RIGHT = 270
+    DPAD_DOWN_RIGHT = 271
+    MEDIA_SKIP_FORWARD = 272
+    MEDIA_SKIP_BACKWARD = 273
+    MEDIA_STEP_FORWARD = 274
+    MEDIA_STEP_BACKWARD = 275
+    SOFT_SLEEP = 276
+    CUT = 277
+    COPY = 278
+    PASTE = 279
+    SYSTEM_NAVIGATION_UP = 280
+    SYSTEM_NAVIGATION_DOWN = 281
+    SYSTEM_NAVIGATION_LEFT = 282
+    SYSTEM_NAVIGATION_RIGHT = 283
+    ALL_APPS = 284
+    
+    # =========================================================================
+    # Aliases for original Android KeyEvent names
+    # =========================================================================
+    # These aliases are provided to maintain compatibility with the original
+    # Android KeyEvent naming convention (AKEYCODE_*). This makes it easier
+    # to reference keys using the same names as in Android documentation.
+    
+    # Numeric key aliases
+    KEYCODE_0 = KEY_0         # '0' key
+    KEYCODE_1 = KEY_1         # '1' key
+    KEYCODE_2 = KEY_2         # '2' key
+    KEYCODE_3 = KEY_3         # '3' key
+    KEYCODE_4 = KEY_4         # '4' key
+    KEYCODE_5 = KEY_5         # '5' key
+    KEYCODE_6 = KEY_6         # '6' key
+    KEYCODE_7 = KEY_7         # '7' key
+    KEYCODE_8 = KEY_8         # '8' key
+    KEYCODE_9 = KEY_9         # '9' key
+    KEYCODE_11 = KEY_11       # '11' key
+    KEYCODE_12 = KEY_12       # '12' key

uiautodev/remote/scrcpy.py

@@ -0,0 +1,177 @@
+import asyncio
+import json
+import logging
+import os
+import socket
+import struct
+from typing import Optional
+
+import retry
+from adbutils import AdbError, Network, adb
+from adbutils._adb import AdbConnection
+from adbutils._device import AdbDevice
+from starlette.websockets import WebSocket, WebSocketDisconnect
+
+from uiautodev.remote.touch_controller import ScrcpyTouchController
+
+logger = logging.getLogger(__name__)
+
+class ScrcpyServer:
+    """
+    ScrcpyServer class is responsible for managing the scrcpy server on Android devices.
+    It handles the initialization, communication, and control of the scrcpy server,
+    including video streaming and touch control.
+    """
+
+    def __init__(self, device: AdbDevice, scrcpy_jar_path: Optional[str] = None):
+        """
+        Initializes the ScrcpyServer instance.
+
+        Args:
+            scrcpy_jar_path (str, optional): Path to the scrcpy server JAR file. Defaults to None.
+        """
+        self.scrcpy_jar_path = scrcpy_jar_path or os.path.join(os.path.dirname(__file__), '../binaries/scrcpy_server.jar')
+        self.device = device
+        self.resolution_width = 0  # scrcpy 投屏转换宽度
+        self.resolution_height = 0  # scrcpy 投屏转换高度
+        
+        self._shell_conn: AdbConnection
+        self._video_conn: socket.socket
+        self._control_conn: socket.socket
+
+        self._setup_connection()
+    
+    def _setup_connection(self):
+        self._shell_conn = self._start_scrcpy_server(control=True)
+        self._video_conn = self._connect_scrcpy(self.device)
+        self._control_conn = self._connect_scrcpy(self.device)
+        self._parse_scrcpy_info(self._video_conn)
+        self.controller = ScrcpyTouchController(self._control_conn)
+
+    @retry.retry(exceptions=AdbError, tries=20, delay=0.1)
+    def _connect_scrcpy(self, device: AdbDevice) -> socket.socket:
+        return device.create_connection(Network.LOCAL_ABSTRACT, 'scrcpy')
+
+    def _parse_scrcpy_info(self, conn: socket.socket):
+        dummy_byte = conn.recv(1)
+        if not dummy_byte or dummy_byte != b"\x00":
+            raise ConnectionError("Did not receive Dummy Byte!")
+        logger.debug('Received Dummy Byte!')
+        device_name = conn.recv(64).decode('utf-8').rstrip('\x00')
+        logger.debug(f'Device name: {device_name}')
+        codec = conn.recv(4)
+        logger.debug(f'resolution_data: {codec}')
+        resolution_data = conn.recv(8)
+        logger.debug(f'resolution_data: {resolution_data}')
+        self.resolution_width, self.resolution_height = struct.unpack(">II", resolution_data)
+        logger.debug(f'Resolution: {self.resolution_width}x{self.resolution_height}')
+
+    def close(self):
+        try:
+            self._control_conn.close()
+            self._video_conn.close()
+            self._shell_conn.close()
+        except:
+            pass
+    
+    def __del__(self):
+        self.close()
+
+    def _start_scrcpy_server(self, control: bool = True) -> AdbConnection:
+        """
+        Pushes the scrcpy server JAR file to the Android device and starts the scrcpy server.
+
+        Args:
+            control (bool, optional): Whether to enable touch control. Defaults to True.
+
+        Returns:
+            AdbConnection
+        """
+        # 获取设备对象
+        device = self.device
+
+        # 推送 scrcpy 服务器到设备
+        device.sync.push(self.scrcpy_jar_path, '/data/local/tmp/scrcpy_server.jar', check=True)
+        logger.info('scrcpy server JAR pushed to device')
+
+        # 构建启动 scrcpy 服务器的命令
+        start_command = (
+            'CLASSPATH=/data/local/tmp/scrcpy_server.jar '
+            'app_process / '
+            'com.genymobile.scrcpy.Server 2.7 '
+            'log_level=info max_size=1024 max_fps=30 '
+            'video_bit_rate=8000000 tunnel_forward=true '
+            'send_frame_meta=false '
+            f'control={"true" if control else "false"} '
+            'audio=false show_touches=false stay_awake=false '
+            'power_off_on_close=false clipboard_autosync=false'
+        )
+        conn = device.shell(start_command, stream=True)
+        logger.debug("scrcpy output: %s", conn.conn.recv(100))
+        return conn # type: ignore
+
+    async def handle_unified_websocket(self, websocket: WebSocket, serial=''):
+        logger.info(f"[Unified] WebSocket connection from {websocket} for serial: {serial}")
+
+        video_task = asyncio.create_task(self._stream_video_to_websocket(self._video_conn, websocket))
+        control_task  = asyncio.create_task(self._handle_control_websocket(websocket))
+        
+        try:
+            # 不使用 return_exceptions=True，让异常能够正确传播
+            await asyncio.gather(video_task, control_task)
+        finally:
+            # 取消任务
+            for task in (video_task, control_task):
+                if not task.done():
+                    task.cancel()
+            logger.info(f"[Unified] WebSocket closed for serial={serial}")
+
+    async def _stream_video_to_websocket(self, conn: socket.socket, ws: WebSocket):
+        # Set socket to non-blocking mode
+        conn.setblocking(False)
+        
+        while True:
+            # check if ws closed
+            if ws.client_state.name != "CONNECTED":
+                logger.info('WebSocket no longer connected. Exiting video stream.')
+                break
+            # Use asyncio to read data asynchronously
+            data = await asyncio.get_event_loop().sock_recv(conn, 1024*1024)
+            if not data:
+                logger.warning('No data received, connection may be closed.')
+                raise ConnectionError("Video stream ended unexpectedly")
+            # send data to ws
+            await ws.send_bytes(data)
+
+    async def _handle_control_websocket(self, ws: WebSocket):
+        while True:
+            try:
+                message = await ws.receive_text()
+                logger.debug(f"[Unified] Received message: {message}")
+                message = json.loads(message)
+
+                width, height = self.resolution_width, self.resolution_height
+                message_type = message.get('type')
+                if message_type == 'touchMove':
+                    xP = message['xP']
+                    yP = message['yP']
+                    self.controller.move(int(xP * width), int(yP * height), width, height)
+                elif message_type == 'touchDown':
+                    xP = message['xP']
+                    yP = message['yP']
+                    self.controller.down(int(xP * width), int(yP * height), width, height)
+                elif message_type == 'touchUp':
+                    xP = message['xP']
+                    yP = message['yP']
+                    self.controller.up(int(xP * width), int(yP * height), width, height)
+                elif message_type == 'keyEvent':
+                    event_number = message['data']['eventNumber']
+                    self.device.shell(f'input keyevent {event_number}')
+                elif message_type == 'text':
+                    text = message['detail']
+                    self.device.shell(f'am broadcast -a SONIC_KEYBOARD --es msg \'{text}\'')
+                elif message_type == 'ping':
+                    await ws.send_text(json.dumps({"type": "pong"}))
+            except json.JSONDecodeError as e:
+                logger.error(f"Invalid JSON message: {e}")
+                continue

uiautodev/remote/touch_controller.py

@@ -0,0 +1,123 @@
+import enum
+import socket
+import struct
+
+from construct import Byte, Int16ub, Int32ub, Int64ub, Struct
+
+from uiautodev.remote.android_input import KeyeventAction, MetaState
+from uiautodev.remote.keycode import KeyCode
+
+
+# https://github.com/Genymobile/scrcpy/blob/master/app/src/control_msg.h#L29
+class MessageType(enum.IntEnum):
+    INJECT_KEYCODE = 0
+    INJECT_TEXT = 1
+    INJECT_TOUCH_EVENT = 2
+    INJECT_SCROLL_EVENT = 3
+    BACK_OR_SCREEN_ON = 4
+    EXPAND_NOTIFICATION_PANEL = 5
+    EXPAND_SETTINGS_PANEL = 6
+    COLLAPSE_PANELS = 7
+    GET_CLIPBOARD = 8
+    SET_CLIPBOARD = 9
+    SET_DISPLAY_POWER = 10
+    ROTATE_DEVICE = 11
+    UHID_CREATE = 12
+    UHID_INPUT = 13
+    UHID_DESTROY = 14
+    OPEN_HARD_KEYBOARD_SETTINGS = 15
+    START_APP = 16
+    RESET_VIDEO = 17
+
+
+TouchEvent = Struct(
+    "type" / Byte,               # SC_CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT
+    "action" / Byte,             # AKEY_EVENT_ACTION_DOWN
+    "pointer_id" / Int64ub,      # 8-byte pointer ID
+    "x" / Int32ub,               # X coordinate
+    "y" / Int32ub,               # Y coordinate
+    "width" / Int16ub,           # width
+    "height" / Int16ub,          # height
+    "pressure" / Int16ub,        # pressure
+    "action_button" / Int32ub,   # action button
+    "buttons" / Int32ub          # buttons
+)
+
+
+# Define the structure for key events
+KeyEvent = Struct(
+    "type" / Byte,               # SC_CONTROL_MSG_TYPE_INJECT_KEYCODE
+    "action" / Byte,             # AKEY_EVENT_ACTION (DOWN, UP, MULTIPLE)
+    "keycode" / Int32ub,         # Android keycode
+    "repeat" / Int32ub,          # Repeat count
+    "metastate" / Int32ub        # Meta state flags (SHIFT, ALT, etc.)
+)
+
+
+class ScrcpyTouchController:
+    """scrcpy控制类，支持scrcpy版本>=2.2"""
+
+    def __init__(self, control_socket: socket.socket):
+        self.control_socket = control_socket
+
+    def _build_touch_event(self, action: int, x: int, y: int, width: int, height: int):
+        x = max(0, min(x, width))
+        y = max(0, min(y, height))
+        return TouchEvent.build(dict(
+            type=MessageType.INJECT_TOUCH_EVENT,
+            action=action,
+            pointer_id=1,
+            x=x,
+            y=y,
+            width=width,
+            height=height,
+            pressure=1,
+            action_button=1, # AMOTION_EVENT_BUTTON_PRIMARY (action button)
+            buttons=1, # AMOTION_EVENT_BUTTON_PRIMARY (buttons)
+        ))
+
+    def down(self, x: int, y: int, width: int, height: int):
+        """发送down操作"""
+        data = self._build_touch_event(0, x, y, width, height)
+        self.control_socket.send(data)
+
+    def up(self, x: int, y: int, width: int, height: int):
+        """发送up操作"""
+        data = self._build_touch_event(1, x, y, width, height)
+        self.control_socket.send(data)
+
+    def move(self, x: int, y: int, width: int, height: int):
+        """发送move操作"""
+        data = self._build_touch_event(2, x, y, width, height)
+        self.control_socket.send(data)
+
+    def text(self, text: str):
+        """发送文本操作"""
+
+        # buffer = text.encode("utf-8")
+        # values = struct.pack(self.format_string, 2, 3, 1, len(buffer), 0, 0, 0, self.const_value,
+        #                      self.unknown1, self.unknown2) + buffer
+        # self.control_socket.send(values)
+        pass
+
+    def key(self, action: KeyeventAction, keycode: KeyCode, repeat: int, metastate: MetaState):
+        """
+        Send a keycode event to the Android device
+        
+        Args:
+            action: Key action (DOWN, UP, or MULTIPLE)
+            keycode: Android key code to send
+            repeat: Number of times the key is repeated
+            metastate: Meta state flags (SHIFT, ALT, etc.)
+        """
+        # Build the data using the KeyEvent structure
+        data = KeyEvent.build(dict(
+            type=MessageType.INJECT_KEYCODE,  # Type byte
+            action=action,                   # Action byte
+            keycode=keycode,                   # Keycode (4 bytes)
+            repeat=repeat,                   # Repeat count (4 bytes)
+            metastate=metastate,        # Meta state (4 bytes)
+        ))
+        
+        # Send the data to the control socket
+        self.control_socket.send(data)

uiautodev/router/device.py

@@ -80,7 +80,8 @@ def make_router(provider: BaseProvider) -> APIRouter:
             else:
                 return Response(content=f"Invalid format: {format}", media_type="text/plain", status_code=400)
         except Exception as e:
-            logger.exception("dump_hierarchy failed")
+            #logger.exception("dump_hierarchy failed")
+            logger.error(f"Error dumping hierarchy: {str(e)}")
             return Response(content=str(e), media_type="text/plain", status_code=500)
     
     @router.post('/{serial}/command/tap')

{uiautodev-0.6.0.dist-info → uiautodev-0.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: uiautodev
-Version: 0.6.0
+Version: 0.7.1
 Summary: Mobile UI Automation, include UI hierarchy inspector, script recorder
 License: MIT
 Author: codeskyblue
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: adbutils (>=2.7.0,<3.0.0)
+Requires-Dist: adbutils (>=2.8.10,<3)
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: construct
 Requires-Dist: fastapi (>=0.111.0,<0.112.0)
@@ -25,8 +25,9 @@ Requires-Dist: poetry (>=1.8.2,<2.0.0)
 Requires-Dist: pydantic (>=2.6,<3.0)
 Requires-Dist: pygments (>=2)
 Requires-Dist: uiautomator2 (>=2)
-Requires-Dist: uvicorn[standard]
+Requires-Dist: uvicorn
 Requires-Dist: wdapy (>=0.2.2,<0.3.0)
+Requires-Dist: websockets (>=10.4)
 Project-URL: Homepage, https://uiauto.dev
 Description-Content-Type: text/markdown
 
@@ -80,7 +81,23 @@ make format
 
 # run server
 make dev
+
+# If you encounter the error NameError: name 'int2byte' is not defined,
+# try installing a stable version of the construct package to resolve it:
+# and restart: make dev
+pip install construct==2.9.45
+
+```
+
+运行测试
+
+```sh
+make test
 ```
 
+# Links
+- https://app.tangoapp.dev/ 基于webadb的手机远程控制项目
+- https://docs.tangoapp.dev/scrcpy/video/web-codecs/ H264解码器
+
 # LICENSE
 [MIT](LICENSE)

{uiautodev-0.6.0.dist-info → uiautodev-0.7.1.dist-info}/RECORD

@@ -1,13 +1,14 @@
-uiautodev/__init__.py,sha256=nCGwaTL1ifIZD9hnH2Gl14g3cUbMyEWFZmTebRCLGrs,164
+uiautodev/__init__.py,sha256=C3uyY7lWpX_Ggw9MkWZQfP13oV4gM2QgBttrO1NQzO0,164
 uiautodev/__main__.py,sha256=0WZHyHW-M7FG5RexANNoIB5pkCX8xwQbTnmaOA9Y1kg,176
-uiautodev/app.py,sha256=U0aDW2dwNEVy5kSBAbTCo2CAVyzaEZrJFBzQsCSoV3c,3215
+uiautodev/app.py,sha256=dzylhfAId-GqjsyQuJznCNzn2NIK9WZ7PsiHhUrazvY,4615
 uiautodev/appium_proxy.py,sha256=yMzPnIDo50hYSaq0g5bXUpgRrFa_849wNa2o7ZpxGNY,1773
+uiautodev/binaries/scrcpy_server.jar,sha256=ojxWWfNsJg8QXAItJ7yz6v_6JgcOe6qe2mbQE3ehrbo,71200
 uiautodev/case.py,sha256=Jk2_5X2F-XIPnGuYTCqOVQiwwchwOhF7uKK5oKv5shg,3919
-uiautodev/cli.py,sha256=K4CEvGJSDWLAFR5tvls2Qp4evQ2lApLoUxA-4DI2-Sc,6235
+uiautodev/cli.py,sha256=nqxVTaNkItIN5REGEgVPFr0JWxPmeIPz_tZvFQNU7Jc,5442
 uiautodev/command_proxy.py,sha256=C9z-dITMED4k5na45NMdEWAXlLh3Ll921mKuefFyk78,5226
 uiautodev/command_types.py,sha256=pWdnCS4FRnEIiR1ynd4cjXX8zeFndjPztacBlukt61E,1761
 uiautodev/common.py,sha256=1A0kXfxVrp_i5mc_aRjuqSDWFFZ7DwZR9qpRLu2GMMg,1488
-uiautodev/driver/android.py,sha256=LOOF2d7Fg8crzA7G0rjBMQ63PQlCtLNCWfR20YEhrSE,6394
+uiautodev/driver/android.py,sha256=ZdgMkcoyqleibHbPeg-9bDnpFx3KHBnQxhLZlnKOmbE,6344
 uiautodev/driver/appium.py,sha256=U3TGpOXmu3tEa3E1ttTFoXehOfFyjavJQ3XA4CtqeBE,5308
 uiautodev/driver/base_driver.py,sha256=neoVS9T8MN5RXvW6vvqXSc6pcBW_fqujJurjUrlt0OA,2816
 uiautodev/driver/harmony.py,sha256=93pwlg04wazey8MQM6DEvcBkr52REYVw4bwz321fK38,8031
@@ -18,16 +19,20 @@ uiautodev/driver/udt/appium-uiautomator2-v5.12.4-light.apk,sha256=cKUVKpqEiGRXOD
 uiautodev/driver/udt/udt.py,sha256=p6opbUtYxEGTINIX83F6m2CtzB42iSSBYRv1SjXCEFg,8351
 uiautodev/exceptions.py,sha256=TuRD5SWQk5N2_KjrcDuXG_p84LBhLa2QEEXyFNFm0yQ,465
 uiautodev/model.py,sha256=hziSYyh7ufaKbQrMmRMcIVeZ0x-pwkLMHljrI-qu184,950
-uiautodev/provider.py,sha256=oElv04fsxrBBBm1FZ6VyNqquSQbhJXD25ApC7UgDsVI,2862
-uiautodev/router/device.py,sha256=GHW83L63MxnjAEmTwhpetGatiu8iO0AOYr74UyFuF24,4835
+uiautodev/provider.py,sha256=EnBI8PD2eoBjqugGS5cmy8GZ1Z7EaEF6YEQSfpOMN6s,2862
+uiautodev/remote/android_input.py,sha256=r9y2SxnDw0GhN44emL-2Nz0UasaVaVtzh53hd-LJ710,2445
+uiautodev/remote/keycode.py,sha256=RHSJVfcNY2pelQd7_tcE6T0j3n8CKBkiku7A2AJZUpk,8097
+uiautodev/remote/scrcpy.py,sha256=Iagm9RrdB67KC2fkyyzpCeHYT0VMSQhoBEks1R_bXpo,7380
+uiautodev/remote/touch_controller.py,sha256=dYl5XTLaYEyZiNJmKwHQpw9QhPSkN3iUetJSaiQJBHg,4255
+uiautodev/router/device.py,sha256=zYrxjVGjrz7Jw8G9KNO0su22OIiQDuuSHBDBDpC1PG8,4899
 uiautodev/router/xml.py,sha256=MKVLhjMBqE4qbEraQxvdrVp_OBnylEL9Wti5lnmBDk4,891
 uiautodev/static/demo.html,sha256=qC7qUZP5Af9T3V5EuFGbovzv8mArwiGMWsX_vcs_Bt0,1240
 uiautodev/utils/common.py,sha256=L1qBBBS6jRgkXlGy5o6Xafo49auLXKRWyX9x8U_IKjc,4821
 uiautodev/utils/envutils.py,sha256=Clyt2Hz9PXpK_fT0yWbMmixXyGvCaJO3LAgamM7aUVc,197
 uiautodev/utils/exceptions.py,sha256=lL_G_E41KWvfXnl32-E4Vgr3_HyTboxq_EwzdQMuvK4,637
 uiautodev/utils/usbmux.py,sha256=LYupLDn7U4KFKhYQJrmIroS-3040gqZQVDRDB_FNDJM,17386
-uiautodev-0.6.0.dist-info/LICENSE,sha256=RyeW676gBYO7AVVP2zQgfEx5rPSt46vR47xXZe7TlX4,1068
-uiautodev-0.6.0.dist-info/METADATA,sha256=BmJOpByP-LzY61Q5-DUfH7eq3VnIXSHZ1viCbbCK4Qs,2373
-uiautodev-0.6.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-uiautodev-0.6.0.dist-info/entry_points.txt,sha256=zBY8GgseYAAzPFA5Cf4rCCS9ivdyWsNxMVVYIaGAHJU,88
-uiautodev-0.6.0.dist-info/RECORD,,
+uiautodev-0.7.1.dist-info/LICENSE,sha256=RyeW676gBYO7AVVP2zQgfEx5rPSt46vR47xXZe7TlX4,1068
+uiautodev-0.7.1.dist-info/METADATA,sha256=r50rNe8RnSTSsyAECW_HFmH_FwScV1CKwpucBJ9yuds,2776
+uiautodev-0.7.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+uiautodev-0.7.1.dist-info/entry_points.txt,sha256=zBY8GgseYAAzPFA5Cf4rCCS9ivdyWsNxMVVYIaGAHJU,88
+uiautodev-0.7.1.dist-info/RECORD,,

{uiautodev-0.6.0.dist-info → uiautodev-0.7.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any