API 手册

版本号：v3.3.2.0

API连接方式

支持三种连接方式，可以使用熟悉的程序语言操作，也能通过Ai快速生成脚本

WebSocket访问

地址：ws://127.0.0.1:50001/
参数：JSON格式

示例：打开WebSocketKing网站，发送json请求执行api功用

img

HTTP GET访问

地址：http://127.0.0.1:65001/?type=post
参数：url网址拼接

示例：打开任意浏览器，输入包含api参数的网址执行api功用

img

HTTP POST访问

地址：http://127.0.0.1:65001/
参数：JSON格式

示例：打开Brunot工具，POST方式发送json请求执行api功用

img

综合JavaScript语言示例

运行环境：html网页或vscode里执行

img

通用参数说明

执行请求：jsons格式

{
  "id": "id123",            // 必填，自己起个名字，方便识别这个命令
  "num": "3,7-12,15,",      //操作的设备号，all=所有设备,多个编号用英文逗号(,)分开，连续编号用英文短线(-)表示; 设备号和分组二选一
  "group": "组1,组2,组5",   //操作的设备分组名，all=所有组; 设备号和分组二选一
  "cmd": "输入文本 123"     //具体要执行的命令
}

执行请求：url网址拼接格式

//在访问网址后面拼接上json格式里的内容
http://127.0.0.1:65001/?id=id123&num=2,3&cmd=StartApp com.android.settings

响应结果：jsons格式

{
  "id": "id123",     //对应id请求的结果
  "msg": "success",  //执行状态，success=已执行，由于投屏的特殊性，执行结果正确性需要另外检测判断；failed =请求格式不正确或执行异常
  "data":"300,500"   //返回执行获取的数据，没数据时为空
}

API功能及示例

启动app

描述：启动app

命令：StartApp 参数 1/参数 2

  • 参数 1：要启动app的包名
  • 参数 2：要启动app的Activity名

操作数量：单个或多个

返回结果：返回执行状态，无返回数据

⚠️ 提示：包名和Activity名可以先运行指定的APP, 然后在软件画面窗口标题上右键，选菜单【查看设备信息】或【设备应用管理】，两处显示activity可能不同，如果其中一种启动失败，可以尝试另一种

// 请求
{
  "id": "id123",  
  "num": "2,3",     
  "cmd": "StartApp com.android.settings/com.android.settings.homepage.SettingsHomepageActivity" //启动设置
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":""          //无返回数据

}

停止app

描述：停止app

命令：StopApp 参数 1

  • 参数 1：要停止app的包名

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

⚠️ 提示：包名在软件画面窗口标题上右键，选菜单的【设备应用管理】查看

// 请求
{
  "id": "id123", 
  "num": "2,3",                         
  "cmd": "StopApp com.android.settings" //关闭设置
}

点击

描述：点击一个坐标位置

命令：click 参数 1,参数 2

  • 参数 1：X坐标
  • 参数 2：Y坐标

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

// 请求
{
  "id": "id123", 
  "num": "2,3",         
  "cmd": "click 50,250" //点击坐标x=50,y=250
}

滑动（拖动）

描述：滑动屏幕或拖动

命令：swipe 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6

  • 参数 1：起点X坐标
  • 参数 2：起点Y坐标
  • 参数 3：终点X坐标
  • 参数 4：终点Y坐标
  • 参数 5：滑动的时间，单位毫秒；滑动时间过长相当于长按，长按后变成拖动

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

// 请求
{
  "id": "id123",
  "num": "2,3",                      
  "cmd": "swipe 50,250,500,250,600"  //在600毫秒内,从50，250位置滑动到500,250
}

滚动

描述：滚动页面，需要页面支持滚动

命令：scroll 参数1,参数2,参数3,参数4,参数5

  • 参数 1：滚动X坐标
  • 参数 2：滚动Y坐标
  • 参数 3：动方向
  • [x] 1=前进;
  • [x] -1=后退;
  • 参数 4：滚动轴向
  • [x] v=垂直滚动;
  • [x] h=水平滚动;
  • 参数 5：滚动次数

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

// 请求
//示例：在坐标50,250位置垂直向前滚动10次
{
  "id": "id123",
  "num": "2,3",                  
  "cmd": "scroll 50,250,1,v,10"  //在坐标50,250位置垂直向前滚动10次
}

输入文本

描述：在焦点位置输入文字内容

