文档中心>物联网开发平台

接入指南

最近更新时间:2021-03-12 14:39:32

我的收藏

App SDK 模块说明

iOS

子模块
实现相关功能
QCDeviceCenter
配网模块
QCAPISets
设备控制、消息相关、家庭管理、账户管理等 API
QCFoundation
工具类

Android

子模块
实现相关功能
link
配网模块
auth
设备控制、消息相关、家庭管理、账户管理等 API
utils
工具类
log
日志模块

SDK 接入详情

接入前 API 参数对照表

基础参数对照表:

参数名称
参数说明
phoneNumber
手机号
countryCode
国际区号,如中国大陆区号为86
email
邮箱地址
familyId
家庭 ID
familyName
家庭名称
familyAddress
家庭地址
Role
1是所有者, 0是普通成员
roomId
房间 ID
roomName
房间名
ProductId
设备产品 ID
Avatar
用户信息中头像链接
signature
使用绑定设备 API 时传入,设备签名
DeviceId
设备 ID

设备控制面板列表参数对照表:

参数名称
参数说明
ID
设备可控属性
name
设备可控属性名,如”电源开关”、“颜色”
big
设备可控属性,面板按钮是否是大按钮
type
设备可控属性,面板按钮类型,如:btn-big、btn-col-1
value
属性值
familyAddress
家庭地址
LastUpdate
最后一次更新时间戳

SDK 使用举例

#iOS举例:设备配网接入
#1.创建配网对象QCSmartConfig或者QCSoftAP(视配网方式决定),注:SDK 内不持有配网对象,需使用者自己持有
self.sc = [[QCSmartConfig alloc] initWithSSID:name PWD:password BSSID:bssid];
self.sc.delegate = self;

#2.遵循TIoTCoreAddDeviceDelegate协议,设置代理,并接入代理方法:
- (void)onResult:(QCResult *)result{
if (result.code == 0) {// 配网成功
}
else {// 配网失败
}
}

#3.开始配网流程
[self.sc startAddDevice];

更多功能

账户系统、家庭相关操作、设备控制等详细操作,请参考 SDK Demo 工程 iOS 版本 LinkSDKDemoAndroid 版本 sdkdemo

详细接口对照表

物联网应用开发文档
对应文档地址
应用端 API
用户管理
配网管理
设备管理
设备分享
家庭管理
设备定时
消息管理
长连接通信
数据结构
若接入过程中有其他问题,请参考 基于 SDK 常见问题