Skip to content

Commit

Permalink
add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
yume-chan committed Aug 25, 2023
1 parent dae4dcd commit 740086d
Show file tree
Hide file tree
Showing 12 changed files with 83 additions and 10 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion apps/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"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"
}
10 changes: 10 additions & 0 deletions common/changes/@yume-chan/adb/main_2023-08-25-21-49.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/adb",
"comment": "Add typed errors for `framebuffer` command when current app disables screen capture",
"type": "none"
}
],
"packageName": "@yume-chan/adb"
}
10 changes: 10 additions & 0 deletions common/changes/@yume-chan/adb/main_2023-08-25-21-50.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"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"
}
10 changes: 10 additions & 0 deletions common/changes/@yume-chan/adb/main_2023-08-25-21-51.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/adb",
"comment": "Add `recursive` and `force` options to `rm` method, allow deleting folders",
"type": "none"
}
],
"packageName": "@yume-chan/adb"
}
10 changes: 10 additions & 0 deletions common/changes/@yume-chan/android-bin/main_2023-08-25-21-49.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/android-bin",
"comment": "Add support to stop `bugreport`",
"type": "none"
}
],
"packageName": "@yume-chan/android-bin"
}
10 changes: 10 additions & 0 deletions common/changes/@yume-chan/android-bin/main_2023-08-25-21-50.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@yume-chan/android-bin",
"comment": "Merge `bugreport` and `bugreportz` wrappers, providing an `automatic` method to choose the best available bugreport method",
"type": "none"
}
],
"packageName": "@yume-chan/android-bin"
}
2 changes: 1 addition & 1 deletion common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion common/config/rush/repo-state.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
{
"pnpmShrinkwrapHash": "a5141c6066b3d19a36bfe08201796dd2828a4130",
"pnpmShrinkwrapHash": "8baf2e2e007bb49d5230ce1eded20db5d82dd1ff",
"preferredVersionsHash": "bf21a9e8fbc5a3846fb05b4fa0859e0917b2202f"
}
3 changes: 1 addition & 2 deletions libraries/adb-server-node-tcp/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "@yume-chan/adb-server-node-tcp",
"private": true,
"version": "0.0.19",
"version": "0.0.20",
"description": "ADB server connection for `@yume-chan/adb` using Node.js' `net` module",
"keywords": [
"adb",
Expand Down
4 changes: 3 additions & 1 deletion rush.json
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,9 @@
},
{
"packageName": "@yume-chan/adb-server-node-tcp",
"projectFolder": "libraries/adb-server-node-tcp"
"projectFolder": "libraries/adb-server-node-tcp",
"shouldPublish": true,
"versionPolicyName": "adb"
},
{
"packageName": "@yume-chan/adb-cli",
Expand Down

0 comments on commit 740086d

Please sign in to comment.