命令：setText 参数1

  • 参数 1：要输入的内容，\r 表示换行

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

// 请求
//示例：在指定位置输入abcd
{
  "id": "id123",
  "num": "2,3",           
  "cmd": "setText abcd"   //输入abcd
}

执行脚本

描述：执行的脚本是在【脚本管理器】保存的脚本，类型包括中控脚本、autojs 脚本和 easyclick 脚本

命令：RunScript 参数1

  • 参数 1：要执行的脚本名称

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

// 请求
{
  "id": "id123",
  "num": "2,3",             
  "cmd": "RunScript test1"  //执行名称为test1的脚本
}

执行脚本文件

描述：执行电脑上的脚本文件，类型需要和软件支持的类型配套，包括autojs 脚本和 easyclick 脚本

命令：RunScriptFile 参数1

  • 参数 1：要执行的脚本文件

操作设备数量：单个或多个

返回结果：返回执行状态，无返回数据

// 请求
{
  //示例：执行d盘里“脚本3.js”文件的脚本
  "id": "id123",
  "num": "2,3",                        //操作2号和3号设备
  "cmd": "RunScriptFile d:\\脚本3.js"  //执行d盘里“脚本3.js”的脚本文件
}

adb命令

描述：执行 adb 命令

命令：完整 adb 命令

  • 参数 1：要执行的 adb

操作设备数量：单个或多个,all=全部

返回结果：返回执行状态，并返回 adb 命令的数据

// 请求
{
  //执行adb devices命令
  "id": "id123",
  "num": "all",         
  "cmd": "adb devices"  //执行adb devices命令
}

设备截屏文件格式

描述：截取设备屏幕上的高清原图

命令：ImgScreenCapture 参数 1,参数 2

  • 参数 1：截屏保存位置，如 d:\cls\a，保存时自动加上后缀,保存文件名为 d:\cls\a.png
  • 参数 2：是否自动添加设备编号(如 a1.png)
  • [x] true=添加;
  • [x] false=不添加;

操作设备数量：单个或多个,参数2设置成false时单个有效

返回结果：返回执行状态，无返回数据

// 请求
{
  "id": "id123",
  "num": "2,3",                              
  "cmd": "ImgScreenCapture d:\\cls\\a,true"  //截屏的片保存在d:\cls文件夹，文件名为a2.png a3.png
}

设备截屏Base64格式

描述：截取设备屏幕上的高清原图

命令：ImgCaptureScreenBase64 参数 1,参数 2,参数 3,参数 4,参数 5

  • 参数 1：查找范围左上角 X 坐标
  • 参数 2：查找范围左上角 Y 坐标
  • 参数 3：查找范围右下角 X 坐标
  • 参数 4：查找范围右下角 Y 坐标
  • 参数 5：指定返回的图片格式：jpg、png、bmp

操作设备数量：单个

返回结果：返回经过Gzip压缩后的图片Base64编码数据(不含前缀"data:image/jpg;base64,")

// 请求
{
  "id": "id123",
  "num": "2",                                  
  "cmd": "ImgCaptureScreenBase64 0,0,0,0,jpg"  //返回2号设备截图
}

//响应
{
  "id": "id123",
  "msg": "success",  "data":"H4sIAAAAAAAACuz817LzSpckCD4QxgxazVrch9HqkIH9peQB5AHkAeQB5AHkAeQB5AHkAB5AHkAeQB5AHkAeQB54NvzACnc//gBnlpFGXaeAAA="  //返回的图片数据
}

快速设备截屏文件格式

⚠️ 提示：需要在软件设置中把【系统设置 - 硬件加速 - 画面加速模式】设为【加速模式2】

描述：截取设备在电脑屏幕显示的画面，画面清晰度与小图画面分辨率有关

命令：FastImgScreenCapture 参数 1,参数 2

  • 参数 1：截屏保存位置，如 d:\cls\a，保存时会自动加上后缀,保存文件名为 d:\cls\a.png
  • 参数 2：否自动添加设备编号(如 a1.png)
  • [x] true=添加;
  • [x] false=不添加;

操作设备数量：单个或多个,参数2设置成false时单个有效

返回结果：返回执行状态，无返回数据

// 请求
{
  "id": "id123",
  "num": "2,3",                                  
  "cmd": "FastImgScreenCapture d:\\cls\\a,true"  //示例：截屏图片保存在d:\cls文件夹，文件名为a2.png a3.png
}

