文档中心

场景介绍

控制传输主要用于主机（Host）和设备（Device）进行设备状态的获取和设置，进行设备属性状态的控制。根据设备支持的端点类型支持控制传输读和写。

环境准备

环境要求

开发工具及配置：

DevEco Studio作为驱动开发工具，是进行驱动开发必备条件之一，开发者可以使用该工具进行开发、调试、打包等操作。请下载安装该工具，并参考DevEco Studio使用指南中的创建工程及运行进行基本的操作验证，保证DevEco Studio可正常运行。
SDK版本配置：

扩展外设管理提供的ArkTS接口，所需SDK版本为API16及以上才可使用。
HDC配置：

HDC（HarmonyOS Device Connector）是为开发人员提供的用于调试的命令行工具，通过该工具可以在Windows/Linux/Mac系统上与真实设备或者模拟器进行交互，详细参考HDC配置。

搭建环境

在PC上安装DevEco Studio，要求版本在4.1及以上。
将public-SDK更新到API 16或以上。
PC安装HDC工具，通过该工具可以在Windows/Linux/Mac系统上与真实设备或者模拟器进行交互。
用USB线缆将搭载HarmonyOS的设备连接到PC。

开发指导

接口说明

展开

接口名	描述
usbControlTransfer(pipe: USBDevicePipe, requestparam: USBDeviceRequestParams, timeout?: number): Promise<number>	控制传输。

更多关于设备管理和传输模式的详细接口介绍，请查阅@ohos.usbManager。

开发步骤

主机（Host）连接设备（Device），通过usbControlTransfer接口进行数据传输。以下步骤描述了如何使用控制传输方式来传输数据：

说明

以下示例代码只是使用控制传输方式来传输数据的必要流程，需要放入具体的方法中执行。在实际调用时，设备开发者需要遵循设备相关协议进行调用，确保数据的正确传输和设备的兼容性。

导入模块。

// 导入usbManager模块
import { usbManager, BusinessError } from '@kit.BasicServicesKit';
import { JSON } from '@kit.ArkTS';

Index.ets

获取设备列表。

// 获取设备列表。
let deviceList: usbManager.USBDevice[] = [];
try {
  deviceList = usbManager.getDevices();
} catch (error) {
  let errorObj: BusinessError = error as BusinessError;
  console.error(`USB getDevices failed: code=${errorObj.code}, message=${errorObj.message}`);
  this.logInfo_ += '\n[ERROR] USB getDevices failed: code=' + errorObj.code + ', message=' + errorObj.message;
}

console.info(`deviceList: ${deviceList}`);
this.logInfo_ += '\n[INFO] deviceList: ' + JSON.stringify(deviceList);
if (deviceList === undefined || deviceList.length === 0) {
  console.error('deviceList is empty');
  this.logInfo_ += '\n[ERROR] deviceList is empty';
  return;
}
/*
  deviceList结构示例
  [
    {
      name: '1-1',
      serial: '',
      manufacturerName: '',
      productName: '',
      version: '',
      vendorId: 7531,
      productId: 2,
      clazz: 9,
      subClass: 0,
      protocol: 1,
      devAddress: 1,
      busNum: 1,
      configs: [
        {
          id: 1,
          attributes: 224,
          isRemoteWakeup: true,
          isSelfPowered: true,
          maxPower: 0,
          name: '1-1',
          interfaces: [
            {
              id: 0,
              protocol: 0,
              clazz: 9,
              subClass: 0,
              alternateSetting: 0,
              name: '1-1',
              endpoints: [
                {
                  address: 129,
                  attributes: 3,
                  interval: 12,
                  maxPacketSize: 4,
                  direction: 128,
                  number: 1,
                  type: 3,
                  interfaceId: 0,
                }
              ]
            }
          ]
        }
      ]
    }
  ]
 */
this.deviceList_ = deviceList;

Index.ets

获取设备操作权限。

if (this.deviceList_ === undefined || this.deviceList_.length === 0) {
  console.error('deviceList is empty');
  this.logInfo_ += '\n[ERROR] deviceList is empty';
  return;
}
let deviceList: usbManager.USBDevice[] = this.deviceList_;
let deviceName: string = deviceList[0].name;
// 申请操作指定的device的操作权限。
usbManager.requestRight(deviceName).then((hasRight: boolean) => {
  console.info('usb device request right result: ' + hasRight);
  this.logInfo_ += '\n[INFO] usb device request right result: ' + JSON.stringify(hasRight);
}).catch((error: BusinessError) => {
  console.error(`usb device request right failed : code=${error.code}, message=${error.message}`);
  this.logInfo_ += '\n[ERROR] usb device request right failed: code=' + error.code + ', message=' + error.message;
});

