ms-vite-plugin 1.1.1 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/dist/build.js +6 -0
  2. package/dist/cli.js +98 -8
  3. package/dist/mcp/device-config.d.ts +55 -0
  4. package/dist/mcp/device-config.js +183 -0
  5. package/dist/mcp/docs-service.d.ts +65 -0
  6. package/dist/mcp/docs-service.js +168 -0
  7. package/dist/mcp/project.d.ts +16 -0
  8. package/dist/mcp/project.js +74 -0
  9. package/dist/mcp/tools.d.ts +18 -0
  10. package/dist/mcp/tools.js +825 -0
  11. package/dist/mcp/types.d.ts +32 -0
  12. package/dist/mcp/types.js +11 -0
  13. package/dist/mcp-server.d.ts +2 -0
  14. package/dist/mcp-server.js +86 -0
  15. package/dist/project.d.ts +89 -0
  16. package/dist/project.js +306 -0
  17. package/dist/version.d.ts +12 -0
  18. package/dist/version.js +63 -0
  19. package/docs/api/action.md +922 -0
  20. package/docs/api/appleocr.md +229 -0
  21. package/docs/api/config.md +122 -0
  22. package/docs/api/cryptoUtils.md +232 -0
  23. package/docs/api/device.md +374 -0
  24. package/docs/api/file.md +516 -0
  25. package/docs/api/global.md +617 -0
  26. package/docs/api/hid.md +1032 -0
  27. package/docs/api/hotUpdate.md +166 -0
  28. package/docs/api/http.md +548 -0
  29. package/docs/api/image.md +907 -0
  30. package/docs/api/ime.md +290 -0
  31. package/docs/api/logger.md +324 -0
  32. package/docs/api/media.md +248 -0
  33. package/docs/api/mysql.md +441 -0
  34. package/docs/api/netCard.md +200 -0
  35. package/docs/api/node.md +353 -0
  36. package/docs/api/paddleocr.md +246 -0
  37. package/docs/api/pip.md +242 -0
  38. package/docs/api/system.md +572 -0
  39. package/docs/api/thread.md +269 -0
  40. package/docs/api/tomatoocr.md +425 -0
  41. package/docs/api/tts.md +334 -0
  42. package/docs/api/ui.md +947 -0
  43. package/docs/api/utils.md +265 -0
  44. package/docs/api/yolo.md +310 -0
  45. package/docs/apicn/action.md +919 -0
  46. package/docs/apicn/appleocr.md +233 -0
  47. package/docs/apicn/config.md +120 -0
  48. package/docs/apicn/device.md +385 -0
  49. package/docs/apicn/file.md +511 -0
  50. package/docs/apicn/global.md +613 -0
  51. package/docs/apicn/hid.md +1033 -0
  52. package/docs/apicn/hotUpdate.md +170 -0
  53. package/docs/apicn/http.md +672 -0
  54. package/docs/apicn/image.md +924 -0
  55. package/docs/apicn/ime.md +290 -0
  56. package/docs/apicn/logger.md +332 -0
  57. package/docs/apicn/media.md +252 -0
  58. package/docs/apicn/mysql.md +445 -0
  59. package/docs/apicn/netCard.md +200 -0
  60. package/docs/apicn/node.md +362 -0
  61. package/docs/apicn/paddleocr.md +255 -0
  62. package/docs/apicn/pip.md +242 -0
  63. package/docs/apicn/system.md +575 -0
  64. package/docs/apicn/thread.md +269 -0
  65. package/docs/apicn/tts.md +338 -0
  66. package/docs/apicn/ui.md +933 -0
  67. package/docs/apicn/utils.md +265 -0
  68. package/docs/apicn/yolo.md +314 -0
  69. package/docs/apipython/action.md +901 -0
  70. package/docs/apipython/appleocr.md +226 -0
  71. package/docs/apipython/config.md +126 -0
  72. package/docs/apipython/cryptoUtils.md +246 -0
  73. package/docs/apipython/device.md +365 -0
  74. package/docs/apipython/file.md +476 -0
  75. package/docs/apipython/g.md +154 -0
  76. package/docs/apipython/hid.md +1059 -0
  77. package/docs/apipython/hotUpdate.md +154 -0
  78. package/docs/apipython/image.md +938 -0
  79. package/docs/apipython/ime.md +306 -0
  80. package/docs/apipython/logger.md +330 -0
  81. package/docs/apipython/media.md +221 -0
  82. package/docs/apipython/mysql.md +432 -0
  83. package/docs/apipython/netCard.md +219 -0
  84. package/docs/apipython/node.md +331 -0
  85. package/docs/apipython/overview.md +66 -0
  86. package/docs/apipython/paddleocr.md +211 -0
  87. package/docs/apipython/pip.md +231 -0
  88. package/docs/apipython/system.md +458 -0
  89. package/docs/apipython/tomatoocr.md +444 -0
  90. package/docs/apipython/tts.md +331 -0
  91. package/docs/apipython/ui.md +949 -0
  92. package/docs/apipython/utils.md +284 -0
  93. package/docs/apipython/yolo.md +281 -0
  94. package/package.json +8 -4
