USB HID 接口

说明

本页为 自动化接口 / USB HID 模块，与其它开放接口模块并列；对应脚本 usbHidEvent。

USB HID 开放接口供第三方语言（Python、易语言、C++ 等）通过 HTTP 控制 iPhone，无需蓝牙板 / OTG 板
路径前缀：中控地址，例如 http://127.0.0.1:8019
全部为 POST，Content-Type: application/json
与脚本模块 USB HID 函数（usbHidEvent）一一对应
适配 EC iOS USB 10.7.0+；手机建议 iOS 17+

通用返回

1
{
2
  "code": 0,
3
  "msg": "",
4
  "data": ""
5
}

字段	说明
code	`0` 成功，其它失败
msg	失败时的错误信息
data	部分接口返回业务数据（如剪贴板文本）；多数动作接口可为空

会话

POST 开启 USB HID 会话

POST /openapi/usbhidSessionStart

对应 usbHidEvent.sessionStart(gate)。会话已存在时会复用。

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "gate": true
4
}

参数	类型	必选	说明
deviceId	string	是	设备 ID
gate	boolean	否	是否增强兼容模式，默认 `true`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "gate": True
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSessionStart", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "gate": true
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSessionStart", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSessionStart" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","gate":true}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"gate\":true}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSessionStart", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 关闭 USB HID 会话

POST /openapi/usbhidSessionStop

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSessionStop", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSessionStop", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSessionStop" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSessionStop", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 重建 USB HID 会话

POST /openapi/usbhidSessionRestart

点击无响应时可重建会话（对应投屏右键「重建 USBHID 会话」）。

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "gate": true
4
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "gate": True
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSessionRestart", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "gate": true
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSessionRestart", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSessionRestart" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","gate":true}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"gate\":true}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSessionRestart", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

屏幕与坐标

POST 设置屏幕尺寸

POST /openapi/usbhidSetScreenSize

按截图/投屏实际分辨率填写。也可用 width / height 代替 w / h。

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "w": 1170,
4
  "h": 2532
5
}

参数	类型	必选	说明
deviceId	string	是	设备 ID
w / width	number	是	宽
h / height	number	是	高

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "w": 1170,
6
  "h": 2532
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSetScreenSize", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "w": 1170,
4
  "h": 2532
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSetScreenSize", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSetScreenSize" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","w":1170,"h":2532}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"w\":1170,\"h\":2532}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSetScreenSize", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

触控

坐标与投屏画面、截图像素坐标一致。

POST 点击

POST /openapi/usbhidClickPoint

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 200,
4
  "y": 400
5
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 200,
6
  "y": 400
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidClickPoint", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 200,
4
  "y": 400
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidClickPoint", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidClickPoint" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":200,"y":400}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":200,\"y\":400}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidClickPoint", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 双击

POST /openapi/usbhidDoubleClickPoint

参数同点击：deviceId、x、y。

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 200,
6
  "y": 400
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidDoubleClickPoint", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 200,
4
  "y": 400
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidDoubleClickPoint", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidDoubleClickPoint" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":200,"y":400}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":200,\"y\":400}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidDoubleClickPoint", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 长按

POST /openapi/usbhidPress

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 200,
4
  "y": 400,
5
  "delay": 500
6
}

参数	类型	必选	说明
delay	number	否	长按毫秒，默认 `500`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 200,
6
  "y": 400,
7
  "delay": 500
8
}
9
r = requests.post("http://127.0.0.1:8019/openapi/usbhidPress", json=body, timeout=30)
10
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 200,
4
  "y": 400,
5
  "delay": 500
6
};
7
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidPress", {
8
  method: "POST",
9
  headers: { "Content-Type": "application/json" },
10
  body: JSON.stringify(body),
11
});
12
const data = await res.json();
13
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidPress" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":200,"y":400,"delay":500}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":200,\"y\":400,\"delay\":500}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidPress", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 滑动

POST /openapi/usbhidSwipeToPoint

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 100,
4
  "y": 800,
5
  "ex": 100,
6
  "ey": 200,
7
  "duration": 500
8
}

参数	类型	必选	说明
x, y	number	是	起点
ex, ey	number	是	终点
duration / delay	number	否	滑动时长毫秒，默认 `500`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 100,
6
  "y": 800,
7
  "ex": 100,
8
  "ey": 200,
9
  "duration": 500
10
}
11
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSwipeToPoint", json=body, timeout=30)
12
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 100,
4
  "y": 800,
5
  "ex": 100,
6
  "ey": 200,
7
  "duration": 500
8
};
9
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSwipeToPoint", {
10
  method: "POST",
11
  headers: { "Content-Type": "application/json" },
12
  body: JSON.stringify(body),
