Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[zh-cn]: create docs for HID #24285

Merged
merged 4 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions files/zh-cn/web/api/hid/connect_event/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: HID:connect 事件
slug: Web/API/HID/connect_event
l10n:
sourceCommit: 534e2c61fee576355e8a9b7036d9fa36056edb03
---

{{securecontext_header}}{{APIRef("WebHID API")}}{{SeeCompatTable}}{{AvailableInWorkers("window_and_worker_except_shared")}}

{{domxref("HID")}} 接口的 **`connect`** 事件在用户代理连接到 HID 设备时触发。

## 语法

在诸如 {{domxref("EventTarget.addEventListener", "addEventListener()")}} 之类的方法中使用事件名称,或设置一个事件处理器属性。

```js
addEventListener("connect", (event) => {});

onconnect = (event) => {};
```

## 事件类型

一个 {{domxref("HIDConnectionEvent")}}。继承自 {{domxref("Event")}}。

{{InheritanceDiagram("HIDConnectionEvent")}}

## 事件属性

_除下面列出的属性外,还可以使用来自于父接口 {{domxref("Event")}} 的属性。_

- {{domxref("HIDConnectionEvent.device", "device")}} {{ReadOnlyInline}}
- : 触发此事件的 {{domxref("HIDDevice")}}。

## 示例

在以下示例中,注册了一个事件监听器来监听设备的连接。然后使用 {{domxref("HIDDevice.productName")}} 将设备的名称打印到控制台。

```js
navigator.hid.addEventListener("connect", ({ device }) => {
console.log(`HID 已连接:${device.productName}`);
});
```

## 规范

{{Specifications}}

## 浏览器兼容性

{{Compat}}
51 changes: 51 additions & 0 deletions files/zh-cn/web/api/hid/disconnect_event/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: HID:disconnect 事件
slug: Web/API/HID/disconnect_event
l10n:
sourceCommit: 534e2c61fee576355e8a9b7036d9fa36056edb03
---

{{securecontext_header}}{{APIRef("WebHID API")}}{{SeeCompatTable}}{{AvailableInWorkers("window_and_worker_except_shared")}}

{{domxref("HID")}} 接口的 **`disconnect`** 事件在用户代理断开与 HID 设备的链接时触发。

## 语法

在诸如 {{domxref("EventTarget.addEventListener", "addEventListener()")}} 之类的方法中使用事件名称,或设置一个事件处理器属性。

```js
addEventListener("disconnect", (event) => {});

ondisconnect = (event) => {};
```

## 事件类型

一个 {{domxref("HIDConnectionEvent")}}。继承自 {{domxref("Event")}}。

{{InheritanceDiagram("HIDConnectionEvent")}}

## 事件属性

_除下面列出的属性外,还可以使用来自于父接口 {{domxref("Event")}} 的属性。_

- {{domxref("HIDConnectionEvent.device", "device")}} {{ReadOnlyInline}}
- : 触发此事件的 {{domxref("HIDDevice")}}。

## 示例

在以下示例中,注册了一个事件监听器来监听设备的断开连接。然后使用 {{domxref("HIDDevice.productName")}} 将设备的名称打印到控制台。

```js
navigator.hid.addEventListener("disconnect", ({ device }) => {
console.log(`HID 断开连接:${device.productName}`);
});
```

## 规范

{{Specifications}}

## 浏览器兼容性

{{Compat}}
45 changes: 45 additions & 0 deletions files/zh-cn/web/api/hid/getdevices/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: HID:getDevices() 方法
slug: Web/API/HID/getDevices
l10n:
sourceCommit: 534e2c61fee576355e8a9b7036d9fa36056edb03
---

{{securecontext_header}}{{APIRef("WebHID API")}}{{SeeCompatTable}}{{AvailableInWorkers("window_and_worker_except_shared")}}

{{domxref("HID")}} 接口的 **`getDevices()`** 方法获取一个包含用户之前已通过 {{domxref("HID.requestDevice","requestDevice()")}} 调用授予访问权限的已连接 HID 设备列表。

## 语法

```js-nolint
getDevices()
```

### 参数

无。

### 返回值

一个兑现一组 {{domxref("HIDDevice")}} 对象的 {{jsxref("Promise")}}。

## 示例

以下示例获取设备列表并将设备名称记录到控制台。

```js
document.addEventListener("DOMContentLoaded", async () => {
let devices = await navigator.hid.getDevices();
devices.forEach((device) => {
console.log(`HID:${device.productName}`);
});
});
```

## 规范

{{Specifications}}

## 浏览器兼容性

{{Compat}}
44 changes: 44 additions & 0 deletions files/zh-cn/web/api/hid/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: HID
slug: Web/API/HID
l10n:
sourceCommit: 534e2c61fee576355e8a9b7036d9fa36056edb03
---

{{securecontext_header}}{{APIRef("WebHID API")}}{{SeeCompatTable}}{{AvailableInWorkers("window_and_worker_except_shared")}}

**`HID`** 接口提供连接到 _HID 设备_、列出已连接的 HID 设备以及为已连接的 HID 设备处理事件的方法。

{{InheritanceDiagram}}