快速设备截屏Base64格式

⚠️ 提示：需要在软件设置中把【系统设置 - 硬件加速 - 画面加速模式】设为【加速模式2】

描述：截取设备在电脑屏幕显示的画面，画面清晰度与小图画面分辨率有关

命令：FastImgCaptureScreenBase64 参数 1,参数 2,参数 3,参数 4,参数 5

  • 参数 1：查找范围左上角 X 坐标
  • 参数 2：查找范围左上角 Y 坐标
  • 参数 3：查找范围右下角 X 坐标
  • 参数 4：查找范围右下角 Y 坐标
  • 参数 5：指定返回的图片格式：jpg、png、bmp

操作设备数量：单个

返回结果：返回经过Gzip压缩后的图片Base64编码数据(不含前缀"data:image/jpg;base64,")

// 请求
{
  "id": "id123",
  "num": "2",                                      
  "cmd": "FastImgCaptureScreenBase64 0,0,0,0,jpg"  //返回2号设备截图
}

响应

{
  "id": "id123",
  "msg": "success",  "data":"H4sIAAAAAAAACuz817LzSpckCD4QxgxazVrch9HqkIH9peQB5AHkAeQB5AHkAeQB5AHkAB5AHkAeQB5AHkAeQB54NvzACnc//gBnlpFGXaeAAA="  //返回的图片数据
}

保存界面元素

描述：保存界面 UI 元素

命令：UiSaveXml 参数 1,参数 2

  • 参数 1：UI元素文件保存位置，如 d:\cls\a，保存时会自动加上后缀,保存文件名为 d:\cls\a.xml
  • 参数 2：否自动添加设备编号(如 a1.xml)
  • [x] true=添加;
  • [x] false=不添加;

操作设备数量：单个或多个,参数2设置成false时单个有效

返回结果：返回执行状态，无返回找值

// 请求
{
  "id": "id123",
  "num": "2,3",
  "cmd": "UiSaveXml d:\\cls\\a,true" //xml内容保存在d:\cls文件夹，文件名为a2.xml a3.xml
}

查找单个元素

描述：根据 xpath 表达式查找元素，找后可点击

命令：UiFindElement 参数 1,,参数 2,,参数 3,,参数 4,,参数 5,,参数 6,,参数7

  • 参数 1：xpath 表达式，如"//node[@text='hello']"
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;
  • 参数 7：返回类型
  • [x] point=返回指定元素坐标;
  • [x] node=返回指定元素所有属性;
  • [x] nodes=返回指定元素及子所有属性;

操作设备数量：单个

返回结果：返回执行状态，并且返回指定类型,没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "UiFindElement //node[@text='hello'],,0,,0,,0,,0,,true,,point"  //全屏查找内容为hello的第一个元素，找到就点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30"     //返回找到的坐标
}

查找多个元素

描述：根据 xpath 表达式查找元素

命令：UiFindElements 参数 1,,参数 2,,参数3

  • 参数 1：是否过滤空掉空文本的元素
  • [x] true=过滤;
  • [x] false=不过滤;
  • 参数 2：xpath 表达式，如"//node[@text='hello']"
  • 参数 3：返回类型
  • [x] point=返回指定元素坐标;
  • [x] node=返回指定元素所有属性;
  • [x] nodes=返回指定元素及子所有属性;

操作设备数量：单个

返回结果：返回执行状态，返回指定类型，多个坐标用双分号";"分隔，没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "UiFindElements true,,//node[@text='hello']"  //查找所有内容为hello的元素
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30,,100,110"  //返回找到的2个坐标
}

查找颜色

描述：从设备屏幕的高清原图中查找颜色，全图查找坐标参数全部为 0，找后可点击

命令：ImgFindColor 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6,参数 7

  • 参数 1：查找的 16 位颜色值，如#ffffff
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：相似度 1 到 100，
  • 参数 7：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;

操作设备数量：单个

返回结果：返回执行状态，并且返回找到的坐标，没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "ImgFindColor #ffffff,0,0,0,0,90,true"  //全屏查找白色,相似度90以上，找到后点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30"    //返回找到的坐标
}

快速查找颜色

⚠️ 提示：需要在软件设置中把【系统设置 - 硬件加速 - 画面加速模式】设为【加速模式2】

描述：从电脑屏幕显示画面中查找颜色，结果准确度与小图画面分辨率有关，全图查找坐标参数全部为 0，找后可点击