13
});
14
const data = await res.json();
15
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSwipeToPoint" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":100,"y":800,"ex":100,"ey":200,"duration":500}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":100,\"y\":800,\"ex\":100,\"ey\":200,\"duration\":500}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSwipeToPoint", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 按下 / 移动 / 抬起

POST /openapi/usbhidTouchDown
POST /openapi/usbhidTouchMove
POST /openapi/usbhidTouchUp

参数均为：deviceId、x、y。

`POST /openapi/usbhidTouchDown`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 200,
6
  "y": 400
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidTouchDown", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 200,
4
  "y": 400
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidTouchDown", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidTouchDown" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":200,"y":400}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":200,\"y\":400}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidTouchDown", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

`POST /openapi/usbhidTouchMove`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 220,
6
  "y": 420
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidTouchMove", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 220,
4
  "y": 420
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidTouchMove", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidTouchMove" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":220,"y":420}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":220,\"y\":420}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidTouchMove", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

`POST /openapi/usbhidTouchUp`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "x": 220,
6
  "y": 420
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidTouchUp", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "x": 220,
4
  "y": 420
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidTouchUp", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidTouchUp" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","x":220,"y":420}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"x\":220,\"y\":420}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidTouchUp", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 多点触控轨迹

POST /openapi/usbhidMultiTouch

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "finger1": [
4
    { "action": 0, "x": 100, "y": 500, "delay": 20 },
5
    { "action": 2, "x": 100, "y": 300, "delay": 30 },
6
    { "action": 1, "x": 100, "y": 300, "delay": 20 }
7
  ],
8
  "timeout": 10000
9
}

参数	类型	必选	说明
finger1 / data	array/string	是	触点轨迹；`action`：`0` 按下、`2` 移动、`1` 抬起
timeout / delay	number	否	总超时毫秒，默认 `10000`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "finger1": [
6
    {
7
      "action": 0,
8
      "x": 100,
9
      "y": 500,
10
      "delay": 20
11
    },
12
    {
13
      "action": 2,
14
      "x": 100,
15
      "y": 300,
16
      "delay": 30
17
    },
18
    {
19
      "action": 1,
20
      "x": 100,
21
      "y": 300,
22
      "delay": 20
23
    }
24
  ],
25
  "timeout": 10000
26
}
27
r = requests.post("http://127.0.0.1:8019/openapi/usbhidMultiTouch", json=body, timeout=30)
28
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "finger1": [
4
    {
5
      "action": 0,
6
      "x": 100,
7
      "y": 500,
8
      "delay": 20
9
    },
10
    {
11
      "action": 2,
12
      "x": 100,
13
      "y": 300,
14
      "delay": 30
15
    },
16
    {
17
      "action": 1,
18
      "x": 100,
19
      "y": 300,
20
      "delay": 20
21
    }
22
  ],
23
  "timeout": 10000
24
};
25
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidMultiTouch", {
26
  method: "POST",
27
  headers: { "Content-Type": "application/json" },
28
  body: JSON.stringify(body),
29
});
30
const data = await res.json();
31
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidMultiTouch" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","finger1":[{"action":0,"x":100,"y":500,"delay":20},{"action":2,"x":100,"y":300,"delay":30},{"action":1,"x":100,"y":300,"delay":20}],"timeout":10000}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"finger1\":[{\"action\":0,\"x\":100,\"y\":500,\"delay\":20},{\"action\":2,\"x\":100,\"y\":300,\"delay\":30},{\"action\":1,\"x\":100,\"y\":300,\"delay\":20}],\"timeout\":10000}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidMultiTouch", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

输入与按键

POST 粘贴输入

POST /openapi/usbhidInputText

统一剪贴板粘贴，适合中英文。也可用字段 content。

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "text": "你好"
4
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "text": "你好"
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidInputText", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "text": "你好"
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidInputText", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidInputText" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","text":"你好"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"text\":\"你好\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidInputText", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 打字输入

POST /openapi/usbhidTypeText

可打印英文走键盘；含中文、emoji 等自动改粘贴。

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "text": "hello"
4
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "text": "hello"
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidTypeText", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "text": "hello"
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidTypeText", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidTypeText" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","text":"hello"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"text\":\"hello\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidTypeText", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 系统按键

POST /openapi/usbhidSystemKey

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "key": "home"
4
}

key	说明
home	主屏
recents	多任务
lock	锁屏

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "key": "home"
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSystemKey", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "key": "home"
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSystemKey", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSystemKey" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","key":"home"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"key\":\"home\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSystemKey", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 字符按键 / 组合键

POST /openapi/usbhidKeyPressChar

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "prefix": "gui",
4
  "code": "v"
5
}

参数	说明
prefix	可空：`alt` / `ctrl` / `gui` / `shift` / `r_ctrl` / `r_shift`
code	字符或键名，如 `a` / `enter` / `BS`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "prefix": "gui",
6
  "code": "v"
