鸿蒙开源组件——蓝牙快速开发框架

jacksky

发布于 2021-11-29 17:10

浏览

0收藏

FastBle

Ohos Bluetooth Low Energy 蓝牙快速开发框架。

openHarmonyOs，使用简单的方式进行搜索、连接、读写等一系列蓝牙操作，并实时地得到操作反馈。

效果图

Usage

通过DevEco studio 2.0+,并下载SDK Native 版本2.0+ 方式一在entry的gradle中集成如下操作：如果使用har,请将har放到entry中的libs 修改implementation fileTree(dir: 'libs', include: ['.jar','.har'])增加*.har

方式二

allprojects{
    repositories{
        mavenCentral()
    }
}
implementation 'io.openharmony.tpc.thirdlib:fastblelib:1.0.4'

初始化，创建操作对象
后续的所有操作方法，均通过当前所创建的BleManager对象来完成
BleManager.getInstance().init(this); BleManager.getInstance() .enableLog(true) .setReConnectCount(1, 5000) .setConnectOverTime(20000) .setOperateTimeout(5000);
判断当前手机是否支持BLE
boolean isSupportBle()
开启或关闭蓝牙

void enableBluetooth() void disableBluetooth()
查看当前蓝牙状态或连接状态

boolean isBlueEnable() boolean isInScanning() boolean isConnectingOrConnected() boolean isConnected() boolean isServiceDiscovered()
打印异常信息

void handleException(BleException exception)

bleManager.handleException(exception);
ListScanCallback(long timeoutMillis)

普通扫描的Callback

long timeoutMillis: 本次扫描的时间 void onScanning(ScanResult result): 当前正在扫描状态，且搜索到一个外围设备的回调 void onScanComplete(ScanResult[] results): 扫描时间到或手动取消扫描后的回调 ScanResult: 表示返回的扫描结果对象 BluetoothDevice getDevice(): 蓝牙设备对象 byte[] getScanRecord(): 广播数据; int getRssi(): 信号强度
BleGattCallback

扫描并连接的Callback

void onFoundDevice(ScanResult scanResult): 找到设备的回调； void onConnecting(BluetoothGatt gatt, int status): 正在连接的回调； void onConnectError(BleException exception)：连接未成功的回调，通过解析BleException来判断具体未成功的原因； void onConnectSuccess(BluetoothGatt gatt, int status): 连接成功的回调； void onServicesDiscovered(BluetoothGatt gatt, int status): 发现服务的回调； void onDisConnected(BluetoothGatt gatt, int status, BleException exception): 连接断开的回调，特指连接之后的断开。
BleCharacterCallback

Characteristic操作的Callback

void onSuccess(BluetoothGattCharacteristic characteristic): 数据传输回调； void onFailure(BleException exception)：操作或数据传输过程中出错； void onInitiatedResult(boolean result): 操作成功与否的回调；

BleRssiCallback

读Rssi操作的Callback

  void onSuccess(int rssi): 得到rssi数据的回调；
  void onFailure(BleException exception)： 操作或数据传输过程中出错；
  void onInitiatedResult(boolean result): 操作成功与否的回调；

BleException

 int getCode(): 获取异常码；
  String getDescription()： 获取异常描述；

异常码：
- 100：超时
- 101：连接异常
- 102：其他（异常信息可以通过异常描述获取，一般是开发过程中的操作中间步骤的异常）
- 103：设备未找到
- 104：蓝牙未启用
- 105：开启扫描过程失败
扫描所有设备

可获得周围蓝牙设备对象数组

boolean scanDevice(ListScanCallback callback)

返回值表示扫描操作是否成功，具体扫描结果会显示在ListScanCallback的回调方法中。

bleManager.scanDevice(new ListScanCallback(TIME_OUT) { @Override public void onScanning(ScanResult result) { } @Override public void onScanComplete(ScanResult[] results) { } });

连接设备

当搜索到周围设备之后，可以选择选择某一个设备和其连接

void connectDevice(ScanResult scanResult, boolean autoConnect, BleGattCallback callback)

  bleManager.connectDevice(scanResult, true, new BleGattCallback() {

      @Override
      public void onConnecting(BluetoothGatt gatt, int status) {

      }

      @Override
      public void onConnectError(BleException exception) {

      }

      @Override
      public void onConnectSuccess(BluetoothGatt gatt, int status) {

      }

      @Override
      public void onServicesDiscovered(BluetoothGatt gatt, int status) {

      }

      @Override
      public void onDisConnected(BluetoothGatt gatt, int status, BleException exception) {

      }

  });

停止扫描

取消扫描操作

void cancelScan()

  bleManager.cancelScan();

订阅通知notify

boolean notify(String uuid_service, String uuid_notify, BleCharacterCallback callback)

返回值表示notify操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

  bleManager.notify(
          UUID_SERVICE,
          UUID_NOTIFY,
          new BleCharacterCallback() {
              @Override
              public void onSuccess(BluetoothGattCharacteristic characteristic) {

              }

              @Override
              public void onFailure(BleException exception) {

              }

              @Override
              public void onInitiatedResult(boolean result) {

              }
          });

取消订阅通知notify，并移除回调监听

boolean stopNotify(String uuid_service, String uuid_notify)

返回值表示stopNotify操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

  bleManager.stopNotify(UUID_SERVICE, UUID_NOTIFY);

订阅通知indicate

boolean indicate(String uuid_service, String uuid_indicate, BleCharacterCallback callback)

