360智连模块SDK_V1.0.0.0

360智连模组SDK

1、 SDK 架构说明

1.1 架构简述

图1： sdk 架构

如上图1：

A 、红色部分 360 Cloud SDK 实现了设备发现、激活绑定，与云端命令交互等，此部分不开放接口。

B 、蓝色部分 MW API ，这部分封装了相关API 函数，包括KLV 格式装换，相应APP 命令等功能，此部分开放API ，不开放源码。

C 、绿色部分 MCU Interface ，这部分目前有接入开发人员完全实现，主要是基于UART 的与MCU 命令交互协议的实现。

1、Device Found 模块需要配合手机配合来完成，并提供完成的手机APP SDK ；

2、Debug Msg ，用户可以通过侦听UDP 9999端口来获取打印信息。

另：目前MT7681 的所有API 均开放可用。

新增库文件libqihoo_iot.a ，用户只需要调用iot_qihoo.h 中的接口即可。

1.2 SPI Flash Layout 说明

flash_map.h 中是整个工程的flash layout define ，用户可以使用如下图2所示的reserved 的区域，其他区域禁止使用，否则将导致模组工作异常。

UDP

360 Cloud SDK MiddleWare API

MCU Interface

360 Cloud

1、Device Found

2、Debug Msg

TCP

MT7681 SDK API

libqihoo_iot.a

图2：flash layout

1.3开发环境搭建

详情请看Doc文件夹中《MT7681_IoT_FAQ_20140709.pdf》中的第一章 SOURCE CODE COMPILE 内容。

1.4编译调试

编译STA FW1 命令为： make clean;make b=1

编译STA FW2 命令为： make clean;make b=2

生成的目标文件都为： out\sta\MT7681_sta_header.bin，内部的头部内容第8个字节的内容有所差别，06代表 FW2，而04代表FW1。

编译成功后，生成MT7681_sta_header.bin1和MT7681_sta_header.bin2，需要用chksum.exe 添加校验工具对两个文件加入校验信息。

通过校验信息加入后，两个文件也成了版本更新发布的最终版本。

注：

编译时，out\sta\MT7681_sta.map 文件中的 _MEMORY_TOP 不能超过0x0000FD00；

否则固件将变得不再稳定。

1.5烧写升级方式

1、SecureCRT X-modern 128升级方式，

具体方法详见《MT7681_Uart_Firwmare_Upgrade_v0.06_20140517.pdf》

2、用AT命令进行升级，详见下文的AT命令

2、SDK功能点说明

Public：用户可以使用的功能

wifi状态查询接口

接收手机APP命令

设备Push手机APP命令功能

保存设备历史数据功能

控制wifi节能等级功能

同步服务器时间功能

局域网调试log打印功能

串口命令，支持：AT命令，0xAA起头命令

Private：内部固化功能

模组产测接口

Smartconfig功能

被手机APP发现设备功能

云端交互功能

设备升级功能

3、API接口

3.1初始化

void init_wifi_module(void) //开发者实现

描述：此函在IoT_Cust_Init中调用，可以根据demo自行配置初始化内容；参数：无

返回值：无

3.2设置固件版本号

void init_fw_version(int version)

参数：version （>=1000）

返回值：无

描述：

●设置固件版本号，版本号从1000整数，往上递增。

●在init_wifi_module中调用，具体使用请参考demo程序

3.3获取WIFI连接状态

int get_wifi_status(void)

参数：void

返回值：返回服务器连接状态

1 - wifi处于信道侦听状态

2 -wifi收到ssid和password，正在进行连接AP中

3 - 连接路由器失败

4 - 连接路由器成功，且（正在连接云服务，进行注册登录）

5 - 连接路由器成功，且（连接云服务注册失败）

6 - 连接路由器成功，且（连接云服务登录失败）

7 - 连接路由器成功，且（登陆成功）

8 - 脱网工作，未连路由器且未侦听

3.4数据上传

3.4.1 打包上传数据接口

u16_t cloud_package_update(char *dst, u16_t dst_max, char *time_buf, char *data_buf, u16_t data_len)

参数：

time：为8个字节的高字节序，如果为NULL，则为云端填充当前时间

data_buf：数据

data_len：长度

返回：=0 失败，>0则为打包后长度

3.4.2 上传数据接口

int cloud_service_updata(

unsigned int msg_id,

unsigned int type,

int key,

unsigned char level,

const char* senddata,

int datalen,

int timeout，

void (*callback)(unsigned int msg_id,unsigned char is_succcess) )

参数：

参数名称描述值

msg_id 用于调用者区分每次调用的id，将在回调函数中返回

