翻译

中文 | 英文-GPT

android-bot

android-bot 是基于 AutoBot 得 JavaScript SDK，同时支持 浏览器环境 和 Node 环境，Node 环境下，支持自动扫描局域网客户端

NPM| Github| AutoBot 文档

目前已经实现了什么功能 API？

• 获取系统信息（型号信息，硬件信息...）
• 屏幕图像（支持 jpg，base64，支持 websocket 实时输出）
• 触控输入（单指手势，多指手势，支持 websocket 实时输入）
• 按键输入（按键模拟，文字输入，支持中文）
• 屏幕布局（支持 XML，JSON）
• 文件管理（上传，查询，删除）
• 剪切板管理（读取和修改）
• 应用管理（安装，卸载，清除数据，启动停止，详情查看）
• 联系人管理 (增删改查)
• 录制屏幕，熄屏控制，播放音乐，短信查询等
• 通知监听，剪切板监听等

成功案例

• Tntok 投屏（一个可以脱离 adb 的投屏工具）

相关案例

• AutoJS PC 版（一键自动化生成 autox.js 代码）
• Autox.js-集成 autobot 版本（不用无障碍实现自动化）

它可以用来干什么？

• 局域网内无线投屏/实时控制,按键模拟，录制屏幕，布局分析，文件管理，应用管理，通讯录管理
• 通过 NodeJS，Python，Java，C++等语言，只需要调用 Http Api，即可开发譬如：远程投屏控制，自动化测试，自动化运营、批量处理、机器人、自动回复等等

支持浏览器和 NodeJS 环境

在 Node 环境下，支持局域网的网络发现，能自动扫描同个局域网下的设备， 在浏览器环境下，则需要获取设备的 ip 和端口，手动连接

使用方法

准备工作

需要设备安装 AutoBot APP，且成功运行服务，具体可以参考AutoBot 官网->准备工作部分

重要的事情说三遍：

• 此库是基于 AutoBot 官方 Http API 和 WebSocket API 封装，请你务必先仔细阅读AutoBot 文档
• 此库是基于 AutoBot 官方 Http API 和 WebSocket API 封装，请你务必先仔细阅读AutoBot 文档
• 此库是基于 AutoBot 官方 Http API 和 WebSocket API 封装，请你务必先仔细阅读AutoBot 文档

安装支持库

npm i android-bot -s

浏览器内使用

• 浏览器环境下由于不支持 udp，需要主动创建设备

//引入库
import { BrowserWebSocket, Device } from "android-bot";

async function main() {
  //创建一个设备，设备的ip和端口来源于AutoBot APP，此处需要修改为你自己设备的ip和端口
  const device = new Device("192.168.1.100:18080");
  //获取屏幕信息
  let iScreenInfo = await device.screenInfo();
  //获取屏幕截图
  let screenImg = await device.screenShot();
  //获取系统信息
  let iDeviceInfo = await device.getSystemInfo();
  //获取屏幕ui布局的JSON格式
  let iuiObjectJSON = await device.screenJson();
  //获取屏幕ui布局的XML格式，可以使用
  let iuiObjectXML = await device.screenXml();
  //手势滑动（左滑）
  await device.gesture({
    duration: 200,
    points: [
      { x: 168, y: 558 },
      { x: 172, y: 562 },
      { x: 276, y: 562 },
      { x: 306, y: 560 },
      { x: 348, y: 552 },
      { x: 390, y: 548 },
      { x: 442, y: 540 },
      { x: 470, y: 540 },
      { x: 500, y: 538 },
      { x: 520, y: 538 },
      { x: 548, y: 538 },
      { x: 566, y: 538 },
      { x: 596, y: 540 },
    ],
  });
  //....
}

main();

Node 使用

• Node 环境下，可以使用 AdbDevice 扫描局域网内的设备

