sg-ble-next v1.0.2

乐心蓝牙设备小程序插件接入指南

版本更新日志

1.0.1

• 增加stopBluetoothDevicesDiscovery与startBluetoothDevicesDiscovery方法，用于如果有多个蓝牙sdk的时候可能产生冲突的情况

1.0.0

• 完成小程序插件的接入

1 插件使用说明

1.1 插件声明

在app.json中声明插件的引用及小程序的appId:wxe3d2a6ab8dd5b49b，此时如果你之前没有使用过该插件，则会在console中报错“插件未授权 添加插件”

{
  "plugins": {
    "lzbluetooth": {
        "version": "{{最新版本}}",
        "provider": "wxe3d2a6ab8dd5b49b"
    }
  }
}

1.2 插件引入

const lsPlugin = requirePlugin("lzbluetooth");

1.3 插件初始化

申请乐心AppKey

  plugin.init({
    //用邮件乐心分配的appId替换掉下面字符串
      appId: "你申请的appkey",
      logger: null,
      onBluetoothDeviceFound: privateOnBluetoothDeviceFound,              
      onBLECharacteristicValueChange: privateOnBLECharacteristicValueChange,
      onBLEConnectionStateChange: privateOnBLEConnectionStateChange,
      onBluetoothAdapterStateChange: privateOnBluetoothAdapterStateChange,
<<<<<<< HEAD
=======
      stopBluetoothDevicesDiscovery: privateStopBluetoothDevicesDiscovery,
      startBluetoothDevicesDiscovery: privateStartBluetoothDevicesDiscovery,
>>>>>>> 1.0.13.plugin
    });

请求参数：

<<<<<<< HEAD

| stopBluetoothDevicesDiscovery | func | 否 | 微信蓝牙设备结束扫描，默认使用wx.stopBluetoothDevicesDiscovery，如果该方法在其他地方有使用，则需要你自己去避免冲突 | | startBluetoothDevicesDiscovery | func | 否 | 微信蓝牙开始扫描，默认使用wx.startBluetoothDevicesDiscovery，如果该方法在其他地方有使用，则需要你自己去避免冲突 |

1.0.13.plugin | appKey | string | 否 | 与appId一致，只有在使用UI的时候需要 | | tenantName | string | 否 | 租户名称，只有在使用UI的时候需要 | | tenantId | number | 否 | 租户id，只有在使用UI的时候需要 | | subscriptionId | number | 否 | 订阅id，只有在使用UI的时候需要 | | associatedId | string | 否 | 第三方关联userId，只有在使用UI的时候需要 | | debug | boolean | 否 | 订打开H5的vconsole，只有在使用UI的时候需要 | | env | string | 否 | 接口环境：beta测试，online生产，只有在使用UI的时候需要 |

2 设备相关

2.1 搜索&发现设备

蓝牙设备在绑定前，需要先通过扫描获得需要绑定的设备信息， 首先需要调用startScanning接口获取device对象， 您可能需要自己去判断释放有重复的蓝牙设备信号上报并做过滤，在实际应用过程中， 您可能需要经过多个扫描周期才能获得蓝牙搜索结果，调用示例：

// 开始扫描设备
  plugin.startScanning(device => {
    // 将扫描到的设备保存，具体参数参考具体接口
    scanResults.push(device);
    // 刷新UI
    this.setData({
      scanResults
    })
  }) 

请求参数：

device 的数据结构

2.2 停止搜索

强制中断蓝牙搜索，执行搜索过程中中断搜索或页面销毁时，请务必调用停止搜索接口，否则会影响正常的连接流程：

  // 关闭搜索
  plugin.stopScanning();

2.3 绑定设备

搜索完成后， 向用户展示搜索到的设备列表信息， 用户选择目标设备后， 进行设备绑定操作（绑定设备是为了获取你选择设备的信息， 绑定不是必须的，如果您知道用户当前使用的设备信息， 可以不经过绑定直接调用plugin.addMonitorDevice去连接设备并同步数据）调用示例：

  // 用户选择某个设备绑定
  // 如果是安卓设备，则需要判断位置是否可用，位置权限是否可用 let { locationEnabled, locationAuthorized } = wx.getSystemInfoSync();
  plugin.bindDevice({
    mac: mac,   
    callback: res => {
      // 绑定结果 
      let mac = res.mac;
      let bindState = res.bindState;
      /// 只有在绑定错误的时候才有错误码
      let errorCode = res.errorCode;

    }
  });  

