設備管理

本模塊提供分布式設備管理能力。

系統應用可調用接口實現如下功能：

• 注冊和解除注冊設備上下線變化監聽
• 發現周邊不可信設備
• 認證和取消認證設備
• 查詢可信設備列表
• 查詢本地設備信息，包括設備名稱，設備類型和設備標識

說明：

• 本模塊首批接口從API version 7開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。
• 本模塊接口為系統接口，三方應用不支持調用。
• 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import deviceManager from '@ohos.distributedHardware.deviceManager';

deviceManager.createDeviceManager

createDeviceManager(bundleName: string, callback: AsyncCallback): void

創建一個設備管理器實例。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  參數名	類型	必填	說明
  bundleName	string	是	指示應用程序的包名。
  callback	AsyncCallback<[DeviceManager]>	是	DeviceManager實例創建時調用的回調，返回設備管理器對象實例。

• 示例：

  deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) = > {     
      if (err) { 
          console.info("createDeviceManager err:" + JSON.stringify(err));    
          return;
      }
      console.info("createDeviceManager success");
      this.dmInstance = data;
  });
  

DeviceInfo

設備信息。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

DeviceType

表示設備類型的枚舉類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

DeviceStateChangeAction

表示設備狀態變化的枚舉。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

SubscribeInfo

發現信息。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

DiscoverMode

表示發現模式的枚舉。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

ExchangeMedium

表示發現類型的枚舉。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

ExchangeFreq

表示發現頻率的枚舉。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

SubscribeCap

表示發現能力的枚舉。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

AuthParam

認證參數。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

AuthInfo

認證信息。

系統能力 ：以下各項對應的系統能力均為SystemCapability.DistributedHardware.DeviceManager

DeviceManager

設備管理實例，用于獲取可信設備和本地設備的相關信息。在調用DeviceManager的方法前，需要先通過createDeviceManager構建一個DeviceManager實例dmInstance。

release

release(): void

設備管理實例不再使用后，通過該方法釋放DeviceManager實例。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 示例：

  dmInstance.release();
  

getTrustedDeviceListSync

getTrustedDeviceListSync(): Array

同步獲取所有可信設備列表。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 返回值：

  名稱	說明
  Array<[DeviceInfo]>	返回可信設備列表。

• 示例：

  var deviceInfoList = dmInstance.getTrustedDeviceListSync();
  

getTrustedDeviceList8+

getTrustedDeviceList(callback:AsyncCallback>): void

獲取所有可信設備列表。使用callback異步回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  callback	AsyncCallback>	是	獲取所有可信設備列表的回調，返回設備信息。

• 示例：

  dmInstance.getTrustedDeviceList((err, data) = > {
      console.log("getTrustedDeviceList err: " + JSON.stringify(err));
      console.log('get trusted device info: ' + JSON.stringify(data));
    }
  );
  

getTrustedDeviceList8+

getTrustedDeviceList(): Promise>

獲取所有可信設備列表。使用Promise異步回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 返回值：

  類型	說明
  Promise>	Promise實例，用于獲取異步返回結果。

• 示例：

  dmInstance.getTrustedDeviceList().then((data) = > { 
      console.log('get trusted device info: ' + JSON.stringify(data));
  }).catch((err) = > {
      console.log("getTrustedDeviceList err: " + JSON.stringify(err));
  });
  

getLocalDeviceInfoSync8+

getLocalDeviceInfoSync(): [DeviceInfo]

同步獲取本地設備信息。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 返回值：

  名稱	說明
  Array<[DeviceInfo]>	返回可信設備列表。

• 示例：

  var deviceInfo = dmInstance.getLocalDeviceInfoSync();
  

getLocalDeviceInfo8+

getLocalDeviceInfo(callback:AsyncCallback): void

獲取本地設備信息。使用callback異步回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  callback	AsyncCallback<[DeviceInfo]>	是	獲取本地設備信息。

• 示例：

  dmInstance.getLocalDeviceInfo((err, data) = > {
      console.log("getLocalDeviceInfo err: " + JSON.stringify(err));
      console.log('get local device info: ' + JSON.stringify(data));
    }
  );
  

getLocalDeviceInfo8+

getLocalDeviceInfo(): Promise

獲取本地設備信息。使用Promise異步回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 返回值：

  類型	說明
  Promise<[DeviceInfo]>	Promise實例，用于獲取異步返回結果。

• 示例：

  dmInstance.getLocalDeviceInfo().then((data) = > { 
      console.log('get local device info: ' + JSON.stringify(data));
  }).catch((err) = > {
      console.log("getLocalDeviceInfo err: " + JSON.stringify(err));
  });
  

startDeviceDiscovery

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

發現周邊設備。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  subscribeInfo	[SubscribeInfo]	是	發現信息。

• 示例：

  //生成發現標識，隨機數確保每次調用發現接口的標識不一致
  var subscribeId = Math.floor(Math.random() * 10000 + 1000);
  var subscribeInfo = {
      "subscribeId": subscribeId,
      "mode": 0xAA, //主動模式
      "medium": 0,  //自動發現類型，同時支持多種發現類型
      "freq": 2,    //高頻率
      "isSameAccount": false,
      "isWakeRemote": false,
      "capability": 1
  };
  dmInstance.startDeviceDiscovery(subscribeInfo); //當有設備發現時，通過deviceFound回調通知給應用程序
  

stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止發現周邊設備。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  subscribeId	number	是	發現標識。

• 示例：

  //入參需要和startDeviceDiscovery接口傳入的subscribeId配對使用
  dmInstance.stopDeviceDiscovery(subscribeId);
  