Index.ets

打开设备。

if (this.deviceList_ === undefined || this.deviceList_.length === 0) {
  console.error('deviceList is empty');
  this.logInfo_ += '\n[ERROR] deviceList is empty';
  return;
}
let deviceList: usbManager.USBDevice[] = this.deviceList_;
try {
  if (!usbManager.hasRight(deviceList[0]?.name)) {
    console.error('permission denied');
    this.logInfo_ += '\n[ERROR] permission denied';
    return;
  }
  // 打开设备，获取数据传输通道。
  let pipe: usbManager.USBDevicePipe = usbManager.connectDevice(deviceList[0]);
  if (!pipe) {
    console.error('connectDevice failed, pipe is undefined');
    this.logInfo_ += '\n[ERROR] connectDevice failed, pipe is undefined';
    return;
  }
  if (!deviceList?.[0]?.configs?.[0]?.interfaces?.[0]) {
    console.error('invalid interface');
    this.logInfo_ += '\n[ERROR] invalid interface';
    return;
  }
  let interface1: usbManager.USBInterface = deviceList?.[0]?.configs?.[0]?.interfaces?.[0];
  /*
    打开对应接口，在设备信息（deviceList）中选取对应的interface。
    interface1为设备配置中的一个接口。
   */
  usbManager.claimInterface(pipe, interface1, true);
  this.pipe_ = pipe;
  this.interface_ = interface1;
  console.info('open device success');
  this.logInfo_ += '\n[INFO] open device success';
} catch (error) {
  let errorObj: BusinessError = error as BusinessError;
  console.error(`USB hasRight failed: code=${errorObj.code}, message=${errorObj.message}`);
  this.logInfo_ += '\n[ERROR] USB hasRight failed: code=' + errorObj.code + ', message=' + errorObj.message;
}

Index.ets

数据传输。

if (this.pipe_ === undefined) {
  console.error('pipe_ is null');
  this.logInfo_ += '\n[ERROR] pipe_ is null';
  return;
}
let pipe: usbManager.USBDevicePipe = this.pipe_;
/*
  构造控制传输参数
 */
let param: usbManager.USBDeviceRequestParams = {
  bmRequestType: 0x80, // 0x80指一次由设备到主机的标准请求命令
  bRequest: 0x06, // 0x06指获取描述符
  wValue: 0x01 << 8 | 0, // 该值为2个字节，高字节指描述符类型，此处0x01指设备描述符；低字节指描述符索引，设备描述符不涉及，填0
  wIndex: 0, // 索引值，可填0
  wLength: 18, // 描述符的长度，此处18表示设备描述符长度，最大支持1024
  data: new Uint8Array(18)
};

usbManager.usbControlTransfer(pipe, param).then((ret: number) => {
  console.info(`usbControlTransfer = ${ret}`);
  this.logInfo_ += '\n[INFO] usbControlTransfer = ' + JSON.stringify(ret);
}).catch((error: BusinessError) => {
  console.error(`usbControlTransfer error : code=${error.code}, message=${error.message}`);
  this.logInfo_ += '\n[ERROR] usbControlTransfer error: code=' + error.code + ', message=' + error.message;
});

Index.ets

释放接口，关闭设备。

if (this.pipe_ === undefined || this.interface_ === undefined) {
  console.error('pipe_ or interface_ is null');
  this.logInfo_ += '\n[ERROR] pipe_ or interface_ is null';
  return;
}
let pipe: usbManager.USBDevicePipe = this.pipe_;
let interface1: usbManager.USBInterface = this.interface_;
try {
  usbManager.releaseInterface(pipe, interface1);
  usbManager.closePipe(pipe);
} catch (error) {
  let errorObj: BusinessError = error as BusinessError;
  console.error(`failed: code=${errorObj.code}, message=${errorObj.message}`);
  this.logInfo_ += '\n[ERROR] failed: code=' + errorObj.code + ', message=' + errorObj.message;
}

this.pipe_ = undefined;
this.interface_ = undefined;
console.info('close device success');
this.logInfo_ += '\n[INFO] close device success';

Index.ets

USB控制传输

场景介绍

环境准备

环境要求

搭建环境

开发指导

接口说明

开发步骤