ms-vite-plugin 1.4.49 → 1.4.51

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