authenticateDevice

authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback<{deviceId: string, pinToken ?: number}>): void

認證設備。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  deviceInfo	[DeviceInfo]	是	設備信息。
  authParam	[AuthParam]	是	認證參數。
  callback	AsyncCallback<{ deviceId: string, pinToken ?: number }>	是	認證結果回調。

• 示例：

  //認證的設備信息，可以從發現的結果中獲取
  var deviceInfo ={
      "deviceId": "XXXXXXXX",
      "deviceName": "",
      deviceType: 0x0E
  };
  let authParam = {
      "authType": 1, //認證類型： 1 - 無賬號PIN碼認證
      "extraInfo": {} 
  }
  dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) = > {
      if (err) {
          console.info(TAG + "authenticateDevice err:" + JSON.stringify(err));
          return;
      }
      console.info(TAG + "authenticateDevice result:" + JSON.stringify(data));
      token = data.pinToken;
  });
  

unAuthenticateDevice8+

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除認證設備。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  deviceInfo	[DeviceInfo]	是	設備信息。

• 示例：

  dmInstance.unAuthenticateDevice(deviceInfo);
  

verifyAuthInfo

verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void

驗證認證信息。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  authInfo	[AuthInfo]	是	認證信息。
  authInfo	AsyncCallback<{ deviceId: string, level: number }>	是	驗證結果回調。

• 示例：

  let authInfo = {
    "authType": 1,
    "token": xxxxxx,
    "extraInfo": {}
  }
  dmInstance.verifyAuthInfo(authInfo, (err, data) = > {
    if (err) {
        console.info(TAG + "verifyAuthInfo err:" + JSON.stringify(err));
        return;
    }
    console.info(TAG + "verifyAuthInfo result:" + JSON.stringify(data));
  });
  

on('deviceStateChange')

on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void

注冊設備狀態回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	注冊設備狀態回調，固定為deviceStateChange。
  callback	Callback<{ action: [DeviceStateChangeAction], device: [DeviceInfo] }>	是	指示要注冊的設備狀態回調，返回設備狀態和設備信息。

• 示例：

  dmInstance.on('deviceStateChange', (data) = > {      
        console.info("deviceStateChange on:" + JSON.stringify(data));
      }
  );
  

off('deviceStateChange')

off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void

取消注冊設備狀態回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	根據應用程序的包名取消注冊設備狀態回調。
  callback	Callback<{ action: [DeviceStateChangeAction], device: [DeviceInfo] }>	是	指示要取消注冊的設備狀態回調，返回設備狀態和設備信息。

• 示例：

  dmInstance.off('deviceStateChange', (data) = > {      
        console.info('deviceStateChange' + JSON.stringify(data));
     }
  );
  

on('deviceFound')

on(type: 'deviceFound', callback: Callback<{ subscribeId: number, device: DeviceInfo }>): void

注冊發現設備回調監聽。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	注冊設備發現回調，以便在發現周邊設備時通知應用程序。
  callback	Callback<{ subscribeId: number, device: DeviceInfo }>	是	注冊設備發現的回調方法。

• 示例：

  dmInstance.on('deviceFound', (data) = > {
        console.info("deviceFound:" + JSON.stringify(data));
      }
  );
  

off('deviceFound')

off(type: 'deviceFound', callback?: Callback<{ subscribeId: number, device: DeviceInfo }>): void

取消注冊設備發現回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	取消注冊設備發現回調。
  callback	Callback<{ subscribeId: number, device: DeviceInfo }>	是	指示要取消注冊的設備發現回調，返回設備狀態和設備信息。

• 示例：

  dmInstance.off('deviceFound', (data) = > {      
        console.info('deviceFound' + JSON.stringify(data));
      }
  );
  

on('discoverFail')

on(type: 'discoverFail', callback: Callback<{ subscribeId: number, reason: number }>): void

注冊設備發現失敗回調監聽。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	注冊設備發現失敗回調，以便在發現周邊設備失敗時通知應用程序。
  callback	Callback<{ subscribeId: number, reason: number }>	是	注冊設備發現失敗的回調方法。

• 示例：

  dmInstance.on('discoverFail', (data) = > {
        this.log("discoverFail on:" + JSON.stringify(data));
      }
  );
  

off('discoverFail')

off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: number }>): void

取消注冊設備發現失敗回調。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	取消注冊設備發現失敗回調。
  callback	Callback<{ subscribeId: number, reason: number }>	是	指示要取消注冊的設備發現失敗回調。

• 示例：

  dmInstance.off('deviceFound', (data) = > {      
        console.info('deviceFound' + JSON.stringify(data));
      }
  );
  

on('serviceDie')

on(type: 'serviceDie', callback: () => void): void

注冊設備管理服務死亡監聽。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	注冊serviceDie回調，以便在devicemanager服務異常終止時通知應用程序。
  callback	() => void	是	注冊serviceDie的回調方法。

• 示例：

  dmInstance.on("serviceDie", () = > {      
        console.info("serviceDie on");
     }
  );
  

off('serviceDie')

off(type: 'serviceDie', callback?: () => void): void

取消注冊設備管理服務死亡監聽。

系統能力 ：SystemCapability.DistributedHardware.DeviceManager

• 參數：

  名稱	參數類型	必填	說明
  type	string	是	取消注冊serviceDie回調，以便在devicemanager服務異常終止時通知應用程序。
  callback	() => void	否	取消注冊serviceDie的回調方法。HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿

• 示例：

  dmInstance.off("serviceDie", () = > {      
        console.info("serviceDie off");
    }
  );
  

審核編輯 黃宇