7 Star 11 Fork 6

HarmonyOS-TPC / FastBle

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

FastBle

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

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

Preview

||| ||| ||| |||

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.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. 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.

简介

Ohos Bluetooth Low Energy 蓝牙快速开发框架 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/HarmonyOS-tpc/FastBle.git
git@gitee.com:HarmonyOS-tpc/FastBle.git
HarmonyOS-tpc
FastBle
FastBle
master

搜索帮助