@@ -0,0 +1,1032 @@
1
+ # HID 模块
2
+
3
+ HID 模块提供全面的输入控制功能,包括点击、滑动、长按滑动、主屏幕导航等操作,通过蓝牙 HID 设备实现。
4
+
5
+ ## 常量
6
+
7
+ ### hidKey - HID 按键常量
8
+
9
+ 预定义的键盘操作按键常量。
10
+
11
+ ```typescript
12
+ declare const hidKey: {
13
+ COMMAND: number;
14
+ LEFT_CTRL: number;
15
+ LEFT_SHIFT: number;
16
+ LEFT_ALT: number;
17
+ RIGHT_CTRL: number;
18
+ RIGHT_SHIFT: number;
19
+ RIGHT_ALT: number;
20
+ UP_ARROW: number;
21
+ DOWN_ARROW: number;
22
+ LEFT_ARROW: number;
23
+ RIGHT_ARROW: number;
24
+ SPACE: number;
25
+ BACKSPACE: number;
26
+ TAB: number;
27
+ RETURN: number;
28
+ ESC: number;
29
+ INSERT: number;
30
+ DELETE: number;
31
+ PAGE_UP: number;
32
+ PAGE_DOWN: number;
33
+ HOME: number;
34
+ END: number;
35
+ CAPS_LOCK: number;
36
+ F1: number;
37
+ F2: number;
38
+ F3: number;
39
+ F4: number;
40
+ F5: number;
41
+ F6: number;
42
+ F7: number;
43
+ F8: number;
44
+ F9: number;
45
+ F10: number;
46
+ F11: number;
47
+ F12: number;
48
+ };
49
+ ```
50
+
51
+ ## 获取和设置设备信息
52
+
53
+ ### isBLEConnected - 是否连接了蓝牙HID设备
54
+
55
+ 判断是否连接了蓝牙HID设备
56
+
57
+ ```typescript
58
+ function isBLEConnected(): boolean;
59
+ ```
60
+
61
+ **示例:**
62
+
63
+ ```javascript
64
+ // 检查是否连接了蓝牙HID设备
65
+ const isBLEConnected = hid.isBLEConnected();
66
+ logi(isBLEConnected); // 输出: true 或 false
67
+ ```
68
+
69
+ ### isUSBConnected - 是否连接了USB HID设备
70
+
71
+ 判断是否连接了USB HID设备
72
+
73
+ ```typescript
74
+ function isUSBConnected(): boolean;
75
+ ```
76
+
77
+ **示例:**
78
+
79
+ ```javascript
80
+ // 检查是否连接了USB HID设备
81
+ const isUSBConnected = hid.isUSBConnected();
82
+ logi(isUSBConnected); // 输出: true 或 false
83
+ ```
84
+
85
+ ### getBLEHIDDeviceName - 获取蓝牙 HID 设备名称
86
+
87
+ 获取当前连接的蓝牙 HID 设备名称。
88
+
89
+ ```typescript
90
+ function getBLEHIDDeviceName(): string;
91
+ ```
92
+
93
+ **返回值:**
94
+ | 类型 | 描述 |
95
+ | ---- | ---- |
96
+ | string | 蓝牙 HID 设备名称 |
97
+
98
+ **示例:**
99
+
100
+ ```javascript
101
+ const deviceName = hid.getBLEHIDDeviceName();
102
+ logi(deviceName);
103
+ ```
104
+
105
+ ### setBLEHIDDeviceName - 设置蓝牙 HID 设备名称
106
+
107
+ 设置当前蓝牙 HID 设备名称。
108
+
109
+ ```typescript
110
+ function setBLEHIDDeviceName(name: string): boolean;
111
+ ```
112
+
113
+ **参数:**
114
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
115
+ | ---- | ---- | ---- | ------ | ---- |
116
+ | `name` | string | 是 | - | 要设置的蓝牙 HID 设备名称 |
117
+
118
+ **返回值:**
119
+ | 类型 | 描述 |
120
+ | ---- | ---- |
121
+ | boolean | 操作是否成功 |
122
+
123
+ **示例:**
124
+
125
+ ```javascript
126
+ const ok = hid.setBLEHIDDeviceName("KuaiJS-HID");
127
+ logi(ok);
128
+ ```
129
+
130
+ ### getDeviceMac - 获取设备 MAC 字符串
131
+
132
+ 获取设备返回的 MAC 字符串。
133
+
134
+ ```typescript
135
+ function getDeviceMac(): string;
136
+ ```
137
+
138
+ **返回值:**
139
+ | 类型 | 描述 |
140
+ | ---- | ---- |
141
+ | string | 设备 MAC 字符串 |
142
+
143
+ **示例:**
144
+
145
+ ```javascript
146
+ const mac = hid.getDeviceMac();
147
+ logi(mac);
148
+ ```
149
+
150
+ ### resetPosition - 复位坐标
151
+
152
+ 将鼠标坐标复位到左上角(仅相对鼠标模式需要)。
153
+
154
+ ```typescript
155
+ function resetPosition(): boolean;
156
+ ```
157
+
158
+ **返回值:**
159
+ | 类型 | 描述 |
160
+ | ---- | ---- |
161
+ | boolean | 操作是否成功 |
162
+
163
+ **示例:**
164
+
165
+ ```javascript
166
+ // 复位坐标到左上角
167
+ const ok = hid.resetPosition();
168
+ logi(ok); // 输出: true 或 false
169
+ ```
170
+
171
+ ## 录屏
172
+
173
+ ### openRecordScreen - 打开录屏界面
174
+
175
+ 打开录屏界面,用户可以在界面上操作开始、结束录屏。
176
+
177
+ ```typescript
178
+ function openRecordScreen(): void;
179
+ ```
180
+
181
+ **示例:**
182
+
183
+ ```javascript
184
+ // 打开录屏界面
185
+ hid.openRecordScreen();
186
+ ```
187
+
188
+ ### isRecording - 是否录屏中
189
+
190
+ 获取录屏开启状态
191
+
192
+ ```typescript
193
+ function isRecording(): boolean;
194
+ ```
195
+
196
+ **返回值:**
197
+ | 类型 | 描述 |
198
+ | ---- | ---- |
199
+ | boolean | 是否正在录屏 |
200
+
201
+ **示例:**
202
+
203
+ ```javascript
204
+ // 检查是否正在录屏
205
+ const isRecording = hid.isRecording();
206
+ logi(isRecording); // 输出: true 或 false
207
+ ```
208
+
209
+ ## 配置
210
+
211
+ ### setJitterValue - 设置抖动值
212
+
213
+ 设置动作的抖动值。带有抖动参数的动作将在像素范围`-value`到`value`内随机偏移。
214
+
215
+ ```typescript
216
+ function setJitterValue(value: number): void;
217
+ ```
218
+
219
+ **参数:**
220
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
221
+ | ---- | ---- | ---- | ------ | ---- |
222
+ | `value` | number | 是 | - | 随机像素偏移的抖动值 |
223
+
224
+ **示例:**
225
+
226
+ ```javascript
227
+ // 设置抖动值为5像素
228
+ hid.setJitterValue(5);
229
+ ```
230
+
231
+ ### move - 移动坐标
232
+
233
+ 将光标移动到指定坐标。
234
+
235
+ ```typescript
236
+ function move(x: number, y: number): boolean;
237
+ ```
238
+
239
+ **参数:**
240
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
241
+ | ---- | ---- | ---- | ------ | ---- |
242
+ | `x` | number | 是 | - | 目标 X 坐标 |
243
+ | `y` | number | 是 | - | 目标 Y 坐标 |
244
+
245
+ **返回值:**
246
+ | 类型 | 描述 |
247
+ | ---- | ---- |
248
+ | boolean | 操作是否成功 |
249
+
250
+ **示例:**
251
+
252
+ ```javascript
253
+ // 移动到 (100, 200)
254
+ hid.move(100, 200);
255
+ ```
256
+
257
+ ## 基础触摸操作
258
+
259
+ ### click - 点击操作
260
+
261
+ 在指定坐标执行点击操作。
262
+
263
+ ```typescript
264
+ function click(
265
+ x: number,
266
+ y: number,
267
+ duration?: number,
268
+ jitter?: boolean,
269
+ ): boolean;
270
+ ```
271
+
272
+ **参数:**
273
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
274
+ | ---- | ---- | ---- | ------ | ---- |
275
+ | `x` | number | 是 | - | 点击的 X 坐标 |
276
+ | `y` | number | 是 | - | 点击的 Y 坐标 |
277
+ | `duration` | number | 否 | 10 | 点击持续时间(毫秒) |
278
+ | `jitter` | boolean | 否 | false | 启用随机抖动偏移 |
279
+
280
+ **返回值:**
281
+ | 类型 | 描述 |
282
+ | ---- | ---- |
283
+ | boolean | 操作是否成功 |
284
+
285
+ **示例:**
286
+
287
+ ```javascript
288
+ // 简单点击
289
+ hid.click(100, 200);
290
+
291
+ // 带持续时间和抖动的点击
292
+ hid.click(100, 200, 150, true);
293
+ ```
294
+
295
+ ### clickRandom - 随机点击
296
+
297
+ 在指定矩形区域内执行随机点击。
298
+
299
+ ```typescript
300
+ function clickRandom(
301
+ x1: number,
302
+ y1: number,
303
+ x2: number,
304
+ y2: number,
305
+ duration?: number,
306
+ ): boolean;
307
+ ```
308
+
309
+ **参数:**
310
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
311
+ | ---- | ---- | ---- | ------ | ---- |
312
+ | `x1` | number | 是 | - | 左上角 X 坐标 |
313
+ | `y1` | number | 是 | - | 左上角 Y 坐标 |
314
+ | `x2` | number | 是 | - | 右下角 X 坐标 |
315
+ | `y2` | number | 是 | - | 右下角 Y 坐标 |
316
+ | `duration` | number | 否 | 20 | 点击持续时间(毫秒) |
317
+
318
+ **返回值:**
319
+ | 类型 | 描述 |
320
+ | ---- | ---- |
321
+ | boolean | 操作是否成功 |
322
+
323
+ **示例:**
324
+
325
+ ```javascript
326
+ // 在区域内随机点击
327
+ hid.clickRandom(100, 100, 200, 200, 20);
328
+ ```
329
+
330
+ ### doubleClick - 双击
331
+
332
+ 在指定坐标执行双击操作。
333
+
334
+ ```typescript
335
+ function doubleClick(
336
+ x: number,
337
+ y: number,
338
+ duration?: number,
339
+ interval?: number,
340
+ jitter?: boolean,
341
+ ): boolean;
342
+ ```
343
+
344
+ **参数:**
345
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
346
+ | ---- | ---- | ---- | ------ | ---- |
347
+ | `x` | number | 是 | - | X 坐标 |
348
+ | `y` | number | 是 | - | Y 坐标 |
349
+ | `duration` | number | 否 | 20 | 点击持续时间(毫秒) |
350
+ | `interval` | number | 否 | 20 | 两次点击间隔时间(毫秒) |
351
+ | `jitter` | boolean | 否 | false | 启用随机抖动偏移 |
352
+
353
+ **返回值:**
354
+ | 类型 | 描述 |
355
+ | ---- | ---- |
356
+ | boolean | 操作是否成功 |
357
+
358
+ **示例:**
359
+
360
+ ```javascript
361
+ // 带抖动的双击
362
+ hid.doubleClick(100, 100, 20, 20, true);
363
+ ```
364
+
365
+ ### doubleClickRandom - 随机双击
366
+
367
+ 在指定矩形区域内执行随机双击。
368
+
369
+ ```typescript
370
+ function doubleClickRandom(
371
+ x1: number,
372
+ y1: number,
373
+ x2: number,
374
+ y2: number,
375
+ duration?: number,
376
+ interval?: number,
377
+ ): boolean;
378
+ ```
379
+
380
+ **参数:**
381
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
382
+ | ---- | ---- | ---- | ------ | ---- |
383
+ | `x1` | number | 是 | - | 左上角 X 坐标 |
384
+ | `y1` | number | 是 | - | 左上角 Y 坐标 |
385
+ | `x2` | number | 是 | - | 右下角 X 坐标 |
386
+ | `y2` | number | 是 | - | 右下角 Y 坐标 |
387
+ | `duration` | number | 否 | 20 | 点击持续时间(毫秒) |
388
+ | `interval` | number | 否 | 20 | 两次点击间隔时间(毫秒) |
389
+
390
+ **返回值:**
391
+ | 类型 | 描述 |
392
+ | ---- | ---- |
393
+ | boolean | 操作是否成功 |
394
+
395
+ **示例:**
396
+
397
+ ```javascript
398
+ // 在区域内随机双击
399
+ hid.doubleClickRandom(100, 100, 200, 200, 20, 20);
400
+ ```
401
+
402
+ ## 滑动操作
403
+
404
+ ### swipe - 线性滑动
405
+
406
+ 执行从起始坐标到结束坐标的线性滑动。
407
+
408
+ ```typescript
409
+ function swipe(
410
+ x: number,
411
+ y: number,
412
+ ex: number,
413
+ ey: number,
414
+ jitter?: boolean,
415
+ steps?: number,
416
+ ): boolean;
417
+ ```
418
+
419
+ **参数:**
420
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
421
+ | ---- | ---- | ---- | ------ | ---- |
422
+ | `x` | number | 是 | - | 起始 X 坐标 |
423
+ | `y` | number | 是 | - | 起始 Y 坐标 |
424
+ | `ex` | number | 是 | - | 结束 X 坐标 |
425
+ | `ey` | number | 是 | - | 结束 Y 坐标 |
426
+ | `jitter` | boolean | 否 | false | 启用随机抖动偏移 |
427
+ | `steps` | number | 否 | 6 | 滑动步数 |
428
+
429
+ **返回值:**
430
+ | 类型 | 描述 |
431
+ | ---- | ---- |
432
+ | boolean | 操作是否成功 |
433
+
434
+ **示例:**
435
+
436
+ ```javascript
437
+ // 简单滑动
438
+ hid.swipe(100, 100, 200, 200);
439
+
440
+ // 带抖动和自定义步数的滑动
441
+ hid.swipe(100, 100, 200, 200, true, 10);
442
+ ```
443
+
444
+ ### pressAndSwipe - 长按并滑动
445
+
446
+ 长按起始坐标,然后滑动到目标坐标。
447
+
448
+ ```typescript
449
+ function swipe(
450
+ x: number,
451
+ y: number,
452
+ ex: number,
453
+ ey: number,
454
+ duration?: number,
455
+ jitter?: boolean,
456
+ steps?: number,
457
+ ): boolean;
458
+ ```
459
+
460
+ **参数:**
461
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
462
+ | ---- | ---- | ---- | ------ | ---- |
463
+ | `x` | number | 是 | - | 起始 X 坐标 |
464
+ | `y` | number | 是 | - | 起始 Y 坐标 |
465
+ | `ex` | number | 是 | - | 结束 X 坐标 |
466
+ | `ey` | number | 是 | - | 结束 Y 坐标 |
467
+ | `duration` | number | 否 | 500 | 长按持续时间(毫秒) |
468
+ | `jitter` | boolean | 否 | false | 启用随机抖动偏移 |
469
+ | `steps` | number | 否 | 6 | 滑动步数 |
470
+
471
+ **返回值:**
472
+ | 类型 | 描述 |
473
+ | ---- | ---- |
474
+ | boolean | 操作是否成功 |
475
+
476
+ **示例:**
477
+
478
+ ```javascript
479
+ // 长按 1 秒后滑动
480
+ hid.pressAndSwipe(100, 100, 200, 200, 1000);
481
+
482
+ // 长按 1 秒后带抖动和自定义步数的滑动
483
+ hid.pressAndSwipe(100, 100, 200, 200, 1000, true, 10);
484
+ ```
485
+
486
+ ### swipeCurve - 曲线滑动
487
+
488
+ 执行 3 点曲线滑动(先快后慢),通过起始点、中间点和结束点。
489
+
490
+ ```typescript
491
+ function swipeCurve(
492
+ startX: number,
493
+ startY: number,
494
+ midX: number,
495
+ midY: number,
496
+ endX: number,
497
+ endY: number,
498
+ ): boolean;
499
+ ```
500
+
501
+ **参数:**
502
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
503
+ | ---- | ---- | ---- | ------ | ---- |
504
+ | `startX` | number | 是 | - | 起始 X 坐标 |
505
+ | `startY` | number | 是 | - | 起始 Y 坐标 |
506
+ | `midX` | number | 是 | - | 中间点 X 坐标 |
507
+ | `midY` | number | 是 | - | 中间点 Y 坐标 |
508
+ | `endX` | number | 是 | - | 结束 X 坐标 |
509
+ | `endY` | number | 是 | - | 结束 Y 坐标 |
510
+
511
+ **返回值:**
512
+ | 类型 | 描述 |
513
+ | ---- | ---- |
514
+ | boolean | 操作是否成功 |
515
+
516
+ **示例:**
517
+
518
+ ```javascript
519
+ // 通过三个点的曲线滑动
520
+ hid.swipeCurve(100, 100, 150, 50, 200, 100);
521
+ ```
522
+
523
+ ## 系统导航
524
+
525
+ ### homeScreen - 返回主屏幕
526
+
527
+ 返回到设备主屏幕。
528
+
529
+ ```typescript
530
+ function homeScreen(): boolean;
531
+ ```
532
+
533
+ **返回值:**
534
+ | 类型 | 描述 |
535
+ | ---- | ---- |
536
+ | boolean | 操作是否成功 |
537
+
538
+ **示例:**
539
+
540
+ ```javascript
541
+ // 回到主屏幕
542
+ hid.homeScreen();
543
+ ```
544
+
545
+ ## 文本输入
546
+
547
+ ### input - 文本输入
548
+
549
+ 输入文本。
550
+
551
+ ```typescript
552
+ function input(text: string): boolean;
553
+ ```
554
+
555
+ **参数:**
556
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
557
+ | ---- | ---- | ---- | ------ | ---- |
558
+ | `text` | string | 是 | - | 要输入的文本 |
559
+
560
+ **返回值:**
561
+ | 类型 | 描述 |
562
+ | ---- | ---- |
563
+ | boolean | 操作是否成功 |
564
+
565
+ **示例:**
566
+
567
+ ```javascript
568
+ // 输入文本
569
+ hid.input("Hello World");
570
+
571
+ // 输入中文
572
+ hid.input("测试");
573
+ ```
574
+
575
+ ### inputSimple - 基础文本输入
576
+
577
+ 输入基础文本(不支持中文),等价于键盘逐字输出。
578
+
579
+ ```typescript
580
+ function inputSimple(text: string): boolean;
581
+ ```
582
+
583
+ **参数:**
584
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
585
+ | ---- | ---- | ---- | ------ | ---- |
586
+ | `text` | string | 是 | - | 要输入的基础文本(建议 ASCII) |
587
+
588
+ **返回值:**
589
+ | 类型 | 描述 |
590
+ | ---- | ---- |
591
+ | boolean | 操作是否成功 |
592
+
593
+ **示例:**
594
+
595
+ ```javascript
596
+ // 输入英文与数字
597
+ hid.inputSimple("hello_123");
598
+ ```
599
+
600
+ ## 基础按键操作
601
+
602
+ ### space - 空格键
603
+
604
+ 发送空格键按下。
605
+
606
+ ```typescript
607
+ function space(): boolean;
608
+ ```
609
+
610
+ **返回值:**
611
+ | 类型 | 描述 |
612
+ | ---- | ---- |
613
+ | boolean | 操作是否成功 |
614
+
615
+ **示例:**
616
+
617
+ ```javascript
618
+ hid.space();
619
+ ```
620
+
621
+ ### backspace - 退格键
622
+
623
+ 发送退格键按下。
624
+
625
+ ```typescript
626
+ function backspace(): boolean;
627
+ ```
628
+
629
+ **返回值:**
630
+ | 类型 | 描述 |
631
+ | ---- | ---- |
632
+ | boolean | 操作是否成功 |
633
+
634
+ **示例:**
635
+
636
+ ```javascript
637
+ hid.backspace();
638
+ ```
639
+
640
+ ### enter - 回车键
641
+
642
+ 发送回车/换行键按下。
643
+
644
+ ```typescript
645
+ function enter(): boolean;
646
+ ```
647
+
648
+ **返回值:**
649
+ | 类型 | 描述 |
650
+ | ---- | ---- |
651
+ | boolean | 操作是否成功 |
652
+
653
+ **示例:**
654
+
655
+ ```javascript
656
+ hid.enter();
657
+ ```
658
+
659
+ ### pressButton - 按下系统按钮
660
+
661
+ ```typescript
662
+ function pressButton(
663
+ button: "home" | "volumeup" | "volumedown" | "eject",
664
+ ): boolean;
665
+ ```
666
+
667
+ **参数说明:**
668
+
669
+ | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
670
+ | -------- | ------ | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------ |
671
+ | `button` | string | 是 | - | 按钮类型: <br>-`"home"` Home 键 <br>- `"volumeup"` 音量上键 <br>- `"volumedown"` 音量下键 <br>- `"eject"` 显示/隐藏键盘 |
672
+
673
+ **返回值:**
674
+
675
+ | 类型 | 描述 |
676
+ | --------- | ---------------- |
677
+ | `boolean` | 按下按钮是否成功 |
678
+
679
+ **示例:**
680
+
681
+ ```typescript
682
+ // 按下 Home 键
683
+ hid.pressButton("home");
684
+
685
+ // 调高音量
686
+ hid.pressButton("volumeup");
687
+
688
+ // 调低音量
689
+ hid.pressButton("volumedown");
690
+
691
+ // 连续调节音量
692
+ for (let i = 0; i < 5; i++) {
693
+ hid.pressButton("volumeup");
694
+ sleep(200);
695
+ }
696
+ ```
697
+
698
+ ## 组合键
699
+
700
+ ### sendKey - 发送组合键
701
+
702
+ 发送组合键。
703
+
704
+ ```typescript
705
+ function sendKey(key: Array<number | string>): boolean;
706
+ ```
707
+
708
+ **参数:**
709
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
710
+ | ---- | ---- | ---- | ------ | ---- |
711
+ | `key` | Array<number \| string> | 是 | - | 要发送的按键数组 |
712
+
713
+ **返回值:**
714
+ | 类型 | 描述 |
715
+ | ---- | ---- |
716
+ | boolean | 操作是否成功 |
717
+
718
+ **示例:**
719
+
720
+ ```javascript
721
+ // 发送Cmd+C
722
+ hid.sendKey([hidKey.COMMAND, "c"]);
723
+
724
+ // 发送Ctrl+Alt+Delete
725
+ hid.sendKey([hidKey.LEFT_CTRL, hidKey.LEFT_ALT, hidKey.DELETE]);
726
+ ```
727
+
728
+ ### copyText - 复制文本
729
+
730
+ 发送 Command+C 复制文本。
731
+
732
+ ```typescript
733
+ function copyText(): boolean;
734
+ ```
735
+
736
+ **返回值:**
737
+ | 类型 | 描述 |
738
+ | ---- | ---- |
739
+ | boolean | 操作是否成功 |
740
+
741
+ **示例:**
742
+
743
+ ```javascript
744
+ hid.copyText();
745
+ ```
746
+
747
+ ### pasteText - 粘贴文本
748
+
749
+ 发送 Command+V 粘贴文本。
750
+
751
+ ```typescript
752
+ function pasteText(): boolean;
753
+ ```
754
+
755
+ **返回值:**
756
+ | 类型 | 描述 |
757
+ | ---- | ---- |
758
+ | boolean | 操作是否成功 |
759
+
760
+ **示例:**
761
+
762
+ ```javascript
763
+ hid.pasteText();
764
+ ```
765
+
766
+ ## 导航快捷键
767
+
768
+ ### back - 返回
769
+
770
+ 发送 Tab+B 进行返回导航。
771
+
772
+ ```typescript
773
+ function back(): boolean;
774
+ ```
775
+
776
+ **返回值:**
777
+ | 类型 | 描述 |
778
+ | ---- | ---- |
779
+ | boolean | 操作是否成功 |
780
+
781
+ **示例:**
782
+
783
+ ```javascript
784
+ hid.back();
785
+ ```
786
+
787
+ ### recent - 最近应用
788
+
789
+ 显示 APP 切换器
790
+
791
+ ```typescript
792
+ function recent(): boolean;
793
+ ```
794
+
795
+ **返回值:**
796
+ | 类型 | 描述 |
797
+ | ---- | ---- |
798
+ | boolean | 操作是否成功 |
799
+
800
+ **示例:**
801
+
802
+ ```javascript
803
+ hid.recent();
804
+ ```
805
+
806
+ ### lock - 锁屏
807
+
808
+ 发送锁定屏幕指令。
809
+
810
+ ```typescript
811
+ function lock(): boolean;
812
+ ```
813
+
814
+ **返回值:**
815
+ | 类型 | 描述 |
816
+ | ---- | ---- |
817
+ | boolean | 操作是否成功 |
818
+
819
+ **示例:**
820
+
821
+ ```javascript
822
+ hid.lock();
823
+ ```
824
+
825
+ ### unlock - 解锁
826
+
827
+ 发送两次 Home 键解锁屏幕。
828
+
829
+ ```typescript
830
+ function unlock(): boolean;
831
+ ```
832
+
833
+ **返回值:**
834
+ | 类型 | 描述 |
835
+ | ---- | ---- |
836
+ | boolean | 操作是否成功 |
837
+
838
+ **示例:**
839
+
840
+ ```javascript
841
+ hid.unlock();
842
+ ```
843
+
844
+ ## 应用控制
845
+
846
+ ### openURL - 打开 URL
847
+
848
+ 在默认浏览器或相应应用中打开 URL。
849
+
850
+ ```typescript
851
+ function openURL(url: string): boolean;
852
+ ```
853
+
854
+ **参数:**
855
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
856
+ | ---- | ---- | ---- | ------ | ---- |
857
+ | `url` | string | 是 | - | 要打开的 URL |
858
+
859
+ **返回值:**
860
+ | 类型 | 描述 |
861
+ | ---- | ---- |
862
+ | boolean | 操作是否成功 |
863
+
864
+ **示例:**
865
+
866
+ ```javascript
867
+ // 打开网站
868
+ hid.openURL("https://www.example.com");
869
+
870
+ // 使用自定义scheme打开应用
871
+ hid.openURL("myapp://action");
872
+ ```
873
+
874
+ ### openApp - 打开应用
875
+
876
+ 按名称打开应用程序。
877
+
878
+ ```typescript
879
+ function openApp(name: string): boolean;
880
+ ```
881
+
882
+ **参数:**
883
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
884
+ | ---- | ---- | ---- | ------ | ---- |
885
+ | `name` | string | 是 | - | 应用程序名称 或者 包名 |
886
+
887
+ **返回值:**
888
+ | 类型 | 描述 |
889
+ | ---- | ---- |
890
+ | boolean | 操作是否成功 |
891
+
892
+ **示例:**
893
+
894
+ ```javascript
895
+ // 打开Safari
896
+ hid.openApp("Safari");
897
+
898
+ // 打开设置
899
+ hid.openApp("Settings");
900
+
901
+ // 按 bundleId 打开应用
902
+ hid.openApp("com.example.myapp");
903
+ ```
904
+
905
+ ### closeApp - 关闭应用
906
+
907
+ 按名称关闭应用程序。
908
+
909
+ ```typescript
910
+ function closeApp(name: string): boolean;
911
+ ```
912
+
913
+ **参数:**
914
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
915
+ | ---- | ---- | ---- | ------ | ---- |
916
+ | `name` | string | 是 | - | 应用程序名称 或者 包名 |
917
+
918
+ **返回值:**
919
+ | 类型 | 描述 |
920
+ | ---- | ---- |
921
+ | boolean | 操作是否成功 |
922
+
923
+ **示例:**
924
+
925
+ ```javascript
926
+ // 关闭Safari
927
+ hid.closeApp("Safari");
928
+
929
+ // 关闭设置
930
+ hid.closeApp("Settings");
931
+
932
+ // 按 bundleId 关闭应用
933
+ hid.closeApp("com.example.myapp");
934
+ ```
935
+
936
+ ### takeMeToFront - 置于前台
937
+
938
+ 将当前应用置于前台。
939
+
940
+ ```typescript
941
+ function takeMeToFront(): boolean;
942
+ ```
943
+
944
+ **返回值:**
945
+ | 类型 | 描述 |
946
+ | ---- | ---- |
947
+ | boolean | 操作是否成功 |
948
+
949
+ **示例:**
950
+
951
+ ```javascript
952
+ hid.takeMeToFront();
953
+ ```
954
+
955
+ ### currentAppInfo - 获取当前应用信息
956
+
957
+ 获取当前打开应用的信息(仅 iOS 18.2+)。
958
+
959
+ ```typescript
960
+ function currentAppInfo(): {
961
+ name: string;
962
+ bundleId: string;
963
+ } | null;
964
+ ```
965
+
966
+ **返回值:**
967
+ | 类型 | 描述 |
968
+ | ---- | ---- |
969
+ | object \| null | 当前应用信息或 null(如果不可用) |
970
+
971
+ **返回对象属性:**
972
+ | 属性 | 类型 | 描述 |
973
+ | ---- | ---- | ---- |
974
+ | `name` | string | 应用程序名称 |
975
+ | `bundleId` | string | 应用程序包 ID |
976
+
977
+ **示例:**
978
+
979
+ ```javascript
980
+ const appInfo = hid.currentAppInfo();
981
+ if (appInfo) {
982
+ logi(`当前应用: ${appInfo.name} (${appInfo.bundleId})`);
983
+ }
984
+ ```
985
+
986
+ ## 剪贴板操作
987
+
988
+ ### setClipboard - 设置剪贴板内容
989
+
990
+ 设置剪贴板内容。
991
+
992
+ ```typescript
993
+ function setClipboard(text: string): boolean;
994
+ ```
995
+
996
+ **参数:**
997
+ | 参数 | 类型 | 必需 | 默认值 | 描述 |
998
+ | ---- | ---- | ---- | ------ | ---- |
999
+ | `text` | string | 是 | - | 要设置到剪贴板的文本 |
1000
+
1001
+ **返回值:**
1002
+ | 类型 | 描述 |
1003
+ | ---- | ---- |
1004
+ | boolean | 操作是否成功 |
1005
+
1006
+ **示例:**
1007
+
1008
+ ```javascript
1009
+ hid.setClipboard("你好,世界!");
1010
+ ```
1011
+
1012
+ ### getClipboard - 获取剪贴板内容
1013
+
1014
+ 获取当前剪贴板内容。
1015
+
1016
+ ```typescript
1017
+ function getClipboard(): string;
1018
+ ```
1019
+
1020
+ **返回值:**
1021
+ | 类型 | 描述 |
1022
+ | ---- | ---- |
1023
+ | string | 剪贴板内容或 `""`(如果不可用) |
1024
+
1025
+ **示例:**
1026
+
1027
+ ```javascript
1028
+ const clipboardText = hid.getClipboard();
1029
+ if (clipboardText) {
1030
+ logi("剪贴板内容:", clipboardText);
1031
+ }
1032
+ ```