7
}
8
r = requests.post("http://127.0.0.1:8019/openapi/usbhidKeyPressChar", json=body, timeout=30)
9
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "prefix": "gui",
4
  "code": "v"
5
};
6
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidKeyPressChar", {
7
  method: "POST",
8
  headers: { "Content-Type": "application/json" },
9
  body: JSON.stringify(body),
10
});
11
const data = await res.json();
12
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidKeyPressChar" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","prefix":"gui","code":"v"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"prefix\":\"gui\",\"code\":\"v\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidKeyPressChar", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 按下单个键 / 抬起

POST /openapi/usbhidKeyPress — body：deviceId、key（或 code）
POST /openapi/usbhidKeyUp — body：deviceId

`POST /openapi/usbhidKeyPress`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "key": "enter"
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidKeyPress", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "key": "enter"
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidKeyPress", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidKeyPress" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","key":"enter"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"key\":\"enter\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidKeyPress", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

`POST /openapi/usbhidKeyUp`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/usbhidKeyUp", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidKeyUp", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidKeyUp" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidKeyUp", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 音量 / 静音

仅需 deviceId：

POST /openapi/usbhidVolumeUp
POST /openapi/usbhidVolumeDown
POST /openapi/usbhidMute

`POST /openapi/usbhidVolumeUp`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/usbhidVolumeUp", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidVolumeUp", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidVolumeUp" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidVolumeUp", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

`POST /openapi/usbhidVolumeDown`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/usbhidVolumeDown", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidVolumeDown", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidVolumeDown" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidVolumeDown", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

`POST /openapi/usbhidMute`

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/usbhidMute", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidMute", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidMute" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidMute", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

剪贴板

POST 设置剪贴板

POST /openapi/usbhidSetClipboard

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "text": "剪贴板内容"
4
}

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
5
  "text": "剪贴板内容"
6
}
7
r = requests.post("http://127.0.0.1:8019/openapi/usbhidSetClipboard", json=body, timeout=30)
8
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d",
3
  "text": "剪贴板内容"
4
};
5
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidSetClipboard", {
6
  method: "POST",
7
  headers: { "Content-Type": "application/json" },
8
  body: JSON.stringify(body),
9
});
10
const data = await res.json();
11
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidSetClipboard" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d","text":"剪贴板内容"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\",\"text\":\"剪贴板内容\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidSetClipboard", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

POST 读取剪贴板

POST /openapi/usbhidGetClipboard

1
{
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
}

成功时文本在返回的 data 中。

与脚本 / BLE 对照

脚本 `usbHidEvent`	OpenAPI 接口名	说明
sessionStart	usbhidSessionStart	开启会话
sessionStop	usbhidSessionStop	关闭会话
sessionRestart	usbhidSessionRestart	重建会话
setScreenSize	usbhidSetScreenSize	屏幕尺寸
clickPoint	usbhidClickPoint	点击
press	usbhidPress	长按
swipeToPoint	usbhidSwipeToPoint	滑动
typeText / inputText	usbhidTypeText / usbhidInputText	打字 / 粘贴
…	见本页各接口	其余同名对应

请求示例

1
import requests
2

3
body = {
4
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
5
}
6
r = requests.post("http://127.0.0.1:8019/openapi/usbhidGetClipboard", json=body, timeout=30)
7
print(r.json())

1
const body = {
2
  "deviceId": "90e2f3834c0977205e441aa664916a9bdde81e8d"
3
};
4
const res = await fetch("http://127.0.0.1:8019/openapi/usbhidGetClipboard", {
5
  method: "POST",
6
  headers: { "Content-Type": "application/json" },
7
  body: JSON.stringify(body),
8
});
9
const data = await res.json();
10
console.log(data);

1
curl -s -X POST "http://127.0.0.1:8019/openapi/usbhidGetClipboard" \
2
  -H "Content-Type: application/json" \
3
  -d '{"deviceId":"90e2f3834c0977205e441aa664916a9bdde81e8d"}'

1
using System.Text;
2
using var http = new HttpClient { Timeout = TimeSpan.FromSeconds(30) };
3
var json = "{\"deviceId\":\"90e2f3834c0977205e441aa664916a9bdde81e8d\"}";
4
using var content = new StringContent(json, Encoding.UTF8, "application/json");
5
using var res = await http.PostAsync("http://127.0.0.1:8019/openapi/usbhidGetClipboard", content);
6
var text = await res.Content.ReadAsStringAsync();
7
Console.WriteLine(text);

蓝牙板方案见自动化 · 蓝牙 BLE；USB HID 不需要 打开串口、配对开发板等步骤。

更多脚本说明：USB HID 函数 · 投屏场景指引