@ohos.distributedHardware.deviceManager (设备管理)

本模块提供分布式设备管理能力。

系统应用可调用接口实现如下功能：

• 注册和解除注册设备上下线变化监听
• 发现周边不可信设备
• 认证和取消认证设备
• 查询可信设备列表
• 查询本地设备信息，包括设备名称，设备类型和设备标识
• 发布设备发现

说明：

• 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块接口为系统接口，三方应用不支持调用。

导入模块

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

deviceManager.createDeviceManager

createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager>): void

创建一个设备管理器实例。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  deviceManager.createDeviceManager("ohos.samples.jshelloworld", (err, data) => {
    if (err) { 
      console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
      return;
    }
    console.info("createDeviceManager success");
    let dmInstance = data;
  });
} catch(err) {
  console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message);
}

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

PublishInfo⁹⁺

发布设备参数

系统能力：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager

DeviceManager

设备管理实例，用于获取可信设备和本地设备的相关信息。在调用DeviceManager的方法前，需要先通过createDeviceManager构建一个DeviceManager实例dmInstance。

release

release(): void

设备管理实例不再使用后，通过该方法释放DeviceManager实例。

系统能力：SystemCapability.DistributedHardware.DeviceManager

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  dmInstance.release();
} catch (err) {
  console.error("release errCode:" + err.code + ",errMessage:" + err.message);
}

getTrustedDeviceListSync

getTrustedDeviceListSync(): Array<DeviceInfo>

同步获取所有可信设备列表。

系统能力：SystemCapability.DistributedHardware.DeviceManager

返回值：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  var deviceInfoList = dmInstance.getTrustedDeviceListSync();
} catch (err) {
  console.error("getTrustedDeviceListSync errCode:" + err.code + ",errMessage:" + err.message);
}

getTrustedDeviceList⁸⁺

getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): void

获取所有可信设备列表。使用callback异步回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  dmInstance.getTrustedDeviceList((err, data) => {
    if (err) {
      console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
      return;
    }
    console.log('get trusted device info: ' + JSON.stringify(data));
  });
} catch (err) {
  console.error("getTrustedDeviceList errCode:" + err.code + ",errMessage:" + err.message);
}

getTrustedDeviceList⁸⁺

getTrustedDeviceList(): Promise<Array<DeviceInfo>>

获取所有可信设备列表。使用Promise异步回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

返回值：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

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

getLocalDeviceInfoSync⁸⁺

getLocalDeviceInfoSync(): DeviceInfo

同步获取本地设备信息。

系统能力：SystemCapability.DistributedHardware.DeviceManager

返回值：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  var deviceInfo = dmInstance.getLocalDeviceInfoSync();
} catch (err) {
  console.error("getLocalDeviceInfoSync errCode:" + err.code + ",errMessage:" + err.message);
}

getLocalDeviceInfo⁸⁺

getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void

获取本地设备信息。使用callback异步回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  dmInstance.getLocalDeviceInfo((err, data) => {
  if (err) {
    console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
    return;
  }
    console.log('get local device info: ' + JSON.stringify(data));
  });
} catch (err) {
  console.error("getLocalDeviceInfo errCode:" + err.code + ",errMessage:" + err.message);
}

getLocalDeviceInfo⁸⁺

getLocalDeviceInfo(): Promise<DeviceInfo>

获取本地设备信息。使用Promise异步回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

返回值：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

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

startDeviceDiscovery⁸⁺

startDeviceDiscovery(subscribeInfo: SubscribeInfo): void

发现周边设备。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

// 生成发现标识，随机数确保每次调用发现接口的标识不一致
var subscribeId = Math.floor(Math.random() * 10000 + 1000);
var subscribeInfo = {
    "subscribeId": subscribeId,
    "mode": 0xAA, // 主动模式
    "medium": 0,  // 自动发现类型，同时支持多种发现类型
    "freq": 2,    // 高频率
    "isSameAccount": false,
    "isWakeRemote": false,
    "capability": 1
};
try {
  dmInstance.startDeviceDiscovery(subscribeInfo); // 当有设备发现时，通过deviceFound回调通知给应用程序
} catch (err) {
  console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
}

startDeviceDiscovery⁹⁺

startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void

发现周边设备。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