import { AdbDevice, NodeWebSocket, Device } from "android-bot";
import FormData from "form-data";
import fs from "fs";
async function main() {
  //node环境下可以自动扫描局域网内的设备
  const devices = await AdbDevice.listWifiDevices();
  if (devices[0]) {
    let device = devices[0];
    //使用Node环境下的websocket client
    device.setWebSocketClient(new NodeWebSocket());
    let mScreenControl = device.mScreenControl;
    //监听屏幕方向发生改变的消息
    mScreenControl.addScreenOrentationChangeListener(function (
      width,
      height,
      rotation,
      isLandscape
    ) {
      console.log(
        "屏幕发生改变:" +
          `宽度：${width},高度：${height},是否横屏:${isLandscape},方向:${rotation}`
      );
    });
    //获取屏幕截图
    let screenImg = await device.screenShot();
    //获取系统信息
    let iDeviceInfo = await device.getSystemInfo();
    console.log(iDeviceInfo);
    //获取屏幕ui布局的JSON格式
    let iuiObject = await device.screenJson();
  }
}

main();

实时屏幕图像

//引入库
import { BrowserWebSocket, Device } from "android-bot";

async function main() {
  //创建一个设备，设备的 ip 和端口来源于 AutoBot APP
  const device = new Device("192.168.7.119:18080");

  //如果你需要实时；投屏控制（实时屏幕 jpg 图像流，实时触摸文本输入），通知监听，剪切板监听
  //那么你需要设置 websocket client，Node 环境下使用 NodeWebSocket，浏览器环境下你需要使用 BrowserWebSocket
  //mScreenControl 为实时信息的代理对象，你可以用来监听屏幕图像，通知，剪切版信息
  device.setWebSocketClient(new BrowserWebSocket());

  //接收到新的通知信息
  device.mScreenControl.addNotificationChangeListener(function (
    notificationMessage
  ) {
    console.log("接收到新的通知：", notificationMessage);
  });

  //接收到剪切板发生改变的信息
  device.mScreenControl.addClipTextChangeListener(function (text) {
    console.log("接收到粘贴板发生改变通知：", text);
  });

  //实时的屏幕图像回调，注意浏览器环境下 img 为 Blob，Node 环境下为 arrayBuffer
  device.mScreenControl.addScreenChangeListener(function (screenImg) {
    console.log("接收到新的屏幕图像：", screenImg);
  });

  //弱网环境下使用被动式屏幕帧，网络好的情况下可以使用主动式获取屏幕图像帧；
  //只有调用了下边2种方法，屏幕图像的回调才能收到消息
  //device.mScreenControl.startScreenStream();//主动式
  device.mScreenControl.startScreenStreamByPassive(); //被动式
}

main();

更多案例

核心类

Device

ScreenControl

FAQ

我使用了实例代码，为什么代码报错？

由于 Node 环境默认是不支持 websocket 的，需要通过第三方库来实现 WebSocket，因此 Node 环境下的 WebSocket 和浏览器环境下的 WebSocket 有少许不一样

• 因此，如果你的代码在浏览器环境运行请导入 BrowserWebSocket，在 Node 环境下请导入 NodeWebSocket，另外请一定不要导入多余的对象，比如在浏览器环境下错误的导入了 AdbDevice，NodeWebSocket

• Node 导入示例

import { AdbDevice, NodeWebSocket, Device } from "android-bot";

• 浏览器导入示例

import { BrowserWebSocket, Device } from "android-bot";

有些方法的参数我还是有疑问？

android-bot是对 AutoBot 的 Http API 和 WebSocket API 的封装，你可以查看对应的AutoBot 官

二次开发

获取代码

git clone https://github.com/automan-bot/android-bot.git
npm i

NPM scripts

• demo_browser:运行浏览器 demo
• demo_node:运行 Node 环境下 demo
• dev: 以监听模式监听 src/的文件改变，在 dist 下生成新的 Node 环境编译包
• dev:browser:以监听模式监听 src/的文件改变，在 dist 下生成浏览器环境编译包
• build : 编译生成 Node 环境和浏览器环境的编译包
• clean : 清空/dist 目录