智能家居HiLinkSDK集成开发调测指导.docx

华为技术有限公司智能家居HiLink SDKAPI说明文档版本 02发布日期 2019-01-03HUAWEI版权所有©华为技术有限公司2019保留一切权利非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不 得以任何形式传播商标声明5'和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标，由各自的所有人拥有注意您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或 部分产品、服务或特性可能不在您的购买或使用范围之内除非合同另有约定，华为公司对 本文档内容不做任何明示或默示的声明或保证由于产品版本升级或其他原因，本文档内容会不定期进行更新除非另有约定，本文档仅作 为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保华为技术有限公司地址： 深圳市龙岗区坂田华为总部办公楼 邮编：518129网址： 客户服务邮 support@箱：目录1 概述 52 开发包结构 .错误!未定义书签3 HiLink SDK集成详细步骤 错误!未定义书签3.1 添加HiLink SDK开发包到主程序工程中 错误!未定义书签。

3.2 联网功能集成 错误!未定义书签3.3 互联互通功能集成 错误!未定义书签3.3.1修改设备信息 错误!未定义书签3.3.2获取设备状态（可选） 错误!未定义书签3.3.3实现恢复出厂设置（可选） 错误!未定义书签3.3.4存取设备状态或配置（可选） 错误!未定义书签3.3.5实现设备服务状态控制功能 错误!未定义书签3.3.6实现设备服务状态查询功能 错误!未定义书签3.3.7实现设备服务状态上报功能 错误!未定义书签3.3.8实现设备重启预处理功能 错误!未定义书签3.4 OTA功能集成（可选） 错误!未定义书签3.4.1修改升级配置 错误!未定义书签3.4.2实现升级业务函数 错误!未定义书签3.5 DHCP Option 60功能实现 错误!未定义书签4 功能验证 .错误!未定义书签4.1 概述 错误!未定义书签4.2 APP调试环境设置 错误!未定义书签4.3 搜索添加待测设备 错误!未定义书签4.4 验证设备控制功能 错误!未定义书签1概述本文档用于说明HiLink SDK开发包提供的所有API接口，本文中罗列的部分接口对于开 发者来说不一定是必须使用的API接口的头文件在HiLink SDK开发包的如下位置:hilinksdkl-includehilink.hHiLink SDK静态库主头文件，包含 HiLinkSDK入口函数和时间获取函 数hilink_device.h产品功能适配头文件，包含：•设备信息、设备模型定义•待实现设备服务控制、查询响应 函数声明•供调用设备服务状态上报函数声 明hilink_ota.hOTA功能定义头文件hilink_osadapter.hHiLink SDK操作系统适配头文件， 包含系统时间、Flash读写、字符串 操作、内存操作等系统函数适配接 口声明hilink_log.hHiLink SDK系统提供的日志打印接 口函数声明头文件hilink_typedef.h系统类型定义头文件2 HiLink SDK 主要 API 说明2.1 HiLink SDK 入口函数功能描述：HiLink SDK主流程入口函数，启动HiLink配网及互联互通功能输入参数：void返回参数：0主流程启动成功，其他值主流程启动失败int hilink_main(void);2.2获取设备状态函数功能描述：获取设备状态输入参数：void0 offline, 1 online返回参数：int hilink_get_devstatus(void);2.3设置恢复出厂状态功能描述：调用该接口完成设备恢复出厂设置，该接口会设置恢复出厂标志，在标志 设置成功之后会清理掉ssid账号信息，并重启模组输入参数：void返回参数：0恢复出厂成功，-1恢复出厂失败int hilink_restore_factory_settings(void);2.4获取用户配置功能描述：获取存储在Flash的用户配置信息输入参数：len用户需要获取的配置信息长度输出参数：config用户获取的配置信息缓存返回参数：0获取成功，-1获取失败注意事项：(1) config的内存分配和初始化由调用者完成；(2)用户可获取的配置信息最大长度为32字节.int HilinkGetUserConfig(unsigned short len, char* config);功能描述: 输入参数： 输入参数： 返回参数： 注意事项：2.5保存用户配置保存用户配置信息到flashconfig用户配置信息len用户配置信息长度0保存成功，-1保存失败(1)信息写入为覆盖更新，每次写入前会清空旧的数据;(2)用户可存储的配置信息最大长度为3 2字节.int HilinkSetUserConfig(char * config, unsigned short len);2.6获取本地时间功能描述：时间同步模块获取本地日期信息输出参数：p_time_info本地日期信息返回参数：0获取成功，-1获取失败int hilink_get_local_time_info(pstHILINK_TIME_INFO p_time_info);2.7获取UTC时间信息功能描述：时间同步模块获取当前UTC时间和时区信息输出参数：p_time_ms utc时间，单位ms输出参数：time_zone时区信息字符串，posix tz格式输入参数：len时区信息字符串长度返回参数：0获取成功，-1获取失败int hilink_get_utc_time_ms(unsigned long long *p_time_ms, char *time_zone, unsigned int len);2.8获取UTC日期信息功能描述：时间同步模块获取当前UTC日期信息输出参数:p_time_info UTC日期信息返回参数：0获取成功，-1获取失败int hilink_get_utc_time_info(pstHILINK_TIME_INFO p_time_info);2.9转换毫秒时间为日期功能描述：时间同步模块转换ms为日期输入参数：time_ms ms为单位的时间输出参数：p_ti^e_info转换后的日期信息返回参数：0转换成功，-1转换失败int hilink_convert_time(unsigned long long time_ms, pstHILINK_TIME_INFO p_time_info);3日志打印API说明3.1判断日志是否打印功能描述：判断某级别日志是否打印输入参数：level日志级别(参见hilink_log.h中debug_level_t定义)返回参数：1可以打印，0不可打印bool log_is_print(debug_level_t level);3.2设置某级别日志可以打印功能描述：设置某级别日志可以打印输入参数：level日志级别（参见hilink_log.h中debug_level_t定义）void set_log_level(debug_level_t level);3.3 日志打印功能描述输入参数：format格式化字符 输入参数日志打印可变参数int hilink_printf(const char* format, ...);4 OS适配层API说明4.1获取主机IP功能描述:输入参数： 输出参数：输入参数：获取远端主机IPhostname远端主机名称/urlip_list存放远端主机ip地址列表的数组num存放远端主机ip地址列表的数组的大小返回参数：0成功，其他值失败int hilink_gethostbyname(char* hostname, char ip_list[][40], int num);4.2获取系统时间功能描述：获取系统时间输出参数：ms系统时间，以毫秒为单位返回参数：0成功，其他值失败注意事项：在esp8266上该时间最小单位为10msint hilink_gettime(unsigned long* ms);4.3计算字符串长度功能描述：计算字符串长度 输入参数：返回参数：字符串长度值src字符串注意事项：src字符串须保证以'\0'结尾unsigned int hilink_strlen(const char* src);4.4字符串比较功能描述：字符串内容比较输入参数：strl字符串1输入参数：str2字符串2输入参数：len比较长度返回参数:0字符串相等，>0 str1>str2, <0 str1