请求参数：Object object

res 的数据结构

res.bindState 的可能值

res.errorCode 的可能值

res.deviceInfo的数据结构

2.4 取消绑定

当前状态是正在绑定的页面，此时退出绑定页面，则需要需要绑定 调用示例：

// 取消绑定
plugin.cancelBind({ mac });

请求参数：Object object

2.5 添加用户已经绑定的设备

用户打开app时， 若之前已经绑定过设备， 需要将已经绑定的设备的mac地址添加到sdk， sdk会自动连接设备，建议您将用户和设备的绑定关系持久化在云端， sdk初始化成功之后立即添加mac地址到sdk， 调用示例：

  /// 添加监听
  // 如果是安卓设备，则需要判断位置是否可用，位置权限是否可用 let { locationEnabled, locationAuthorized } = wx.getSystemInfoSync();
  
  plugin.addMonitorDevice({ 
    mac: this.data.mac,
    model: this.data.model,
  })

  // 替换目前已监听的
  plugin.setMonitroDevice({ 
    mac: this.data.mac,
    model: this.data.model,
  })

请求参数：Object object ｜ Object object[]

2.6 删除用户正在连接或者同步的设备

当用户需要解除监听设备或正在绑定中断绑定时，解绑后会删除SDK中的缓存的设备信息并断开蓝牙连接，建议您在解绑成功后，清除您App本地或者云端存储的设备信息，并删除和用户的绑定关系， 调用示例：

  /// 删除某个正在监听的设备
  plugin.deleteMonitorDevice({ 
    mac: this.data.mac,
  })

  // 删除全部正在监听的设备
  plugin.deleteAllMonitorDevice({ 
    mac: this.data.mac,
    model: this.data.model,
  })

2.7 设备状态的获取

如果你想获取某个设备的连接状态，可以通过getConnectionState方法获取，如果你想蓝牙的可用状态可以调用isBluetoothAvailable判断是否可用，调用示例：

// 当前蓝牙是否可用
  let bluetoothAvalible = plugin.isBluetoothAvailable();
  // mac 设备的唯一标识
  let state = plugin.getConnectionState({mac}});

请求参数：Object object

返回值：number state

2.8 设备数据或状态的监听

如果你想监听手机蓝牙是否开启，设备的连接状态，及设备同步过来的数据，则可以使用 plugin.$on 监听某个事件，目前支持三个事件 1. 手机蓝牙的开关 eventName = "adaptorState", 2. 蓝牙设备的连接状态 eventName = "connectionState", 3. 蓝牙设备发送给小程序的数据 eventName = "dataReport"

事件是通过 eventKey，同一事件的同一eventKey 回调会被覆盖 取消监听则使用 plugin.$off 参数 调用示例：

  // 监听蓝牙是否可用
  plugin.$on({
    eventName: "adaptorState",
    eventKey: "wo",   // 唯一标识，同一标识的监听会被覆盖
    callback: res => {
      // 蓝牙是否可用
      let bluetoothAvalible = res.available
    },
  });

  // 监听设备的连接状态
  plugin.$on({
    eventName: "connectionState",
    eventKey: 'wo',   // 唯一标识，同一标识的监听会被覆盖
    callback: (mac, state) => {
      // 设备mac，连接状态， 参考2.7 的连接状态
    },
  });

  // 监听数据上报
  plugin.$on({
    eventName: "dataReport",
    eventKey: 'wo',  // 唯一标识，同一标识的监听会被覆盖
    callback: (device, data) => {
      // 设备信息， 数据信息
      // 一般mac用来设备设备
      let mac = device.mac;
      // dataType 识别数据类型
      let dataType = data.dataType;
    },
  });

  // 取消监听
  plugin.$off({
    eventname: "adaptorState",
    eventKey: "wo"
  })

  plugin.$off({
    eventname: "connectionState",
    eventKey: "wo"
  })

  plugin.$off({
    eventname: "dataReport",
    eventKey: "wo"
  })

3 设置项

