zcgelppa/Android_Ble_SDK

Android SDK

Android_Ble_SDK

Android_Ble_SDK是一个用于快速与蓝牙BLE交互的工具包，仅提供给我们合作的客户下载使用，方便提升客户的开发效率。

README: English | 中文

必要条件

• API>19&&BLE 4.0
• vpbluetooth_x.x.x.jar
• gson-x.x.x.jar

如何使用

1. 配置 build.gradle

compile files('libs/vpbluetooth_x.x.x.jar')  
compile files('libs/gson-x.x.x.jar') 或者 compile 'com.google.code.gson:gson:x.x.x'  

2. 配置 Androidmanifest.xml

<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<!--Activity&Service-->
<service android:name="com.inuker.bluetooth.library.BluetoothService" />        
<!--固件升级功能相关-->
<service android:name=".oad.service.DfuService" /> 
<activity android:name=".oad.activity.NotificationActivity" />

3. 蓝牙通信连接

操作说明:所有的操作都只是通过VPOperateManager;

3.1 获取VPOperateManager实例： VPOperateManager.getMangerInstance()
3.2 扫描蓝牙设备: startScanDevice();
3.3 连接蓝牙设备: connectDevice();
    3.3.1 调用密码密码：confirmDevicePwd()
    3.3.2 调用个人信息设置：syncPersonInfo()
3.4 设置连接设备的连接状态监听:registerConnectStatusListener(); //这个方法最好是在连接成功后设置
3.5 设置系统蓝牙的开关状态监听:registerBluetoothStateListener(); //这个方法可以在任何状态下设置
3.6 其他数据交互操作

备注1：
为了避免内存泄漏的情况，请谨慎使用context,推荐使用getApplicationContext();
如：获取VPOperateManager实例：VPOperateManager.getMangerInstance(getApplicationContext())；

备注2： 
如调用扫描设备:VPOperateManager.getMangerInstance().startScanDevice()；
以上统一简写为:startScanDevice();

备注3:
调用connectDevice(),然后在bleNotifyResponse回调成功后,才可执行密码验证操作
第一步要进行的交互是验证密码：confirmDevicePwd()
第二步要进行的交互是同步个人信息：syncPersonInfo()

备注4:
设备不支持异步操作,当多个耗时操作同时进行时,可能会导致数据异常;因此在与设备进行交互时,尽可能避免多个操作同时进行

4. 蓝牙数据交互说明

SDK在蓝牙数据的下发的设计是只需要调用方法,传入设置参数以及监听接口,当数据有返回时,接口会触发回调,以confirmDevicePwd为例

//传入参数
String  pwdStr=“0000”;
boolean is24Hourmodel = false;   
//调用方法,匿名内部类用于回调监听
VPOperateManager.getMangerInstance(mContext).confirmDevicePwd(writeResponse, new IPwdDataListener() {
            @Override
            public void onPwdDataChange(PwdData pwdData) {
                //触发回调
                String message = "PwdData:\n" + pwdData.toString();
                Logger.t(TAG).i(message);
            }
        }, new IDeviceFuctionDataListener() {
            @Override
            public void onFunctionSupportDataChange(FunctionDeviceSupportData functionSupport) {
                //触发回调
                String message = "FunctionDeviceSupportData:\n" + functionSupport.toString();
                Logger.t(TAG).i(message);
            }
        }, new ISocialMsgDataListener() {
            @Override
            public void onSocialMsgSupportDataChange(FunctionSocailMsgData socailMsgData) {
                //触发回调
                String message = "FunctionSocailMsgData:\n" + socailMsgData.toString();
                Logger.t(TAG).i(message);
             }
        }, pwdStr, is24Hourmodel);

5. 固件升级说明

固件升级的作用主要是针对设备的软件功能进行升级,此操作要求非常严谨，升级出错会给用户带来非常不好的体验。  
请谨慎执行此操作，升级操作要求在有网络的条件下进行，包括以下3个步骤,请务必仔细核对。  
具体的升级案例,可参考我司的运行demo工程VpBluetoothSDKDemo下的com.timaimee.vpbluetoothsdkdemo.oad.Activity.OadActivity

1.AndroidMainfest.xml的配置	      
    这个配置已在前面的Activity&Service配置进行过说明，主要是配置两个文件,一个service和一个activity,
    开发者也可以直接拷贝VpBluetoothSDKDemo下的这两个文件。

2.升级前的判断
    a.升级前先进行设备版本校验，升级文件校验
    b.两者进行校验后，发送固件升级命令，设备会进入固件升级模式
    c.然后app找到固件升级模式下的设备时
    d.最后可以调用官方升级程序。

    备注：checkVersionAndFile()方法已封装以上的所有步骤，开发者调用此方法就行。
        回调方法1：onCheckSucces()表示设备版本以及升级文件两者校验成功;
        回调方法2：findOadDevice()表示找到固件升级模式下的设备,可以调用官方升级程序。
     
    其他情况:设备版本以及升级文件已经通过,且文件没有问题，但未发现固件升级模式下的设备，
    处理方式:调用findOadModelDevice()方法，然后在其回调方法findOadDevice()中调用官方升级程序，
    当然这种情况极少，不建议开发单独调用findOadModelDevice();

3.调用官方升级程序
    OadActivity下的startOad()，一般在接口OnFindOadDeviceListener的findOadDevice方法回调后被调用。

鸣谢

• Android-DFU-Library
• BluetoothKit
• Gson

许可协议

Apache Version 2.0

Copyright (C) 2010 Michael Pardo
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.