Bluetooth - blockdate/ios-rn-sdk GitHub Wiki

miot/Bluetooth

蓝牙设备操作类

Export:
Example

import {Device} from 'miot'

const ble = Device.getBluetoothLE();
ble.connect().then(ble=>{

 ble.startDiscoverServices("a-b-c-d-e", ...)
  ...
});

...
ble.getService("a-b-c-d-e").startDiscoverCharacteristics("1-2-3-4-5",...)

...
const charac = ble.getService('...').getCharacteristic('...')
charac.setNotify().then(characteristic=>{}).catch(err=>{});
charac.read().then(characteristic=>{characteristic.value ... }).catch(err=>{});
charac.write().then(characteristic=>{}).catch(err=>{})

...

ble.disconnect()

miot/Bluetooth
- module.exports ⏏
  - static
    - .IBluetoothCharacteristic
      - .isDiscovered : boolean
      - .isValueLoaded : boolean
      - .UUID : string
      - .value : *
      - .read() ⇒ Promise.<IBluetoothCharacteristic>
      - .write(value) ⇒ Promise.<IBluetoothCharacteristic>
      - .writeWithoutResponse(value) ⇒ Promise.<IBluetoothCharacteristic>
      - .setNotify(flag) ⇒ Promise.<IBluetoothCharacteristic>
    - .IBluetoothService
      - .UUID : string
      - .isDiscovered : boolean
      - .getCharacteristic ⇒ IBluetoothCharacteristic
      - .startDiscoverCharacteristics(...characteristicUUIDs) ⇒ boolean
    - .IBluetoothLock
      - .toggle(cmd, timeout) ⇒ Promise.<IBluetoothLock>
      - .isShareKeyValid() ⇒ Promise.<IBluetoothLock>
      - .getOneTimePassword(interval, digits) ⇒ Promise.<Array.<int>>
      - .encryptMessage(message) ⇒ Promise.<string>
      - .decryptMessage(encrypted) ⇒ Promise.<string>
    - .IBluetooth
      - .isBLE : boolean
      - .mac : string
      - .UUID : string
      - .isConnected : boolean
      - .connect(type, option) ⇒ Promise.<IBluetooth>
      - .readRSSI() ⇒ Promise.<*>
      - .disconnect(delay)
      - .maximumWriteValueLength(type)
      - .getVersion() ⇒ Promise.<any>
    - .IBluetoothLE
      - .securityLock ⇒ IBluetoothLock
      - .getService ⇒ IBluetoothService
      - .startDiscoverServices(...serviceUUIDs) ⇒ boolean
      - .getVersion(decrypt) ⇒ boolean
    - .IBluetoothClassic
    - .createBluetoothLE(macOrPeripheralUUID) ⇒ IBluetoothLE
    - .createBluetoothClassic(macOrPeripheralUUID) ⇒ IBluetoothClassic
    - .checkBluetoothIsEnabled() ⇒ Promise.<boolean>
    - .startScan(durationInMillis, ...serviceUUIDs) ⇒ void
    - .stopScan() ⇒ void
    - .retrievePeripheralsForIOS(...UUIDs) ⇒ Promise.<Map.<uuid, Bluetooth>>
    - .retrievePeripheralsWithServicesForIOS(...serviceUUIDs) ⇒ Promise.<Map.<uuid, Bluetooth>>
    - .enableBluetoothForAndroid(silence) ⇒
    - .isBleGatewayConnected(mac) ⇒ Promise.<boolean>
    - .bindDeviceforMIUI(mac)
    - .unBindDeviceforMIUI(mac)
    - .setAlertConfigsOnMIUI(alert, enable, mac)
  - inner
    - ~BluetoothEvent : object

module.exports ⏏

Kind: Exported member
Export:

module.exports.IBluetoothCharacteristic

Kind: static interface of module.exports

.IBluetoothCharacteristic
- .isDiscovered : boolean
- .isValueLoaded : boolean
- .UUID : string
- .value : *
- .read() ⇒ Promise.<IBluetoothCharacteristic>
- .write(value) ⇒ Promise.<IBluetoothCharacteristic>
- .writeWithoutResponse(value) ⇒ Promise.<IBluetoothCharacteristic>
- .setNotify(flag) ⇒ Promise.<IBluetoothCharacteristic>

