藍牙-低功耗周邊設備

onBLEPeripheralConnectionStateChanged

TIP

該API使用方法為： wx.onBLEPeripheralConnectionStateChanged(function listener)。

• 功能說明： 監聽當前周邊設備被連接或斷開連接事件
• 參數及說明： function listener，當前周邊設備被連接或斷開連接事件的監聽函數，參數Object res如下：

  内容	類型	說明
  deviceId	String	連接狀態變化的設備id
  serverId	String	server的UUID
  connected	Boolean	連接目前狀態

offBLEPeripheralConnectionStateChanged

TIP

該API使用方法為： wx.offBLEPeripheralConnectionStateChanged(function listener)

• 功能說明： 移除當前周邊設備被連接或斷開連接事件的監聽函數。

• 參數及說明： function listener，onBLEPeripheralConnectionStateChanged傳入的監聽函數。 不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }

wx.onBLEPeripheralConnectionStateChanged(listener)
wx.offBLEPeripheralConnectionStateChanged(listener) // Pass the same function object used for listening.

createBLEPeripheralServer

TIP

該API使用方法為： wx.createBLEPeripheralServer(Object object)

• 功能說明： 建立本地作為藍牙低功耗周邊設備的服務端，可創建多個。

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： Object res。

  内容	類型	說明
  server	BLEPeripheralServer	周邊設備的服務端

BLEPeripheralServer

TIP

周邊設備的服務端

.addService

TIP

該API使用方法為： BLEPeripheralServer.addService(Object object)

• 功能說明： 添加服務。

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  service	Object	-	是	描述service的Object
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• service結構内容

  結構内容	類型	必填	說明
  uuid	string	是	藍牙服務的UUID
  characteristics	Array.<Object>	是	characteristics清單

• characteristics結構内容

  結構内容	類型	必填	說明
  uuid	string	是	characteristic的UUID
  properties	Object	否	特徵支持的操作
  permission	Object	否	特徵許可權
  value	Array.<Object>	否	特徵對應的二進位值
  descriptors	Array.<Object>	否	描述符數據

  • properties結構内容

  結構内容	類型	預設值	必填	說明
  write	boolean	false	否	寫
  writeNoResponse	boolean	false	否	無回複寫
  read	boolean	false	否	讀
  notify	boolean	false	否	訂閱
  indicate	boolean	false	否	回包

  • permission結構内容

  結構内容	類型	預設值	必填	說明
  readable	boolean	false	否	可讀
  writeable	boolean	false	否	可寫
  readEncryptionRequired	boolean	false	否	加密讀請求
  writeEncryptionRequired	boolean	false	否	加密寫請求

  • descriptors結構内容

  結構内容	類型	必填	說明
  uuid	string	是	Descriptors的UUID
  permission	Object	否	描述符的許可權
  value	ArrayBuffer	否	描述符數據

  • permission結構内容

  結構内容	類型	預設值	必填	說明
  write	boolean	false	否	寫
  read	boolean	false	否	讀

.removeService

TIP

該API使用方法為： BLEPeripheralServer.removeService(Object object)

• 功能說明： 移除服務。
• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  serviceId	String	-	是	service的UUID
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.startAdvertising

TIP

該API使用方法為： BLEPeripheralServer.startAdvertising(Object Object)

• 功能說明： 開始廣播本地創建的周邊設備

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  advertiseRequest	object	-	是	廣播自定義參數
  powerLevel	String	medium	否	廣播功率，合法值為 1.low：功率低 1.medium：功率適中 1.high：功率高
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• advertiseRequest結構内容

  結構内容	類型	預設值	必填	說明
  connectable	boolean	true	否	當前設備是否可連接
  deviceName	String	-	否	廣播中deviceName欄位，默認為空
  serviceUuids	Array.<string>	-	否	要廣播的服務UUID清單。 使用16/32比特UUID時請參攷注意事項
  manufactureData	Array.<Object>	-	否	廣播的製造商資訊。 僅Android支持，iOS因系統限制無法定制
  beacon	object	-	否	以beacon設備形式廣播的參數

  • manufactureData結構内容

  結構内容	類型	必填	說明
  manufacturerId	String	是	製造商ID，0x開頭的十六進位
  manufacturerSpecificData	ArrayBuffer	否	製造商資訊

  • beacon結構内容

  結構内容	類型	必填	說明
  uuid	number	是	Beacon設備廣播的UUID
  major	number	是	Beacon設備的主ID
  minor	number	是	Beacon設備的次ID
  measurePower	number	是	用於判斷距離設備1米時RSSI大小的參攷值

.stopAdvertising

TIP

該API使用方法為： BLEPeripheralServer.stopAdvertising()

• 功能說明： 停止廣播
• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.writeCharacteristicValue

TIP

該API使用方法為： BLEPeripheralServer.writeCharacteristicValue(Object Object)

