accbotTsSdk 文档站accbotTsSdk 文档站
  • 快速接入
  • 运行模式与权限
  • Tauri 桌面工具使用说明
  • Demo 与示例工程
  • 常见问题
  • SDK 模块概览
  • App 模块
  • Auth 模块
  • Acc 模块
  • File 模块
  • Input 模块
  • Shell 模块
  • OCR 模块
  • OpenCV 模块
  • 扩展能力
API 索引
常见问题
Source
  • 快速接入
  • 运行模式与权限
  • Tauri 桌面工具使用说明
  • Demo 与示例工程
  • 常见问题
  • SDK 模块概览
  • App 模块
  • Auth 模块
  • Acc 模块
  • File 模块
  • Input 模块
  • Shell 模块
  • OCR 模块
  • OpenCV 模块
  • 扩展能力
API 索引
常见问题
Source
  • 使用指南

    • 快速接入
    • 运行模式与权限
    • Tauri 桌面工具使用说明
    • Demo 与示例工程
    • 常见问题

快速接入

本页面向第一次接入 @accbot/accbot_sdk 的第三方开发者,说明最基本的安装、连接与调用流程。

1. 安装依赖

npm install @accbot/accbot_sdk @accbot/muxws

当前文档对应的 SDK 包信息见 accbotTsSdk/package.json:

  • 包名:@accbot/accbot_sdk
  • 当前版本:1.0.49

2. 了解运行前提

accbotTsSdk 通过双通道 WebSocket 与设备侧服务通信。常见前提如下:

  • 设备侧服务已启动
  • 可以访问设备的 wsSys / wsApp 通道
  • 目标设备已经完成必要权限授予
  • 调用无障碍、OCR、输入法等能力前,对应权限已开启

如果你是在 Node.js 环境下使用 SDK,需要额外补齐浏览器兼容对象(如 window、document、Image、WebSocket)。项目中的 test/test-all.mjs、test/test-toJson.mjs 就是现成参考。

3. 创建连接

典型流程是:

  1. 创建 wsSys 连接
  2. 创建 wsApp 连接
  3. 用两个连接构造 InitConfig
  4. 创建 AccAndroid 实例
  5. 等待 onAppAndSysCreate 回调后再开始调用模块方法
import { WsConn, SendInterface } from '@accbot/muxws/dist/index.js'
import {
  AccAndroid,
  InitConfig,
  RunModel,
} from '@accbot/accbot_sdk/dist/index.mjs'

const sysWs = new WebSocket('ws://127.0.0.1:19011/wsSys')
const sysWsConn = new WsConn(sysWs)
const sysSendInterface = new SendInterface(sysWsConn)

const appWs = new WebSocket('ws://127.0.0.1:19011/wsApp')
const appWsConn = new WsConn(appWs)
const appSendInterface = new SendInterface(appWsConn)

const config = new InitConfig(
  RunModel.model_adb,
  appSendInterface,
  sysSendInterface,
)
const android = new AccAndroid(config)

await new Promise((resolve) => {
  android.onAppAndSysCreate(() => resolve(true))
})

4. 第一次调用建议

建立连接后,先调用这些低风险接口确认链路正常:

const deviceInfo = await android.app.getDeviceInfo()
const accOk = await android.auth.openAccessibilityService(false)
const fileOk = await android.auth.openAllFile(false)

console.log(deviceInfo.packName, accOk, fileOk)

建议顺序:

  • android.app.getDeviceInfo():确认 SDK 与设备通信正常
  • android.auth.openAccessibilityService(false):确认无障碍状态
  • android.auth.openAllFile(false):确认文件权限状态
  • 再进入节点、输入、OCR 等模块能力

5. 下一步看哪里

  • 想了解运行模式和常见权限:看 运行模式与权限
  • 想按模块查 API:看 SDK 模块文档
  • 想快速找某个方法:看 API 索引
在 GitHub 上编辑此页
上次更新: 2026/4/2 11:26
贡献者: 胖鱼, Claude Opus 4.6
Next