Browse Source

Update documentation

master
陈福行 5 years ago
parent
commit
cb8df88565
2 changed files with 24 additions and 0 deletions
  1. 11
    0
      README.md
  2. 13
    0
      README_CN.md

+ 11
- 0
README.md View File

@@ -436,6 +436,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- BM15Data (BM15 data)

|Type | Parameter |Description
|---|---|---
|String |version|Bluetooth version
@@ -451,6 +452,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- BodyFatData

|Type | Parameter |Description
|---|---|---
|String |date|measurement date
@@ -474,6 +476,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- BroadData (broadcast data)

|Type | Parameter |Description
|---|---|---
|String| name|device name
@@ -485,6 +488,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- DecimalInfo (decimal point information)

|Type | Parameter |Description
|---|---|---
|int |sourceDecimal|source data decimal places
@@ -496,6 +500,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- User (User Information)

|Type | Parameter |Description
|---|---|---
|int| id|
@@ -508,6 +513,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- WeightData (weight data)

|Type | Parameter |Description
|---|---|---
|int |cmdType|command type (1, change; 2, stable; 3, in impedance measurement)
@@ -522,6 +528,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- cn.net.aicare.algorithmutil.BodyFatData(Calculated body fat data)

|Type | Parameter |Description
|---|---|---
|double| bmi| Body mass index
@@ -539,6 +546,7 @@ Get an instance of WBYService.WBYBinder in BleProfileServiceReadyActivity.onServ


- MoreFatData

|Type | Parameter |Description
|---|---|---
|double| standardWeight| Standard weight
@@ -558,6 +566,7 @@ public static enum FatLevel {
}
```
- BleProfileService Connection Status

```
public static final int STATE_CONNECTING = 4; // connecting
public static final int STATE_DISCONNECTED = 0; // disconnect
@@ -567,6 +576,7 @@ public static final int STATE_INDICATION_SUCCESS = 3; // Enable success
public static final int STATE_TIME_OUT = 5; // connection timed out
```
- AicareBleConfig.SettingStatus Status information returned by the device

```
int NORMAL = 0; // Normal
int LOW_POWER = 1; // Low power
@@ -597,6 +607,7 @@ int DATA_SEND_END = 25; // Measured data transmission is complete
int UNKNOWN = -1; // unknown
```
- WBYService Bluetooth information returned by the device

```
public final static int BLE_VERSION = 0; // Bluetooth version
public final static int MCU_DATE = 1; // mcu date

+ 13
- 0
README_CN.md View File

@@ -405,6 +405,7 @@ double bfr, double rom, double pp)
## 类说明

- aicare.net.cn.iweightlibrary.entity.AlgorithmInfo(算法序列信息)

|类型| 参数名| 说明
|---|---|---
|double | weight |体重
@@ -415,6 +416,7 @@ double bfr, double rom, double pp)


- BM09Data(BM09数据)

|类型| 参数名| 说明
|---|---|---
|int | agreementType |协议类型
@@ -433,6 +435,7 @@ double bfr, double rom, double pp)


- BM15Data(BM15数据)

|类型| 参数名| 说明
|---|---|---
|String | version |蓝牙版本
@@ -448,6 +451,7 @@ double bfr, double rom, double pp)


- BodyFatData(体脂数据)

|类型| 参数名| 说明
|---|---|---
|String |date |测量日期
@@ -472,6 +476,7 @@ double bfr, double rom, double pp)


- BroadData(广播数据)

|类型| 参数名| 说明
|---|---|---
|String |name |设备名
@@ -483,6 +488,7 @@ double bfr, double rom, double pp)


- DecimalInfo(小数点位数信息)

|类型| 参数名| 说明
|---|---|---
|int| sourceDecimal |源数据小数点位数
@@ -494,6 +500,7 @@ double bfr, double rom, double pp)


- User(用户信息)

|类型| 参数名| 说明
|---|---|---
|int|id |编号
@@ -505,6 +512,7 @@ double bfr, double rom, double pp)


- WeightData(体重数据)

|类型| 参数名| 说明
|---|---|---
|int| cmdType| 命令类型(1、变化;2、稳定;3、阻抗测量中)
@@ -518,6 +526,7 @@ double bfr, double rom, double pp)


- cn.net.aicare.algorithmutil.BodyFatData(计算得到的体脂数据)

|类型| 参数名| 说明
|---|---|---
|double| bmi|身体质量指数
@@ -534,6 +543,7 @@ double bfr, double rom, double pp)


- MoreFatData

|类型| 参数名| 说明
|---|---|---
|double| standardWeight| 标准体重
@@ -556,6 +566,7 @@ public static enum FatLevel {


- BleProfileService 连接状态

```
public static final int STATE_CONNECTING = 4; //连接中
public static final int STATE_DISCONNECTED = 0; //断开连接
@@ -565,6 +576,7 @@ public static final int STATE_INDICATION_SUCCESS = 3;//使能成功
public static final int STATE_TIME_OUT = 5;//连接超时
```
- AicareBleConfig.SettingStatus 设备返回的状态信息

```
int NORMAL = 0;//正常
int LOW_POWER = 1;//低功耗
@@ -595,6 +607,7 @@ int DATA_SEND_END = 25;//测量数据发送完成
int UNKNOWN = -1;//未知
```
- WBYService 设备返回的蓝牙信息

```
public final static int BLE_VERSION = 0; //蓝牙版本
public final static int MCU_DATE = 1; //mcu日期

Loading…
Cancel
Save