// 生成发现标识，随机数确保每次调用发现接口的标识不一致
var subscribeId = Math.floor(Math.random() * 10000 + 1000);
var subscribeInfo = {
    "subscribeId": subscribeId,
    "mode": 0xAA, // 主动模式
    "medium": 0,  // 自动发现类型，同时支持多种发现类型
    "freq": 2,    // 高频率
    "isSameAccount": false,
    "isWakeRemote": false,
    "capability": 1
};
var filterOptions = {
  "filter_op": "OR", // 可选, 默认"OR"
  "filters": [
      {
          "type": "range",
          "value": 50 // 需过滤发现设备的距离，单位(cm)
      }
  ]
};
try {
  dmInstance.startDeviceDiscovery(subscribeInfo, JSON.stringify(filterOptions)); // 当有设备发现时，通过deviceFound回调通知给应用程序
} catch (err) {
  console.error("startDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
}

stopDeviceDiscovery

stopDeviceDiscovery(subscribeId: number): void

停止发现周边设备。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  // stopDeviceDiscovery和startDeviceDiscovery需配对使用，入参需要和startDeviceDiscovery接口传入的subscribeId值相等
  var subscribeId = 12345;
  dmInstance.stopDeviceDiscovery(subscribeId);
} catch (err) {
  console.error("stopDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
}

publishDeviceDiscovery⁹⁺

publishDeviceDiscovery(publishInfo: PublishInfo): void

发布设备发现。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

// 生成发布标识，随机数确保每次调用发布接口的标识不一致
var publishId = Math.floor(Math.random() * 10000 + 1000);
var publishInfo = {
    "publishId": publishId,
    "mode": 0xAA, // 主动模式
    "freq": 2,    // 高频率
    "ranging": true  // 支持发现时测距
};
try {
  dmInstance.publishDeviceDiscovery(publishInfo); // 当有发布结果时，通过回调通知给应用程序
} catch (err) {
  console.error("publishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
}

unPublishDeviceDiscovery⁹⁺

unPublishDeviceDiscovery(publishId: number): void

停止发布设备发现。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  // unPublishDeviceDiscovery和publishDeviceDiscovery配对使用，入参需要和publishDeviceDiscovery接口传入的publishId值相等
  var publishId = 12345;
  dmInstance.unPublishDeviceDiscovery(publishId);
} catch (err) {
  console.error("unPublishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
}

authenticateDevice

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

认证设备。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

// 认证的设备信息，可以从发现的结果中获取
var deviceInfo ={
    "deviceId": "XXXXXXXX",
    "deviceName": "",
    "deviceType": 0x0E,
    "networkId" : "xxxxxxx",
    "range" : 0
};
let extraInfo = {
        'targetPkgName': 'ohos.samples.xxx',
        'appName': 'xxx',
        'appDescription': 'xxx',
        'business': '0'
}
let authParam = {
    'authType': 1,// 认证类型： 1 - 无帐号PIN码认证
    'extraInfo': extraInfo
}
try {
  dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => {
    if (err) {
        console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
        return;
    }
    console.info("authenticateDevice result:" + JSON.stringify(data));
    let token = data.pinToken;
  });
} catch (err) {
  console.error("authenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
}

unAuthenticateDevice⁸⁺

unAuthenticateDevice(deviceInfo: DeviceInfo): void

解除认证设备。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

try {
  var deviceInfo ={
    "deviceId": "XXXXXXXX",
    "deviceName": "",
    "deviceType": 0x0E,
    "networkId" : "xxxxxxx",
    "range" : 0
  };
  dmInstance.unAuthenticateDevice(deviceInfo);
} catch (err) {
  console.error("unAuthenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
}

verifyAuthInfo

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

验证认证信息。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

错误码：

以下的错误码的详细介绍请参见设备管理错误码

示例：

let authInfo = {
  "authType": 1,
  "token": 123456,
  "extraInfo": {}
}
try {
  dmInstance.verifyAuthInfo(authInfo, (err, data) => {
  if (err) {
      console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
      return;
  }
  console.info("verifyAuthInfo result:" + JSON.stringify(data));
  });
} catch (err) {
  console.error("verifyAuthInfo errCode:" + err.code + ",errMessage:" + err.message);
}

setUserOperation⁹⁺

setUserOperation(operateAction: number, params: string): void;

设置用户ui操作行为。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  /*
    operateAction = 0 - 允许授权
    operateAction = 1 - 取消授权
    operateAction = 2 - 授权框用户操作超时
    operateAction = 3 - 取消pin码框展示
    operateAction = 4 - 取消pin码输入框展示
    operateAction = 5 - pin码输入框确定操作
  */
  let operation = 0;
  dmInstance.setUserOperation(operation, "extra")
  } catch (err) {
    console.error("setUserOperation errCode:" + err.code + ",errMessage:" + err.message);
}

on('uiStateChange')⁹⁺

on(type: 'uiStateChange', callback: Callback<{ param: string}>): void;

ui状态变更回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on('uiStateChange', (data) => {
  console.log("uiStateChange executed, dialog closed" + JSON.stringify(data))
  var tmpStr = JSON.parse(data.param)
  var isShow = tmpStr.verifyFailed
  console.log("uiStateChange executed, dialog closed" + isShow)
});
} catch (err) {
  console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
}

off('uiStateChange')⁹⁺

off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void;

取消ui状态变更回调

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off('uiStateChange');
} catch (err) {
  console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
}

