7 uap mobile api referenceuap_plug_apiuexbluetoothle

1、uexBluetoothLE1、简介蓝牙BLE插件 1.1 、说明蓝牙BLE插件. iOS蓝牙功能须知 iOS设备要在使用蓝牙功能,必须首先设置相应的蓝牙权限; 如果要在进行音频操作,还需要设置音乐权限;在扫描蓝牙设备时,serviceUUIDs参数必传,不能无限制扫描; 获取到数据如要前台,请用LocalNotification;注:由于本插件的特殊性,暂时没法提供方法的示例,整体示例请参考开源源码中的示例1.2 、开源源码插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)1.3 、平台版本支持本插件的所有API默认支持Android4.4+和iOS7.1

2、+操作系统. 有特殊版本要求的API会在文档中额外说明.1.4 、接口有效性本插件所有API默认在插件版本4.0.0+可用.在后续版本中新添加的接口会在文档中额外说明.2、API概览2.1、方法init /初始化uexBluetoothLE.init()说明:回调方法cbInit请在root页面执行init();本插件为单例插件,您可以在任意页面调用本插件的接口,但所有的回调均直接回调给root; 参数:无 示例:initscanDevicestopScanDeviceconnect disconnectsearchForCharacteristicsearchForDescriptorrea

3、dCharacteristicwriteCharacteristicreadDescriptorwriteDescriptorsetCharacteristicNotification readRemoteRssicbInitcbConnectcbSearchForCharacteristic cbSearchForDescriptorcbReadCharacteristiccbWriteCharacteristiccbReadDescriptor cbWriteDescriptoronLeScanonConnectionStateChangeonCharacteristicChanged o

4、nReadRemoteRssiscanDevice /扫描蓝牙设备uexBluetoothLE.scanDevice(serviceUUIDs)说明:扫描到设备后通过onLeScan回调结果 参数:参数类型是否必选参数名称说明serviArrceUU ay IDs由service的UUID字符串组成的数组. serviceUUIDs不传时,插件会扫描所有蓝牙设备;否则,插件会只扫描包含数否组中的指定service的蓝牙设备;iOS系统,在进行蓝牙设备扫描时,该参数必须,若前台扫描则该参数为可选.示例:stopScanDevice /停止扫描设备uexBluetoothLE.stopScanDe

5、vice()说明:停止扫描设备参数:无示例:connect /连接指定蓝牙设备uexBluetoothLE.connect(param)说明:连接指定蓝牙设备.回调方法cbConnect参数:var param=address:/(必选)要连接的蓝牙地址 示例:disconnect /断开蓝牙连接uexBluetoothLE.disconnect()说明:断开蓝牙连接.成功断开后会回调onConnectionStateChange方法 参数:无示例:searchForCharacteristic /从指定service中搜索characteristicuexBluetoothLE.search

6、ForCharacteristic(param)说明:从指定service中搜索characteristic.回调方法cbSearchForCharacteristic参数:var param=serviceUUID:/(必选)string,要搜索的service的UUID示例:searchForDescriptor /从指定characteristic中搜索descriptoruexBluetoothLE.searchForDescriptor(param)说明:从指定characteristic中搜索descriptor.回调方法cbSearchForDescriptor参数:var pa

7、ram=serviceUUID:,/(必选)被搜索的characteristic所在的service的UUID characteristicUUID:/(必选)string 要搜索的characteristics的UUID示例:readCharacteristic /读取CharacteristicuexBluetoothLE.readCharacteristic(param)说明:读取Characteristic.回调方法cbReadCharacteristic参数:var param=serviceUUID:/( 必 选 )service 的 UUID characteristicUUID

8、:/(必选)characteristic的UUID示例:writeCharacteristic /写入数据到CharacteristicuexBluetoothLE.writeCharacteristic(param)说明:写入数据到Characteristic.回调方法cbWriteCharacteristic.方法onCharacteristicChanged 用户需要将实际要写入的值先base64编码成String,再调用此方法.参数:varparam= serviceUUID:,/servic e的UUIDcharacteristicUUID:,/characteristic 的 UU

