集成文档

准备工作

warning

这部分的内容是尤为重要的, 决定了是否可以使用蓝牙, 没有蓝牙权限是无法使用Yasee SDK!!!

!! 没有示例的情况下,查阅 完整Api文档

首先,对接Yasee SDK 需要遵循以下条件:

需要您的手机Android 版本在 Pie 及以上,也就是 Android 9 版本及以上,使用以下方式可以查看版本的信息

public class DeviceInfo {
    public static void logDeviceInfo() {
        Log.d("DeviceInfo", "Brand: " + Build.BRAND);
        Log.d("DeviceInfo", "Device: " + Build.DEVICE);
        Log.d("DeviceInfo", "Model: " + Build.MODEL);
        Log.d("DeviceInfo", "ID: " + Build.ID);
        Log.d("DeviceInfo", "Manufacturer: " + Build.MANUFACTURER);
        Log.d("DeviceInfo", "Product: " + Build.PRODUCT);
        Log.d("DeviceInfo", "SDK: " + Build.VERSION.SDK_INT);
        Log.d("DeviceInfo", "Release: " + Build.VERSION.RELEASE);
        Log.d("DeviceInfo", "Incremental: " + Build.VERSION.INCREMENTAL);
    }
}

需要声明必要的权限列表,此处如有遇到问题,请查阅 Android官方文档

<uses-permission 
    android:name="android.permission.BLUETOOTH"
    android:maxSdkVersion="30"/>
<uses-permission 
    android:name="android.permission.BLUETOOTH_ADMIN" 
    android:maxSdkVersion="30"/>
<uses-permission 
    android:name="android.permission.ACCESS_COARSE_LOCATION" 
    android:maxSdkVersion="30"/>
<uses-permission
     android:name="android.permission.ACCESS_FINE_LOCATION" 
     android:maxSdkVersion="30"/>
<uses-permission 
    android:usesPermissionFlags="neverForLocation"  
    android:name="android.permission.BLUETOOTH_SCAN"/>
<uses-permission 
    android:name="android.permission.BLUETOOTH_ADVERTISE" />
<uses-permission 
    android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-feature 
    android:name="android.hardware.bluetooth_le" 
    android:required="true"/>

声明完成之后,需要在App中动态申请权限,以下为申请权限示例代码:

    private boolean checkBLEConnectionPermission() {
        boolean isGranted = false;
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
            if (ActivityCompat.checkSelfPermission(this, Manifest.permission.BLUETOOTH_CONNECT) == PackageManager.PERMISSION_GRANTED
                    && ActivityCompat.checkSelfPermission(this, Manifest.permission.BLUETOOTH_SCAN) == PackageManager.PERMISSION_GRANTED) {
                isGranted = true;
            }
        } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
            if (ActivityCompat.checkSelfPermission(this, Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED
                    && ActivityCompat.checkSelfPermission(this, Manifest.permission.ACCESS_COARSE_LOCATION) == PackageManager.PERMISSION_GRANTED) {
                isGranted = true;
            }
        } else {
            isGranted = true;
        }
        return isGranted;
    }

需要初始化 Yasee SDK 在1、2 步骤执行完成,并没有任何遗漏之后,要开始导入并且初始化Yasee SDK. 在 Android 工程中导入 AAR（Android Archive）包可以通过以下几种方式进行：
使用 Gradle 导入 AAR 包

本地 AAR 包

如果你有一个本地的 AAR 包，可以将它放在工程的 libs 目录下，然后在 build.gradle 文件中进行配置。

将 AAR 包放入 libs 目录在你的模块（通常是 app 模块）的 libs 目录中放置 AAR 文件，例如 libs/mylibrary.aar。
在 build.gradle 文件中配置在模块的 build.gradle 文件中添加以下代码：

repositories {
    flatDir {
        dirs 'libs'
    }
}

dependencies {
    implementation(name: 'mylibrary', ext: 'aar')
}

远程 AAR 包

如果你的 AAR 包托管在远程仓库中，可以通过在 build.gradle 文件中添加仓库地址和依赖项来导入。