## 实例属性

_此接口也从其父接口 {{domxref("EventTarget")}} 继承属性。_

## 实例方法

_此接口也从其父接口 {{domxref("EventTarget")}} 继承方法。_

- {{domxref("HID.getDevices","getDevices()")}} {{Experimental_Inline}}
- : 返回一个 {{jsxref("Promise")}},其在兑现时提供一个数组,包含用户之前已通过 {{domxref("HID.requestDevice","requestDevice()")}} 调用授予访问权限的已连接 HID 设备。
- {{domxref("HID.requestDevice","requestDevice()")}} {{Experimental_Inline}}
- : 返回一个 {{jsxref("Promise")}},其在兑现时提供一个包含已连接 {{domxref("HIDDevice")}} 对象的数组。调用此函数将触发用户代理的权限流程,以便从返回的设备列表中获得访问一个选定设备的权限。

### 事件

- {{domxref("HID.connect_event", "connect")}} {{Experimental_Inline}}
- : 当 HID 设备连接时触发。
- {{domxref("HID.disconnect_event", "disconnect")}} {{Experimental_Inline}}
- : 当 HID 设备断开连接时触发。

## 规范

{{Specifications}}

## 浏览器兼容性

{{Compat}}

## 参见

- [WebHID API](/zh-CN/docs/Web/API/WebHID_API)
116 changes: 116 additions & 0 deletions files/zh-cn/web/api/hid/requestdevice/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: HID:requestDevice() 方法
slug: Web/API/HID/requestDevice
l10n:
sourceCommit: f2088b8912ef205a737551441d54b73507bd3ac6
---

{{securecontext_header}}{{APIRef("WebHID API")}}{{SeeCompatTable}}

{{domxref("HID")}} 接口的 **`requestDevice()`** 方法请求请问 HID 设备。

用户代理将显示一个包含已连接设备列表的权限对话框,并要求用户选择其中一个设备并授予权限。

## 语法

```js-nolint
requestDevice(options)
```

### 参数

- `options`

- : 一个对象,包含要与之配对的可能设备的过滤器对象数组。每个过滤器对象可以具有以下属性:

- `vendorId` {{optional_inline}}
- : 一个整数,表示请求的 HID 设备的供应商 ID(即:vendorId)
- `productId` {{optional_inline}}
- : 一个整数,表示请求的 HID 设备的产品 ID(即:productId)
- `usagePage` {{optional_inline}}

- : 一个整数,表示请求设备的 HID 用途中的用途页面组件。顶级集合的用途用于识别设备类型。

可以在 [HID 使用表](https://usb.org/document-library/hid-usage-tables-15) 文档中找到标准 HID 用途值。

- `usage` {{optional_inline}}
- : 一个整数,表示请求设备的 HID 用途中的用途 ID 组件。

> [!NOTE]
> 设备过滤器用于缩小向用户展示的设备列表。如果没有过滤器,则显示所有连接的设备。当包含一个或多个过滤器时,如果任何过滤器匹配,则包含该设备。为了匹配过滤器,该过滤器中包含的所有规则都必须匹配。

### 返回值

一个会兑现为与传入的过滤器匹配的已连接 {{domxref("HIDDevice")}} 对象数组的 {{jsxref("Promise")}}。

### 异常

- `SecurityError` {{domxref("DOMException")}}
- : 如果页面不允许访问 HID 功能,则会抛出此异常。

## 安全性

需要[瞬态用户激活](/zh-CN/docs/Web/Security/User_activation)。用户必须与页面或 UI 元素进行交互,才能使此功能正常工作。

## 示例

### 匹配具有所有四个过滤器规则的设备

在以下示例中,请求一个具有供应商 ID `0xABCD`、产品 ID `0x1234`、用途页面 `0x0C` 和用途 ID `0x01` 的 HID 设备。只有匹配所有这些规则的设备才会显示。

```js
let requestButton = document.getElementById("request-hid-device");
requestButton.addEventListener("click", async () => {
let device;
try {
const devices = await navigator.hid.requestDevice({
filters: [
{
vendorId: 0xabcd,
productId: 0x1234,
usagePage: 0x0c,
usage: 0x01,
},
],
});
device = devices[0];
} catch (error) {
console.log("发生错误。");
}

if (!device) {
console.log("没有选择设备。");
} else {
console.log(`HID:${device.productName}`);
}
});
```

### 包含两个过滤器的示例

下一个示例包含了两个过滤器。如果设备匹配其中任何一个过滤器,它们将被显示出来。

```js
// 过滤具有 Nintendo Switch Joy-Con USB 供应商/产品 ID 的设备。
const filters = [
{
vendorId: 0x057e, // 任天堂株式会社(Nintendo Co., Ltd)
productId: 0x2006, // Joy-Con 左手柄
},
{
vendorId: 0x057e, // 任天堂株式会社(Nintendo Co., Ltd)
productId: 0x2007, // Joy-Con 右手柄
},
];

// 提示用户选择一个 Joy-Con 设备。
const [device] = await navigator.hid.requestDevice({ filters });
```

## 规范

{{Specifications}}

## 浏览器兼容性

{{Compat}}