支付寶小程序藍(lán)牙 API列表

my.openBluetoothAdapter

初始化藍(lán)牙適配器。

入?yún)?/h3>

名稱	類型	必填	描述
autoClose	Boolean	否	不傳的話默認(rèn)是true，表示是否在離開當(dāng)前頁(yè)面時(shí)自動(dòng)斷開藍(lán)牙(僅對(duì)android有效)
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

錯(cuò)誤碼描述

示例代碼

my.openBluetoothAdapter({
  success: (res) => {
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.closeBluetoothAdapter

關(guān)閉本機(jī)藍(lán)牙模塊。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.closeBluetoothAdapter({
  success: (res) => {
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.getBluetoothAdapterState

獲取本機(jī)藍(lán)牙模塊狀態(tài)。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

示例代碼

my.getBluetoothAdapterState({
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.startBluetoothDevicesDiscovery

開始搜尋附近的藍(lán)牙外圍設(shè)備。搜索結(jié)果將在 onBluetoothDeviceFound 事件中返回。

入?yún)?/h3>

名稱	類型	必填	描述
services	Array	否	藍(lán)牙設(shè)備主 service 的 uuid 列表
allowDuplicatesKey	Boolean	否	是否允許重復(fù)上報(bào)同一設(shè)備， 如果允許重復(fù)上報(bào)，則onBluetoothDeviceFound 方法會(huì)多次上報(bào)同一設(shè)備，但是 RSSI 值會(huì)有不同
interval	Integer	否	上報(bào)設(shè)備的間隔，默認(rèn)為0，意思是找到新設(shè)備立即上報(bào)，否則根據(jù)傳入的間隔上報(bào)
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.startBluetoothDevicesDiscovery({
  services: ['fff0'],
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.stopBluetoothDevicesDiscovery

停止搜尋附近的藍(lán)牙外圍設(shè)備。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.stopBluetoothDevicesDiscovery({
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.getBluetoothDevices

獲取所有已發(fā)現(xiàn)的藍(lán)牙設(shè)備，包括已經(jīng)和本機(jī)處于連接狀態(tài)的設(shè)備。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

device對(duì)象

示例代碼

my.getBluetoothDevices({
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.getConnectedBluetoothDevices

獲取處于已連接狀態(tài)的設(shè)備。

入?yún)?/h3>

名稱	類型	必填	描述
services	Array	否	藍(lán)牙設(shè)備主 service 的 uuid 列表
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

device對(duì)象

示例代碼

my.getConnectedBluetoothDevices({
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.connectBLEDevice

連接低功耗藍(lán)牙設(shè)備。

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備id
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.connectBLEDevice({
  // 這里的 deviceId 需要在上面的 getBluetoothDevices 或 onBluetoothDeviceFound 接口中獲取
  deviceId: deviceId,
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.disconnectBLEDevice

斷開與低功耗藍(lán)牙設(shè)備的連接。

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備id
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.disconnectBLEDevice({
  deviceId: deviceId,
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.writeBLECharacteristicValue

向低功耗藍(lán)牙設(shè)備特征值中寫入數(shù)據(jù)。

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備 id，參考 device 對(duì)象
serviceId	String	是	藍(lán)牙特征值對(duì)應(yīng) service 的 uuid
characteristicId	String	是	藍(lán)牙特征值的 uuid
value	Hex String	是	藍(lán)牙設(shè)備特征值對(duì)應(yīng)的值，16進(jìn)制字符串，限制在20字節(jié)內(nèi)
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.writeBLECharacteristicValue({
  deviceId: deviceId,
  serviceId: serviceId,
  characteristicId: characteristicId,
  value: 'fffe',
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.readBLECharacteristicValue

讀取低功耗藍(lán)牙設(shè)備特征值中的數(shù)據(jù)。調(diào)用后在my.onBLECharacteristicValueChange() 事件中接收數(shù)據(jù)返回。

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備 id，參考 device 對(duì)象
serviceId	String	是	藍(lán)牙特征值對(duì)應(yīng) service 的 uuid
characteristicId	String	是	藍(lán)牙特征值的 uuid
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

characteristic對(duì)象

藍(lán)牙設(shè)備characteristic(特征值)信息

示例代碼

my.readBLECharacteristicValue({
  deviceId: deviceId,
  serviceId: serviceId,
  characteristicId: characteristicId,
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.notifyBLECharacteristicValueChange

啟用低功耗藍(lán)牙設(shè)備特征值變化時(shí)的 notify 功能。注意：必須設(shè)備的特征值支持notify才可以成功調(diào)用，具體參照 characteristic 的 properties 屬性 另外，必須先啟用notify才能監(jiān)聽(tīng)到設(shè)備 characteristicValueChange 事件。

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備 id，參考 device 對(duì)象
serviceId	String	是	藍(lán)牙特征值對(duì)應(yīng) service 的 uuid
characteristicId	String	是	藍(lán)牙特征值的 uuid
descriptorId	String	否	notify 的 descriptor 的 uuid （只有android 會(huì)用到，非必填，默認(rèn)值00002902-0000-10008000-00805f9b34fb）
state	Boolean否	-	是否啟用notify或indicate
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

示例代碼

my.notifyBLECharacteristicValueChange({
  deviceId: deviceId,
  serviceId: serviceId,
  characteristicId: characteristicId,
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.getBLEDeviceServices

獲取藍(lán)牙設(shè)備所有 service（服務(wù)）

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備 id，參考 device 對(duì)象
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)

success 返回值

service對(duì)象

藍(lán)牙設(shè)備service(服務(wù))信息

示例代碼

my.getBLEDeviceServices({
  deviceId: deviceId,
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.getBLEDeviceCharacteristics

獲取藍(lán)牙設(shè)備所有 characteristic（特征值）

入?yún)?/h3>

名稱	類型	必填	描述
deviceId	String	是	藍(lán)牙設(shè)備 id，參考 device 對(duì)象
serviceId	String	是	藍(lán)牙特征值對(duì)應(yīng) service 的 uuid
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

characteristic對(duì)象

藍(lán)牙設(shè)備 characteristic （特征值）信息

properties 對(duì)象

示例代碼

my.getBLEDeviceCharacteristics({
  deviceId: deviceId,
  serviceId: serviceId,
  success: (res) => {
    console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

my.onBluetoothDeviceFound

尋找到新的藍(lán)牙設(shè)備時(shí)觸發(fā)此事件。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

device對(duì)象

示例代碼

my.onBluetoothDeviceFound({
  success: (res) => {
    console.log(res);
  }
});

my.offBluetoothDeviceFound

移除尋找到新的藍(lán)牙設(shè)備事件的監(jiān)聽(tīng)。

示例代碼

my.offBluetoothDeviceFound();

my.onBLECharacteristicValueChange

監(jiān)聽(tīng)低功耗藍(lán)牙設(shè)備的特征值變化的事件。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

示例代碼

my.onBLECharacteristicValueChange({
  success: (res) => {
    console.log(res);
  }
});

my.offBLECharacteristicValueChange

移除低功耗藍(lán)牙設(shè)備的特征值變化事件的監(jiān)聽(tīng)。

示例代碼

my.offBLECharacteristicValueChange();

my.onBLEConnectionStateChanged

監(jiān)聽(tīng)低功耗藍(lán)牙連接的錯(cuò)誤事件，包括設(shè)備丟失，連接異常斷開等。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

示例代碼

my.onBLEConnectionStateChanged({
  success: (res) => {
    console.log(res);
  }
});

my.offBLEConnectionStateChanged

移除低功耗藍(lán)牙連接的錯(cuò)誤事件的監(jiān)聽(tīng)。

示例代碼

my.offBLEConnectionStateChanged();

my.onBluetoothAdapterStateChange

監(jiān)聽(tīng)本機(jī)藍(lán)牙狀態(tài)變化的事件。

入?yún)?/h3>

名稱	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

success 返回值

示例代碼

my.onBluetoothAdapterStateChange({
  success: (res) => {
    console.log(res);
  }
});

my.offBluetoothAdapterStateChange

移除本機(jī)藍(lán)牙狀態(tài)變化的事件的監(jiān)聽(tīng)。

示例代碼

my.offBluetoothAdapterStateChange();

錯(cuò)誤碼