目录
接口说明
H5页面获取设备信息 JS API是为了扩展摇周边应用的场景,让开发者能够在自己的H5应用上通过接入微信JS-SDK,实现搜索周边Beacon信号的一套api。在调用此接口之前,需要先把设备分组,微信客户端只会返回已在分组中的设备信息,如何把设备分组,请查看上述分组相关的接口描述。
H5页面获取设备信息JSAPI包括startSearchBeacons、stopSearchBeacons、onSearchBeacons三个接口,只支持6.2.5以上的微信版本调用,需使用微信JS-SDK调用,且调用的公众账号需与创建分组的公众账号一致。在需要调用JS接口的页面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.1.0.js,JS-SDK说明文档
# 开启查找周边ibeacon设备接口
接口说明
查找周边设备,目的是为有一定开发能力的商户提供查找自己周边设备的接口,在微信内置浏览器中被访问的网页,可使用该JS代码调起查找商家自己周边的设备,方便商家利用此接口来检查周边是否存在自己的设备。 微信客户端只要检测到有信号的设备即返回设备信息,时间间隔为1S,android与iOS皆批量返回检测到有信息的设备。
接口调用说明
示例:
wx.startSearchBeacons({
ticket:"",
complete:function(argv){
//回调函数
}
});
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
ticket | 否 | 摇周边的业务ticket,系统自动添加在摇出来的页面链接后面 |
返回说明
打开成功返回:“startSearchBeacons:ok”;
打开后未stop再次打开 :“startSearchBeacons:already started”;
蓝牙未打开返回 :“startSearchBeacons:bluetooth power off”;
地理位置服务未打开返回: “startSearchBeacons:location service disable”;
系统不支持返回 :“startSearchBeacons:system unsupported”。
# 关闭查找周边ibeacon设备接口
接口说明
关闭查找周边设备。
接口调用说明
示例:
wx.stopSearchBeacons({
complete:function(res){
//回调函数
}
});
返回说明
关闭成功返回“stopSearchBeacons:ok”;
# 监听周边ibeacon设备接口
接口说明
监听周边设备onSearchBeacons接口是在startSearchBeacons接口开启后回调的,该接口返回该商家注册的在周边的相关设备。
接口调用说明
示例:
wx.onSearchBeacons({
complete:function(argv){
//回调函数
}
});
返回说明
onSearchBeacons:
{
"beacons":[
{
"major":10008,
"minor":57686,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"accuracy":"0.235344",
"rssi":"-66",
"proximity":"1",
"heading":"288.1355"
},
{
"major":10008,
"minor":57687,
"uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
"accuracy":"0.349124",
"rssi":"-49",
"proximity":"2",
"heading":"288.1355"
}
]
}
参数说明
参数 | 说明 |
---|---|
UUID、major、minor | UUID、major、minor |
accuracy | 距离,单位为米 |
proximity | 精度,0:CLProximityUnknown, 1:CLProximityImmediate, 2:CLProximityNear, 3:CLProximityFar |
rssi | 接收信号的强度指示 |
heading | 接收信号时设备的方向(安卓设备返回有此字段,iOS无);iOS设备若需要获取方向,可以利用HTML5标准API获取, 查看示例 |