Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 87dccbe8 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!5179 【英文】翻译已完成4663 

Merge pull request !5179 from shawn_he/OpenHarmony-3.1-Release
上级 17149897 40898d80
隐藏空白更改
内联 并排
Showing with 103 addition and 104 deletion
en/application-dev/dfx/hiappevent-guidelines.md
浏览文件 @ 87dccbe8
...@@ -15,7 +15,7 @@ JS application event logging APIs are provided by the **hiAppEvent** module. ...@@ -15,7 +15,7 @@ JS application event logging APIs are provided by the **hiAppEvent** module.
| write(string eventName, EventType type, object keyValues, AsyncCallback\<void> callback): void | void | Logs application events in asynchronous mode. This method uses an asynchronous callback to return the result. | | write(string eventName, EventType type, object keyValues, AsyncCallback\<void> callback): void | void | Logs application events in asynchronous mode. This method uses an asynchronous callback to return the result. |
| write(string eventName, EventType type, object keyValues): Promise\<void> | Promise\<void> | Logs application events in asynchronous mode. This method uses a promise to return the result. | | write(string eventName, EventType type, object keyValues): Promise\<void> | Promise\<void> | Logs application events in asynchronous mode. This method uses a promise to return the result. |
When an asynchronous callback is used, the return value can be processed directly in the callback. When a promise is used, the return value can also be processed in the promise in a similar way. For details about the result codes, see [Event Verification Result Codes](hiappevent-overview.md#Event Verification Result Codes). When an asynchronous callback is used, the return value can be processed directly in the callback. When a promise is used, the return value can also be processed in the promise in a similar way. For details about the result codes, see [Event Verification Result Codes](#event-verification-result-codes).
**APIs for Event Logging Configuration** **APIs for Event Logging Configuration**
...@@ -23,6 +23,24 @@ When an asynchronous callback is used, the return value can be processed directl ...@@ -23,6 +23,24 @@ When an asynchronous callback is used, the return value can be processed directl
| ------------------------------ | ------------ | ------------------------------------------------------------ | | ------------------------------ | ------------ | ------------------------------------------------------------ |
| configure(ConfigOption config) | boolean | Sets the configuration options for application event logging.<br>The value **true** indicates that the operation is successful, and value **false** indicates the opposite. | | configure(ConfigOption config) | boolean | Sets the configuration options for application event logging.<br>The value **true** indicates that the operation is successful, and value **false** indicates the opposite. |
## Event Verification Result Codes
| Result Code | Cause | Check Rule | Processing Method |
| ----------- | ---------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 0 | None | Event verification is successful. | Event logging is normal. No action is required. |
| -1 | Invalid event name | The event name is not empty and contains a maximum of 48 characters.<br/>The event name consists of only the following characters: digits (0 to 9), letters (a to z), and underscore (\_).<br/>The event name does not start with a digit or underscore (_). | Ignore this event and do not perform logging. |
| -2 | Invalid event parameter type | The event name must be a string.<br/>The event type must be a number.<br/>The key value must be an object. | Ignore this event and do not perform logging. |
| -99 | Application event logging disabled | The application event logging function is disabled. | Ignore this event and do not perform logging. |
| -100 | Unknown error | None | Ignore this event and do not perform logging. |
| 1 | Invalid key name | The key name is not empty and contains a maximum of 16 characters.<br/>The key name consists of only the following characters: digits (0 to 9), letters (a to z), and underscore (\_).<br/>The key name does not start with a digit or underscore (\_).<br/>The key name does not end with an underscore (_). | Ignore the key-value pair and continue to perform logging. |
| 2 | Invalid key type | The key must be a string. | Ignore the key-value pair and continue to perform logging. |
| 3 | Invalid value type | The supported value types vary depending on the programming language:<br/>boolean, number, string, or Array [basic element] | Ignore the key-value pair and continue to perform logging. |
| 4 | Value too long | The value can contain a maximum of 8*1024 characters. | Ignore the key-value pair and continue to perform logging. |
| 5 | Excess key-value pairs | The number of key-value pairs must be less than or equal to 32. | Ignore the excess key-value pairs and continue to perform logging. |
| 6 | Excess elements in a list value | The number of elements in a list value must be less than or equal to 100. | Truncate the list with only the first 100 elements retained, and continue to perform logging. |
| 7 | Invalid list value | A list value can only be a basic element.<br/>The elements in a list value must be of the same type. | Ignore the key-value pair and continue to perform logging. |
## How to Develop ## How to Develop
In this example, an application event is logged after the application startup execution page is loaded. In this example, an application event is logged after the application startup execution page is loaded.
...@@ -75,4 +93,4 @@ In this example, an application event is logged after the application startup ex ...@@ -75,4 +93,4 @@ In this example, an application event is logged after the application startup ex
The following sample is provided to help you better understand how to develop the application event logging feature: The following sample is provided to help you better understand how to develop the application event logging feature:
- [`JsDotTest`: Event Logging Test (JavaScript) (API 7)](https://gitee.com/openharmony/app_samples/tree/master/DFX/JsDotTest) - [`JsDotTest`: Event Logging Test (JavaScript) (API 8)](https://gitee.com/openharmony/app_samples/tree/master/DFX/JsDotTest)
en/application-dev/dfx/hiappevent-overview.md
浏览文件 @ 87dccbe8
...@@ -7,20 +7,3 @@ HiAppEvent provides event logging APIs for applications to log the fault, statis ...@@ -7,20 +7,3 @@ HiAppEvent provides event logging APIs for applications to log the fault, statis
The HiAppEvent module of OpenHarmony can be used to develop application event services and provide functions related to application events, including flushing application events to a disk and querying historical application event data. The HiAppEvent module of OpenHarmony can be used to develop application event services and provide functions related to application events, including flushing application events to a disk and querying historical application event data.
**Logging**: Logs changes caused by user operations to provide service data for development, product, and O&M analysis. **Logging**: Logs changes caused by user operations to provide service data for development, product, and O&M analysis.
## Event Verification Result Codes
| Result Code | Cause | Check Rule | Processing Method |
| ----------- | ---------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 0 | None | Event verification is successful. | Event logging is normal. No action is required. |
| -1 | Invalid event name | The event name is not empty and contains a maximum of 48 characters.<br/>The event name consists of only the following characters: digits (0 to 9), letters (a to z), and underscore (\_).<br/>The event name does not start with a digit or underscore (_). | Ignore this event and do not perform logging. |
| -2 | Invalid event parameter type | The event name must be a string.<br/>The event type must be a number.<br/>The key value must be an object. | Ignore this event and do not perform logging. |
| -99 | Application event logging disabled | The application event logging function is disabled. | Ignore this event and do not perform logging. |
| -100 | Unknown error | None | Ignore this event and do not perform logging. |
| 1 | Invalid key name | The key name is not empty and contains a maximum of 16 characters.<br/>The key name consists of only the following characters: digits (0 to 9), letters (a to z), and underscore (\_).<br/>The key name does not start with a digit or underscore (\_).<br/>The key name does not end with an underscore (_). | Ignore the key-value pair and continue to perform logging. |
| 2 | Invalid key type | The key must be a string. | Ignore the key-value pair and continue to perform logging. |
| 3 | Invalid value type | The supported value types vary depending on the programming language:<br/>boolean, number, string, or Array [basic element] | Ignore the key-value pair and continue to perform logging. |
| 4 | Value too long | The value can contain a maximum of 8*1024 characters. | Ignore the key-value pair and continue to perform logging. |
| 5 | Excess key-value pairs | The number of key-value pairs must be less than or equal to 32. | Ignore the excess key-value pairs and continue to perform logging. |
| 6 | Excess elements in a list value | The number of elements in a list value must be less than or equal to 100. | Truncate the list with only the first 100 elements retained, and continue to perform logging. |
| 7 | Invalid list value | A list value can only be a basic element.<br/>The elements in a list value must be of the same type. | Ignore the key-value pair and continue to perform logging. |
\ No newline at end of file
en/application-dev/reference/apis/js-apis-usb.md
浏览文件 @ 87dccbe8
...@@ -20,7 +20,7 @@ Obtains the USB device list. ...@@ -20,7 +20,7 @@ Obtains the USB device list.
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Array&lt;Readonly&lt;[USBDevice](#usbdevice)&gt;&gt; | Device information list.| | Array&lt;Readonly&lt;[USBDevice](#usbdevice)&gt;&gt; | Device information list. |
- **Example** - **Example**
```js ```js
...@@ -92,12 +92,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -92,12 +92,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| device | [USBDevice](#usbdevice) | Yes| USB device information.| | device | [USBDevice](#usbdevice) | Yes| USB device information. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Readonly&lt;[USBDevicePipe](#usbdevicepipe)&gt; | USB device pipe for data transfer.| | Readonly&lt;[USBDevicePipe](#usbdevicepipe)&gt; | USB device pipe for data transfer. |
- **Example** - **Example**
```js ```js
...@@ -117,12 +117,12 @@ Checks whether the application has the permission to access the device. ...@@ -117,12 +117,12 @@ Checks whether the application has the permission to access the device.
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceName | string | Yes| Device name.| | deviceName | string | Yes| Device name. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the application has the permission to access the device; returns **false** otherwise.| | boolean | Returns **true** if the application has the permission to access the device; returns **false** otherwise. |
- **Example** - **Example**
```js ```js
...@@ -143,12 +143,12 @@ Requests the temporary permission for the application to access the USB device. ...@@ -143,12 +143,12 @@ Requests the temporary permission for the application to access the USB device.
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceName | string | Yes| Device name.| | deviceName | string | Yes| Device name. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Returns **true** if the temporary device access permissions are granted; returns **false** otherwise.| | Promise&lt;boolean&gt; | Returns **true** if the temporary device access permissions are granted; returns **false** otherwise. |
- **Example** - **Example**
```js ```js
...@@ -158,7 +158,6 @@ Requests the temporary permission for the application to access the USB device. ...@@ -158,7 +158,6 @@ Requests the temporary permission for the application to access the USB device.
}); });
``` ```
## usb.claimInterface ## usb.claimInterface
claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number
...@@ -172,14 +171,14 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -172,14 +171,14 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address. |
| iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to claim.| | iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to claim. |
| force | boolean | No| Whether to forcibly claim the USB interface. The default value is **false**, indicating not to forcibly claim the USB interface.| | force | boolean | No| Whether to forcibly claim the USB interface. The default value is **false**, indicating not to forcibly claim the USB interface. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| number | Returns **0** if the USB interface is successfully claimed; returns an error code otherwise.| | number | Returns **0** if the USB interface is successfully claimed; returns an error code otherwise. |
- **Example** - **Example**
```js ```js
...@@ -201,13 +200,13 @@ Before you do this, ensure that you have claimed the interface by calling [usb.c ...@@ -201,13 +200,13 @@ Before you do this, ensure that you have claimed the interface by calling [usb.c
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address. |
| iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to release.| | iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to release. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| number | Returns **0** if the USB interface is successfully released; returns an error code otherwise.| | number | Returns **0** if the USB interface is successfully released; returns an error code otherwise. |
- **Example** - **Example**
```js ```js
...@@ -229,13 +228,13 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -229,13 +228,13 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address. |
| config | [USBConfig](#usbconfig) | Yes| USB configuration to set.| | config | [USBConfig](#usbconfig) | Yes| USB configuration to set. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| number | Returns **0** if the USB configuration is successfully set; returns an error code otherwise.| | number | Returns **0** if the USB configuration is successfully set; returns an error code otherwise. |
- **Example** - **Example**
```js ```js
...@@ -243,27 +242,26 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -243,27 +242,26 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
console.log(`setConfiguration = ${ret}`); console.log(`setConfiguration = ${ret}`);
``` ```
## usb.setInterface ## usb.setInterface
setInterface(pipe: USBDevicePipe, iface: USBInterface): number setInterface(pipe: USBDevicePipe, iface: USBInterface): number
Sets a USB interface. Sets a USB interface.
Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB device list and interfaces, call [usb.requestRight](#usbrequestright) to request the device access permission, and call [usb.connectDevice](#usbconnectdevice) to obtain **devicepipe** as an input parameter. Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB device list and interfaces, call [usb.requestRight](#usbrequestright) to request the device access permission, call [usb.connectDevice](#usbconnectdevice) to obtain **devicepipe** as an input parameter, and call [usb.claimInterface](#usbclaiminterface) to claim the USB interface..
**System capability**: SystemCapability.USB.USBManager **System capability**: SystemCapability.USB.USBManager
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address. |
| iface | [USBInterface](#usbinterface) | Yes| USB interface to set.| | iface | [USBInterface](#usbinterface) | Yes| USB interface to set. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| number | Returns **0** if the USB interface is successfully set; returns an error code otherwise.| | number | Returns **0** if the USB interface is successfully set; returns an error code otherwise. |
- **Example** - **Example**
```js ```js
...@@ -285,12 +283,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -285,12 +283,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Uint8Array | Raw descriptor data.| | Uint8Array | Raw descriptor data. The value **undefined** indicates that the operation has failed. |
- **Example** - **Example**
```js ```js
...@@ -311,12 +309,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -311,12 +309,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| number | File descriptor of the USB device.| | number | File descriptor of the USB device. The value **-1** indicates that the operation has failed. |
- **Example** - **Example**
```js ```js
...@@ -337,14 +335,14 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -337,14 +335,14 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device. |
| contrlparam | [USBControlParams](#usbcontrolparams) | Yes| Control transfer parameters.| | contrlparam | [USBControlParams](#usbcontrolparams) | Yes| Control transfer parameters. |
| timeout | number | No| Timeout duration. The default value is **0**, indicating no timeout.| | timeout | number | No| Timeout duration. The default value is **0**, indicating no timeout. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;number&gt; | Returns the size of the transmitted or received data block if the control transfer is successful; returns **-1** if an exception occurs.| | Promise&lt;number&gt; | Returns the size of the transmitted or received data block if the control transfer is successful; returns **-1** if an exception occurs. |
- **Example** - **Example**
```js ```js
...@@ -367,15 +365,15 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -367,15 +365,15 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device. |
| endpoint | [USBEndpoint](#usbendpoint) | Yes| USB endpoint, which is used to determine the USB port for data transfer.| | endpoint | [USBEndpoint](#usbendpoint) | Yes| USB endpoint, which is used to determine the USB port for data transfer. |
| buffer | Uint8Array | Yes| Buffer for writing or reading data.| | buffer | Uint8Array | Yes| Buffer for writing or reading data. |
| timeout | number | No| Timeout duration. The default value is **0**, indicating no timeout.| | timeout | number | No| Timeout duration. The default value is **0**, indicating no timeout. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;number&gt; | Returns the size of the transmitted or received data block if the control transfer is successful; returns **-1** if an exception occurs.| | Promise&lt;number&gt; | Returns the size of the transmitted or received data block if the control transfer is successful; returns **-1** if an exception occurs. |
- **Example** - **Example**
```js ```js
...@@ -401,12 +399,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi ...@@ -401,12 +399,12 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi
- **Parameters** - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe.| | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe. |
- **Return value** - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| number | Returns **0** if the USB device pipe is closed successfully; returns an error code otherwise.| | number | Returns **0** if the USB device pipe is closed successfully; returns an error code otherwise. |
- **Example** - **Example**
```js ```js
...@@ -423,14 +421,14 @@ Represents the USB endpoint from which data is sent or received. You can obtain ...@@ -423,14 +421,14 @@ Represents the USB endpoint from which data is sent or received. You can obtain
| Name| Type| Description| | Name| Type| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| address | number | Endpoint address.| | address | number | Endpoint address. |
| attributes | number | Endpoint attributes.| | attributes | number | Endpoint attributes. |
| interval | number | Endpoint interval.| | interval | number | Endpoint interval. |
| maxPacketSize | number | Maximum size of data packets on the endpoint.| | maxPacketSize | number | Maximum size of data packets on the endpoint. |
| direction | [USBRequestDirection](#usbrequestdirection) | Endpoint direction.| | direction | [USBRequestDirection](#usbrequestdirection) | Endpoint direction. |
| number | number | Endpoint number.| | number | number | Endpoint number. |
| type | number | Endpoint type.| | type | number | Endpoint type. |
| interfaceId | number | Unique ID of the interface to which the endpoint belongs.| | interfaceId | number | Unique ID of the interface to which the endpoint belongs. |
## USBInterface ## USBInterface
...@@ -441,13 +439,13 @@ Represents a USB interface. One [USBConfig](#usbconfig) can contain multiple **U ...@@ -441,13 +439,13 @@ Represents a USB interface. One [USBConfig](#usbconfig) can contain multiple **U
| Name| Type| Description| | Name| Type| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| id | number | Unique ID of the USB interface.| | id | number | Unique ID of the USB interface. |
| protocol | number | Interface protocol.| | protocol | number | Interface protocol. |
| clazz | number | Device type.| | clazz | number | Device type. |
| subClass | number | Device subclass.| | subClass | number | Device subclass. |
| alternateSetting | number | Settings for alternating between descriptors of the same USB interface.| | alternateSetting | number | Settings for alternating between descriptors of the same USB interface. |
| name | string | Interface name.| | name | string | Interface name. |
| endpoints | Array&lt;[USBEndpoint](#usbendpoint)&gt; | Endpoints that belong to the USB interface.| | endpoints | Array&lt;[USBEndpoint](#usbendpoint)&gt; | Endpoints that belong to the USB interface. |
## USBConfig ## USBConfig
...@@ -458,13 +456,13 @@ Represents the USB configuration. One [USBDevice](#usbdevice) can contain multip ...@@ -458,13 +456,13 @@ Represents the USB configuration. One [USBDevice](#usbdevice) can contain multip
| Name| Type| Description| | Name| Type| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| id | number | Unique ID of the USB configuration.| | id | number | Unique ID of the USB configuration. |
| attributes | number | Configuration attributes.| | attributes | number | Configuration attributes. |
| maxPower | number | Maximum power consumption, in mA.| | maxPower | number | Maximum power consumption, in mA. |
| name | string | Configuration name, which can be left empty.| | name | string | Configuration name, which can be left empty. |
| isRemoteWakeup | boolean | Support for remote wakeup.| | isRemoteWakeup | boolean | Support for remote wakeup. |
| isSelfPowered | boolean | Support for independent power supplies.| | isSelfPowered | boolean | Support for independent power supplies. |
| interfaces | Array&nbsp;&lt;[USBInterface](#usbinterface)&gt; | Supported interface attributes.| | interfaces | Array&nbsp;&lt;[USBInterface](#usbinterface)&gt; | Supported interface attributes. |
## USBDevice ## USBDevice
...@@ -475,19 +473,19 @@ Represents USB device information. ...@@ -475,19 +473,19 @@ Represents USB device information.
| Name| Type| Description| | Name| Type| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| busNum | number | Bus address.| | busNum | number | Bus address. |
| devAddress | number | Device address.| | devAddress | number | Device address. |
| serial | string | Device SN.| | serial | string | Device SN. |
| name | string | Device name.| | name | string | Device name. |
| manufacturerName | string | Device manufacturer.| | manufacturerName | string | Device manufacturer. |
| productName | string | Product information.| | productName | string | Product information. |
| version | string | Version.| | version | string | Version. |
| vendorId | number | Vendor ID.| | vendorId | number | Vendor ID. |
| productId | number | Product ID.| | productId | number | Product ID. |
| clazz | number | Device class.| | clazz | number | Device class. |
| subClass | number | Device subclass.| | subClass | number | Device subclass. |
| protocol | number | Device protocol code.| | protocol | number | Device protocol code. |
| configs | Array&lt;[USBConfig](#usbconfig)&gt; | Device configuration descriptor information.| | configs | Array&lt;[USBConfig](#usbconfig)&gt; | Device configuration descriptor information. |
## USBDevicePipe ## USBDevicePipe
...@@ -498,8 +496,8 @@ Represents a USB device pipe, which is used to determine a USB device. ...@@ -498,8 +496,8 @@ Represents a USB device pipe, which is used to determine a USB device.
| Name| Type| Description| | Name| Type| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| busNum | number | Bus address.| | busNum | number | Bus address. |
| devAddress | number | Device address.| | devAddress | number | Device address. |
## USBControlParams ## USBControlParams
...@@ -510,12 +508,12 @@ Represents control transfer parameters. ...@@ -510,12 +508,12 @@ Represents control transfer parameters.
| Name| Type| Description| | Name| Type| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| request | number | Request type.| | request | number | Request type. |
| target | [USBRequestTargetType](#usbrequesttargettype) | Represents the request target type.| | target | [USBRequestTargetType](#usbrequesttargettype) | Type of the request target. |
| reqType | [USBControlRequestType](#usbcontrolrequesttype) | Request control type.| | reqType | [USBControlRequestType](#usbcontrolrequesttype) | Request control type. |
| value | number | Request parameters| | value | number | Request parameters|
| index | number | Index of the request parameter value.| | index | number | Index of the request parameter value. |
| data | Uint8Array | Buffer for writing or reading data.| | data | Uint8Array | Buffer for writing or reading data. |
## USBRequestTargetType ## USBRequestTargetType
...@@ -526,8 +524,8 @@ Represents the request target type. ...@@ -526,8 +524,8 @@ Represents the request target type.
| Name| Default Value | Description| | Name| Default Value | Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| USB_REQUEST_TARGET_DEVICE | 0 | Device.| | USB_REQUEST_TARGET_DEVICE | 0 | Device. |
| USB_REQUEST_TARGET_INTERFACE | 1 | Interface.| | USB_REQUEST_TARGET_INTERFACE | 1 | Interface. |
| USB_REQUEST_TARGET_ENDPOINT | 2 | Endpoint| | USB_REQUEST_TARGET_ENDPOINT | 2 | Endpoint|
| USB_REQUEST_TARGET_OTHER | 3 | Others| | USB_REQUEST_TARGET_OTHER | 3 | Others|
...@@ -541,7 +539,7 @@ Enumerates control request types. ...@@ -541,7 +539,7 @@ Enumerates control request types.
| Name| Default Value | Description| | Name| Default Value | Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| USB_REQUEST_TYPE_STANDARD | 0 | Standard| | USB_REQUEST_TYPE_STANDARD | 0 | Standard|
| USB_REQUEST_TYPE_CLASS | 1 | Class.| | USB_REQUEST_TYPE_CLASS | 1 | Class. |
| USB_REQUEST_TYPE_VENDOR | 2 | Vendor| | USB_REQUEST_TYPE_VENDOR | 2 | Vendor|
...@@ -553,5 +551,5 @@ Enumerates request directions. ...@@ -553,5 +551,5 @@ Enumerates request directions.
| Name| Default Value | Description| | Name| Default Value | Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| USB_REQUEST_DIR_TO_DEVICE | 0 | Request for writing data from the host to the device.| | USB_REQUEST_DIR_TO_DEVICE | 0 | Request for writing data from the host to the device. |
| USB_REQUEST_DIR_FROM_DEVICE | 0x80 | Request for reading data from the device to the host.| | USB_REQUEST_DIR_FROM_DEVICE | 0x80 | Request for reading data from the device to the host. |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或