添加远程仓库地址

repositories {
    maven {
        url 'https://your.remote.repository/url'
    }
}

dependencies {
    implementation 'com.example:yourlibrary:1.0.0@aar'
}

导入 AAR 包主要有两种方式：本地导入和远程导入。选择适合你的项目需求的方法，并在 build.gradle 文件中进行相应的配置。完成配置后，同步项目，Android Studio 将会自动导入并解析 AAR 包中的内容。

需要在没有示例的情况下,查阅 完整文档

大纲

接下来,我们将分为以下几个步骤,带领您集成、以及使用Yasee 官方 SDK.

准备工作
- 声明权限
- 运行时请求权限
初始化 Yasee SDK
- 蓝牙配置信息 (BleConfig)
- Android相关的上下文信息 (Yasee)
- 人员配置信息 (User)
数据通知相关
- 设备连接通知
- 设备收发信息通知
- 设备绑定变更通知
蓝牙相关操作
- 搜索 Yasee 设备
- 连接 Yasee 设备
- 获取设备支持检测项
- 获取检测项支持的指令
- 收发与外设的双向指令

正式开始

异常处理情况 & 参数情况

对于一个SDK而言,👉完整的Api文档👈是必不可少的;
在处理异常和参数理解上有重要的意义, 因此, SDK在使用中会有可视化的参数提示,如:

在编码过程中,可以查看详细的参数信息

在获取数据对象和模型对象的时候,常规的异常捕获需要做到:

// 空值判断
if (value == null) return;

// try 异常捕获
try {
    // 概率下可存在 奔溃的情况
} catch (ArithmeticException err) {
    // 失败的逻辑处理
}

初始化 Yasee SDK

初始化操作是必须要做的操作,集成Yasee SDK第一步却是以下内容步.

/// 设置整个SDK所使用到的上下文环境
Yasee.getSingle().context = getApplicationContext();

/// 设置搜索自动暂停的时间 (秒级)
/// BleConfig(Integer scanTimer)
Yasee.getSingle().bleConfig = new BleConfig(5);

/// 设置人员信息
/// 设置当前的使用人, 
/// 主要是为了 肺功能 和 体脂上的人员信息设置 
/// User(Integer sex(1-男,2-女), Integer age, Integer smoking(1-抽,0-不), Integer height(cm), Integer weight(kg))
Yasee.getSingle().currentUser = new User(1,20,0,178,75);

对于示例中的模型,如有理解歧义,可查看详细的注释说明:

详细请点击 User
详细请点击 BleConfig

warning

设置当前的人员信息,主要的功能是为了肺功能和体脂中的人员信息设置! 如果没有这两种检测项的测量可忽略

通知相关内容

所有的有关Yasee SDK 的通知和数据交互,都是通过 Notify来处理的,包含但未来不限于:

设备的绑定、解绑与搜索 (NotifyType.(searchDevices|bindDevices))
设备的连接与断开 (NotifyType.deviceLink)
设备的通讯数据 (NotifyType.deviceData)
设备的历史数据数据 (NotifyType.testHistory)

首先我们需要了解的是通知的类型,只有了解了通知的类型才能更好的监听来自SDK的各类信息通知:

/**
 * 信息类型
 * /// 通知的类型
 *     /// 设备蓝牙状态
 *     case bleState
 *     /// 设备搜索列表
 *     case searchDevices
 *     /// 设备绑定列表
 *     case bindDevices
 *     /// 设备连接状态
 *     case deviceLink
 *     /// 设备传输数据
 *     case deviceData
 *     /// 设备历史数据
 *     case testHistory
 */
public enum NotifyType {

    /*
    * 设备蓝牙状态
    * */
    bleState,

    /**
     * 设备搜索列表
     */
    searchDevices,

    /**
     * 设备绑定列表
     */
    bindDevices,

    /**
     * 设备连接变化
     */
    deviceLink,


    /**
     * 设备数据内容 Notify
     */
    deviceData       // 设备数据内容 Notify

    /**
     * 设备历史数据内容 Notify
     */
    testHistory       // 设备数据内容 Notify
}