返回值表示indicate操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

  bleManager.indicate(
          UUID_SERVICE,
          UUID_INDICATE,
          new BleCharacterCallback() {
              @Override
              public void onSuccess(BluetoothGattCharacteristic characteristic) {

              }

              @Override
              public void onFailure(BleException exception) {

              }

              @Override
              public void onInitiatedResult(boolean result) {

              }
          });

取消订阅通知indicate，并移除回调监听

boolean stopIndicate(String uuid_service, String uuid_notify)

返回值表示stopIndicate操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

  bleManager.stopIndicate(UUID_SERVICE, UUID_INDICATE);

写

boolean writeDevice(String uuid_service, String uuid_write, byte[] data, BleCharacterCallback callback)

返回值表示write操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

bleManager.writeDevice(
          UUID_SERVICE,
          UUID_WRITE,
          HexUtil.hexStringToBytes(SAMPLE_WRITE_DATA),
          new BleCharacterCallback() {
              @Override
              public void onSuccess(BluetoothGattCharacteristic characteristic) {

              }

              @Override
              public void onFailure(BleException exception) {

              }

              @Override
              public void onInitiatedResult(boolean result) {

              }
          });

读

boolean readDevice(String uuid_service, String uuid_read, BleCharacterCallback callback)

返回值表示read操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

  bleManager.readDevice(
          UUID_SERVICE,
          UUID_READ,
          new BleCharacterCallback() {
              @Override
              public void onSuccess(BluetoothGattCharacteristic characteristic) {

              }

              @Override
              public void onFailure(BleException exception) {

              }

              @Override
              public void onInitiatedResult(boolean result) {

              }
          });

读外设的Rssi

boolean readRssi(BleRssiCallback callback)

返回值表示readRssi操作是否成功，BleCharacterCallback()中的onInitiatedResult也表示本次操作是否成功，功能一致，便于不同情况下的用途。

 bleManager.readRssi(new BleRssiCallback() {
      @Override
      public void onSuccess(int rssi) {

      }

      @Override
      public void onFailure(BleException exception) {

      }

      @Override
      public void onInitiatedResult(boolean result) {

      }
  });

manual remove callback

void stopListenCharacterCallback(String uuid)

不再监听这个特征的数据变化，适用于移除notify、indicate、write、read对应的callback。

  bleManager.stopListenCharacterCallback(uuid_sample);

复位（断开此次蓝牙连接，移除所有回调）

void closeBluetoothGatt()

  bleManager.closeBluetoothGatt();

新增普通蓝牙扫描api

在BleManager中新增普通蓝牙扫描api：blueToothScan,cancelBlueToothScan,unSubscribeBlueTooth,and so so。

BleManager.getInstance().bluetToothScan(blueToothScanCallback);
 /**
     * blutTooth 普通蓝牙扫描 ，，因为ble在hmos太多坑，所以还写了普通蓝牙扫描
     */
    private BlueToothScanCallback blueToothScanCallback =
            new BlueToothScanCallback() {
                @Override
                public void notifyDiscoveryState(boolean isStarted) {
                    // 扫描状态改变
                    if (isStarted) {
                        progressBar.setVisibility(Component.VISIBLE);
                    } else {
                        progressBar.setVisibility(Component.HIDE);
                    }
                }

                @Override
                public void notifyBluetoothStatusChanged() {
                    // 蓝牙状态改变
                    if (BleManager.getInstance().getBluetoothManager().getBtState() == STATE_OFF
                            || BleManager.getInstance().getBluetoothManager().getBtState() == STATE_TURNING_OFF) {
                        aSwitch.setChecked(false);
                    } else {
                        aSwitch.setChecked(true);
                    }
                }

                @Override
                public void updateAvailableDevices(BluetoothRemoteDevice btRemoteDevice) {
                    // 扫描到的有效蓝牙
                    //              toast(btRemoteDevice.getDeviceAddr()+"");
                    BluetoothDevice device = new BluetoothDevice();
                    device.setAddress(btRemoteDevice.getDeviceAddr());
                    device.setBlueRemoteDevice(btRemoteDevice);

                    Optional<String> optName = btRemoteDevice.getDeviceName();
                    String name = optName.orElse(btRemoteDevice.getDeviceAddr());
                    device.setName(name);

                    simpleBlueToothDevices.add(device);

                    simpleBlueToothProvider.notifyDataChanged();
                }

                @Override
                public void updatePairedDevices(BluetoothRemoteDevice btRemoteDevice) {
                    // 扫描到已配对的蓝牙

                }

                @Override
                public void updateFinishScanResult(List<BluetoothRemoteDevice> blueToothDevices) {
                    // 扫描完成后扫描结果
                    for (BluetoothRemoteDevice btRemoteDevice : blueToothDevices) {
                        BluetoothDevice device = new BluetoothDevice();
                        device.setAddress(btRemoteDevice.getDeviceAddr());
                        device.setBlueRemoteDevice(btRemoteDevice);

                        Optional<String> optName = btRemoteDevice.getDeviceName();
                        String name = optName.orElse(btRemoteDevice.getDeviceAddr());

                        device.setName(name);
                        simpleBlueToothDevices.add(device);
                    }
                    simpleBlueToothProvider.notifyDataChanged();

                    showProgressBar(false);
                }
            };

Issue

v1.0 ble 扫描并连接，Notify(OS暂不支持)，Indicate(OS暂不支持)，OS sdk暂时未暴露出mac,deviceName等相关属性，需OS sdk发布3.0版本更新

Entry运行要求

通过DevEco studio,并下载SDK 将项目中的build.gradle文件中dependencies→classpath版本改为对应的版本（即你的IDE新建项目中所用的版本）

License

   Copyright 2016 chenlijian

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

	   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

分类

标签

FastBle-master.zip 8.82M 209次下载