命令：FastImgFindColor 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6,参数 7

  • 参数 1：查找的 16 位颜色值，如#ffffff
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：相似度 1 到 100
  • 参数 7：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;

操作设备数量：单个

返回结果：返回执行状态，并且返回找到的坐标,没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "FastImgFindColor #ffffff,0,0,0,0,90,true"  //全屏查找白色,相似度90以上，找到后点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30"    //返回找到的坐标
}

查找图片

描述：从设备屏幕的高清原图中查找图片，全图查找坐标参数全部为 0，找后可点击

命令：ImgFindImg 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6,参数 7

  • 参数 1：查找的图片位置，如#ffffff
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：相似度 1 到 100
  • 参数 7：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;

操作设备数量：单个

返回结果：返回执行状态，并且返回找到的坐标,没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "ImgFindImg d:\\cls\\a.png,0,0,0,0,90,false"  //全屏查找d:\cls\a.png的图片,相似度90以上，找到后不点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30"    //返回找到的坐标
}

快速查找图片

⚠️ 提示：需要在软件设置中把【系统设置 - 硬件加速 - 画面加速模式】设为【加速模式2】

描述：从电脑屏幕显示画面中查找图片，结果准确度与小图画面分辨率有关，全图查找坐标参数全部为 0，找后可点击

命令：FastImgFindImg 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6,参数 7

  • 参数 1：查找的图片位置，如#ffffff
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：相似度 1 到 100
  • 参数 7：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;

操作设备数量：单个

返回结果：返回执行状态，并且返回找到的坐标,没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "FastImgFindImg d:\\cls\\a.png,0,0,0,0,90,false"  //全屏查找d:\cls\a.png的图片,相似度90以上，找到后不点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30"    //返回找到的坐标
}

Ocr提取屏幕文本

描述：Ocr从设备屏幕的高清原图中提取文本

命令：OcrGetText 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6

  • 参数 1：查找范围左上角 X 坐标
  • 参数 2：查找范围左上角 Y 坐标
  • 参数 3：查找范围右下角 X 坐标
  • 参数 4：查找范围右下角 Y 坐标
  • 参数 5：相似度 1 到 100
  • 参数 6：是否返回所有数据
  • [x] true=返回所有;
  • [x] false=只返回文本和中心坐标;

操作设备数量：单个

返回结果：返回执行状态，返回找到的所有内容text、相似度score和坐标point，多个结果用换行符"\n"分隔，没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "OcrGetText 0,0,0,0,50,true"  //全屏提取相似度在50以上的内容
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"text:内容1,score:0.5,point:20,30;100,110;90,130,20,50;;text:内容2,score:0.5,point:20,30;100,110;90,130,20,50"  //返回找到的内容
}

Ocr快速提取屏幕文本

⚠️ 提示：需要在软件设置中把【系统设置 - 硬件加速 - 画面加速模式】设为【加速模式2】

描述：Ocr从电脑屏幕显示画面中提取文本，结果准确度与小图画面分辨率有关

命令：FastOcrGetText 参数 1,参数 2,参数 3,参数 4,参数 5,参数 6

  • 参数 1：查找范围左上角 X 坐标
  • 参数 2：查找范围左上角 Y 坐标
  • 参数 3：查找范围右下角 X 坐标
  • 参数 4：查找范围右下角 Y 坐标
  • 参数 5：相似度 1 到 100
  • 参数 6：是否返回所有数据
  • [x] true=返回所有;
  • [x] false=只返回文本和中心坐标;

操作设备数量：单个

返回结果：返回执行状态，返回找到的所有内容text、相似度score和坐标point，多个结果用换行符"\n"分隔，没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "FastOcrGetText 0,0,0,0,50,true"  //全屏提取相似度在50以上的内容
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"text:内容1,score:0.5,point:20,30;100,110;90,130,20,50;;text:内容2,score:0.5,point:20,30;100,110;90,130,20,50"  //返回找到的内容
}

Ocr查找屏幕文本

描述：Ocr从设备屏幕的高清原图中查找文本，可点击

命令：OcrFindText 参数 1,,参数 2,,参数 3,,参数 4,,参数 5,,参数 6,,参数 7,,参数 8,,参数9

  • 参数 1：要查找的内容
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：匹配度 1 到 100
  • 参数 7：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;
  • 参数 8：判断方法：
  • [x] true=包含，省略时默认值;
  • [x] false=相同;
  • 参数 9：是否返回所有数据
  • [x] true=返回所有;
  • [x] false=只返回文本和中心坐标;

