iOS SDK API 文档
版本 | 修改内容 | 修订人 |
---|---|---|
1.0.0 | 初步接入蓝牙秤和围度尺等设备 | Symons |
1.0.1 | 优化设备连接和体脂算法 | Symons |
1.0.2 | 优化广播秤逻辑、体脂算法增加骨骼肌率 | Symons |
1.0.3 | 增加新的设备支持,增加日志功能,修改部分模型类属性 | Symons |
1.0.4 | 增加平衡秤支持,优化日志功能 | Symons |
1.0.5 | 增加新的围度尺支持,修复bug | Symons |
1.0.6 | 优化设备连接,支持8电极设备,支持历史数据上报 | Symons |
1.0.7 | 修复iOS下mac地址解析错误,增加身高尺支持 | Symons |
1.0.8 | 支持广播秤切换单位,支持跳绳设备,兼容天猫精灵设备 | Symons |
1.0.9 | 增加广播心率秤支持,修复跳绳卡路里负数,优化跳绳数据解析,增加跳绳ota | Symons |
1.1.0 | 支持watchos,支持部分身高尺和秤ota,支持BLE+WIFI设备,支持新的8电极算法 | Symons |
1.2.0 | 支持基站跳绳 | Symons |
1.3.0 | 支持彩屏秤,优化OTA速度 | Symons |
通用接口类
ICDeviceManager(SDK主入口)
shared
获取单例对象,SDK接口以单例形式存在
delegate
负责监听SDK初始化结果、蓝牙状态、设备连接状态以及数据上传等回调
initMgr
初始化SDK(默认配置),将通过onInitFinish回调初始化结果. 注:所有接口仅在sdk初始化后才能调用,App运行期间,只需要初始化一次,无需重复初始化
initMgrWithConfig:
使用配置类来初始化SDK,将通过onInitFinish回调初始化结果. 注:所有接口仅在sdk初始化后才能调用,App运行期间,只需要初始化一次,无需重复初始化
参数名 | 类型 | 备注 |
---|---|---|
config | ICDeviceManagerConfig | 配置选项,假如不知道怎么选择,请使用默认的 |
updateUserInfo:
更新用户信息
参数名 | 类型 | 备注 |
---|---|---|
userInfo | ICUserInfo | 用户信息 |
setUserList:
更新用户信息列表
参数名 | 类型 | 备注 |
---|---|---|
userlist | NSArray< ICUserInfo* > | 用户信息 |
scanDevice:
扫描周围的设备,如无需扫描,则调用stopScan停止扫描,否则将不会自动停止。 注:蓝牙关闭的情况下,扫描接口不生效,如果处于在扫描中关闭蓝牙接口,扫描将自动停止,无需再调用stopScan,即使蓝牙开启,也不会自动扫描。
参数名 | 类型 | 备注 |
---|---|---|
delegate | id< ICScanDeviceDelegate > | 扫描结果回调 |
stopScan
停止扫描
addDevice:callback:
添加设备
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICAddDeviceCallBack | 操作回调, 仅是告诉开发者添加设备到SDK是否成功,而非连接状态,连接状态通过onDeviceConnectionChanged回调,添加成功后,SDK会自行管理设备的连接。 |
addDevices:callback:
添加设备列表(注:有多少个device就会回调多少次)
参数名 | 类型 | 备注 |
---|---|---|
devices | NSArray< ICDevice * > | 设备列表 |
callback | ICAddDeviceCallBack | 操作回调, 操作回调,仅是告诉开发者添加设备到SDK是否成功,而非连接状态,连接状态通过onDeviceConnectionChanged回调,添加成功后,SDK会自行管理设备的连接。 |
removeDevice:callback:
删除设备
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICRemoveDeviceCallBack | 操作回调, 设备删除后,设备如果已连接上,将会断开,不会再有连接状态回调 |
removeDevices:callback:
删除设备列表
参数名 | 类型 | 备注 |
---|---|---|
devices | NSArray< ICDevice * > | 设备列表 |
callback | ICRemoveDeviceCallBack | 操作回调, 设备删除后,设备如果已连接上,将会断开,不会再有连接状态回调 |
upgradeDevice:filePath:mode
升级设备,升级状态通过onReceiveUpgradePercent回调。注:并非所有设备都有OTA功能。如果升级过程中设备断开,SDK将会自动重连并重新开始升级流程,如升级过程中蓝牙关闭,SDK将会停止升级流程,蓝牙开启后也不会继续升级,与调用stopUpgradeDevice接口效果相同。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
filePath | NSString | 升级文件路径 |
mode | ICOTAMode | 升级模式 |
stopUpgradeDevice
停止升级设备
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
upgradeDevices:filePath:mode
升级设备,升级状态通过onReceiveUpgradePercent回调。注:并非所有设备都有OTA功能。如果升级过程中设备断开,SDK将会自动重连并重新开始升级流程,如升级过程中蓝牙关闭,SDK将会停止升级流程,蓝牙开启后也不会继续升级,与调用stopUpgradeDevice接口效果相同。
参数名 | 类型 | 备注 |
---|---|---|
devices | NSArray< ICDevice * > | 设备 |
filePath | NSString | 升级文件路径 |
mode | ICOTAMode | 升级模式 |
getSettingManager
获取设备设置接口
getBodyFatAlgorithmsManager
获取体脂算法接口
isBLEEnable
蓝牙是否已经开启, 注:请在初始化回调成功后再调用,否则将返回NO
version
SDK版本
getLogPath
SDK日志文件夹路径,仅保留最近7天的日志
ICDeviceManagerSettingManager(设备设置接口)
负责设备的所有设置, 注:仅连接式的设备支持设置。
通用设置接口
setUserInfo:userInfo:callback:
给单个设备设置单独的用户信息, 主要作用在于同一个app同时连接多个设备,各设备需要使用不同的用户信息,如仅是单设备,无需调用该接口,使用updateUserInfo接口就好了。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userInfo | ICUserInfo | 用户信息 |
callback | ICSettingCallback | 设置回调 |
setUserList:userInfos:callback:
给单个设备设置单独的用户信息列表, 主要作用在于同一个app同时连接多个设备,设备需要使用不同的用户信息列表,如仅是单设备,无需调用该接口,使用setUserList接口就好了。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userInfos | NSArray< ICUserInfo* > | 用户信息列表 |
callback | ICSettingCallback | 设置回调 |
readUserInfo:callback:
读取昵称和头像,仅部分设备支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
体重秤/体脂秤相关接口
setScaleUnit:unit:callback:
设置人体秤单位
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
unit | ICWeightUnit | 单位 |
callback | ICSettingCallback | 设置回调 |
configWifi:mode:ssid:password:callback:
设备配网,配网状态通过onReceiveConfigWifiResult回调, 注:仅BLE+WIFI双模设备支持.
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
mode | ICConfigWifiMode | Wifi配网模式 |
ssid | NSString | WIFI SSID |
password | NSString | WIFI Password,如无密码则传空字符串 |
callback | ICSettingCallback | 设置回调 |
setScaleUIItems:items:callback:
设置设备显示的项, 注:仅部分秤支持.
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
items | NSArray< NSNumber * > | 显示的项 |
callback | ICSettingCallback | 设置回调 |
setOtherParams:type:param:callback:
设置厂商特定参数, 注:仅部分秤支持.
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
type | NSUInteger | 根据客户意思不一样 |
param | NSObject | 根据客户意思不一样 |
callback | ICSettingCallback | 设置回调 |
setDeviceKey:key:callback:
设置秤的解密密钥, 注:仅部分秤支持.
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
key | NSString | 密钥 |
callback | ICSettingCallback | 设置回调 |
sendData:type:userId:obj:callback:
发送数据到秤, 注:仅部分秤支持.
注: 同一个设备,同一时间仅能调用一次,必须等上一个发送完成才能调用下一个
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
type | ICSendDataType | 数据类型 |
userId | NSUInteger | 用户id |
obj | NSObject | 数据 |
callback | ICSettingCallback | 设置回调 |
cancelSendData:callback:
取消发送数据, 注:仅部分秤支持.
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
setCommand:cmd:param:callback:
下发工程设置指令, 注:仅部分秤支持.
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
cmd | NSUInteger | 指令号 |
param | NSObject | 参数 |
callback | ICSettingCallback | 设置回调 |
updateUserInfo_W:userInfo:callback:
W秤:更新或添加用户信息
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userInfo | ICUserInfo | 用户信息 |
callback | ICSettingCallback | 设置回调 |
setCurrentUserInfo_W:userInfo:callback:
W秤:设置当前用户信息
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userInfo | ICUserInfo | 用户信息 |
callback | ICSettingCallback | 设置回调 |
deleteUser_W:userId:callback:
W秤:删除用户
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userId | NSInteger | 用户ID |
callback | ICSettingCallback | 设置回调 |
getUserList_W:callback:
W秤:获取用户列表,用户列表将从onReceiveUserInfoList
回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
startScanWifi_W:callback:
W秤:发起扫描WiFi列表, WiFi列表将从onReceiveScanWifiInfo_W
回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
stopScanWifi_W:callback:
W秤:停止扫描WiFi列表
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
configWifi_W:ssid:password:method:callback:
W秤:配置WiFi,配网状态将从onReceiveCurrentWifiInfo_W
回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
ssid | NSString | WiFi SSID |
password | NSString | WiFi 密码 |
method | NSInteger | WiFi 加密方法 (onReceiveScanWifiInfo_W 返回的method ) |
callback | ICSettingCallback | 设置回调 |
setHello_W:enable:callback:
W秤:设置开机时的欢迎页
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
enable | BOOL | 是否显示 |
callback | ICSettingCallback | 设置回调 |
setPowerMode_W:isNormal:callback:
W秤:设置电源模式
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
isNormal | BOOL | 是否为普通模式 |
callback | ICSettingCallback | 设置回调 |
setScreen_W:items:callback:
W秤:设置屏幕显示项 注: 0:体重 1:体脂率 2:肌肉量 3:BMI 4:水分率 5:肌肉率 6:去脂体重 7:骨量 8:蛋白率 9:内脏脂肪 10:BMR 11:身体年龄
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
items | NSArray< NSNumber * > | 显示项 |
callback | ICSettingCallback | 设置回调 |
wakeupScreen_W:callback:
W秤:唤醒屏幕
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
setScreenTime_W:time:callback:
W秤:设置屏幕显示时间
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
time | NSInteger | 时间(秒) |
callback | ICSettingCallback | 设置回调 |
bindDevice_W:callback:
W秤:设置绑定,将会更新绑定标识,扫描时ICScanDeviceInfo.bindStatus
和调用queryBindStatus_W
能看到设备已绑定
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
queryBindStatus_W:callback:
W秤:查询绑定状态,onReceiveBindState_W
回调绑定状态
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
reset_W:callback:
W秤:重置秤
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
deleteAllUser_W:callback:
W秤:删除所有用户数据
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
startUpgrade_W:currentVersion:newVersion:callback:
W秤:开始升级
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
currentVersion | NSString | 当前版本 |
newVersion | NSString | 新版本 |
callback | ICSettingCallback | 设置回调 |
围尺/身高尺相关接口
setRulerUnit:unit:callback:
设置围尺/身高尺单位
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
unit | ICRulerUnit | 单位 |
callback | ICSettingCallback | 设置回调 |
setRulerBodyPartsType:type:callback:
设置当前围尺身体部位, 注:非所有围尺都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
type | ICRulerBodyPartsType | 身体部位 |
callback | ICSettingCallback | 设置回调 |
setRulerMeasureMode:mode:callback:
设置围尺测量模式, 注:非所有围尺都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
mode | ICRulerMeasureMode | 测量模式 |
callback | ICSettingCallback | 设置回调 |
厨房秤相关接口
setWeight:weight:callback:
设置重量到厨房秤,单位:毫克, 注:非所有厨房秤都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
weight | NSInteger | 重量,单位:毫克,最大不能超过65535毫克 |
callback | ICSettingCallback | 设置回调 |
deleteTareWeight:callback:
厨房秤去皮功能, 注:非所有厨房秤都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
setKitchenScaleUnit:unit:callback:
设置厨房秤单位
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
unit | ICKitchenScaleUnit | 单位, 注:如果秤不支持该单位,将不会生效 |
callback | ICSettingCallback | 设置回调 |
setNutritionFacts:type:value:callback:
设置营养成分值到厨房秤, 注:非所有厨房秤都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
type | ICKitchenScaleNutritionFactType | 营养类型 |
value | NSInteger | 营养值 |
callback | ICSettingCallback | 设置回调 |
powerOffKitchenScale:callback:
设置厨房秤关机, 注:非所有厨房秤都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
跳绳相关接口
startSkipMode:mode:param:callback:
开始跳绳, 注:调用接口后,如果跳绳没有转动,则跳绳不会真的开始
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
mode | ICSkipMode | 测量模式 |
param | NSInteger | 模式参数,如果是计时跳,就填时间秒数(范围:1-5999),如果是计次跳,就填总的次数(范围:1-9999),自由跳则默认0 |
callback | ICSettingCallback | 设置回调 |
startSkipExt:param:callback:
开始跳绳, 注:调用接口后,如果跳绳没有转动,则跳绳不会真的开始
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
param | ICSkipParam | 模式参数 |
callback | ICSettingCallback | 设置回调 |
stopSkip:callback:
停止跳绳
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
callback | ICSettingCallback | 设置回调 |
setSkipLightSetting:lightEffects:mode:callback:
设置跳绳设备灯效, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
lightEffects | NSArray< ICSkipLightSettingData* > | 灯效列表 |
mode | ICSkipLightMode | 灯效模式 |
callback | ICSettingCallback | 设置回调 |
setSkipSoundSetting:config:callback:
设置跳绳设备音效, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
config | ICSkipSoundSettingData | 音效设置 |
callback | ICSettingCallback | 设置回调 |
setBPM:type:bpm:callback:
设置跳绳BPM, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
type | ICBPMType | 节拍类型 |
bpm | int | 节拍设置 |
callback | ICSettingCallback | 设置回调 |
setVolume:volume:callback:
设置音量大小, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
volume | int | 声音大小: 0-100 |
callback | ICSettingCallback | 设置回调 |
setSkipPlayFreq:freq:callback:
设置跳绳播报频率, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
freq | int | 每跳多少个就播报一次,固定50、100、150、200 |
callback | ICSettingCallback | 设置回调 |
setHRMax:hr:callback:
设置跳绳心率上限, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
hr | int | 心率上限 |
callback | ICSettingCallback | 设置回调 |
setHR:hr:callback:
设置HR, 注:仅部分跳绳设备支持。
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
hr | int | 当前心率 |
callback | ICSettingCallback | 设置回调 |
lockStSkip:callback:
基站专用:
下发准备
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
callback | ICSettingCallback | 设置回调 |
queryStAllNode:callback:
基站专用:
查询在线状态
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
callback | ICSettingCallback | 设置回调 |
changeStName:name:callback:
基站专用:
更改节点设备广播名
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
name | NSString | 广播名,长度限制在6个英文字符 |
callback | ICSettingCallback | 设置回调 |
changeStNo:dstId:stno:callback:
基站专用:
更改设备的节点号码和基站编码。基站替换和跳绳的添加、替换都通过该节点实现
节点号码: 每个入网的设备都有个ID,如1~60。如果要更改一个设备的节点ID,则目标节点ID改为最新的ID,原节点ID是当前节点ID.
基站号码: 每个基站都有个号码,这个号码是基站要连接哪些跳绳的标识。如果跳绳的所属基站号码与当前基站不一致,基站将不会去连接。
参数名 | 类型 | 备注 |
---|---|---|
device | NSString | 设备mac地址 |
dstId | int | 目标节点ID |
st_no | int | 所属基站号码(最大0x000000~0xFFFFFF) |
callback | ICSettingCallback | 设置回调 |
setNickNameInfo:nodeId:nickName:headType:sclass:grade:studentNo:callback:
基站专用:
改变指定节点的昵称
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
nodeId | NSUInteger | 节点ID |
nickName | NSString | 昵称 |
headType | NSUInteger | 头像序号 |
sclass | NSUInteger | 班级 |
grade | NSUInteger | 年级 |
studentNo | NSUInteger | 学生编号 |
callback | ICSettingCallback | 设置回调 |
exitNetwork:callback:
基站专用:
解散基站网络
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
callback | ICSettingCallback | 设置回调 |
removeNodeIds:nodeIds:callback:
基站专用:
移除指定节点
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
nodeIds | NSArray< NSNumber* > | 节点ID列表 |
callback | ICSettingCallback | 设置回调 |
setRootNodeId:matchMode:callback:
基站专用:
设置根节点
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
matchMode | NSUInteger | 基站运行模式 |
callback | ICSettingCallback | 设置回调 |
setClientNodeId:callback:
基站专用:
设置从节点
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
callback | ICSettingCallback | 设置回调 |
bindHRDevice:nodeId:hrDeviceMac:callback:
基站专用:
绑定HR设备
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 基站设备 |
nodeId | NSUInteger | 需要绑定心率设备的节点ID |
hrDeviceMac | NSString | 心率设备 |
callback | ICSettingCallback | 设置回调 |
ICBodyFatAlgorithmsManager(体脂算法接口)
体脂数据重新计算, 注:少部分设备不支持重算.原有的单个重算接口已移除
reCalcBodyFatWithWeightData:userInfo:
重新计算用户体脂数据, 注:算法类型使用weightData内的属性
参数名 | 类型 | 备注 |
---|---|---|
weightData | ICWeightData | 体重数据,必填:weight_kg,bfa_type, electrode以及阻抗数据属性 |
userInfo | ICUserInfo | 用户信息 |
ICDeviceManagerDelegate(SDK状态及数据回调)
通用回调
onInitFinish:
SDK初始化完成回调, 注:所有接口仅在sdk初始化后才能调用
参数名 | 类型 | 备注 |
---|---|---|
bSuccess | BOOL | 初始化是否成功 |
onBleState:
蓝牙改变状态回调
参数名 | 类型 | 备注 |
---|---|---|
state | ICBleState | 蓝牙状态 |
onDeviceConnectionChanged:state:
设备连接状态回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
state | ICDeviceConnectState | 连接状态 |
onReceiveUpgradePercent:status:percent:
设备升级状态回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
status | ICUpgradeStatus | 升级状态 |
percent | int | 升级进度,范围:0-100 |
onReceiveBattery:battery:ext:
电量回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
battery | int | 电量,范围:0-100 |
ext | NSObject | 扩展字段,如是基站跳绳,则该字段的值表示节点ID,类型:NSNumber |
onReceiveDeviceInfo:deviceInfo:
设备信息回调, 注:非所有设备都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
deviceInfo | ICDeviceInfo | 设备信息 |
onReceiveRSSI:rssi:
设备信号强度回调, 注:非所有设备都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
rssi | int | 信号强度 |
onReceiveUserInfo:userInfo:
收到设备上报的用户信息,暂时支持竞技款跳绳, 注:非所有设备都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userInfo | ICUserInfo | 用户信息 |
onReceiveUserInfoList:userInfos:
收到设备上报的用户信息列表,用户信息并不完整,只包含一部分, 注:非所有设备都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
userInfos | NSArray< ICUserInfo* > | 用户信息列表 |
onReceiveHR:hr:
第三方心率设备数据上传, 注:非所有设备都支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
hr | int | 心率值 |
体重秤/体脂秤回调
onReceiveWeightData:data:
体重秤数据回调, 注:部分设备不通过这个接口回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICWeightData | 测量数据 |
onReceiveWeightCenterData:data:
平衡数据回调, 注:仅部分设备支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICWeightCenterData | 平衡数据 |
onReceiveCoordData:data:
坐标数据回调, 注:仅部分设备支持
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICCoordData | 测量坐标数据 |
onReceiveMeasureStepData:step:data:
体重秤数据回调, 注:部分设备不通过这个接口回调,分步骤体重、平衡、阻抗、心率数据回调(8电极秤以及VA秤使用该接口回调)
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
step | ICMeasureStep | 当前处于的步骤 |
data | NSObject | 数据, 注:不同步骤,data的对象不一样,可看step的类型定义 |
onReceiveWeightHistoryData:data:
体重秤历史数据回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICWeightHistoryData | 体重历史数据 |
onReceiveWeightUnitChanged:unit:
设备单位改变回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
unit | ICWeightUnit | 设备当前单位 |
onReceiveConfigWifiResult:state:
配网结果回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
state | ICConfigWifiState | 配网状态 |
onReceiveScanWifiInfo_W:ssid:method:rssi:
W秤:收到扫描的WiFi列表
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
ssid | NSString | WiFi SSID |
method | NSInteger | WiFi 加密方式 |
rssi | NSInteger | 信号 |
onReceiveCurrentWifiInfo_W:status:ip:ssid:rssi:
W秤:收到当前连接WiFi信息
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
status | NSInteger | 状态(0:未配网, 1:未连接WiFi, 2:已连接WiFi未连接服务器, 3:已连接服务器, 4:WiFi模块未上电) |
ip | NSString | IP |
ssid | NSString | WiFi SSID |
rssi | NSInteger | 信号 |
onReceiveBindState_W:status:
W秤:收到绑定状态
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
status | NSInteger | 绑定状态(1:已绑定, 0:未绑定) |
厨房秤回调
onReceiveKitchenScaleData:data:
厨房秤数据回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICWeightData | 测量数据 |
onReceiveKitchenScaleUnitChanged:unit:
厨房秤单位改变
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
unit | ICKitchenScaleUnit | 设备当前单位 |
围尺/身高尺回调
onReceiveRulerData:data:
围尺/身高尺数据回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICRulerData | 测量数据 |
onReceiveRulerUnitChanged:unit:
围尺/身高尺单位改变
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
unit | ICRulerUnit | 设备当前单位 |
onReceiveRulerMeasureModeChanged:mode:
围尺测量模式改变回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
mode | ICRulerMeasureMode | 设备当前测量模式 |
跳绳回调
onReceiveSkipData:data:
跳绳数据回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICSkipData | 跳绳数据 |
onReceiveHistorySkipData:data:
跳绳历史数据回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
data | ICSkipData | 跳绳历史数据 |
onNodeConnectionChanged:nodeId:state:
基站专用:
节点设备连接状态回调
参数名 | 类型 | 备注 |
---|---|---|
device | ICDevice | 设备 |
nodeId | int | 节点ID |
state | ICDeviceConnectState | 连接状态 |
ICScanDeviceDelegate(扫描结果回调接口)
扫描结果回调代理
onScanResult:
扫描结果回调
参数名 | 类型 | 备注 |
---|---|---|
deviceInfo | ICScanDeviceInfo | 扫描到的设备信息 |
Model定义
Model定义
ICDeviceManagerConfig(配置类)
SDK配置类,用于配置SDK
isShowPowerAlert
蓝牙未打开时,打开app是否弹出的蓝牙未打开对话框(默认:YES)
ICDevice(设备类)
设备类
macAddr
设备mac地址
ICScanDeviceInfo(扫描设备信息类)
扫描到的设备信息
name
广播名
type
设备类型
communicationType
设备通讯方式
macAddr
mac地址
services
服务ID列表
rssi
信号强度(越小越大,0:系统配对设备,-128:信号值有误)
st_no
基站号码, 注:基站专用
nodeId
节点ID, 注:基站专用
bindStatus
绑定状态(0:未绑定,1:已绑定,2:不支持查询)
ICUserInfo(用户信息类)
用户信息
人体秤设备大多只需height、age、sex、weightUnit赋值,厨房秤设备大多只需kitchenUnit赋值,围尺设备大多只需rulerUnit、rulerMode赋值
userIndex
用户编号,默认:1
userId
用户ID,默认:0
nickName
用户呢称,默认:"iCOMON"
nickNameCS
用户呢称校验码,默认0
headTypeSequence
用户头像序列
headType
用户头像索引
lang;
语言,默认:1
nodeId
节点ID,竞技款跳绳/基站跳绳
sclass
年级,竞技款跳绳/基站跳绳
grade
班级,竞技款跳绳/基站跳绳
studentNo
学号,竞技款跳绳/基站跳绳
height
身高(cm),默认:172cm
weight
体重(kg),默认:60.0kg
age
年龄,默认:24
ICSexType sex
性别,默认:ICSexTypeMale
startWeight
起始体重(kg),默认:50.0kg
argetWeight
目标体重(kg),默认:50.0kg
weightDirection
体重方向,默认:0 减重,1:增重
bfaType
使用体脂算法版本,默认:ICBFATypeWLA01
客户在使用时,大多数不需要关心这个,使用默认值就好了
lockBfaType
锁定使用体脂算法版本,设置以后,设备上传上来的算法版本将不生效,默认:ICBFATypeWLA01
peopleType
用户类型,默认:ICPeopleTypeNormal
大多算法是没有运动员模式的,只有极少部分算法有,所以更改了该参数如果体脂率没有变化,说明该算法不支持运动员模式。
weightUnit
用户默认的体重单位,默认:ICWeightUnitKg
rulerUnit
用户默认的围尺/身高尺单位,默认:ICRulerUnitCM
rulerMode
用户默认的围尺测量模式,默认:ICRulerMeasureModeLength
kitchenUnit
厨房秤默认单位,默认:ICKitchenScaleUnitG
bmiStanard
BMI标准,默认:ICBMIStandardWHO
enableMeasureImpendence
是否启用测量阻抗,默认:YES,仅支持的设备有效
enableMeasureHr
是否启用测量HR,默认:YES,仅支持的设备有效
enableMeasureBalance
是否启用测量平衡,默认:YES,仅支持的设备有效
enableMeasureGravity
是否启用测量重心,默认:YES,仅支持的设备有效
enableSmallThing
是否启用小物模式,默认:YES,仅支持的设备有效
enableGirth
是否启用体围数据计算,对于37算法,默认是不支持的
maxRNI
每日最大摄入卡路里, 仅部分营养秤支持
currentRNI
当前摄入卡路里, 仅部分营养秤支持
currentRNIProgress
当前的摄入进度, 仅部分营养秤支持
ICDeviceInfo(设备信息)
设备信息, 非所有设备都有,广播设备没有,连接设备仅新款有
mac
设备mac地址
model
设备型号
sn
设备SN
firmwareVer
固件版本号
hardwareVer
硬件版本号
softwareVer
软件版本号, 目前这个没有使用,请使用firmwareVer
manufactureName
厂商信息
ICWeightData(体重数据类)
体重数据
userId
用户ID,默认:0
isStabilized
数据是否稳定, 注: 数据不稳定,则只有体重数据有效,不稳定的数据只做展示用,请勿保存,如果是通过onReceiveMeasureStepData回调的数据,则通过接口中的step参数来判断是否结束测量
weight_g
体重(g)
weight_kg
体重(kg)
weight_lb
体重(lb)
weight_st
体重(st:lb),注:这个字段跟weight_st_lb一起使用
weight_st_lb
体重(st:lb),注:这个字段跟weight_st一起使用
precision_kg
kg体重小数点位数,如:weight_kg=70.12,则precision=2,weight_kg=71.5,则precision_kg=1
precision_lb
lb体重小数点位数,如:weight_lb=70.12,则precision=2,weight_lb=71.5,则precision_lb=1
precision_st_lb
st:lb体重小数点位数
kg_scale_division
kg分度值
lb_scale_division
lb分度值
temperature
温度,单位:摄氏度
time
测量时间戳(秒)
isSupportHR
支持心率测量
hr
心率值
bmi
身体质量指数BMI(精度:0.1)
bodyFatPercent
体脂率(百分比, 精度:0.1)
subcutaneousFatPercent
皮下脂肪率(百分比, 精度:0.1)
visceralFat
内脏脂肪指数(精度:0.1), 实际该值是取整的,但是部分客户使用带小数点的来表示,这里为了兼容也采用小数点的形式,开发者根据自己需要来决定是否取整
musclePercent
肌肉率(百分比, 精度:0.1)
bmr
基础代谢率(单位:kcal)
boneMass
骨重(单位:kg,精度:0.1)
moisturePercent
水含率(百分比,精度:0.1)
physicalAge
身体年龄
proteinPercent
蛋白率(百分比,精度:0.1)
smPercent
骨骼肌率(百分比,精度:0.1)
bodyScore
身体评分
whr
腰臀比
bodyType
身体类型
targetWeight
目标体重
weightControl
体重控制
bfmControl
脂肪量控制
ffmControl
去脂体重控制
weightStandard
标准体重
bfmStandard
标准脂肪量
bmiStandard
标准BMI
smmStandard
标准骨骼肌量
ffmStandard
标准去脂体重
bmrStandard
标准BMR
bfpStandard
标准体脂率
bmiMax
bmi标准的最大值
bmiMin
bmi标准的最小值
bfmMax
脂肪量标准的最大值
bfmMin
脂肪量标准的最小值
bfpMax
脂肪率标准的最大值
bfpMin
脂肪率标准的最小值
weightMax
体重标准的最大值
weightMin
体重标准的最小值
smmMax
骨骼肌量标准的最大值
smmMin
骨骼肌量标准的最小值
boneMax
骨量标准的最大值
boneMin
骨量标准的最小值
waterMassMax
含水量标准的最大值
waterMassMin
含水量标准的最小值
proteinMassMax
蛋白量标准的最大值
proteinMassMin
蛋白量标准的最小值
muscleMassMax
肌肉量标准的最大值
muscleMassMin
肌肉量标准的最小值
bmrMax
bmr标准的最大值
bmrMin
bmr标准的最小值
smi
骨骼肌质量指数
obesityDegree
肥胖程度
electrode
电极数,4电极或者8电极
imp
双脚阻抗(4电极)/全身阻抗(8电极) (单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗, 对于4电极单频设备,只需要取imp(绝大部分设备都属于这类)
imp2
双脚阻抗(4电极,高频)/左手阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗, 对于4电极双频设备,只需要取imp和imp2
imp3
右手阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗
imp4
左腳阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗
imp5
右腳阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗
extData
体重扩展数据(8电极的部分数据在这里面)
data_calc_type
数据计算方式(0:sdk,1:设备计算)
bfa_type
本次体脂数据计算的算法类型
state
阻抗状态
impendenceType
阻抗类型
impendenceProperty
阻抗属性
impendences
阻抗列表,基本是8电极双频使用
waist
腰围(单位:cm, 精度:0.1)
chest
胸围(单位:cm, 精度:0.1)
hip
臀围(单位:cm, 精度:0.1)
arm
臂围(单位:cm, 精度:0.1)
thigh
腿围(单位:cm, 精度:0.1)
neck
颈围(单位:cm, 精度:0.1)
ICWeightExtData(体重数据扩展类)
体重扩展数据,主要是8电极的部分数据
left_arm
左手体脂与标准左手体脂的比值 (单位:%, 精度:0.1)
right_arm
右手体脂与标准右手体脂的比值(单位:%, 精度:0.1)
left_leg
左脚体脂与标准左脚体脂的比值(单位:%, 精度:0.1)
right_leg
右脚体脂与标准右手体脂的比值(单位:%, 精度:0.1)
all_body
躯干体脂与标准躯干体脂的比值(单位:%, 精度:0.1)
left_arm_kg
左手脂肪量(单位:kg, 精度:0.1)
right_arm_kg
右手脂肪量(单位:kg, 精度:0.1)
left_leg_kg
左脚脂肪量(单位:kg, 精度:0.1)
right_leg_kg
右脚脂肪量(单位:kg, 精度:0.1)
all_body_kg
躯干脂肪量(单位:kg, 精度:0.1)
left_arm_muscle
左手肌肉量与标准左手肌肉量的比值(单位:%, 精度:0.1)
right_arm_muscle
右手肌肉量与标准右手肌肉量的比值(单位:%, 精度:0.1)
left_leg_muscle
左脚肌肉量与标准左脚肌肉量的比值(单位:%, 精度:0.1)
right_leg_muscle
右脚肌肉量与标准右手肌肉量的比值(单位:%, 精度:0.1)
all_body_muscle
躯干肌肉量与标准躯干肌肉量的比值(单位:%, 精度:0.1)
left_arm_muscle_kg
左手肌肉量(单位:kg, 精度:0.1)
right_arm_muscle_kg
右手肌肉量(单位:kg, 精度:0.1)
left_leg_muscle_kg
左脚肌肉量(单位:kg, 精度:0.1)
right_leg_muscle_kg
右脚肌肉量(单位:kg, 精度:0.1)
all_body_muscle_kg
躯干肌肉量(单位:kg, 精度:0.1)
ICWeightHistoryData(体重历史数据类)
体重历史数据
userId
用户ID,默认:0
weight_g
体重(g)
weight_kg
体重(kg)
weight_lb
体重(lb)
weight_st
体重(st:lb),注:这个字段跟weight_st_lb一起使用
weight_st_lb
体重(st:lb),注:这个字段跟weight_st一起使用
precision_kg
kg体重小数点位数,如:weight_kg=70.12,则precision=2,weight_kg=71.5,则precision_kg=1
precision_lb
lb体重小数点位数,如:weight_lb=70.12,则precision=2,weight_lb=71.5,则precision_lb=1
precision_st_lb
st:lb体重小数点位数
kg_scale_division
kg分度值
lb_scale_division
lb分度值
time
测量时间戳(秒)
hr
心率值
electrode
电极数,4电极或者8电极
imp
双脚阻抗(4电极)/全身阻抗(8电极) (单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗, 对于4电极单频设备,只需要取imp(绝大部分设备都属于这类)
imp2
双脚阻抗(4电极,高频)/左手阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗, 对于4电极双频设备,只需要取imp和imp2。
imp3
右手阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗
imp4
左腳阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗
imp5
右腳阻抗(8电极)(单位:欧姆ohm),如阻抗等于0,则代表测量不到阻抗
centerData
平衡数据,部分设备有
data_calc_type
数据计算方式(0:sdk,1:设备计算)
bfa_type
本次数据的算法类型
impendences
阻抗列表,基本是8电极双频使用
impendenceType
阻抗类型
impendenceProperty
阻抗属性
ICWeightCenterData(平衡数据类)
体重平衡数据
isStabilized
数据是否稳定,不稳定的数据只做展示用,请勿保存
time
测量时间戳(秒)
precision_kg
kg体重小数点位数,如:weight=70.12,则precision=2,weight=71.5,则precision_kg=1
precision_lb
lb体重小数点位数,如:weight=70.12,则precision=2,weight=71.5,则precision_lb=1
precision_st_lb
st:lb体重小数点位数
kg_scale_division
kg分度值
lb_scale_division
lb分度值
left_weight_g
左边体重(g)
right_weight_g
右边体重(g)
leftPercent
左边体重占比(%)
rightPercent
右边体重占比(%)
left_weight_kg
左边体重(kg)
right_weight_kg
右边体重(kg)
left_weight_lb
左边体重(lb)
right_weight_lb
右边体重(lb)
left_weight_st
左边体重(st:lb)
right_weight_st
右边体重(st:lb)
left_weight_st_lb
左边体重(st:lb)
right_weight_st_lb
右边体重(st:lb)
ICScaleSoundSettingData(秤语音设置类)
秤语音设置类
soundLanguageCode
秤的语言类型 根据设备返回的支持列表来选择。
soundVolume
秤的音量大小 0:静音, 1~30:小, 31~70:中, 71~100:大
soundBroadcastOn
秤的语音播报开关
soundEffectsOn
秤的音效开关
listSoundSupportLanguage
秤支持的语言列表
ICRulerData(围尺/身高尺数据)
围尺、身高尺数据
isStabilized
数据是否稳定,不稳定的数据只做展示用,请勿保存
distance_in
距离inch
distance_cm
距离cm
distance_ft
距离ft'in中的ft整数部分
distance_ft_in
距离ft'in中的in小数部分
distance
测量长度(0.1mm)
time
测量时间戳(秒)
partsType
身体部位类型,部分围尺设备有
precision_in
inch距离小数点位数,如:distance_in=70.12,则precision_in=2,distance_in=71.5,则precision_in=1
precision_cm
cm距离小数点位数,如:distance_cm=70.12,则precision_cm=2,distance_cm=71.5,则precision_cm=1
unit
本次测量的单位
mode
本次的测量模式
ICSkipFreqData(跳绳绊绳数据)
跳绳频次数据
duration
持续时间(单位:秒)
skip_count
次数
ICSkipData(跳绳数据)
跳绳数据
isStabilized
数据是否稳定数, 不稳定的数据只做展示用,请勿保存
time
测量时间,单位:秒
mode
跳绳模式
setting
设置的参数
elapsed_time
跳绳使用的时间
actual_time
跳绳实际使用的时间, 不是所有跳绳设备都支持
skip_count
总跳绳的次数
avg_freq
平均频次
cur_speed
当前速度,非所有设备都有,目前仅S2有
fastest_freq
最快频次
calories_burned
热量消耗,单位:kcal
fat_burn_efficiency
燃脂效率,单位:kcal/hour
most_jump
最多连跳
hr
心率
freqs
绊绳数据, 注:跟freq_count的数量可能不一致,这是正常的情况,因为受限于硬件Flash容量大小以及传输的速率,freqs无法做到所有绊绳数据都保存。
freq_count
绊绳总次数, 注:跟freqs的数量可能不一致,这是正常的情况,因为受限于硬件Flash容量大小以及传输的速率,freqs无法做到所有绊绳数据都保存。
status
跳绳状态,非所有设备都有,目前仅S2有
setting_group
组数,非所有设备都有,目前仅S2有
setting_rest_time
设置休息时间,非所有设备都有,目前仅S2有
interrupts
间歇跳数据,非所有设备都有,目前仅S2有
nodeId
节点ID, 基站专用
battery
节点电量, 基站专用
nodeInfo
节点信息, 基站专用
nodeMac
节点Mac, 基站专用
ICSkipParam(跳绳模式参数)
跳绳模式参数
mode
模式
param
跳绳参数/ 间歇跳,单轮时长/单轮次数(S2)
rest_time
间歇跳,单轮休息时长
group
间歇跳,组数
matchMode
竞技款的比赛模式,0: 5人竞技,1: 团队竞技
ICSkipInterruptData(间歇跳数据)
间歇跳数据
index
序号
rest_time
休息时间
time
时长
skip_count
跳绳个数
calories_burned
热量消耗
avg_freq
平均速度
freq_count
绊绳次数
ICSkipLightSettingData(灯效设置类)
灯效设置类
r
红色,范围:0~255
g
绿色,范围:0~255
b
蓝色,范围:0~255
modeValue
模式值(设置的模式不同,该值表示的意思不同),范围:0~255
ICSkipSoundSettingData(音效设置类)
音效设置类
soundOn
是否开启语音开关
soundType
语音类型
soundVolume
声音大小
fullScoreOn
满分开关
fullScoreBPM
满分速率
soundMode
语音间隔模式
modeParam
模式参数
isAutoStop
是否自动停止播放,YES:APP下发开始后,跳绳不会播放语音 ,NO:跳绳和APP都会播放语音
ICKitchenScaleData(厨房秤数据类)
厨房秤数据
isStabilized
数据是否稳定数, 不稳定的数据只做展示用,请勿保存
value_mg
数据值,单位:mg
value_g
数据值,单位:G
value_ml
数据值,单位:ml
value_ml_milk
数据值,单位:ml milk
value_oz
数据值,单位:oz
value_lb
数据值,单位:lb:oz中的lb
value_lb_oz
数据值,单位:lb:oz中的oz
value_fl_oz
数据值,单位:fl.oz
value_fl_oz_uk
数据值,单位:fl.oz, 英制
value_fl_oz_milk
数据值,单位:fl.oz, 美制
value_fl_oz_milk_uk
数据值,单位:fl.oz, 英制
time
测量时间戳(秒)
unit
本次数据单位
precision
小数点位数, 如:value_g=70.12,则precision=2,value_g=71.5,则precision=1
precision_g
g小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_ml
ml 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_lboz
lb:oz中的oz 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_oz
oz 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_ml_milk
ml milk 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_floz_us
fl.oz 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_floz_uk
fl.oz, 英制 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_floz_milk_us
fl.oz, milk 美制 小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
precision_floz_milk_uk
fl.oz, milk 英制小数点位数, 如:value_lb=70.12,则precision=2,value_lb=71.5,则precision=1
unitType
设备数据单位类型,0:公制,1:美制,2:英制
isNegative
数字是否负数
isTare
是否去皮模式
枚举定义
枚举定义
ICBleState
蓝牙状态
定义 | 备注 |
---|---|
ICBleStateUnknown | 未知状态 |
ICBleStateUnsupported | 手机不支持BLE |
ICBleStateUnauthorized | 未获取到蓝牙授权 |
ICBleStatePoweredOff | 蓝牙关闭 |
ICBleStatePoweredOn | 蓝牙打开 |
ICDeviceConnectState
设备连接状态
Definition | Remarks |
---|---|
ICDeviceConnectStateConnected | 已连接 |
ICDeviceConnectStateDisconnected | 已断开 |
ICDeviceCommunicationType
设备通讯方式
定义 | 备注 |
---|---|
ICDeviceCommunicationTypeUnknown | 未知 |
ICDeviceCommunicationTypeConnect | 连接式 |
ICDeviceCommunicationTypeBroadcast | 广播式 |
ICAddDeviceCallBackCode
添加设备回调代码
定义 | 备注 |
---|---|
ICAddDeviceCallBackCodeSuccess | 添加成功,不代表连接成功 |
ICAddDeviceCallBackCodeFailedAndSDKNotInit | 添加失败,SDK未初始化 |
ICAddDeviceCallBackCodeFailedAndExist | 添加失败,设备已存在,无需重复添加 |
ICAddDeviceCallBackCodeFailedAndDeviceParamError | 添加失败,设备参数有错 |
ICRemoveDeviceCallBackCode
删除设备回调代码
定义 | 备注 |
---|---|
ICRemoveDeviceCallBackCodeSuccess | 删除成功 |
ICRemoveDeviceCallBackCodeFailedAndSDKNotInit | 删除失败,SDK未初始化 |
ICRemoveDeviceCallBackCodeFailedAndNotExist | 删除失败,设备不存在 |
ICRemoveDeviceCallBackCodeFailedAndDeviceParamError | 删除失败,设备参数有错 |
ICDeviceType
设备类型
定义 | 备注 |
---|---|
ICDeviceTypeUnKnown | 未知 |
ICDeviceTypeWeightScale | 体重秤 |
ICDeviceTypeFatScale | 脂肪秤 |
ICDeviceTypeFatScaleWithTemperature | 脂肪秤(带温度显示) |
ICDeviceTypeKitchenScale | 厨房秤 |
ICDeviceTypeRuler | 尺(围尺/身高尺) |
ICDeviceTypeBalance | 平衡秤 |
ICDeviceTypeSkip | 跳绳 |
ICDeviceTypeHR | 心率设备 |
ICDeviceSubType
设备子类型
定义 | 备注 |
---|---|
ICDeviceSubTypeDefault | 未知 |
ICDeviceSubTypeEightElectrode | 8电极设备 |
ICDeviceSubTypeHeight | 身高设备 |
ICDeviceSubTypeEightElectrode2 | 8电极设备2 |
ICDeviceSubTypeScaleDual | 双模设备 |
ICDeviceSubTypeLightEffect | 跳绳带灯效 |
ICDeviceSubTypeColor | 彩屏秤 |
ICDeviceSubTypeSound | 跳绳带语音 |
ICDeviceSubTypeLightAndSound | 跳绳带灯效和语音 |
ICDeviceSubTypeBaseSt | 基站 |
ICDeviceSubTypeRopeS2 | iCOMON S2 |
ICDeviceSubTypeNewScale | 新秤 |
ICSettingCallBackCode
设置回调代码
定义 | 备注 |
---|---|
ICSettingCallBackCodeSuccess | 设置成功 |
ICSettingCallBackCodeSDKNotInit | 设置失败,SDK没有初始化 |
ICSettingCallBackCodeSDKNotStart | 设置失败,SDK没有启动 |
ICSettingCallBackCodeDeviceNotFound | 设置失败,找不到设备或者设备未连接,请等待设备连接上后再设置 |
ICSettingCallBackCodeFunctionIsNotSupport | 设置失败,设备不支持该功能 |
ICSettingCallBackCodeDeviceDisConnected | 设置失败,设备已断开 |
ICSettingCallBackCodeInvalidParameter | 设置失败,无效参数 |
ICSettingCallBackCodeWaitLastTaskOver | 设置失败,请等待上一个任务结束 |
ICSettingCallBackCodeFailed | 设置失败 |
ICDeviceFunction
设备功能支持
定义 | 备注 |
---|---|
ICDeviceFunctionWiFi | WIFI功能 |
ICDeviceFunctionVoiceAssistant | 语音助手 |
ICDeviceFunctionSoundEffect | 音效 |
ICDeviceFunctionVolume | 音量 |
ICDeviceFunctionVoiceLanguage | 语音语言 |
ICDeviceFunctionSupportUploadBodyfat | 设备上报体脂率(内部使用,外部不要使用) |
ICDeviceFunctionRev | 预留 |
ICUpgradeStatus
OTA升级状态
定义 | 备注 |
---|---|
ICUpgradeStatusSuccess | 升级成功 |
ICUpgradeStatusUpgrading | 升级中 |
ICUpgradeStatusFail | 升级失败 |
ICUpgradeStatusFailFileInvalid | 升级失败,文件无效 |
ICUpgradeStatusFailNotSupport | 升级失败,设备不支持升级 |
ICOTAMode
OTA升级模式
定义 | 备注 |
---|---|
ICOTAModeAuto | 自动模式 |
ICOTAMode1 | 模式1 |
ICOTAMode2 | 模式2 |
ICOTAMode3 | 模式3 |
ICConfigWifiMode
Wifi配网模式
定义 | 备注 |
---|---|
ICConfigWifiModeDefault | 发送ssid和密码 |
ICConfigWifiModeEnter | 通知秤,app进入配网模式,延长亮屏时间 |
ICConfigWifiModeExit | 通知秤,app退出配网模式 |
ICConfigWifiState
Wifi配网状态
定义 | 备注 |
---|---|
ICConfigWifiStateSuccess | 配网成功 |
ICConfigWifiStateWifiConnecting | WIFI连接中 |
ICConfigWifiStateServerConnecting | 服务器连接中 |
ICConfigWifiStateWifiConnectFail | 配网失败,WIFI连接失败 |
ICConfigWifiStateServerConnectFail | 配网失败,服务器连接失败 |
ICConfigWifiStatePasswordFail | 配网失败,密码错误 |
ICConfigWifiStateFail | 配网失败 |
ICWeightUnit
体重秤单位
定义 | 备注 |
---|---|
ICWeightUnitKg | 公斤 |
ICWeightUnitLb | 磅 |
ICWeightUnitSt | 英石 |
ICWeightUnitJin | 斤 |
ICRulerUnit
围尺/身高尺单位
定义 | 备注 |
---|---|
ICRulerUnitCM | 厘米 |
ICRulerUnitInch | 英寸 |
ICRulerUnitFtInch | 英尺'英寸 |
ICKitchenScaleUnit
厨房秤单位
定义 | 备注 |
---|---|
ICKitchenScaleUnitG | 克 |
ICKitchenScaleUnitMl | 毫升 |
ICKitchenScaleUnitLb | 磅 |
ICKitchenScaleUnitOz | 盎司 |
ICKitchenScaleUnitMg | 毫克 |
ICKitchenScaleUnitMlMilk | 毫升(牛奶) |
ICKitchenScaleUnitFlOzWater | 液体盎司(水) |
ICKitchenScaleUnitFlOzMilk | 液体盎司(牛奶) |
ICSexType
性别
定义 | 备注 |
---|---|
ICSexTypeUnknown | 未知/保密 |
ICSexTypeMale | 男 |
ICSexTypeFemal | 女 |
ICPeopleType
用户类型
定义 | 备注 |
---|---|
ICPeopleTypeNormal | 普通人 |
ICPeopleTypeSportman | 运动员 |
ICBMIStandard
bmi标准
定义 | 备注 |
---|---|
ICBMIStandardWHO | WHO |
ICBMIStandardASIA | 亚洲 |
ICBMIStandardCN | 中国 |
ICMeasureStep
数据类型
定义 | 备注 |
---|---|
ICMeasureStepMeasureWeightData | 测量体重(ICWeightData) |
ICMeasureStepMeasureCenterData | 测量平衡(ICWeightCenterData) |
ICMeasureStepAdcStart | 开始测量阻抗 |
ICMeasureStepAdcResult | 测量阻抗结束(ICWeightData) |
ICMeasureStepHrStart | 开始测量心率 |
ICMeasureStepHrResult | 测量心率结束(ICWeightData) |
ICMeasureStepMeasureOver | 测量结束 |
ICKitchenScaleNutritionFactType
厨房秤营养成分类型
定义 | 备注 |
---|---|
ICKitchenScaleNutritionFactTypeCalorie | 卡路里,最大不超过4294967295 |
ICKitchenScaleNutritionFactTypeTotalCalorie | 总卡路里,最大不超过4294967295 |
ICKitchenScaleNutritionFactTypeTotalFat | 总脂肪 |
ICKitchenScaleNutritionFactTypeTotalProtein | 总蛋白质 |
ICKitchenScaleNutritionFactTypeTotalCarbohydrates | 总碳水化合物 |
ICKitchenScaleNutritionFactTypeTotalFiber | 总脂肪纤维 |
ICKitchenScaleNutritionFactTypeTotalCholesterd | 总胆固醇 |
ICKitchenScaleNutritionFactTypeTotalSodium | 总钠含量 |
ICKitchenScaleNutritionFactTypeTotalSugar | 总糖含量 |
ICKitchenScaleNutritionFactTypeFat | 脂肪 |
ICKitchenScaleNutritionFactTypeProtein | 蛋白质 |
ICKitchenScaleNutritionFactTypeCarbohydrates | 碳水化合物 |
ICKitchenScaleNutritionFactTypeFiber | 膳食纤维 |
ICKitchenScaleNutritionFactTypeCholesterd | 胆固醇 |
ICKitchenScaleNutritionFactTypeSodium | 钠含量 |
ICKitchenScaleNutritionFactTypeSugar | 糖含量 |
ICRulerMeasureMode
围尺测量模式
定义 | 备注 |
---|---|
ICRulerMeasureModeLength | 长度模式 |
ICRulerMeasureModeGirth | 围度模式 |
ICRulerBodyPartsType
围尺设置的部位类型
定义 | 备注 |
---|---|
ICRulerPartsTypeShoulder | 肩膀 |
ICRulerPartsTypeBicep | 手臂 |
ICRulerPartsTypeChest | 胸 |
ICRulerPartsTypeWaist | 腰 |
ICRulerPartsTypeHip | 臀 |
ICRulerPartsTypeThigh | 大腿 |
ICRulerPartsTypeCalf | 小腿 |
ICSkipMode
跳绳模式
定义 | 备注 |
---|---|
ICSkipModeFreedom | 自由跳 |
ICSkipModeTiming | 计时跳 |
ICSkipModeCount | 计次跳 |
ICSkipModeInterruptTime | 计时间歇跳 |
ICSkipModeInterruptCount | 计次间歇跳 |
ICSkipStatus
跳绳状态
定义 | 备注 |
---|---|
ICSkipStatusJumping | 跳绳中 |
ICSkipStatusJumpOver | 跳绳结束 |
ICSkipStatusRest | 跳绳休息中 |
ICSkipLightMode
跳绳灯效模式,一般是支持ICSkipLightModeRPM,其它模式可能不支持
定义 | 备注 |
---|---|
ICSkipLightModeNone | 无 |
ICSkipLightModeRPM | 速度模式 |
ICSkipLightModeTimer | 计时模式 |
ICSkipLightModeCount | 计次模式 |
ICSkipLightModePercent | 百分比模式 |
ICSkipLightModeTripRope | 绊绳次数模式 |
ICSkipLightModeMeasuring | 测量模式模式 |
ICBPMType
bpm类型
定义 | 备注 |
---|---|
ICBPMTypeDefault | 默认 |
ICSkipSoundType
语音类型
定义 | 备注 |
---|---|
ICSkipSoundTypeNone | 无 |
ICSkipSoundTypeFemale | 标准女声 |
ICSkipSoundTypeMale | 标准男声 |
ICSkipSoundMode
语音模式
定义 | 备注 |
---|---|
ICSkipSoundModeNone | 无 |
ICSkipSoundModeTime | 按间隔时长 |
ICSkipSoundModeCount | 按间隔个数 |
ICSendDataType
发送的文件类型
定义 | 备注 |
---|---|
ICSendDataTypeHeadImg | 头像,传入NSData |
ICSendDataTypeNickName | 昵称,传入ICUserInfo |
ICSendDataTypePowerOnImg | 开机动画,传入NSData |
ICSendDataTypePowerOffImg | 关机动画,传入NSData |
ICSDKMode
SDK模式
定义 | 备注 |
---|---|
ICSDKModeDefault | 默认模式 |
ICSDKModeCompetitive | 竞技模式 |
ICBFAType
算法类型,没有列出所有的,正常情况下不需要关心这里的含义
定义 | 备注 |
---|---|
ICBFATypeWLA01 | WLA01算法 |
bodyType(体型表)
体型
定义 | 备注 |
---|---|
0 | 消廋型 |
1 | 偏瘦型 |
2 | 肌肉苗条型 |
3 | 苗条型 |
4 | 肌肉型 |
5 | 匀称型 |
6 | 运动员 |
7 | 略显肥胖型 |
8 | 肥胖型 |
9 | 偏胖型 |
10 | 隐形肥胖型 |