iBluetoothCharacteristic.isDiscovered : `boolean`

是否已经被发现

Kind: instance property of IBluetoothCharacteristic
Read only: true

iBluetoothCharacteristic.isValueLoaded : `boolean`

数值是否已经加载, 为 true 时,本类才能读到正确的 value

Kind: instance property of IBluetoothCharacteristic
Read only: true

iBluetoothCharacteristic.UUID : `string`

特征值的 UUID

Kind: instance property of IBluetoothCharacteristic
Read only: true

iBluetoothCharacteristic.value : `*`

数值, 配合 isValueLoaded 使用

Kind: instance property of IBluetoothCharacteristic
Read only: true
Example

...
  if(charateristic.isValueLoaded){
      const val = characteristic.value;
      ...
  }
  ...

iBluetoothCharacteristic.read() ⇒ `Promise.<IBluetoothCharacteristic>`

读取蓝牙数据

Kind: instance method of IBluetoothCharacteristic

iBluetoothCharacteristic.write(value) ⇒ `Promise.<IBluetoothCharacteristic>`

写数据对应 writeWithResponse

Kind: instance method of IBluetoothCharacteristic

Param	Type
value	`*`

iBluetoothCharacteristic.writeWithoutResponse(value) ⇒ `Promise.<IBluetoothCharacteristic>`

直接写数据对应 writeWithoutResponse

Kind: instance method of IBluetoothCharacteristic

Param	Type
value	`*`

iBluetoothCharacteristic.setNotify(flag) ⇒ `Promise.<IBluetoothCharacteristic>`

设置数值变化监听开关

Kind: instance method of IBluetoothCharacteristic

Param	Type	Description
flag	`boolean`	true 打开监听, false 则关闭监听

module.exports.IBluetoothService

Kind: static interface of module.exports

.IBluetoothService
- .UUID : string
- .isDiscovered : boolean
- .getCharacteristic ⇒ IBluetoothCharacteristic
- .startDiscoverCharacteristics(...characteristicUUIDs) ⇒ boolean

iBluetoothService.UUID : `string`

蓝牙服务 UUID

Kind: instance property of IBluetoothService
Read only: true

iBluetoothService.isDiscovered : `boolean`

蓝牙服务是否已被发现

Kind: instance property of IBluetoothService
Read only: true

iBluetoothService.getCharacteristic ⇒ `IBluetoothCharacteristic`

获取蓝牙特征

Kind: instance property of IBluetoothService

Param	Type
characteristicUUID	`string`

iBluetoothService.startDiscoverCharacteristics(...characteristicUUIDs) ⇒ `boolean`

发现蓝牙特征

Kind: instance method of IBluetoothService

Param	Type	Description
...characteristicUUIDs	`string`	特征的 UUID

module.exports.IBluetoothLock

Kind: static interface of module.exports

.IBluetoothLock
- .toggle(cmd, timeout) ⇒ Promise.<IBluetoothLock>
- .isShareKeyValid() ⇒ Promise.<IBluetoothLock>
- .getOneTimePassword(interval, digits) ⇒ Promise.<Array.<int>>
- .encryptMessage(message) ⇒ Promise.<string>
- .decryptMessage(encrypted) ⇒ Promise.<string>

iBluetoothLock.toggle(cmd, timeout) ⇒ `Promise.<IBluetoothLock>`

支持小米加密芯片的蓝牙设备，开关蓝牙锁

Kind: instance method of IBluetoothLock

Param	Type	Description
cmd	`int`	操作命令可传入 0 ，1 ，2三个 int 值，分别代表开锁，上锁，反锁
timeout	`int`	毫秒蓝牙未响应的超时时间

Example

