add changelog (740086d2) · Commits · e / tools / webadb

README.md

+16 −4

Original line number	Diff line number	Diff line
		@@ -2,21 +2,33 @@

		[![MIT license](https://img.shields.io/github/license/yume-chan/ya-webadb)](https://github.com/yume-chan/ya-webadb/blob/main/LICENSE)

		A library and application for browsers to interact with Android devices via ADB.
		A library and a Web app that allow browsers to interact with Android devices via ADB (Android Debugging Protocol).

		All features are working on Chrome for Android, use a C-to-C cable or run WebSockify in Termux to connect.
		All features work on Chrome for Android, use a C-to-C (or OTG) cable or via WebSockify running in Termux (see [compatibility table](#compatibility) below).

		[🚀 Online Demo](https://yume-chan.github.io/ya-webadb)
		[🚀 Web App](https://tango-web-mu.vercel.app/) \| [Old demo](https://yume-chan.github.io/ya-webadb)

		For USB connection, close Google ADB (Run `adb kill-server` in a terminal or close `adb.exe` from Task Manager) and all programs that may use ADB (e.g. Android Studio, Visual Studio, Godot Editor, etc.) before connecting.

		## Working Modes

		### Direct Connection Mode

		In this mode, Google ADB is not required for this library to communicate with Android devices (in fact, Google ADB must not be running in order to use this mode).

		This mode is suitable for running on end-users' devices where Google ADB is not installed, or on mobile devices where Google ADB is not available.

		### Google ADB Client Mode

		In this mode, this library talks to a Google ADB server, which is either running on the same machine or on a remote machine. This allows other ADB-based tools to work alongside this library.

		## Compatibility

		\| Connection \| Chromium-based Browsers \| Firefox \| Node.js \|
		\| ----------------------------------------- \| ------------------------------ \| --------- \| ----------------------------- \|
		\| USB cable \| Supported using [WebUSB] API \| No \| Supported using `usb` package \|
		\| Wireless through [WebSocket] <sup>1</sup> \| Supported \| Supported \| Possible using `ws` package \|
		\| Wireless through TCP \| WIP using [Direct Sockets] API \| No \| Possible using `net` module \|
		\| Wireless through TCP \| Waiting for [Direct Sockets] API \| No \| Possible using `net` module \|

		[webusb]: https://wicg.github.io/webusb/
		[websocket]: https://websockets.spec.whatwg.org/

apps/cli/package.json

+1 −1

Original line number	Diff line number	Diff line
		@@ -32,7 +32,7 @@
		},
		"dependencies": {
		"@yume-chan/adb": "workspace:^0.0.20",
		"@yume-chan/adb-server-node-tcp": "workspace:^0.0.19",
		"@yume-chan/adb-server-node-tcp": "workspace:^0.0.20",
		"@yume-chan/android-bin": "workspace:^0.0.20",
		"@yume-chan/stream-extra": "workspace:^0.0.20",
		"commander": "^10.0.1",

common/changes/@yume-chan/adb-credential-web/main_2023-08-25-21-49.json

0 → 100644

+10 −0

Original line number	Diff line number	Diff line
		{
		"changes": [
		{
		"packageName": "@yume-chan/adb-credential-web",
		"comment": "Change to save private keys in IndexedDB, allow usage from Web Workers",
		"type": "none"
		}
		],
		"packageName": "@yume-chan/adb-credential-web"
		}

common/changes/@yume-chan/adb/main_2023-08-25-21-49.json

0 → 100644

+10 −0

Original line number	Diff line number	Diff line
		{
		"changes": [
		{
		"packageName": "@yume-chan/adb",
		"comment": "Add typed errors for `framebuffer` command when current app disables screen capture",
		"type": "none"
		}
		],
		"packageName": "@yume-chan/adb"
		}

common/changes/@yume-chan/adb/main_2023-08-25-21-50.json

0 → 100644

+10 −0

Original line number	Diff line number	Diff line
		{
		"changes": [
		{
		"packageName": "@yume-chan/adb",
		"comment": "Change `AdbDaemonTransport` class to automatically close the connection, unless the new `preserveConnection` option is `true`",
		"type": "none"
		}
		],
		"packageName": "@yume-chan/adb"
		}