01 蓝牙入口模块 - MiEcosystem/miot-plugin-sdk GitHub Wiki

蓝牙设备操作类 蓝牙设备的开发，详见：BLE设备，此处不再赘述蓝牙开发的流程以及蓝牙的工作原理。 默认大家对iOS中的CoreBluetooth和Android中的android.bluetooth有一定了解，了解了这些内容再来读此文档，事半功倍。 蓝牙设备由1个js文件拆分为5个js文件，主要为： index.js 蓝牙设备相关入口文件 BluetoothDevice.js 普通蓝牙设备功能文件，包含了蓝牙设备的基本操作，比如发现，连接，取消链接，蓝牙事件等模块。 LockDevice.js 蓝牙锁独有的相关功能文件，提供了蓝牙锁的开关锁，密码管理，加解密等功能 CoreBluetooth.js 蓝牙服务/特征值管理类文件，提供了蓝牙服务，蓝牙特征值等模块 ClassicDevice.js 经典蓝牙功能文件，包含了经典蓝牙的连接，数据读写等操作，一般开发者不用关心此文件。 每个文件的具体功能，请直接查看此文件的具体文档。

Export: public
Doc_name: 蓝牙入口模块
Doc_index: 1
Doc_directory: bluetooth
Example

import {Bluetooth} from 'miot/device/bluetooth'

 Bluetooth.checkBluetoothIsEnabled().then(result => {
        this.state.isEnable = result;
        if (result) {
            this.addLog("蓝牙已开启")
            this.startScan();
        } else {
            this.addLog("蓝牙未开启，请检查开启蓝牙后再试")
            Host.ui.showBLESwitchGuide();
        }
    })

...

ble.disconnect()

• miot/device/bluetooth
  • module.exports ⏏
    • static
      • .UUID128 ⇒ string
      • .isSameUUID(uuid1, uuid2)
      • .createBluetoothLE(macOrPeripheralID) ⇒ IBluetooth
      • .createBluetoothClassic(macOrPeripheralID) ⇒ IBluetoothClassic
      • .checkBluetoothIsEnabled() ⇒ [ 'Promise' ].<boolean>
      • .startScan(durationInMillis, ...serviceUUIDs) ⇒ void
      • .stopScan() ⇒ void
      • .retrievePeripheralsForIOS(...UUIDs) ⇒ [ 'Promise' ].<Map.<uuid, IBluetooth>>
      • .retrievePeripheralsWithServicesForIOS(...serviceUUIDs) ⇒ [ 'Promise' ].<Map.<uuid, IBluetooth>>
      • .enableBluetoothForAndroid(silence) ⇒
      • .isBleGatewayConnected(mac) ⇒ [ 'Promise' ].<boolean>
      • .isBleOrMeshGatewayConnected(mac, forceRefresh) ⇒ [ 'Promise' ].<Object>
      • .getBtGateWaySubDeviceRSSI() ⇒ [ 'Promise' ].<Object>
      • .bindDeviceforMIUI(mac)
      • .unBindDeviceforMIUI(mac)
      • .setAlertConfigsOnMIUI(alert, enable, mac)
    • inner
      • ~blespec

蓝牙操作入口类

Kind: Exported interface

标准化蓝牙UUID为128位大写

Kind: static property of module.exports

Example

import {Bluetooth} from 'miot/device/bluetooth';
const myServiceUUID = Bluetooth.UUID128("0015");
const myCharacterUUID = Bluetooth.UUID128("f7255c06-e981-46f1-be3d-86c5cd1bb590");

用以判断两个 UUID 是否相等

Kind: static method of module.exports

创建蓝牙设备,自动确定是普通蓝牙设备还是蓝牙锁设备。

Kind: static method of module.exports

Example

import {Bluetooth} from 'miot/device/bluetooth';
  const ble = Bluetooth.createBluetoothLE("a.b.c...")

创建经典蓝牙设备

Kind: static method of module.exports

Example

import {Bluetooth} from 'miot/device/bluetooth'
  const bludtoothClassic = Bluetooth.createBluetoothClassic("a.b.c...")

判断蓝牙是否开放,如果没打开，可以调用Host.ui.showBLESwitchGuide()打开提示页面，让用户打开蓝牙。

Kind: static method of module.exports
Returns: [ 'Promise' ].<boolean> - 此方法不会走reject
Example

Bluetooth.checkBluetoothIsEnabled().then(result => {
            this.state.isEnable = result;
            if (result) {
                this.addLog("蓝牙已开启")
                this.startScan();
            } else {
                this.addLog("蓝牙未开启，请检查开启蓝牙后再试")
                Host.ui.showBLESwitchGuide();
            }
        });