可以通过消息通知的类型,来区分数据的类型是什么, 并且使用什么类型的数据来接收数据类型数据类型, 主要包含:

NotifyContent.BleLink
- 连接状态
- 被操作的设备
NotifyContent.BleNotifyData
- 数据解析的对象
- 被操作的设备
- 交互使用的原始数据帧
NotifyContent.BleSearch (暂未使用)

对于示例中的模型,如有理解歧义,可查看详细的注释说明:

详细请点击 NotifyContent

// 以 接收数据为例. 首先创建 监听接收接口:

NotifyInterface _ni = new NotifyInterface() {
    @Override
    public NotifyType getType() {
        // 想要接收的数据类型 (按照自己的需求来设置)
        return NotifyType.deviceData;
    }

    @Override
    public void message(NotifyResp data) {
        NotifyResp.BleNotifyData data = (NotifyResp.BleNotifyData) data.data;
        HashMap _m = (HashMap) data.data;
        String text = String.format("%s\n start============\n  原始: %s\n  指令类型:%s \n  指令可视化数据:%s\nend================\n", binding.sendData.getText(),Arrays.toString(data.raw),data.step.name(), _m==null ? "" : _m.toString());
        Logs.print(text);
        new Handler(Looper.getMainLooper()).post(new Runnable() {
            @Override
            public void run() {
                // 更新操作
            }
        });
    }
};

设备控制相关操作

蓝牙相关的步骤,比较固定,基本包含搜索、连接、发送信息

// 搜索设备
Yasee.getSingle().scan();

// 连接设备
(BleDevice) device.connect();

// 通过 mac 地址和 设备名称连接一个位置设备
// 主要是在 设备已经缓存了设备信息在本地时使用, 如 重连、缓存器拾取等
// BleDevice(String mac, AdvertisementData Avdadata)
BleDevice device = new BleDevice("MAC",AdvertisementData);
// 这里可以使用 空值判断来中断异常
if (device == null) throw new IllegalArgumentException("获取设备失败");
device.connect();

// 断开设备
(BleDevice) device.disconnect();

// 获取 设备 支持的 检测项列表
List<Check> checks = Products.supportChecks((BleDevice) device);

// 获取 检测项 支持的 指令
List<Cmd> cmds = checks.get(0).getCmds();

// 发送 控制命令 (测量、停止、 获取Code 等等 )
(BleDevice) device.send(ccs.get(0).handwareCode,cs.get(0).id,null); 

// 发送 接收使用 Notify 通知

对于示例中的模型,如有理解歧义,可查看详细的注释说明:

详细请点击 BleDevice
详细请点击 Check
详细请点击 Products

设置默认的绑定列表

Yasee SDK 支持初始化绑定列表,并根据初始化的设备列表进行自动连接操作;首先我们需要获取一个List<BleDecive>对象;

warning

自动连接功能取决于初始化设备的设置,由BleConfig中的reconnect字段控制,如果需要设置自动连接,需要配置此属性,默认情况支持自动连接!!

以下为设备初始化:

/// 获得List<BleDevice> 数组
List<BleDevice> alls = Devices.getSingle().getDevices()

/// 获取 设备管理对象
Devices single = Devices.getSingle()


/// 设置初始化 默认的设备,此操作可以让设备进入自动连接(前提是配置了自动连接)
single.initDevices(List<BleDevice>);

对于示例中的模型,如有理解歧义,可查看详细的注释说明:

详细请点击 Devices

Demo 下载

Android下载

AAR 下载

建议对接前使用 Demo体验或者查阅本文档

AAR下载

准备工作​

大纲​

正式开始​

异常处理情况 & 参数情况​

初始化 Yasee SDK​

通知相关内容​

设备控制相关操作​

设置默认的绑定列表​

Demo 下载​

AAR 下载​

准备工作

大纲

正式开始

异常处理情况 & 参数情况

初始化 Yasee SDK

通知相关内容

设备控制相关操作

设置默认的绑定列表

Demo 下载

AAR 下载