• 功能說明： 往指定特徵寫入二進位數據值，並通知已連接的主機。 從機的特徵值已發生變化，該接口會處理是走回包還是走訂閱。
• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  serviceId	string	-	是	藍牙特徵對應服務的UUID
  characteristicId	string	-	是	藍牙特徵的UUID
  value	ArrayBuffer	-	是	characteristic對應的二進位值
  needNotify	boolean	-	是	是否需要通知主機value已更新
  callbackId	number	-	是	可選，處理回包時使用
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.onCharacteristicWriteRequest

TIP

該API使用方法為： BLEPeripheralServer.onCharacteristicWriteRequest(function listener)

• 功能說明： 監聽已連接的設備請求寫當前周邊設備的特徵值事件。 收到該消息後需要立刻調用writeCharacteristicValue寫回數據，否則主機不會收到響應。
• 參數及說明： function listener，已連接的設備請求寫當前周邊設備的特徵值事件的監聽函數，參數Object res如下：

  内容	類型	說明
  serverId	String	藍牙特徵對應服務的UUID
  characteristicId	String	藍牙特徵的UUID
  callbackId	Number	唯一標識碼，調用writeCharacteristicValue時使用
  value	ArrayBuffer	請求寫入特徵的二進位數據值

.offCharacteristicWriteRequest

TIP

該API使用方法為： BLEPeripheralServer.offCharacteristicWriteRequest(function listener)

• 功能說明： 移除已連接的設備請求寫當前周邊設備的特徵值事件的監聽函數

• 參數及說明： function listener，onCharacteristicWriteRequest傳入的監聽函數。 不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }

BLEPeripheralServer.onCharacteristicWriteRequest(listener)
BLEPeripheralServer.offCharacteristicWriteRequest(listener)  // Pass the same function object used for listening.

.onCharacteristicReadRequest

TIP

該API使用方法為： BLEPeripheralServer.onCharacteristicReadRequest(function listener)

• 功能說明： 監聽已連接的設備請求讀當前周邊設備的特徵值事件。 收到該消息後需要立刻調用writeCharacteristicValue寫回數據，否則主機不會收到響應。
• 參數及說明： function listener，已連接的設備請求讀當前周邊設備的特徵值事件的監聽函數，參數Object res如下：

  内容	類型	說明
  serverId	String	藍牙特徵對應服務的UUID
  characteristicId	String	藍牙特徵的UUID
  callbackId	Number	唯一標識碼，調用writeCharacteristicValue時使用

.offCharacteristicReadRequest

TIP

該API使用方法為： BLEPeripheralServer.offCharacteristicReadRequest(function listener)

• 功能說明： 移除已連接的設備請求讀當前周邊設備的特徵值事件的監聽函數

• 參數及說明： function listener，onCharacteristicReadRequest傳入的監聽函數。 不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }

BLEPeripheralServer.onCharacteristicReadRequest(listener)
BLEPeripheralServer.offCharacteristicReadRequest(listener)   // Pass the same function object used for listening.

.onCharacteristicSubscribed

TIP

該API使用方法為： BLEPeripheralServer.onCharacteristicSubscribed(function listener)

• 功能說明： 監聽特徵訂閱事件，僅iOS支持
• 參數及說明： function listener，特徵訂閱事件的監聽函數，參數Object res如下：

  内容	類型	說明
  serverId	String	藍牙特徵對應服務的UUID
  characteristicId	String	藍牙特徵的UUID

.offCharacteristicSubscribed

TIP

該API使用方法為： BLEPeripheralServer.offCharacteristicSubscribed(function listener)

• 功能說明： 移除特徵訂閱事件的監聽函數

• 參數及說明： function listener，onCharacteristicSubscribed傳入的監聽函數。 不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }

BLEPeripheralServer.onCharacteristicSubscribed(listener)
BLEPeripheralServer.offCharacteristicSubscribed(listener)  // Pass the same function object used for listening.

.onCharacteristicUnsubscribed

TIP

該API使用方法為： BLEPeripheralServer.onCharacteristicUnsubscribed(function listener)

• 功能說明： 監聽取消特徵訂閱事件，僅iOS支持
• 參數及說明： function listener，取消特徵訂閱事件的監聽函數，參數Object res如下：

  内容	類型	說明
  serverId	String	藍牙特徵對應服務的UUID
  characteristicId	String	藍牙特徵的UUID

.offCharacteristicUnsubscribed

TIP

該API使用方法為： BLEPeripheralServer.offCharacteristicUnsubscribed(function listener)

• 功能說明： 移除取消特徵訂閱事件的監聽函數

• 參數及說明： function listener，onCharacteristicUnsubscribed傳入的監聽函數。 不傳此參數則移除所有監聽函數。

• 示例代碼：

const listener = function (res) { console.log(res) }


BLEPeripheralServer.onCharacteristicUnsubscribed(listener)
BLEPeripheralServer.offCharacteristicUnsubscribed(listener)   // Pass the same function object used for listening.