HarmonyOS 裝置管理開發:USB 服務開發指導

HarmonyOS開發者社群發表於2023-11-24

基本概念

USB 服務是應用訪問底層的一種裝置抽象概念。開發者根據提供的 USB API,可以獲取裝置列表、控制裝置訪問許可權、以及與連線的裝置進行資料傳輸、控制命令傳輸等。

運作機制

USB 服務系統包含 USB API、USB Service、USB HAL。

圖 1 USB 服務運作機制 HarmonyOS 裝置管理開發:USB 服務開發指導


●  USB API:提供 USB 的基礎 API,主要包含查詢 USB 裝置列表、批次資料傳輸、控制命令傳輸、許可權控制等。

●  USB Service:主要實現 HAL 層資料的接收、解析、分發以及對裝置的管理等。

●  USB HAL 層:提供給使用者態可直接呼叫的驅動能力介面。

場景介紹

Host 模式下,可以獲取到已經連線的 USB 裝置列表,並根據需要開啟和關閉裝置、控制裝置許可權、進行資料傳輸等。

介面說明

USB 服務主要提供的功能有:查詢 USB 裝置列表、批次資料傳輸、控制命令傳輸、許可權控制等。

USB 類開放能力如下,具體請查閱 API參考文件

表 1 USB 類的開放能力介面

HarmonyOS 裝置管理開發:USB 服務開發指導


HarmonyOS 裝置管理開發:USB 服務開發指導


HarmonyOS 裝置管理開發:USB 服務開發指導


HarmonyOS 裝置管理開發:USB 服務開發指導

開發步驟

USB 裝置可作為 Host 裝置連線 Device 裝置進行資料傳輸。開發示例如下:

1.  獲取裝置列表。

```ts
// 匯入USB介面api包。
import usb from '@ohos.usbManager';
// 獲取裝置列表。
let deviceList : Array<usb.USBDevice> = usb.getDevices();
/
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,
              }
            ]
          }
        ]
      }
    ]
  }
]
/



2.  獲取裝置操作許可權。

```ts 
import usb from '@ohos.usbManager'; 
import { BusinessError } from '@ohos.base'; 
let deviceName : string = deviceList[0].name;
// 申請操作指定的device的操作許可權。
usb.requestRight(deviceName).then((hasRight : boolean) => {
  console.info("usb device request right result: " + hasRight);
}).catch((error : BusinessError)=> {
  console.info("usb device request right failed : " + error);
});
```



3.  開啟 Device 裝置。

```ts
// 開啟裝置,獲取資料傳輸通道。
let interface1 = deviceList[0].configs[0].interfaces[0];
let interface1 : number = deviceList[0].configs[0].interfaces[0];
/
 開啟對應介面,在裝置資訊(deviceList)中選取對應的interface。
interface1為裝置配置中的一個介面。
/
usb.claimInterface(pipe, interface1, true);



let pipe : USBDevicePipe = usb.connectDevice(deviceList[0]);

4.  資料傳輸。

import usb from '@ohos.usbManager'; 
import { BusinessError } from '@ohos.base';
/*
 讀取資料,在device資訊中選取對應資料接收的endpoint來做資料傳輸
(endpoint.direction == 0x80);dataUint8Array是要讀取的資料,型別為Uint8Array。
*/
let inEndpoint : USBEndpoint = interface1.endpoints[2];
let outEndpoint : USBEndpoint = interface1.endpoints[1];
let dataUint8Array : Array<number> = new Uint8Array(1024);
usb.bulkTransfer(pipe, inEndpoint, dataUint8Array, 15000).then((dataLength : number) => {
if (dataLength >= 0) {
  console.info("usb readData result Length : " + dataLength);
} else {
  console.info("usb readData failed : " + dataLength);
}
}).catch((error : BusinessError) => {
console.info("usb readData error : " + JSON.stringify(error));
});
// 傳送資料,在device資訊中選取對應資料傳送的endpoint來做資料傳輸。(endpoint.direction == 0)
usb.bulkTransfer(pipe, outEndpoint, dataUint8Array, 15000).then((dataLength : number) => {
  if (dataLength >= 0) {
    console.info("usb writeData result write length : " + dataLength);
  } else {
    console.info("writeData failed");
  }
}).catch((error : BusinessError) => {
  console.info("usb writeData error : " + JSON.stringify(error));
});



let inEndpoint : USBEndpoint = interface1.endpoints[2];

5.  釋放介面,關閉裝置。

```ts
usb.releaseInterface(pipe, interface1);
usb.closePipe(pipe);
```





來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/70009402/viewspace-2997134/,如需轉載,請註明出處,否則將追究法律責任。

相關文章