Mobile Platform as a Service：藍芽 API 概覽

版本要求

藍芽類型	版本要求	Android 或 iOS 版本要求
BLE 低功耗藍芽	mPaaS 10.1.60 及以上版本。	Android： 5.0 及以上版本 iOS：無版本要求
傳統藍芽	mPaaS 10.1.60 及以上版本。	-

基本流程

低功耗藍芽流程圖

傳統藍芽流程圖

藍芽 API

低功耗藍芽

名稱	功能說明
my.connectBLEDevice	串連低功耗藍牙裝置。
my.disconnectBLEDevice	斷開與低功耗藍牙裝置的串連。
my.getBLEDeviceCharacteristics	擷取藍牙裝置所有 characteristic（特徵值）。
my.getBLEDeviceServices	擷取所有已發現的藍牙裝置，包括已經和本機處於串連狀態的裝置。
my.notifyBLECharacteristicValueChange	啟用低功耗藍牙裝置特徵值變化時的 notify 功能。
my.offBLECharacteristicValueChange	取消監聽低功耗藍牙裝置的特徵值變化的事件。
my.offBLEConnectionStateChanged	取消低功耗藍芽串連狀態變化事件的監聽。
my.onBLECharacteristicValueChange	監聽低功耗藍牙裝置的特徵值變化的事件。
my.onBLEConnectionStateChanged	監聽低功耗藍芽串連的錯誤事件，包括裝置丟失，串連異常斷開等。
my.readBLECharacteristicValue	讀取低功耗藍牙裝置特徵值中的資料。
my.writeBLECharacteristicValue	向低功耗藍牙裝置特徵值中寫入資料。

傳統藍芽

名稱	功能說明
my.closeBluetoothAdapter	關閉本機藍芽模組。
my.getBluetoothAdapterState	擷取本機藍芽模組狀態。
my.getBluetoothDevices	擷取所有已發現的藍牙裝置，包括已經和本機處於串連狀態的裝置。
my.getConnectedBluetoothDevices	擷取處於已串連狀態的裝置。
my.offBluetoothAdapterStateChange	移除本機藍芽狀態變化的事件的監聽。
my.offBluetoothDeviceFound	移除尋找到新的藍牙裝置事件的監聽。
my.onBluetoothDeviceFound	搜尋到新的藍牙裝置時觸發此事件。
my.onBluetoothAdapterStateChange	監聽本機藍芽狀態變化的事件。
my.openBluetoothAdapter	初始化小程式藍芽適配器。
my.startBluetoothDevicesDiscovery	開始搜尋附近的藍芽外圍裝置。
my.stopBluetoothDevicesDiscovery	停止搜尋附近的藍芽外圍裝置。

調用樣本

//初始化
my.openBluetoothAdapter({
  success: (res) => {
      console.log(res);
  }
});
//註冊發現事件
my.onBluetoothDeviceFound({
  success: (res) => {
    let device = res.devices[0];
    //串連發現的裝置
    my.connectBLEDevice({
      deviceId: deviceId,
      success: (res) => {
        console.log(res)
      },
      fail:(res) => {
      },
      complete: (res)=>{
      }
    });
    //停止搜尋
    my.stopBluetoothDevicesDiscovery({
      success: (res) => {
        console.log(res)
      },
      fail:(res) => {
      },
      complete: (res)=>{
      }
    });
  }
});
//註冊串連事件
my.onBLEConnectionStateChanged({
  success: (res) => {
      console.log(res);
    if (res.connected) {
        //開始讀寫 notify 等操作
        my.notifyBLECharacteristicValueChange({
          deviceId: deviceId,
          serviceId: serviceId,
          characteristicId: characteristicId,
          success: (res) => {
              console.log(res)
          },
          fail:(res) => {
          },
          complete: (res)=>{
          }
        });
    }
  }
});
//註冊接收 read 或 notify 的資料
my.onBLECharacteristicValueChange({
  success: (res) => {
      console.log(res);
  }
});
//開始搜尋
my.startBluetoothDevicesDiscovery({
  services: ['fff0'],
  success: (res) => {
      console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

//中斷連線
my.disconnectBLEDevice({
  deviceId: deviceId,
  success: (res) => {
      console.log(res)
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});

//登出事件
my.offBluetoothDeviceFound();
my.offBLEConnectionStateChanged();
my.offBLECharacteristicValueChange();

//退出藍芽模組
my.closeBluetoothAdapter({
  success: (res) => {
  },
  fail:(res) => {
  },
  complete: (res)=>{
  }
});