harmony 鸿蒙@system.bluetooth (蓝牙)

2022-08-09
浏览 (1109)

@system.bluetooth (蓝牙)

说明：

从API Version 7 开始，该接口不再维护，推荐使用@ohos.bluetooth.ble等相关profile接口。

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

导入模块

import bluetooth from '@system.bluetooth';

bluetooth.startBLEScan(OBJECT)

开始搜寻附近的低功耗蓝牙外围设备。此操作比较耗费系统资源，请在搜索并连接到设备后调用bluetooth.stopBLEScan方法停止搜索。

系统能力： SystemCapability.Communication.Bluetooth.Lite

参数： 表1 StartBLEScanOptions

名称	类型	必填	说明
interval	number	否	上报设备的间隔，单位毫秒，默认值为0。0表示找到新设备立即上报，其他数值根据传入的间隔上报。
success	Function	否	接口调用成功的回调函数。
fail	Function	否	接口调用失败的回调函数。
complete	Function	否	接口调用结束的回调函数。

示例：

  bluetooth.startBLEScan({
    interval:0,
    success() {
      console.log('call bluetooth.startBLEScan success.');
    },
    fail(code, data) {
      console.log('call bluetooth.startBLEScan failed, code:' + code + ', data:' + data);
    },
    complete() {
      console.log('call bluetooth.startBLEScan complete.');
    }
  });

bluetooth.stopBLEScan(OBJECT)

停止搜寻附近的低功耗蓝牙外围设备。与bluetooth.startBLEScan(OBJECT)接口配套使用。

系统能力： SystemCapability.Communication.Bluetooth.Lite

参数： 表2 StopBLEScanOptions

名称	类型	必填	说明
success	Function	否	接口调用成功的回调函数。
fail	Function	否	接口调用失败的回调函数。
complete	Function	否	接口调用结束的回调函数。

示例：

  bluetooth.stopBLEScan({
    success() {
      console.log('call bluetooth.stopBLEScan success.');
    },
    fail(data, code) {
      console.log('call bluethooth.stopBLEScan fail, code:' + code + ', data:' + data);
    },
    complete() {
      console.log('call bluethooth.stopBLEScan complete.');
    }
  });

bluetooth.subscribeBLEFound(OBJECT)

订阅寻找到新设备。再次调用时，会覆盖前一次调用效果，即仅最后一次调用生效。

系统能力： SystemCapability.Communication.Bluetooth.Lite

参数： 表3 SubscribeBLEFoundOptions

名称	类型	必填	说明
success	Function	是	寻找到新设备上报时调用的回调函数。
fail	Function	否	接口调用失败的回调函数。

表4 success返回值：

参数名	类型	说明
devices	Array<BluetoothDevice>	新搜索到的设备列表。

表5 BluethoothDevice

参数名	类型	说明
addrType	string	设备地址类型，可能值有： - public: 公共地址 - random: 随机地址
addr	string	设备MAC地址。
rssi	number	设备蓝牙的信号强弱指标。
txpower	string	广播数据中的txpower字段。
data	hex string	广播数据（包含广播数据和扫描响应数据），十六进制字符串。

示例：

  bluetooth.subscribeBLEFound({
    success(data) {
      console.log('call bluetooth.subscribeBLEFound success, data: ${data}.');
    },
    fail(data, code) {
      console.log('call bluetooth.startBLEScan failed, code:' + code + ', data:' + data);
    }
  });

bluetooth.unsubscribeBLEFound()

解除订阅寻找到新设备。

系统能力： SystemCapability.Communication.Bluetooth.Lite

示例：

  bluetooth.unsubscribeBLEFound();

常见错误码

错误码	说明
1100	是否处于已连接状态。
1101	当前蓝牙适配器不可用。
1102	没有找到指定设备。
1103	连接失败。
1104	没有找到指定服务。
1105	没有找到指定特征值。
1106	当前连接已断开。
1107	当前特征值不支持此操作。
1108	其余所有系统上报的异常。
1109	系统版本不支持 BLE。