Skip to content

藍牙-信標

stopBeaconDiscovery

TIP

該API使用方法為: wx.stopBeaconDiscovery(Object object)

  • 功能說明: 停止蒐索附近的Beacon設備。
  • 參數及說明: Object object。
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)
  • 錯誤碼
    錯誤碼錯誤資訊說明
    0ok正常
    11000unsupport系統或設備不支持
    11001bluetooth service unavailable藍牙服務不可用
    11002location service unavailable位置服務不可用
    11003already start已經開始蒐索
    10004not startBeaconDiscovery還未開始蒐索
    11005system error系統錯誤
    11006invalid data參數不正確

startBeaconDiscovery

TIP

該API使用方法為: wx.startBeaconDiscovery(Object object)

  • 功能說明: 開始蒐索附近的Beacon設備。

  • 參數及說明: Object object。

    内容類型預設值必填說明
    uuidsArray.<string>-Beacon設備廣播的UUID清單
    ignoreBluetoothAvailablebooleanfalse是否校驗藍牙開關,僅在iOS下有效。 iOS 11起,控制台裏關掉藍牙,還是能繼續使用Beacon服務
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)
  • 錯誤碼

    錯誤碼錯誤資訊說明
    0ok正常
    11000unsupport系統或設備不支持
    11001bluetooth service unavailable藍牙服務不可用
    11002location service unavailable位置服務不可用
    11003already start已經開始蒐索
    10004not startBeaconDiscovery還未開始蒐索
    11005system error系統錯誤
    11006invalid data參數不正確
  • 示例代碼:

js
wx.startBeaconDiscovery({
  success(res) { }
})

onBeaconUpdate

TIP

該API使用方法為: wx.onBeaconUpdate(function listener)

  • 功能說明: 監聽Beacon設備更新事件,僅能注册一個監聽

  • 參數及說明: function listener,Beacon設備更新事件的監聽函數,參數Object res如下:

    内容類型說明
    beaconsArray.<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如下:

    内容類型說明
    availableboolean服務現時是否可用
    discoveringboolean現時是否處於蒐索狀態
  • 示例代碼:

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。

    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)
  • object.success回呼函數參數: Object res。

    内容類型說明
    beaconsArray.<BeaconInfo>Beacon設備清單
  • 錯誤碼

    錯誤碼錯誤資訊說明
    0ok正常
    11000unsupport系統或設備不支持
    11001bluetooth service unavailable藍牙服務不可用
    11002location service unavailable位置服務不可用
    11003already start已經開始蒐索
    10004not startBeaconDiscovery還未開始蒐索
    11005system error系統錯誤
    11006invalid data參數不正確

BeaconInfo

  • 功能說明: Beacon設備

  • 内容及說明

    内容類型說明
    uuidstringBeacon設備廣播的UUID
    majornumberBeacon設備的主ID
    minornumberBeacon設備的次ID
    proximitynumber表示設備距離的枚舉值(僅iOS)
    accuracynumberBeacon設備的距離,單位m。 iOS上,proximity為0時,accuracy為-1
    rssinumber表示設備的信號強度,單位dBm
    • proximity的合法值
      說明
      0訊號太弱不足以計算距離,或非iOS設備
      1十分近
      2比較近
      3