开始扫描蓝牙设备，此方法没有回调，扫描得到的结果，通过BluetoothEvent.bluetoothDeviceDiscovered.addListener()来获取扫描的结果，获取到正确的蓝牙设备对象后，记得调用下面的Bluetooth.stopScan()来停止蓝牙扫描。

Kind: static method of module.exports

Example

import Bluetooth from 'miot/Bluetooth'
 Bluetooth.startScan(3000, 'FE95','FE96')

 BluetoothEvent.bluetoothDeviceDiscovered.addListener((result) => {
            if (bt) {
                console.log("发现设备" + JSON.stringify(result))
            } else {
                this.addLog("初次发现设备" + JSON.stringify(result))
                //普通蓝牙设备的连接必须在扫描到设备之后手动创建 ble 对象
                bt = Bluetooth.createBluetoothLE(result.uuid || result.mac);//android 用 mac 创建设备，ios 用 uuid 创建设备
                Bluetooth.stopScan();
                this.connect();
            }
        })

停止扫描蓝牙设备,此方法同样没有回调方法。获取到需要的设备，或者返回上一页，记得调用stopScan

Kind: static method of module.exports

iOS 平台获取已连接 BLE的蓝牙设备，适用于可穿戴长连接设备，一般此种类型的设备不需要断开。此方法可以理解为，根据UUID去获取已经连接的蓝牙设备 已经连接的蓝牙设备不会发送广播，所以通过下面两行代码连接，必定返回失败： const ble = Device.getBluetoothLE();ble.connect().then(ble=>{}) 因机制不同，android可以正常连接到。所以提供了下面两个方法，专门用于iOS连接失败后，获取已连接的ble对象。 此方法对应 coreBLuetooth 中 retrievePeripheralsWithIdentifiers:(NSArray<NSUUID *> *)identifiers 方法

Kind: static method of module.exports
Returns: [ 'Promise' ].<Map.<uuid, IBluetooth>> - resolve: 返回一个map，key为UUID，value为IBluetooth对象 reject: false（android调用时）

Example

Bluetooth.retrievePeripheralsForIOS("PeripheralUUID1","PeripheralUUID2","PeripheralUUID3")

iOS 平台通过 serviceUUID 获取已连接 BLE Peripheral，适用于可穿戴长连接设备 使用场景同上面的retrievePeripheralsForIOS方法，不同点在于，此处是根据serviceUUID来筛选，表示筛选包含此serviceUUID的蓝牙设备 对应 coreBLuetooth 中 retrieveConnectedPeripheralsWithServices:(NSArray<CBUUID *> *)serviceUUIDs 方法

Kind: static method of module.exports
Returns: [ 'Promise' ].<Map.<uuid, IBluetooth>> - resolve：返回一个map，key为UUID，value为IBluetooth对象 reject：false（android调用时）

Example

Bluetooth.retrievePeripheralsWithServicesForIOS("serviceUUID1","serviceUUID2","serviceUUID3")

打开蓝牙（Android），iOS无法直接操作蓝牙的打开，只能通过Host.ui.showBLESwitchGuide();提示用户打开蓝牙。

Kind: static method of module.exports
Returns: void 无返回值

判断当前设备是否通过蓝牙网关扫描到了。 已知使用场景：如果是，可以考虑在更多设置加一个去蓝牙网关的入口，跳转到蓝牙网关页面，然后可以操作网关绑定此设备为子设备

Kind: static method of module.exports
Returns: [ 'Promise' ].<boolean> - ，此方法不会走reject

判断当前设备是否被蓝牙/蓝牙Mesh网关扫描到

Kind: static method of module.exports
Returns: [ 'Promise' ].<Object> - 成功时的返回值： {code:0,data:{connected:[true/false],mac:[网关mac]}} 已连接时connected=true,反之connected=false，mac可能为空； 失败时可能返回返回值： {code:-1,message:"mac is null or empty."} {code:-2,message:"cann't find any gateway device."} {code:-3,message:"internal error xxxx"}
Since: 10040

获取信号强度RSSI

Kind: static method of module.exports
Returns: [ 'Promise' ].<Object> - 成功时：{"code":0, "data":{RSSI: x}} 失败时：{"code":-1, "message":"xxx" }
Since: 10038

只在MIUI上支持，维持长连接 如果连接失败，则会隔一段时间尝试重连，如果继续失败，则重连间隔会翻倍，直到上限。

Kind: static method of module.exports

只在MIUI上支持，解除长连接

Kind: static method of module.exports

只在MIUI上支持，维持长连接 如果连接失败，则会隔一段时间尝试重连，如果继续失败，则重连间隔会翻倍，直到上限。

Kind: static method of module.exports

ble直连spec相关 API

Kind: inner property of module.exports
See: miot/device/bluetooth/blespec