type 数据格式，用于服务端解析数据

key 存储关键字，用于不同类型数据的区分

level 暂无意义

senddata 发送数据缓冲区

datalen 数据长度有效值：1~450

timeout 超时时间0：默认时间10s >0: 超时时间s

callback 执行结果的回调函数

is_succcess 回调函数参数，代表数据上传结果0：成功

非0：失败

返回值：

0：成功

非0：失败

3.5接收下发命令接口

3.5.1 初始化命令下发函数

void init_command_handle(

int ( *p_iot_command_handle)( unsigned int seq,

const char* command_data,

int command_len)

)

参数：p_iot_command_handle 函数指针

返回：无

描述：

●初始化iot_command_handle钩子函数

●在init_wifi_module中调用，具体使用请参考demo程序

3.5.2 命令下发函数实现

int iot_command_handle( //开发者实现

unsigned int seq,

const char* command_data,

int command_len

)

描述：SDK接收到下发命令，执行命令后调用3.6的响应接口传回执行结果，SDK将结果发送至服务端。

参数：

参数名称描述值

seq 消息标

识

由回调函数返回，用于调用者区分多条命令，对函数实现者无

意义

command_len 数据长度

command_data 数据命令定义见注 1

返回值：

0：成功

非0：失败

注：

iot_command_handle中command_data的layout格式为：

CmdId[2B]+CmdLen[2B]+Data[],CmdId和CmdLen都为短整形，且为大端字节序；

其中CmdId 0~255为本SDK内部命令（请勿使用），开放区域为256~65535.

3.6响应下发命令

void respond_command (unsigned int seq,const char* data,int data_len)

SDK接收到下发命令，执行命令后调用此接口传回执行结果，SDK将结果发送至服务端。参数：

参数名称描述值

seq 消息标识用于接收命令的seq对应

data 数据与iot_command_handle对应

data_len 数据长度

返回值：无

3.7命令透传接口

int iot_command_direct_handle(

unsigned int seq,

const char* command_data,

int command_len

}

参数和使用方法与iot_command_handle一致，主要用于前期用户做调试用。

3.8查询服务器时间

int cloud_date_query(

int timeout ,

void (*callback)( int errcode, unsigned long long millisecond) )

参数：

参数名称描述值

timeout 超时时间0：默认时间10s >0: 超时时间s

callback 执行结果的回调函数

errcode 执行结果0：成功

非0：失败

millisecond 查询到的时间从1970年1月1日到当前的毫秒数返回值：

0：成功

3.9低功耗控制API

int power_save_level(UINT8 level, UINT32 sleeptime)

描述：用户设置低功耗级别。每个级别关闭的模块有所不一致，唤醒时间也有所差别，详见下表中说明。

参数：

Level：功耗级别，范围1~5，各级别说明。

Sleeptime：在这种模式下休眠的时间（单位us）

返回值：

0：成功

非0：失败

3.10局域网打印log功能

int debug_info_broadcast (PUCHAR buf, u16_t len)

描述：局域网广播log，目标端口9999。

参数：

buf：数据

len：打印长度，目前支持不超过64Bytes

返回值：

非0：失败

3.11升级MCU相关OTA操作

3.11.1 操作函数类型定义

typedef struct _IOT_OTA_OP_ {

/* ota related callback functions */

void (*p_get_mcu_version)(u32_t seq);

void (*p_set_new_mcu_version)(int new_mcu_vsn);

void (*p_iot_mcu_ota_handle) (u8_t *data_buf, u16_t len);

}IOT_OTA_OP_T, *P_ IOT_OTA_OP_T;

3.11.2 初始化操作函数

void init_mcu_ota_ops(P_IOT_OTA_OP_T p_ota_ops) //中间层实现

参数：P_IOT_OTA_OP_T

返回：无

描述：若无MCU升级需求不需要调用此初始化函数；若有MCU升级需要才要做初始化，开发者主要定义IOT_OTA_OP_T类型接口体，并初始化成员后，把其地址传入初始化函数init_mcu_ota_ops。

3.11.3 中间层请求mcu版本

void get_mcu_version(u32_t seq) //开发者实现

参数：seq，中间层给出个序列号

返回：无

描述：中间层请求mcu 版本号

3.11.4 返回给中间层MCU版本号

void set_mcu_version ( u32_t seq, int mcu_version) //中间层实现

参数：

seq：与get_mcu_version传过来的seq需要保持一致

mcu_version：开发者传入当前的mcu version

返回：无

描述：响应中间层mcu版本号，通常需要在收到get_mcu_version后才进行回复。

3.11.5 中间层发送MCU的新版本号

