藍牙-信標
stopBeaconDiscovery
TIP
該API使用方法為: wx.stopBeaconDiscovery(Object object)
- 功能說明: 停止蒐索附近的Beacon設備。
- 參數及說明: Object object。
内容 類型 預設值 必填 說明 success Function - 否 接口調用成功的回呼函數 fail Function - 否 接口調用失敗的回呼函數 complete Function - 否 接口調用結束的回呼函數(無論成功與否都執行) - 錯誤碼
錯誤碼 錯誤資訊 說明 0 ok 正常 11000 unsupport 系統或設備不支持 11001 bluetooth service unavailable 藍牙服務不可用 11002 location service unavailable 位置服務不可用 11003 already start 已經開始蒐索 10004 not startBeaconDiscovery 還未開始蒐索 11005 system error 系統錯誤 11006 invalid data 參數不正確
startBeaconDiscovery
TIP
該API使用方法為: wx.startBeaconDiscovery(Object object)
功能說明: 開始蒐索附近的Beacon設備。
參數及說明: Object object。
内容 類型 預設值 必填 說明 uuids Array.< string>- 是 Beacon設備廣播的UUID清單 ignoreBluetoothAvailable boolean false 否 是否校驗藍牙開關,僅在iOS下有效。 iOS 11起,控制台裏關掉藍牙,還是能繼續使用Beacon服務 success Function - 否 接口調用成功的回呼函數 fail Function - 否 接口調用失敗的回呼函數 complete Function - 否 接口調用結束的回呼函數(無論成功與否都執行) 錯誤碼
錯誤碼 錯誤資訊 說明 0 ok 正常 11000 unsupport 系統或設備不支持 11001 bluetooth service unavailable 藍牙服務不可用 11002 location service unavailable 位置服務不可用 11003 already start 已經開始蒐索 10004 not startBeaconDiscovery 還未開始蒐索 11005 system error 系統錯誤 11006 invalid data 參數不正確 示例代碼:
js
wx.startBeaconDiscovery({
success(res) { }
})onBeaconUpdate
TIP
該API使用方法為: wx.onBeaconUpdate(function listener)
功能說明: 監聽Beacon設備更新事件,僅能注册一個監聽
參數及說明: function listener,Beacon設備更新事件的監聽函數,參數Object res如下:
内容 類型 說明 beacons Array.<BeaconInfo> 當前搜尋到的所有Beacon設備清單 示例代碼:
js
wx.onBeaconUpdate(res => {
console.log(res.beacons)
})offBeaconUpdate
TIP
該API使用方法為: wx.offBeaconUpdate()
功能說明: 移除Beacon設備更新事件的全部監聽函數。
示例代碼:
js
wx.offBeaconUpdate()onBeaconServiceChange
TIP
該API使用方法為: wx.onBeaconServiceChange(function listener)
功能說明: 監聽Beacon服務狀態變化事件,僅能注册一個監聽。
參數及說明: function listener,Beacon服務狀態變化事件的監聽函數,參數Object res如下:
内容 類型 說明 available boolean 服務現時是否可用 discovering boolean 現時是否處於蒐索狀態 示例代碼:
js
wx.onBeaconServiceChange(res => {
console.log(res.available, res.discovering)
})offBeaconServiceChange
TIP
該API使用方法為: wx.offBeaconServiceChange()
功能說明: 移除Beacon服務狀態變化事件的全部監聽函數。
示例代碼:
js
wx.offBeaconServiceChange()getBeacons
TIP
該API使用方法為: wx.getBeacons(Object object)
功能說明: 獲取所有已蒐索到的Beacon設備。
參數及說明: Object object。
内容 類型 預設值 必填 說明 success Function - 否 接口調用成功的回呼函數 fail Function - 否 接口調用失敗的回呼函數 complete Function - 否 接口調用結束的回呼函數(無論成功與否都執行) object.success回呼函數參數: Object res。
内容 類型 說明 beacons Array.<BeaconInfo> Beacon設備清單 錯誤碼
錯誤碼 錯誤資訊 說明 0 ok 正常 11000 unsupport 系統或設備不支持 11001 bluetooth service unavailable 藍牙服務不可用 11002 location service unavailable 位置服務不可用 11003 already start 已經開始蒐索 10004 not startBeaconDiscovery 還未開始蒐索 11005 system error 系統錯誤 11006 invalid data 參數不正確
BeaconInfo
功能說明: Beacon設備
内容及說明
内容 類型 說明 uuid string Beacon設備廣播的UUID major number Beacon設備的主ID minor number Beacon設備的次ID proximity number 表示設備距離的枚舉值(僅iOS) accuracy number Beacon設備的距離,單位m。 iOS上,proximity為0時,accuracy為-1 rssi number 表示設備的信號強度,單位dBm - proximity的合法值
值 說明 0 訊號太弱不足以計算距離,或非iOS設備 1 十分近 2 比較近 3 遠
- proximity的合法值