小程序向设备发送指令都是通过pushSetting 包括手环绑定时候输入随机码，蓝牙配网的时候 发送扫描指令， 发送wifi连接指令，以及一些手设备的设置项等等 小程序向设备获取设置项都是通过getSetting 调用示例：

  // 生产设置项的对象
  let settingFactory = plugin.settingFactory;
  let scanWifiSetting = new settingFactory.ScanWifiReq();
  plugin.pushSetting({
    mac: mac,
    setting: scanWifiSetting
  }).then((value) => {
    console.info('发送指令获取wifi列表', value)
  }).catch(resp => {
    wx.showToast({ title: "设置失败，请重试", icon: "none", duration: 3000 });
  });

  // 获取设置项
  plugin.getSetting({
    mac: mac,
    settingType: settingType
  }).then(resp => {
      console.warn('获取设置项成功', resp);
  }).catch(resp => {
      wx.showToast({ title: "获取设置失败，请重试", icon: "none", duration: 1000 });
  });

设置项请求参数：Object object

获取设置项请求参数：

settingType 的取值

catch的 resp 的数据结构

resp.code 的枚举

settingFactory的方法列表

4 数据接收

当你监听了dataReport 事件的时候的回调， 一般通过dataType来判断数据是什么类型 下表为数据类型和实例对照表

5 体脂秤相关数据的发送与接收

5.1 体脂秤设置项

5.1.1 体脂秤心率的开关

控制体脂秤测量心率的开关 A6HeartRateSetting 的参数

5.1.2 体脂秤单位设置

控制体脂秤单位的显示 A6UnitSetting 的参数

5.2 体脂秤蓝牙配网

蓝牙配网一般流程 1. 监听数据的接收 2. 向蓝牙设备发送扫描wifi指令 （扫描wifi这个动作是蓝牙设备完成的，因为手机不能扫描附近的wifi设备） 3. 通过监听的数据得到扫描到的wifi列表 4. 选中某个wifi 并输入密码， 然后向蓝牙设备发送指定wifi的连接指令 调用示例：

  let settingFactory = plugin.settingFactory;

  // 监听设备向小程序同步数据
   plugin.$on("dataReport", "wifiConfig", (device, dataReport) => {
      if (dataReport.dataType === 'apInfo' || dataReport.dataType === 'wifiInfo') {
        // 这里收到的的是wifi数据
        this.addApToUI(dataReport);
      } else if (dataReport.dataType === 'configStatus') {
        // 这里收到的是连接wifi的状态结果
        // 需要注意的是只需要认第一个回调为准，因为有可能返回多个状态
        //配网结果回包 0 success || fail reason code
        wx.hideLoading();
        console.log('ui配网结果:', dataReport, dataReport.status === 0);
        if (dataReport.status === 0) {
          this.showErrorBack('配置Wi-Fi成功');
        } else {
          this.showErrorBack('配置Wi-Fi失败');
        }
      }
    });

  let scanWifiSetting = new settingFactory.ScanWifiReq();
  // 向设备发送搜索wifi指令
  plugin.pushSetting({
    mac: mac,
    setting: scanWifiSetting
  }).then((value) => {
    console.info('发送指令获取wifi列表', value)
  }).catch(_ => {
    wx.showToast({ title: "设置失败，请重试", icon: "none", duration: 3000 });
  });

  // 选中某个wifi 并输入密码，然后向设备发送指令
  let deviceSetting = new settingFactory.ConnectWifiReq({ bssid: this.data.selectAp.bssid, password: this.data.password });
    let options = {
      mac: this.data.mac,
      setting: deviceSetting
    };
    pushSetting(options).then(res => {
      // 这里只能说明发送成功，具体是否成功则需要看dataReport.dataType === 'configStatus'的结果
    }).catch(_ => {
      wx.showToast({ title: "设置失败，请重试", icon: "none", duration: 3000 });
    });

5.2.1 扫描wifi