import {Bluetooth} from 'miot'
...
Bluetooth.createBluetoothLE(...).connect(...).then(device => {
 device.securityLock().toggle(0,5000)
     .then(lock => {console.log('toggle success')})
     .catch(err => {console.log('toggle failed'})
})
...

iBluetoothLock.isShareKeyValid() ⇒ `Promise.<IBluetoothLock>`

支持小米加密芯片的蓝牙设备，在被分享的设备中，调用此方法，可判断分享的电子钥匙是否有效

Kind: instance method of IBluetoothLock
Example

import {Bluetooth} from 'miot'
...
Bluetooth.createBluetoothLE(...).securityLock().isShareKeyValid()
 .then(lock => {console.log('ShareKey is valid')})
 .catch(err => {console.log('ShareKey isn't valid'})
...

iBluetoothLock.getOneTimePassword(interval, digits) ⇒ `Promise.<Array.<int>>`

支持小米加密芯片的蓝牙设备，获取一次性密码组假设输入 interval 为 30，则会从当日 0 点开始计算，每 30 分钟为一个刷新间隔。生成的密码在当前刷新间隔及下一个刷新间隔内有效。如当日 10:19 生成，则该组密码在 10:00 ~ 10:30（当前刷新间隔）以及 10:30 ~ 11:00 (下一个刷新间隔) 有效。密码组中每条密码使用一次即过期。注意设备上获取当前时间（UTC，精度为秒）的准确性由设备保证，否则会有计算误差。

Kind: instance method of IBluetoothLock

Param	Type	Description
interval	`int`	时间间隔，单位为分钟，类型为 number，传入 10 到 60 的整数
digits	`int`	密码位数，类型为 number，传入 6 到 8 的整数

Example

import {Bluetooth} from 'miot'
...
Bluetooth.createBluetoothLE(...).securityLock().getOneTimePassword(30,6)
 .then(pwd => {console.log('one time password is ', pwd)})
 .catch(err => {console.log('get one time password failed, ', err})
...

iBluetoothLock.encryptMessage(message) ⇒ `Promise.<string>`

支持小米加密芯片的蓝牙设备，使用此方法将明文加密为密文后，可发送给设备

Kind: instance method of IBluetoothLock

Param	Type	Description
message	`string`	明文

Example

import {Bluetooth} from 'miot'
...
Bluetooth.createBluetoothLE(...).securityLock().encryptMessage('message')
 .then(msg => {console.log('encrypted message is ', msg)})
 .catch(err => {console.log('encrypted message failed, ', err})
...

iBluetoothLock.decryptMessage(encrypted) ⇒ `Promise.<string>`

支持小米加密芯片的蓝牙设备，使用此方法将明文加密为密文后，可发送给设备

Kind: instance method of IBluetoothLock

Param	Type	Description
encrypted	`string`	密文

Example

import {Bluetooth} from 'miot'
...
Bluetooth.createBluetoothLE(...).securityLock().encryptMessage('decryptedMessage')
 .then(msg => {console.log('decrypt message is ', msg)})
 .catch(err => {console.log('decrypt message failed, ', err})
...

module.exports.IBluetooth

Kind: static interface of module.exports

.IBluetooth
- .isBLE : boolean
- .mac : string
- .UUID : string
- .isConnected : boolean
- .connect(type, option) ⇒ Promise.<IBluetooth>
- .readRSSI() ⇒ Promise.<*>
- .disconnect(delay)
- .maximumWriteValueLength(type)
- .getVersion() ⇒ Promise.<any>

iBluetooth.isBLE : `boolean`

是否 BLE 蓝牙

Kind: instance property of IBluetooth
Read only: true

iBluetooth.mac : `string`

蓝牙设备的 mac 地址

Kind: instance property of IBluetooth
Read only: true

iBluetooth.UUID : `string`

蓝牙设备的 UUID

Kind: instance property of IBluetooth
Read only: true

iBluetooth.isConnected : `boolean`

蓝牙是否已经连接

Kind: instance property of IBluetooth
Read only: true

iBluetooth.connect(type, option) ⇒ `Promise.<IBluetooth>`

打开蓝牙链接. option参数peripheralID为iOS 平台的可选参数，因为iOS平台无法获取普通 BLE 蓝牙设备的 Mac，所以当 type 为 3 时，iOS 上需填入 peripheralID peripheralID 可通过 startScan（）搜索周边蓝牙设备获取（如设备OTA中，设备固件切换，无小米蓝牙协议相关服务时需建立连接），或通过retrievePeripheralsWithServicesForIOS（）搜索已连接设备获取（如可穿戴长连接设备，无法发送 mibeacon）建立连接后，SDK 会用 peripheralID 充当 Mac 地址