操作设备数量：单个

返回结果：返回执行状态，返回找到的坐标，没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "OcrFindText hello,,0,,0,,0,,0,,90,,true,,false,,true"  
//全屏查找相似度90以上的第一个hello，找到就点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30;100,110;90,130,20,50"  //返回找到的坐标
}

Ocr快速查找屏幕文本

⚠️ 提示：需要在软件设置中把【系统设置 - 硬件加速 - 画面加速模式】设为【加速模式2】

描述：Ocr从电脑屏幕显示画面中查找文本，结果准确度与小图画面分辨率有关，可点击

命令：FastOcrFindText 参数 1,,参数 2,,参数 3,,参数 4,,参数 5,,参数 6,,参数 7,,参数 8,,参数 9

  • 参数 1：要查找的内容
  • 参数 2：查找范围左上角 X 坐标
  • 参数 3：查找范围左上角 Y 坐标
  • 参数 4：查找范围右下角 X 坐标
  • 参数 5：查找范围右下角 Y 坐标
  • 参数 6：匹配度 1 到 100
  • 参数 7：找到后是否点击
  • [x] true=点击;
  • [x] false=不点击;
  • 参数 8：判断方法
  • [x] true=包含，省略时默认值;
  • [x] false=相同;
  • 参数 9：是否返回所有数据
  • [x] true=返回所有;
  • [x] false=只返回文本和中心坐标;

操作设备数量：单个

返回结果：返回执行状态，返回找到的坐标，没找到无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "FastOcrFindText hello,,0,,0,,0,,0,,90,,true,,false,,true"  //全屏查找相似度90以上的第一个hello，找到就点击
}

//响应
{
  "id": "id123",
  "msg": "success",
  "data":"20,30;100,110;90,130,20,50"  //返回找到的坐标
}

上传文件

描述：上传文件

命令：PushFile 参数 1,参数 2

  • 参数 1：要上传的电脑端文件
  • 参数 2：要保存手机上的位置

操作设备数量：单个或多个

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "PushFile d:\\abc\\a1.txt,/sdcard/Download/b1.txt"  
//示例：把电脑a1.txt文件上传到手机内部存储的Download文件夹里，并改名为b1.txt
}

下载文件

描述：下载文件

命令：PullFile 参数 1,参数 2

  • 参数 1：需要从手机上下载的文件
  • 参数 2：保存到电脑的位置

操作设备数量：单个

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "PullFile /sdcard/Download/b1.png,d:\\abc\\"  
//示例：把手机b1.txt文件保存到电脑的abc文件夹里
}

按键操作（回主页/返回等）

描述：根据键码按键操作

命令：Key 参数 1

操作设备数量：单个或多个

返回结果：返回执行状态，无返回值

// 请求
//常用码：HOME=返回主页，BACK=返回上一步，APP_SWITCH=切换应用，VOLUME_UP=音量加，VOLUME_DOWN=音量减，VOLUME_MUTE=静音
{
  "id": "id123",
  "num": "2",
  "cmd": "Key HOME"  //回到手机主页
}

窗口消息

描述：设置设备窗口消息

命令：Toast 参数1,参考2

  • 参数 1：消息显示时长，单位毫秒
  • 参数 2：消息内容

操作设备数量：单个或多个

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "Toast 3000,hello"  //设备窗口上显示hello，3秒后消失
}

全局消息

描述：设置全局消息

命令：GlobalToast 参数 1,参考 2

  • 参数 1：消息内容
  • 参数 2：消息类型
  • [x] i=普通消息;
  • [x] w=警告消息;
  • [x] e=错误消息，错误消息需要手动关闭显示;

操作设备数量：单个或多个

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "GlobalToast hello,i"  //软件右上角显示全局普通消息hello，3秒后会自动消失
}

获取设备

描述：获取当前设备编号、标题和DeviceId

命令：OnlineDevice 参数 1,参数 2

  • 参数 1：返回指定设备类型
  • [x] all=返回当前正常投屏的所有设备;
  • [x] select=返回当前已选取的设备列表;
  • [x] display=返回当前分组显示的设备列表;
  • 参数 2：返回指定设备信息, 当为adb列表时，返回默认会话
  • [x] number=返回设备编号;
  • [x] title=返回设备标题;
  • [x] deviceid=返回设备DevicesId;
  • [x] all=返回设备编号、标题和DevicesId

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，并且返回相应数据

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "OnlineDevice all,all"  //获取所有设备的所有信息
}


