系统功能接口
MCU在与云端通信之前,需要先对模组做一些初始化相关的工作,并且要等待模组进入正常联网状态,之后,才能进入正常使用云端功能。
模组初始化
模组在初始化完成前,定时向MCU发送初始化请求,MCU收到初始化请求报文后,需要发送携带PRODUCT_ID、PRODUCT_KEY、MCU_VER信息的回应报文。
◆ 接收初始化命令
Voidiot_init_cb(uint8_t*ModuleMac,
uint8_t*ModuleVersion)
说明:
该函数在收到模组的初始化命令后,由SDK调用。发送返回信息的代码已经添加。
参数 | 长度 | 说明 |
---|---|---|
ModuleMac | 6 | 模组的MAC地址 |
ModuleVersion | 5 | 模组的固件版本,xx.xx格式 |
时间同步
当MCU需要与云端同步时间时,可以主动发起时间同步请求。
◆ 发送时间请求
voidiot_get_onlinetime(void)
说明:
该函数用于向云端发送时间请求。
◆ 接收时间信息
voidiot_get_onlinetime_cb(uint32_ttimestamp)
说明:
该函数在收到云端返回的时间信息后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
timestamp | 4 | 网络时间戳 |
模组状态报告
voidiot_status_cb(uint8_tdev_status,
uint32_ttimestamp)
说明:
该函数在收到模组的状态报告后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
dev_status | 1 | 模组当前状态 |
timestamp | 4 | 状态报告对应的时间戳 |
重置模组
voidiot_reset_module(uint8_tResetMode)
说明:
该函数用于向模组发送重置命令。
参数 | 长度 | 说明 |
---|---|---|
ResetMode | 1 | 设置配网模式:0x01:smartconfig模式,0x02:AP模式(暂不支持) |
产测模式
◆ 发送产测命令
voidiot_factory_test_mode(void)
说明:该函数用于向模组发送产测命令。
◆ 接收产测结果
voidiot_factory_test_cb(uint8_tTestResult,
uint8_tSignalIntensity)
说明:
该函数在收到模组返回的产测结果后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
TestResult | 1 | 测试结果:0x00:成功0x01:未找到产测路由0x02:模组扫描故障 |
SignalIntensity | 1 | 信号强度,0~100,0最差,100最强 |
发送数据回调
◆ 接收数据回调
voidiot_data_cb(uint32_tdata_seq)
说明:该函数在收到模组返回的数据发送结果后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
data_seq | 4 | 发送数据的序列号 |
用户绑定
◆ 发送绑定命令
voidiot_start_bind_user(uint32_tTimeout)
说明:用于设置设备允许被绑定。
参数 | 长度 | 说明 |
---|---|---|
Timeout | 4 | 允许绑定的超时时间 |
◆ 接收绑定结果
voidiot_bind_cb(uint8_tresult)
说明:该函数在收到模组返回的绑定结果后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
result | 1 | 绑定结果: 0x00:设置允许绑定命令的回复 0x01:绑定成功 0x02:绑定失败(超时或设备未联网) |
用户解绑
◆ 发送解绑命令
voidiot_unbind_user(uint32_tTimeout)
说明:该函数用于发送解绑命令。
参数 | 长度 | 说明 |
---|---|---|
Timeout | 4 | 解绑超时时间 |
◆ 接收解绑结果
voidiot_unbind_cb()
说明:该函数在收到模组返回的解绑成功结果后,由SDK调用。
用户分享信息改变
◆ 用户分享信息改变回调
voidiot_share_chg_cb(uint8_tresult)
说明:该函数在收到模组发送的分享用户变化结果后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
result | 1 | 分享用户变化情况:0x00:分享用户增加0x01:分享用户减少 |
获取用户信息
◆ 发送获取用户信息命令
int32_tiot_get_info(INFO_TYPE_TInfoType)
说明:该函数用于发送获取用户信息指令。
参数 | 长度 | 说明 |
---|---|---|
InfoType | 4 | 获取用户信息类型: 0x00:主用户信息 0x01:分享用户信息 0x02:设备信息 |
◆ 接收用户信息回调
voidiot_info_cb(INFO_TYPE_Tinfo_type,void*info)
说明:该函数在收到模组返回用户信息数据后,由SDK调用。
参数 | 长度 | 说明 |
---|---|---|
info_type | 4 | 返回用户信息类型: 0x00:主用户信息 0x01:分享用户信息 0x02:设备信息 |
info | 用户信息结构 |