Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
50eb6763
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
50eb6763
编写于
1月 13, 2023
作者:
L
luo-wei246
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
fix:Update the USB module js interface guide
Signed-off-by:
N
luo-wei246
<
luowei137@huawei.com
>
上级
3da03c25
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
21 addition
and
18 deletion
+21
-18
zh-cn/application-dev/device/usb-guidelines.md
zh-cn/application-dev/device/usb-guidelines.md
+11
-8
zh-cn/application-dev/reference/apis/js-apis-usb-deprecated.md
.../application-dev/reference/apis/js-apis-usb-deprecated.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-usb.md
zh-cn/application-dev/reference/apis/js-apis-usb.md
+5
-5
未找到文件。
zh-cn/application-dev/device/usb-guidelines.md
浏览文件 @
50eb6763
...
...
@@ -24,13 +24,13 @@ USB类开放能力如下,具体请查阅[API参考文档](../reference/apis/js
| getDevices(): Array
<
Readonly
<
USBDevice
>>
| 获取接入主设备的USB设备列表。如果没有设备接入,那么将会返回一个空的列表。 |
| setConfiguration(pipe: USBDevicePipe, config: USBConfig): number | 设置设备的配置。 |
| setInterface(pipe: USBDevicePipe, iface: USBInterface): number | 设置设备的接口。 |
| claimInterface(pipe: USBDevicePipe, iface: USBInterface,
force
?: boolean): number | 注册通信接口。 |
| bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise
<
number
>
| 批量传输。 |
| claimInterface(pipe: USBDevicePipe, iface: USBInterface,
force
?: boolean): number | 注册通信接口。 |
| bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout
?: number): Promise
<
number
>
| 批量传输。 |
| closePipe(pipe: USBDevicePipe): number | 关闭设备消息控制通道。 |
| releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number | 释放注册过的通信接口。 |
| getFileDescriptor(pipe: USBDevicePipe): number | 获取文件描述符。 |
| getRawDescriptor(pipe: USBDevicePipe): Uint8Array | 获取原始的USB描述符。 |
| controlTransfer(pipe: USBDevicePipe, contr
lparam: USBControlParams, timeout
?: number): Promise
<
number
>
| 控制传输。 |
| controlTransfer(pipe: USBDevicePipe, contr
olparam: USBControlParams, timeout
?: number): Promise
<
number
>
| 控制传输。 |
## 开发步骤
...
...
@@ -57,7 +57,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例
vendorId: 7531,
productId: 2,
clazz: 9,
sub
c
lass: 0,
sub
C
lass: 0,
protocol: 1,
devAddress: 1,
busNum: 1,
...
...
@@ -74,7 +74,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例
id: 0,
protocol: 0,
clazz: 9,
sub
c
lass: 0,
sub
C
lass: 0,
alternateSetting: 0,
name: "1-1",
endpoints: [
...
...
@@ -115,11 +115,12 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例
```
js
// 打开设备,获取数据传输通道。
let
pipe
=
usb
.
connectDevice
(
deviceList
[
0
]);
let
interface1
=
deviceList
[
0
].
configs
[
0
].
interfaces
[
0
];
/*
打开对应接口,在设备信息(deviceList)中选取对应的interface。
interface1为设备配置中的一个接口。
*/
usb
.
claimInterface
(
pipe
,
interface1
,
true
);
usb
.
claimInterface
(
pipe
,
interface1
,
true
);
```
4.
数据传输。
...
...
@@ -129,7 +130,9 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例
读取数据,在device信息中选取对应数据接收的endpoint来做数据传输
(endpoint.direction == 0x80);dataUint8Array是要读取的数据,类型为Uint8Array。
*/
let
inEndpoint
=
interface1
.
endpoints
[
2
];
let
outEndpoint
=
interface1
.
endpoints
[
1
];
let
dataUint8Array
=
new
Uint8Array
(
1024
);
usb
.
bulkTransfer
(
pipe
,
inEndpoint
,
dataUint8Array
,
15000
).
then
(
dataLength
=>
{
if
(
dataLength
>=
0
)
{
console
.
info
(
"
usb readData result Length :
"
+
dataLength
);
...
...
@@ -142,7 +145,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例
console
.
info
(
"
usb readData error :
"
+
JSON
.
stringify
(
error
));
});
// 发送数据,在device信息中选取对应数据发送的endpoint来做数据传输。(endpoint.direction == 0)
usb
.
bulkTransfer
(
pipe
,
e
ndpoint
,
dataUint8Array
,
15000
).
then
(
dataLength
=>
{
usb
.
bulkTransfer
(
pipe
,
outE
ndpoint
,
dataUint8Array
,
15000
).
then
(
dataLength
=>
{
if
(
dataLength
>=
0
)
{
console
.
info
(
"
usb writeData result write length :
"
+
dataLength
);
}
else
{
...
...
zh-cn/application-dev/reference/apis/js-apis-usb-deprecated.md
浏览文件 @
50eb6763
...
...
@@ -45,7 +45,7 @@ console.log(`devicesList = ${JSON.stringify(devicesList)}`);
vendorId
:
7531
,
productId
:
2
,
clazz
:
9
,
sub
c
lass
:
0
,
sub
C
lass
:
0
,
protocol
:
1
,
devAddress
:
1
,
busNum
:
1
,
...
...
@@ -62,7 +62,7 @@ console.log(`devicesList = ${JSON.stringify(devicesList)}`);
id
:
0
,
protocol
:
0
,
clazz
:
9
,
sub
c
lass
:
0
,
sub
C
lass
:
0
,
alternateSetting
:
0
,
name
:
"
1-1
"
,
endpoints
:
[
...
...
@@ -173,7 +173,7 @@ usb.requestRight(devicesName).then((ret) => {
## usb.claimInterface
claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number
claimInterface(pipe: USBDevicePipe, iface: USBInterface, force
?: boolean): number
注册通信接口。
...
...
@@ -350,7 +350,7 @@ let ret = usb.getFileDescriptor(devicepipe);
## usb.controlTransfer
controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout?: number): Promise
<
number
>
controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout
?: number): Promise
<
number
>
控制传输。
...
...
@@ -382,7 +382,7 @@ usb.controlTransfer(devicepipe, USBControlParams).then((ret) => {
## usb.bulkTransfer
bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise
<
number
>
bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout
?: number): Promise
<
number
>
批量传输。
...
...
zh-cn/application-dev/reference/apis/js-apis-usb.md
浏览文件 @
50eb6763
...
...
@@ -43,7 +43,7 @@ console.log(`devicesList = ${JSON.stringify(devicesList)}`);
vendorId
:
7531
,
productId
:
2
,
clazz
:
9
,
sub
c
lass
:
0
,
sub
C
lass
:
0
,
protocol
:
1
,
devAddress
:
1
,
busNum
:
1
,
...
...
@@ -60,7 +60,7 @@ console.log(`devicesList = ${JSON.stringify(devicesList)}`);
id
:
0
,
protocol
:
0
,
clazz
:
9
,
sub
c
lass
:
0
,
sub
C
lass
:
0
,
alternateSetting
:
0
,
name
:
"
1-1
"
,
endpoints
:
[
...
...
@@ -253,7 +253,7 @@ if (usb.addRight(bundleName, devicesName) {
## usb.claimInterface
claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number
claimInterface(pipe: USBDevicePipe, iface: USBInterface, force
?: boolean): number
注册通信接口。
...
...
@@ -430,7 +430,7 @@ let ret = usb.getFileDescriptor(devicepipe);
## usb.controlTransfer
controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout?: number): Promise
<
number
>
controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout
?: number): Promise
<
number
>
控制传输。
...
...
@@ -462,7 +462,7 @@ usb.controlTransfer(devicepipe, USBControlParams).then((ret) => {
## usb.bulkTransfer
bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise
<
number
>
bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout
?: number): Promise
<
number
>
批量传输。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录