小程序向体脂秤发起开始扫描指令，体脂秤自动发现附近可用并兼容的Wifi信息，然后回调给小程序。调用参考 4(#4 蓝牙配网) 中的调用示例. 数据类型 ScanWifiReq 没有参数

5.2.2 wifi数据

ApInfo的数据结构

5.2.3 配置wifi

App发送Wifi SSID和密码到设备， 设备自动进行Wifi的连接过程， 并将连接结果回调给APP 数据类型 ConnectWifiReq 参数如下:

5.2.4 WifiInfo的数据结构

这个数据是获取当前的配网信息的信息结果（获取配网信息目前没有暴露接口）

5.2.5 ConfigStatus的数据结构

这个是连接wifi的结果的数据结果

5.3 体制秤数据 ScaleData

6 血压计相关

6.1 血压数据结构BPData

7 手环相关

7.1 通用枚举

7.1.1 SportMode

SportMode 的取值

7.1.2 SportSubMode

SportSubMode 的取值

7.2 手环设置

7.2.1 有个特殊的设置项集合类 获取设置大部分是这个对象，这个对象包含多种设置项，它既是可设置的对象，也是可获取的对象，具体类型具体看对应的指令

MultipleSetting 的数据结构

setting 的数据结构

<<<<<<< HEAD | 属性 | 类型 | 说明 | | :---- | :----: | :-------------------------------------------------------------------- |

| tag | number | 不同的tag代表着不同的类型 |

1.0.13.plugin | value | number | 如果只有一个参数的情况下，value生效，如果不是，则看具体的设置类型 |

实例

// 快捷屏幕设置
let value = {
    tag: 0x04,
    value: 2   
  };
  settingInfo = new settingFactory.MultipleSetting([value])

7.2.2 心率检测

456支持获取 HeartRateWarningSetting的数据结构

sportHrSetting 与 generalHrSetting 的数据结构

实例

let generalHr = {
    max: 80,
    min: 50,
    enable: true,
  };
  let sportHr = {
    max: 120,
    min: 81,
    enable: true
  }
let setting = new settingFactory.HeartRateWarningSetting(sportHr, generalHr);

7.2.3 快捷屏幕 仅456支持

456支持获取 这个使用到了一个设置项的积累类 可以参考 MultipleSetting setting 的数据结构

实例

  let value = {
    tag: 0x04,
    value: 2
  };
  settingInfo = new settingFactory.MultipleSetting([value])

7.2.4 睡眠血氧开关 仅456支持

456支持获取 这个使用到了一个设置项的积累类 可以参考 MultipleSetting setting 的数据结构

实例

  let sleepOximetryInfo = {
    tag: 0x20,
    value: 1,
  }
  settingInfo = new settingFactory.MultipleSetting([sleepOximetryInfo]);

7.2.5 久坐提醒

456可支持获取 SedentaryReminderSetting 的数据结构

实例

/** 构建函数
  constructor(
        enable = true,
        startHour = 8,
        startMinute = 0,
        endHour = 18,
        endMinute = 0,
        frequency = 60,
        repeatTime = RepeatTime.all,
        vibrationType = VibrationType.always,
        vibrationTime = 5,
        vibrationLevel1 = 9,
        vibrationLevel2 = 9
    )
    */

  settingInfo = new settingFactory.SedentaryReminderSetting()

7.2.6 睡眠提醒计划

支持获取，获取的有效值 只有开关与时间 只能支持一次设置一个 NewEventRemindSetting 的数据结构

EventInfo 的数据结构

实例

  let event = {
    index: 1,
    type: 3,
    desc: "",
    enable: true,
    hour: 23,
    minute: 0,
    repeatTime: 0b1111111,
    vibrationType: 0,
    vibrationTime: 5,
    vibrationLevel1: 9,
    vibrationLevel2: 9,
  }
  settingInfo = new settingFactory.NewEventRemindSetting([event]);

7.2.7 事件提醒（闹钟）

支持获取 只能支持一次设置一个 EventReminderSetting 的数据结构

EventInfo 的数据结构

实例

  let event = {
    napEnable: true,
    lightSleepEnable: true,
    index: 1,
    desc: `设置闹钟提醒发发发`,
    enable: true,
    isDelete: false,
    napAlertTime: 15,
    lightSleepAlertTime: 15,
    hour: 19,
    minute: 50,
    repeatTime: 1,
    vibrationType: 2,
    vibrationTime: 3,
    vibrationLevel1: 4,
    vibrationLevel2: 5,
  }

  settingInfo = new settingFactory.EventReminderSetting(Array(event));

7.2.8 时间格式

TimeFormatSetting 的数据格式

实例

  // 0表示24小时制  1表示12小时制
  settingInfo = new settingFactory.TimeFormatSetting(0x01);

7.2.9 表盘推送

456的表盘也不支持切换顺序 index 1、2、3、4表示本地表盘，5表示相册表盘，6与7表示云端表盘 PushDialSetting的数据结构

实例

  /** 构建函数
  constructor(
        dialIndex: number,
        id: string = "",
        dialType: number = 2,
        fileName: string = "",
        backgroundImageName: string = "",
        styleId: number = 0,
        colorId: number = 0,
        fileBuf: ArrayBuffer = new ArrayBuffer(0),
        onUpgradeProcess?: (process: number) => void,
        onUpgradeComplete?: (code: number, msg: string) => void)
        */

  // 相册表盘
  setting = new settingFactory.PushDialSetting(dailIndex, id, 1, "test", "test", 0, 0, buf);

  // 云端表盘
  setting = new settingFactory.PushDialSetting(dailIndex, id, 0, "test", "test", 0, 0, buf);

7.2.10 表盘选择

表盘位置上必须有表盘表盘选择才能成功 DialEnableSetting 的数据结构

实例

  let setting = new settingFactory.DialEnableSetting(dialIndex, [1, 2, 3, 4, 5, 6, 7]);

7.2.11 表盘删除

这个使用到了一个设置项的积累类 可以参考 MultipleSetting setting 的数据结构

DialInfo 的数据结构

实例

  let setting = new settingFactory.MultipleSetting([{ tag: 0x34, list: [{ index: 7, dailType: 0 }] }]);

7.2.12 目标设置

EncourageTargetSetting 的数据结构

实例

  settingInfo = new settingFactory.EncourageTargetSetting(true, 6, 10);

7.2.13 天气设置

WeatherSetting 的数据结构

Weather 的数据结构

实例

let weather = {
    weatherCode: 22,
    minTemperature: 10,
    maxTemperature: 20,
    aqi: 10,
  }
  settingInfo = new settingFactory.WeatherSetting(166666666, [weather]);

7.2.14 新天气设置 456 支持

NewWeatherSetting 的数据结构

Weather 的数据结构

实例

//0x00 晴(白天);
//0x01 晴(夜晚);
//0x02 多云;
//0x03 晴间多云(白天);
//0x04 晴间多云(夜晚);
//0x05 大部多云(白天);
//0x06 大部多云(夜晚);
//0x07 阴;
//0x08 阵雨;
//0x09 雷阵雨;
//0x0A 冰雹或雷阵雨伴有冰雹;
//0x0B 小雨;
//0x0C 中雨;
//0x0D 大雨;
//0x0E 暴雨;
//0x0F 大暴雨;
//0x10 特大暴雨;
//0x11 冻雨;
//0x12 雨夹雪;
//0x13 阵雪;
//0x14 小雪;
//0x15 中雪;
//0x16 大雪;
//0x17 暴雪;
//0x18 浮尘;
//0x19 扬沙;
//0x1A 沙尘暴;
//0x1B 强沙尘暴;
//0x1C 雾;
//0x1D 霾;
//0x1E 风;
//0x1F 大风;
//0x20 飓风;
//0x21 热带风暴;
//0x22 龙卷风;
  let weather = {
    weatherCode: 22,
    minTemperature: 10,
    maxTemperature: 20,
    currentTemperature: 5,
    windSpeed: 10,
    humidity: 11,
    uvIndex: 11,
    aqi: 10,
    sunriseHour: 6,
    sunriseMinute: 0,
    sunsetHour: 18,
    sunsetMinute: 9,
  }
  settingInfo = new settingFactory.NewWeatherSetting(166666666, [weather]);

7.2.14 旧的表盘设置

DialTypeSetting 的数据结构

实例

  settingInfo = new settingFactory.DialTypeSetting(1);

7.2.15 自定义一级屏幕设置

CustomPagesSetting

旧版的屏幕比如 memboHR2 LSBand5s LSBand 的取值

456等屏幕的取值

7.3 手环接收的数据结构

7.3.1 总结数据 DailyData

DailyData的数据结构

Daily 的数据结构

7.3.2 心率数据 HeartRateData

HeartRateData 的数据结构

7.3.3 睡眠原始数据 SleepData

SleepData 的数据结构

7.3.4 睡眠报告 SleepReportData 456支持

SleepReportData 的数据结构

SleepInfo 的数据结构

7.3.5 运动卡路里 SportCaloriesData

SportCaloriesData 的数据结构

7.3.6 运动记录 SportReportData

SportReportData 的数据结构

TimeState 的数据结构

7.3.7 血氧数据与晨脉 BloodOxygenData 456支持

BloodOxygenData 的数据结构

BloodOxygenInfo 的数据结构

7.3.8 运动状态 SportStatusData（发起运动）

SportStatusData 的数据结构

7.3.9 闹钟开关 AlarmClockSwitchData 456支持

AlarmClockSwitchData 的数据结构

7.3.10 表盘变更数据 DailReportData 456支持

DailReportData 的数据结构

7.3.11 表盘详情数据 DialDetailData 456 支持

DialDetailData 的数据结构

8 跳绳相关

8.1 跳绳设置

8.2 跳绳