9、ID value:/要写入的值 示例:readDescriptor /读取DescriptoruexBluetoothLE.readDescriptor(param)说明:读取Descriptor.回调方法cbReadDescriptor.参数:varparam= serviceUUID:/servic e的UUIDcharacteristicUUID:/characteristic 的 UUID descriptorUUID:/descriptor的UUID示例:writeDescriptor /写入数据到DescriptoruexBluetoothLE.writeDescriptor(pa

10、ram)说明:写入数据到Descriptor.回调方法cbWriteDescriptor. 用户需要将实际要写入的值先base64编码成String,再调用此方法.参数:varparam= serviceUUID:/servic e的UUIDcharacteristicUUID:/characteristic 的 UUID descriptorUUID:/descriptor 的 UUID value:/要写入的值 示例:setCharacteristicNotification /某一个Characteristic数据变化uexBluetoothLE.setCharacteristicNot

11、ification(param)说明:某一个Characteristic数据变化.方法onCharacteristicChanged参数:varparam= serviceUUID:,/servic e的UUIDcharacteristicUUID:,/characteristic 的 UUID enable:/true 或false,开启或关闭 示例:readRemoteRssi /读取已连接设备的RssiuexBluetoothLE.readRemoteRssi()说明:读取已连接设备的Rssi.方法onReadRemoteRssi.参数:无示例:2.2、回调方法cbInit /初始化的回