//响应
{
  "id": "id123",
  "msg": "success",
  "data":"1/标题一/eo7dw6aedss;2/标题二/192.168.7.5:5555"  //返回设备编号、标题和对应DevicesId号
}

获取分组设备

描述：获取分组所属设备编号、标题和DeviceId

命令：GroupDevice 参数1,参数2

  • 参数 1：分组的名称
  • 参数 2：返回指定设备信息
  • [x] number=返回设备编号;
  • [x] title=返回设备标题;
  • [x] deviceid=返回设备DevicesId;
  • [x] all=返回设备编号、标题和DevicesId

    操作设备数量：全局命令，不需要指定

    返回结果：返回执行状态，并且返回用设备编号

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "GroupDevice 分组1,all" //获取分组1设备的所有信息
}


//响应
{
  "id": "id123",
  "msg": "success",
  "data":"1/标题一/eo7dw6aedss;2/标题二/192.168.7.5:5555"  //返回设备编号、标题和对应DevicesId号
}

切换分组

描述：显示指定分组的设备

命令：SwitchGroup 参数1

  • 参数 1：分组的名称

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "SwitchGroup 分组1"  //显示分组1的画面
}

切换到下一组

描述：显示下一个分组的设备

命令：NextGroup

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "NextGroup"
}

切换到上一组

描述：显示上一个分组的设备

命令：BackGroup

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "BackGroup"
}

切换到下一大图

描述：显示下一个大图

命令：NextBigImg

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "NextBigImg"
}

切换到上一大图

描述：显示上一个大图

命令：BackBigImg

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "BackBigImg"
}

切换大图

描述：切换到指定大图

命令：SwitchBigImg

操作设备数量：单个

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "2",
  "cmd": "SwitchBigImg"  //2号设备切换成大图模式
}

获取大图设备号

描述：获取当前大图设备号

命令：BigImgDevice

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "BigImgDevice"
}

刷新画面

描述：刷新指定设备画面

命令：RefreshImg

操作设备数量：单个或多个

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "2,3",
  "cmd": "RefreshImg"
}

重新加载设备

描述：重新指定设备

命令：LoadDevice

操作设备数量：单个或多个

返回结果：返回执行状态，无返回值

//请求
{
  "id": "id123",
  "num": "2,3",
  "cmd": "LoadDevice"
}

刷新IP连接状态

描述：刷新IP连接状态

命令：RefreshIpConnection

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "RefreshIpConnection"
}

关闭已连接的ip

描述：关闭已连接的ip

命令：CloseIpConnection

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "CloseIpConnection"
}

修改Ip地址列表

描述：修改Ip地址列表

命令：EditIpList 参数1,参数2,参数3

  • 参数 1：修改方式
  • [x] add=保留原来ip地址列表，并增加新的ip地址;
  • [x] clear=删除原来ip地址列表，重新添加;
  • 参数 2：添加后处理方式
  • [x] none=仅添加;
  • [x] connect=添加完成后，刷新连接;
  • [x] reconnect=先移除现有连接，然后添加完成后，刷新连接;
  • 参数 3：adb的ip连接地址列表，格式为ip地址:端口号，ip和端口用英文冒号(:)分隔，多个ip地址用英文逗号(,)分隔

操作设备数量：全局命令，不需要指定

返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "EditIpList clear,192.168.1.1:5555,192.168.1.2:5555,192.168.1.3:5001"  //清除原有的ip列表，重新添加3个
}

设置使用向导

描述：设置使用向导

命令：SetConnectWizard 参数1

  • 参数 1：要设置成的模式
  • [x] 1=USB数据线连接;
  • [x] 2=OTG、WIFI网络连接;
  • [x] 3=USB、OTG、WIFI混合连接;
  • [x] 4=USB转WIFI连接;
  • [x] 5=USB转OTG连接;

    操作设备数量：全局命令，不需要指定

    返回结果：返回执行状态，无返回值

// 请求
{
  "id": "id123",
  "num": "",
  "cmd": "SetConnectWizard 2"  //使用向导切换到2 OTG、WIFI网络连接
}