void set_new_mcu_version(int new_mcu_vsn) //开发者实现

参数：new_mcu_vsn

返回：无

描述：中间层传出的mcu新版本号

3.11.6 响应中间层是否升级

void mcu_rsp_update(int update_flag) //中间层实现

参数：update_flag ， =0： 需要升级， =1：不需要升级 返回：无

描述：mcu 回应中间层是否开始升级，得到中间层新的mcu 版本号

（set_new_mcu_version ）之后5s 内回应。否则将错过此次升级过程。

3.11.7 数据包处理函数

int iot_mcu_ota_handle(int ota_pkgnum, u8_t * buf, u16_t len) //开发者实现 参数：ota_pkgnum: 数据包编号； buf ：数据； len ：数据包长度 返回：=0为OK ， 非0为失败

描述：中间层发送mcu bin data ，需要开发者实现；开始最大为128B ，最后一个包可能小于128B 。

约束：目前此函数调用为BLOCK 方式，开发者需要在函数中将数据发送给mcu 端，并且确认数据包的传输结果，最大等待时间为100MS ，可以参考此函数的demo code 实现。

3.11.8 OTA 交互逻辑图如下：

图： OTA 接口交互图

3.12 重置wifi 信息接口

void iot_reset_wifi(void) 参数：无 返回：无

描述：重新返回侦听模式，清除当前的ssid 和password 等信息。

4、 应用实例

4.1 实现一个简单的GPIO 开关控制

在iot_qihoo_demo.c 中，实现了一个简单的GPIO0的开关控制命令实例；

iot_mcu_ota_handle

mcu_rsp_update

set_new_mcu_version set_mcu_version get_mcu_version

MCU INTERFACE

MiddleWare

API

●通过iot_command_handle中命令识别CmdId=256时，调用IoT_gpio_output

接口，对GPIO0做开关控制，CmdData为0时为关，为1时为开

●调用respond_command进行响应。

4.2实现一个基于Uart 0xAA命令交互

在iot_qihoo_demo.c中，实现了一个AA 00 80 00 2A 55的十六进制命令交互实例；

●通过iot_command_handle中命令识别CmdId=257时，调用

iot_send_aa_cmd接口，发送“AA 00 80 04 [XX XX XX] CS 55”的十六进制命令

●通过iot_parse_aa_cmd对Uart MCU端的响应“AA 00 80 00 2A 55”做处理

●调用respond_command进行响应。

4.3定时上传当前数据到云端

在iot_qihoo_demo.c中，实现了update_data_task函数，定时向云端上传数据的例子。其中，上传数据为无意义数据。命令响应超时为30s，回调函数为update_data_cb。

5、其它命令说明、

5.1AT命令

发送方式，目前AT命令支持Uart 和 Udp 30001 Port 两种发送通道。

在IoT_parse_ATcommand函数中增加了一些自定义命令，默认命令不做介绍，可以根据需要，自行根据模板进行添加。

5.2强制升级命令

AT#360update#192.168.253.1#/wifi_fw.bin#

模组下载http://192.168.253.1/wifi_fw.bin1或http://192.168.253.1/wifi_fw.bin2

的升级文件，并自动完成升级。

5.30xAA命令

目前的sdk支持“AT”、0xAA 等三种命令，使用时可以添加任意格式的命令，但是必须与以上三种命令做到互斥，至少命令头部的第一个字节一定不能重复，再结合命令本身的长度等信息，可以识别完整命令。

Uart单字母中断接收函数UART_Rx_Cb实现了识别接收功能，UART_Rx_Packet_Dispatch函数来处理接收到的具体命令包。

5.3.1 添加发送命令：

在iot_aa_cmd.h中

A、添加 ENUM_AA_CMD 命令号，其中0x0060和0x0061为qihoo私有命令

B、添加 ENUM_AA_CMD_LEN，指明此条命令的长度

C、AA_CMD_SEND_NUM 修改命令总条数

C、AA_CMD_SEND_ALL_BUF_LEN 增加所需要的 BUF 总长度

5.3.2 命令下发：

int iot_send_aa_cmd(u16_t ctrl_code, u8_t *data, u8_t len, int seq) 参数：

ctrl_code 控制码

data, 数据

len, 长度

seq 于手机APP或云端异步通信时的编号

返回：

0：成功

非0：失败

5.3.3 命令解析：

int iot_parse_aa_cmd(u8_t * cmd_buf, u16_t len)

参数：

Cmd_buf 数据，注：数据中不包含0xAA的头部

Len 长度

0：成功

非0：失败

6、工具使用

6.1 网络调试助手

6.2 secureCRT 串口助手6.3 CM串口调试助手