12、调方法uexBluetoothLE.cbInit(data)说明:初始化的回调方法 参数:var data=resultCode:/(必选) 0-BLE启动成功,1-BLE启动失败 示例:window.uexOnload = function(type) uexBluetoothLE.c bInit = cbInit;functioncbInit(data) alert(cbIcbConnect /连接指定蓝牙设备的回调方法uexBluetoothLE.cbConnect(data)说明:连接指定蓝牙设备的回调方法 参数:var data=services:/(必选) service的UUID

13、构成的数组 示例:window.uexOnload =function(type) uexBluetoothLE.cbConnect= cbConnect;functioncbConnect(data) alert(cbConnect: +cbSearchForCharacteristic /从指定service中搜索characteristic的回调方法uexBluetoothLE.cbSearchForCharacteristic(data)说明:从指定service中搜索characteristic的回调方法 参数:var data=serviceUUID:,/(必选)被搜索的servi

14、ce的UUIDcharacteristics:/(必选)list 此service下的uexBLECharacteristic结构构成的数组 uexBLECharacteristic结构说明见附录 示例:window.uexOnload =function(type) uexBluetoothLE.cbSearchForCharacteristic = cbSearchForCharacteristic;functioncbSearchForCharacteristic(data) alert(cbSearchForCharacteristic: +cbSearchForDescriptor

15、/从指定characteristic中搜索descriptor的回调方法uexBluetoothLE.cbSearchForDescriptor(data)说明:从指定characteristic中搜索descriptor的回调方法 参数:var data=serviceUUID:/被搜索的characteristic所在的service的UUID characteristicUUID:,/被搜索的characteristic的UUIDdescriptors:,/list 此characteristic下的uexBLEDescriptor结构构成的数组,uexBLEDescriptor结构说明

16、见附录 示例:window.uexOnload =function(type) uexBluetoothLE.cbSearchForDescriptor = cbSearchForDescriptor;functioncbSearchForDescriptor(data) alert(cbSearchForDescriptor: +cbReadCharacteristic /读取Characteristic的回调方法uexBluetoothLE.cbReadCharacteristic(data)说明:读取Characteristic的回调方法 参数:var data=resultCode:/

17、0-成功,1-失败data:/uexBLECharacteristic的Json格式 uexBLECharacteristic结构说明见附录 示例:window.uexOnload =function(type) uexBluetoothLE.cbReadCharacteristic = cbReadCharacteristic;functioncbReadCharacteristic(data) alert(cbReadCharacteristic: +cbWriteCharacteristic /写入数据到Characteristic的回调方法uexBluetoothLE.cbWriteC

18、haracteristic(data)说明:写入数据到Characteristic的回调方法 参数:var data=resultCode:/0-成功,1-失败data:uexBLECharacteristic的Json格式 uexBLECharacteristic结构说明见附录 示例:window.uexOnload =function(type) uexBluetoothLE.cbWriteCharacteristic = cbWriteCharacteristic;functioncbWriteCharacteristic(data) alert(cbWriteCharacteristi

19、c: +cbReadDescriptor /读取Descriptor的回调方法uexBluetoothLE.cbReadDescriptor(data)说明:读取Descriptor的回调方法 参数:var data=resultCode:/0-成功,1-失败data:/uexBLEDescriptor的Json格式 uexBLEDescriptor结构说明见附录 示例:window.uexOnload =function(type) uexBluetoothLE.cbReadDescriptor = cbReadDescriptor;functioncbReadDescriptor(data

20、) alert(cbReadDescriptor: +cbWriteDescriptor /写入数据到Descriptor的回调方法uexBluetoothLE.cbWriteDescriptor(data)参数:var data=resultCode:/0-成功,1-失败data:uexBLEDescriptor的Json格式 uexBLEDescriptor结构说明见附录 示例:window.uexOnload =function(type) uexBluetoothLE.cbWriteDescriptor = cbWriteDescriptor;functioncbWriteDescri

21、ptor(data) alert(cbWriteDescriptor: +2.3、方法onLeScan /扫描到设备的方法uexBluetoothLE.onLeScan(data)参数:vardata= a ddress:, name:各字段含义如下:参数名称参数类型是否必选说明addressStringAndroid的address参数传回的是设备的mac地址;iOS的address参数传回的是设备的UUID是nameString是蓝牙设备名称示例:window.uexOnload =function(type) uexBluetoothLE.onLeSca n = onLeScan;fun

22、ctiononLeScan(data) alert(onLeScan: +onConnectionStateChange /连接状态改变的方法uexBluetoothLE.onConnectionStateChange(data)参数:var data=resultCode:/(必选)0-已连接上,1-已断开 示例:window.uexOnload =function(type) uexBluetoothLE.onConnectionStateChange = onConnectionStateChange;functiononConnectionStateChange(data) alert

23、(onConnectionStateChange: +onCharacteristicChanged /Characteristic内容改变的方法uexBluetoothLE.onCharacteristicChanged(data)参数:参数名称参数类型是否必选说明dataJsonuexBLECharacteristic的Json格式数据,uexBLECharacteristic结构说明见附录 是示例:window.uexOnload =function(type) uexBluetoothLE.onCharacteristicChanged = onCharacteristicChange

24、d;functiononCharacteristicChanged(data) alert(onCharacteristicChanged: +onReadRemoteRssi /readRemoteRssi的方法uexBluetoothLE.onReadRemoteRssi(data)参数:参数名称参数类型是否必选说明dataJson对象rssi的相关数据是示例:window.uexOnload =function(type) uexBluetoothLE.onReadRemoteRssi = onReadRemoteRssi;functiononReadRemoteRssi(data) a

25、lert(onCharacteristicChanged:3、附录3.1 uexBLEDescriptor结构说明var uexBLEDescriptorserviceUUID:,/ 此 descriptor 所 属 的 service 的 UUID characteristicUUID:,/此descriptor所属的characteristic的UUID UUID:,/string,此descriptor的UUIDvalue:,/string,此descriptor的值 needDecode:/是否需要base64解码 true/false,为true时,用户需要将value进行base6

26、4解码 permissions 权限说明请参考permissions权限说明 3.2 uexBLECharacteristic结构说明var uexBLECharacteristicserviceUUID:,/string,此Characteristic所属的service的UUID UUID:,/string,此Characteristic的UUIDvalue:,/string,此Characteristic的值,base64编码,用户获取到value之后,需要先进行base64解码permissions:,/(仅iOS)Number,此Characteristic的权限说明 writeType;,/(仅Android)Number,此Characteristic的写入方式 descriptors:/list uexBLEDescriptor结构的数组,描述了此Characteristic下所有的Descriptorpermissions 权限说明请参考permissions权限说明 writeType 写入方式请参考writeType3.3 permissions