on('deviceStateChange')

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

注册设备状态回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on('deviceStateChange', (data) => {
    console.info("deviceStateChange on:" + JSON.stringify(data));
  });
} catch (err) {
  console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
}

off('deviceStateChange')

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

取消注册设备状态回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off('deviceStateChange', (data) => {
    console.info('deviceStateChange' + JSON.stringify(data));
  });
} catch (err) {
  console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message);
}

on('deviceFound')

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

注册发现设备回调监听。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on('deviceFound', (data) => {
    console.info("deviceFound:" + JSON.stringify(data));
  });
} catch (err) {
  console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
}

off('deviceFound')

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

取消注册设备发现回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off('deviceFound', (data) => {
    console.info('deviceFound' + JSON.stringify(data));
  });
} catch (err) {
  console.error("deviceFound errCode:" + err.code + ",errMessage:" + err.message);
}

on('discoverFail')

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

注册设备发现失败回调监听。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on('discoverFail', (data) => {
      console.info("discoverFail on:" + JSON.stringify(data));
  });
} catch (err) {
  console.error("discoverFail errCode:" + err.code + ",errMessage:" + err.message);
}

off('discoverFail')

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

取消注册设备发现失败回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off('discoverFail', (data) => {
    console.info('discoverFail' + JSON.stringify(data));
  });
} catch (err) {
  console.error("discoverFail errCode:" + err.code + ",errMessage:" + err.message);
}

on('publishSuccess')⁹⁺

on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): void

注册发布设备发现回调监听。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on('publishSuccess', (data) => {
    console.info("publishSuccess:" + JSON.stringify(data));
  });
} catch (err) {
  console.error("publishSuccess errCode:" + err.code + ",errMessage:" + err.message);
}

off('publishSuccess')⁹⁺

off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): void

取消注册设备发布成功回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off('publishSuccess', (data) => {
    console.info('publishSuccess' + JSON.stringify(data));
  });
} catch (err) {
  console.error("publishSuccess errCode:" + err.code + ",errMessage:" + err.message);
}

on('publishFail')⁹⁺

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

注册设备发布失败回调监听。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on('publishFail', (data) => {
    console.info("publishFail on:" + JSON.stringify(data));
  });
} catch (err) {
  console.error("publishFail errCode:" + err.code + ",errMessage:" + err.message);
}

off('publishFail')⁹⁺

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

取消注册设备发布失败回调。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off('publishFail', (data) => {
    console.info('publishFail' + JSON.stringify(data));
  });
} catch (err) {
  console.error("publishFail errCode:" + err.code + ",errMessage:" + err.message);
}

on('serviceDie')

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

注册设备管理服务死亡监听。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.on("serviceDie", () => {
    console.info("serviceDie on");
  });
} catch (err) {
  console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
}

off('serviceDie')

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

取消注册设备管理服务死亡监听。

系统能力：SystemCapability.DistributedHardware.DeviceManager

参数：

示例：

try {
  dmInstance.off("serviceDie", () => {
    console.info("serviceDie off");
  });
} catch (err) {
  console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message);
}