客户端通讯 Spec 智能家居系统客户端

客户端通讯客户端通讯 SpecSpec 智能家居系统客户端智能家居系统客户端 Version 0 1 2020 年 4 月 3 日 XXXX 软件股份有限公司软件股份有限公司 交互设计书 xx 软件股份有限公司 第2 页 目录目录 读者清单读者清单 5 参考文档参考文档 5 1 概述概述 6 1 1 目的 6 1 2 名词解释 6 2 系统通讯框架系统通讯框架 7 2 1 网络拓扑结构 7 2 2 网络传输协议 SIP 7 2 3 数据传输定义 8 2 3 1 会话状态描述 8 2 3 2 数据类型应用场景 8 2 3 3 数据格式 9 2 4 数据传输流程 9 2 4 1 手机客户端注册流程 9 2 4 2 手机客户端与ICON连接流程 10 2 4 3 手机客户端控制家电流程 11 2 4 4 手机查看监控流程 11 2 4 5 客户端登录流程 12 3 数据类型定义数据类型定义 13 3 1 INVITE 13 3 2 ACK 14 3 3 NACK 14 3 4 REQUEST MSG 15 3 5 RESPONSE MSG 15 3 6 CTR MSG 15 3 7 BYE 16 4 手机与手机与 ICON 交互数据体详细定义交互数据体详细定义 16 4 1 请求指定类型的所有设备序列号列表 16 4 2 响应指定类型的所有设备序列号列表 17 4 3 请求指定设备的具体状态 17 4 4 响应指定普通设备的具体状态 17 4 5 响应指定空调的具体状态 18 4 6 响应指定温湿度设备的具体状态 19 4 7 响应指定智能插座的具体状态 19 4 8 响应指定摄像头的历史记录 20 4 9 响应 ICON 下载信息 20 4 10 响应空调驱动列表信息 21 交互设计书 xx 软件股份有限公司 第3 页 4 11 手机发送设备控制命令 21 4 12 ICON 返回控制命令执行结果 21 4 13 请求所有房间列表 22 4 14 响应所有房间列表 22 4 15 请求指定房间的所有设备列表 23 4 16 响应指定房间的所有设备列表 23 4 17 请求指定类型的所有设备列表 23 4 18 响应指定类型的所有设备列表 24 4 19 请求文件操作 24 4 20 响应获取文件列表 25 5 ICON 与与 BOA 服务器交互数据详细定义服务器交互数据详细定义 25 5 1 房间增加 25 5 2 房间删除 26 5 3 房间修改 26 5 4 设备增加 26 5 5 设备删除 26 5 6 设备修改 27 5 7 获取所有房间信息 27 5 8 获取摄像头安全等级 待定 27 5 9 获取指定类型的所有设备列表 27 5 10 获取指定房间的所有设备列表 28 5 11 获取设备列表 28 5 12 获取指定开关类设备的状态 28 5 13 获取指定摄像头的历史记录 29 5 14 获取 ICON 下载信息 29 5 15 获取空调驱动列表信息 29 5 16 获取房间温度 29 5 17 获取房间湿度 30 5 18 获取智能插座信息 接线板功率 30 5 19 对 ZIGBEE 设备发送控制命令 待定 30 5 20 空调开始学习 31 5 21 设置上网方式 DHCP 31 5 22 设置上网方式 STATIC IP 32 5 23 设置上网方式 PPPOE 32 5 24 设置 WLAN 32 5 25 添加下载任务 待定 33 5 26 删除下载任务 33 5 27 开始下载任务 33 5 28 停止下载任务 33 5 29 查询所有下载任务 34 6 报文键值码定义报文键值码定义 34 7 请求类型定义请求类型定义 35 交互设计书 xx 软件股份有限公司 第4 页 8 控制命令类型定义控制命令类型定义 36 9 设备类型定义设备类型定义 37 10 系统通讯信息码定义系统通讯信息码定义 38 交互设计书 xx 软件股份有限公司 第5 页 修改记录 Revision Number Revision DateSummary of ChangesAuthor 0 12012 10 22Initial draft 蒋生栋 0 22012 10 31 添加客户端登录流程 添加请求类型 定义 监控视频历史记录 及请求 相应摄像头历史记录报文 添加信息 码定义 蒋生栋 1 02012 11 23添加 ICON 与 BOA 服务器交互数据详 细定义 蒋生栋 2 02012 11 28 通讯报文中的常量数字化 ICON 与 BOA 服务器交互数据增加报 文唯一标识 sn 蒋生栋 2 12012 12 1手机与 ICON 交互数据增加房间信息 及根据类型请求设备信息 ICON 与 BOA 服务器交互数据增加房 间 设备增删改 去除唯一标识 sn 蒋生栋 2 22013 1 5 新增文件浏览相关控制命令及键值码蒋生栋 读者清单读者清单 NamePositionCompanyAction 参考文档参考文档 Document NameVersionAuthorLink 交互设计书 xx 软件股份有限公司 第6 页 1 1 概述概述 1 1目的目的 针对智能家居的需求分解 编写移动终端与 icon 设备通讯接口 以方便合作开发设计 软件 1 2名词解释名词解释 Icon P2P peer to peer 交互设计书 xx 软件股份有限公司 第7 页 2 2 系统通讯框架系统通讯框架 2 1网络拓扑结构网络拓扑结构 Internet 登陆 状态 配置 服务器 Stun服务器 中转服务器 二期 大亚服务器平台 NAT ios设备 Andriod设备Windows设备 NAT Icon 硬盘 Ip摄像头 家居控制器 Icon本地系统 Note 2 2网络传输协议 网络传输协议 SIP 本系统采用 SIP Session Initiation Protocol 信令控制协议 交互设计书 xx 软件股份有限公司 第8 页 2 3数据传输定义数据传输定义 2 3 1会话状态描述会话状态描述 手机客户端与 ICON 设备会话存在三种状态 分别是 打开 绑定 关闭 定义如下 打开状态 open 手机客户端向 ICON 设备发送 INVITE 此时不能直接进行数据交互 绑定状态 bound 由 ICON 设备回复 200 OK 完成连接 此时可进行数据交互 关闭状态 close 手机客户端发送控制 请求命令收到回复后发送 BYE 客户端 手机客户端与 ICON 状态描述如下 打开 关闭绑定发送命令 enquire link 心跳机制 建立 SIP 会话 建立 SIP 会话 INVITE Figure 2 3 1 1 客户端状态 2 3 2数据类型应用场景数据类型应用场景 数据类型要求会话状态手机端发送ICON 端发送 INVITEOpenYesNo ACKOpenNoYes NACKOpenNoYes REQUEST MSGBoundYesNo RESPONSE MSGBoundNoYes CTR MSGBoundYesNo BYEBoundYesNo ENQUIRE LINKBoundYesYes ENQUIRE LINK ACKBoundYesYes 交互设计书 xx 软件股份有限公司 第9 页 2 3 3数据格式数据格式 数据交换格式采用 JSON JavaScript Object Notation 具体定义如下 KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myphone 10 20 30 3 Dst信息接收方 sip myicon 202 20 12 4 CipherFlag加密标识 0 不加密 1 加密 CommandID 数据类型 数 据 体 可 选 MessageBody MAC 可选 备注 是否需要加密及算法待定 2 4数据传输流程数据传输流程 2 4 1手机客户端注册流程手机客户端注册流程 Figure 2 4 1 1 手机客户端注册流程 交互设计书 xx 软件股份有限公司 第10 页 2 4 2手机客户端与手机客户端与 ICON 连接流程连接流程 Figure 2 4 2 1 手机客户端与 ICON 设备交互时序图 交互设计书 xx 软件股份有限公司 第11 页 2 4 3手机客户端控制家电流程手机客户端控制家电流程 Figure 2 4 3 1 手机客户端通过 ICON 设备控制家电时序图 Note 2 4 4手机查看监控流程手机查看监控流程 建立连接后 用户点击任一摄像头设备时 手机端向 ICON 发送一条请求信息 4 3 ICON 根据 4 4 格式回复一条信息 执行成功 失败 如成功则通过 RTP 直接发送流媒体视频 手机端收到成 功的回复后则开始接收并解码显示 当用户退出监控界面时手机端发送 BYE 3 7 信息通知 ICON 结束会话 交互设计书 xx 软件股份有限公司 第12 页 手机SIP服务器ICON Request 转发 response OK OK RTP视频 Figure 2 4 4 1 手机客户端通过 ICON 设备查看监控视频时序图 2 4 5客户端登录流程客户端登录流程 手机端登录时首先根据配置文件定义 内网 外网各一台 sip 服务器 查找可连接的服务器 如果均 无法连接则不能登录 只有一台可连接时直接登录该服务器 如果两台服务器均可连接时提供用户 选择界面 根据用户选择登录相应服务器 交互设计书 xx 软件股份有限公司 第13 页 内外网 均不可用 Y N Y 内外网 均可用 内网可用 N Y 登录失败 选择 网络 登录外 部服务器 N 登录内 部服务器 登录外 部服务器 登录内 部服务器 选择外网选择内网 成功 登录 N 登录服务器 N 登录成功 Y 3 3 数据类型定义数据类型定义 3 1INVITE 手机端通过服务器向 ICON 发送连线请求 KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myphone 10 20 30 3 Dst信息接收方 sip myicon 202 20 12 4 CipherFlag0 CommandIDINV 数 据 体 交互设计书 xx 软件股份有限公司 第14 页 MAC 可选 3 2ACK ICON 通过服务器向手机端发送回应信息 成功 回应类型包括 INVITE CTR MSG BYE KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myicon 10 20 30 3 Dst信息接收方 sip myphone 202 20 12 4 CipherFlag0 CommandIDACK 数 据 体 RequestSn 指定回复的信息序列号 信息码 200 MAC 可选 3 3NACK ICON 通过服务器向手机端发送回应信息 失败 回应类型包括 INVITE CTR MSG BYE KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myicon 10 20 30 3 Dst信息接收方 sip myphone 202 20 12 4 CipherFlag0 CommandIDNAK 数 据 体 RequestSn 指定回复的信息序列号 ErrorCode 错误码 系统通讯信息码定义 MAC 可选 3 4REQUEST MSG 手机端通过服务器向 ICON 发送请求 设备列表 设备状态等 KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myphone 10 20 30 3 Dst信息接收方 sip myicon 202 20 12 4 CipherFlag0 CommandIDREQ 数 据 体 RequestCode 请求类型 交互设计书 xx 软件股份有限公司 第15 页 Msg MAC 可选 3 5RESPONSE MSG ICON 通过服务器回应手机端请求 KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myicon 10 20 30 3 Dst信息接收方 sip myphone 202 20 12 4 CipherFlag0 CommandIDRSP 数 据 体 RequestSn 指定回复的信息序列号 RequestCode 请求类型 OpFlag0 执行成功 1 执行失败 Msg 执行成功时为具体数据信息 失败时为错误码 系统通讯信息码定 义 MAC 可选 3 6CTR MSG 手机端通过服务器向 ICON 发送控制指令 KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myphone 10 20 30 3 Dst信息接收方 sip myicon 202 20 12 4 CipherFlag0 CommandIDCTR 数 据 体 EquipNo 设备编号 CmdType 控制指令类型 CmdValue 控制指令 MAC 可选 3 7BYE 手机端收到 ICON 回复后断开连线 KeyDescription 数 据 头 Sn信息序列号 UAC ID timestamp Src信息发送方 sip myphone 10 20 30 3 Dst信息接收方 sip myicon 202 20 12 4 CipherFlag0 CommandIDBYE 交互设计书 xx 软件股份有限公司 第16 页 数 据 体 MAC 可选 4 4 手机与手机与 ICONICON 交互数据体详细定义交互数据体详细定义 4 1请求指定类型的所有设备序列号列表请求指定类型的所有设备序列号列表 手机端新增设备时点击任一设备类型时发出该请求 类型为 REQ No Type Code 说明说明 备注备注 1 0 xF006 请求类型 报文键值码定义 0 x0001 请求类型定义 2 0 xF00C 参数数量 固定为 1 个 3 0 xF00D 详细参数 40 xF00A 设备类型 0 所有 1 zigbee 2 camera 5 示例 0 xF001 1234567890 0 xF004 0 0 xF005 0 xE004 0 xF006 0 x0001 0 xF00C 1 0 xF00D 0 xF00A 0 4 2响应指定类型的所有设备序列号列表响应指定类型的所有设备序列号列表 ICON 回应手机端 0 x0001 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0001 3 0 xF010 信息码 系统通讯信息码定义 4 0 xF00F 具体数据信息 50 xF00A 设备类型 60 xF00B 设备序列号 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0001 0 xF010 200 0 xF00F 0 xF00A 1 0 xF00B 112233112233 0 xF00A 2 0 xF00B 112233112255 交互设计书 xx 软件股份有限公司 第17 页 4 3请求指定设备的具体状态请求指定设备的具体状态 手机端点击任一设备时发出该请求 类型为 REQ No Type Code 说明说明 备注备注 1 0 xF006 请求类型 请求类型定义 2 0 xF00C 参数数量 3 0 xF00D 详细参数 20 xF00B设备 ID 示例 0 xF001 1234567890 0 xF004 0 0 xF005 0 xE004 0 xF006 0 x0002 0 xF00C 2 0 xF00D 0 xF00B 112233112233 0 xF00B 112233112213 4 4响应指定普通设备的具体状态响应指定普通设备的具体状态 ICON 回应手机端 0 x0002 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0002 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 设备数量 5 0 xF00F 返回值 60 xF00B设备 ID 70 xF012设备开关状态0 开 1 关 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0002 0 xF010 200 0 xF011 3 0 xF00F 0 xF00B 112233112233 0 xF012 0 0 xF00B 112233112255 0 xF012 1 0 xF00B 112233112266 0 xF012 0 4 5响应指定空调的具体状态响应指定空调的具体状态 ICON 回应手机端 0 x0006 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0006 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 设备数量 固定为 1 5 0 xF00F 返回值 60 xF00B设备 ID 70 xF012开关状态0 开 1 关 交互设计书 xx 软件股份有限公司 第18 页 No Type Code 说明说明 备注备注 80 xF013 空调控制模式 0 驱动下载 1 学习获得 90 xF014空调设定温度9 不可获得 10 0 xF015 空调模式 0 制冷 1 制热 2 除湿 3 通风 4 保留 9 不可获得 110 xF016空调摆风0 开 1 关 9 不可获得 120 xF017空调风量0 自动 1 高 2 中 3 低 9 不可获得 130 xF018空调学习能力 备注 1 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 2 如 0 xF012 为关时 0 xF014 0 xF015 0 xF016 0 xF017 为 9 3 如 0 xF013 为学习获得时 0 xF016 0 xF017 为 9 4 0 xF018 对应的是空调学习到的功能 0 为未学习 1 为已学习 目前空调学习功能为 开 关 制热 和 制冷 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0006 0 xF010 200 0 xF011 1 0 xF00F 0 xF00B 112233112233 0 xF012 0 0 xF013 0 0 xF014 23 0 xF015 0 0 xF016 0 0 xF017 1 0 xF018 0110 4 6响应指定温湿度设备的具体状态响应指定温湿度设备的具体状态 ICON 回应手机端 0 x0007 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0007 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 设备数量 5 0 xF00F 返回值 60 xF00B设备 ID 70 xF019房间温度 80 xF01A 房间湿度 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0007 0 xF010 200 0 xF011 2 0 xF00F 0 xF00B 112233112233 0 xF019 27 0 xF01A 50 0 xF00B 112233112255 0 xF019 26 0 xF01A 35 4 7响应指定智能插座的具体状态响应指定智能插座的具体状态 ICON 回应手机端 0 x0008 报文 类型为 RSP 交互设计书 xx 软件股份有限公司 第19 页 No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0008 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 设备数量 5 0 xF00F 返回值 60 xF00B设备 ID 70 xF012设备开关状态0 开 1 关 80 xF01B 电量消耗 备注 1 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 2 如 0 xF012 为关 0 xF01B 为默认值 99999 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0008 0 xF010 200 0 xF011 1 0 xF00F 0 xF00B 112233112233 0 xF012 0 0X1B 135 0 xF00B 112233112255 0 xF012 1 0X1B 99999 4 8响应指定摄像头的历史记录响应指定摄像头的历史记录 ICON 回应手机端 0 x0003 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0003 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 文件数量 5 0 xF00F 返回值 60 xF01C监控视频文件名称 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0003 0 xF010 200 0 xF011 2 0 xF00F 0 xF01C 201211221235 mp4 0 xF01C 201211221808 mp4 4 9响应响应 ICON 下载信息下载信息 ICON 回应手机端 0 x0004 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0004 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 文件数量 5 0 xF00F 返回值 交互设计书 xx 软件股份有限公司 第20 页 No Type Code 说明说明 备注备注 60 xF01D下载文件名称 70 xF01E下载状态0 下载中 1 暂停 2 完成 80 xF01F文件大小单位为 KB 90 xF020已下载大小单位为 KB Msg 执行成功时为具体数据信息 失败时为错误码 系统通讯 信息码定义 数据格式为 FileName xxx xxx DownloadStatus resume pause complete FileSize 12MB FileDownloaded 8M 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0004 0 xF010 200 0 xF011 2 0 xF00F 0 xF01D xx apk 0 xF01E 0 0 xF01F 12345 0 xF020 7890 0 xF01D xx 3gp 0 xF01E 2 0 xF01F 6589 0 xF020 1335 4 10 响应空调驱动列表信息响应空调驱动列表信息 ICON 回应手机端 0 x0005 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0005 3 0 xF010 返回信息码 系统通讯信息码定义 4 0 xF011 驱动数量 5 0 xF00F 返回值 60 xF021空调厂商 70 xF022空调型号 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0005 0 xF010 200 0 xF011 2 0 xF00F 0 xF021 Sanyo 0 xF022 kc135 0 xF021 ChunLan 0 xF022 KL789 4 11 手机发送设备控制命令手机发送设备控制命令 手机端对任一设备进行控制时发出该命令 类型为 CTR No Type Code 说明说明 备注备注 1 0 xF007 控制指令数量 报文键值码定义 2 0 xF008 详细控制命令 30 xF00B 设备编号 40 xF009 控制指令类型 参考 控制命令类型 50 xF00D 控制指令参数 备注 0 xF00B 为 0000 时该指令为针对 ICON 所发 交互设计书 xx 软件股份有限公司 第21 页 示例 0 xF001 1234567890 0 xF004 0 0 xF005 0 xE006 0 xF007 2 0 xF008 0 xF00B 112233112233 0 xF009 0 x1001 0 xF00D 0 xF00B 112233112266 0 xF009 0 x1015 0 xF00D 201211221235 mp4 4 12 ICON 返回控制命令执行结果返回控制命令执行结果 Icon 将接收到的 BOA 返回结果回传给手机 No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF010 返回信息码 系统通讯信息码定义 执行成功示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE002 0 xF00E 1234567890 0 xF010 200 执行失败示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE003 0 xF00E 1234567890 0 xF010 500 4 13 请求所有房间列表请求所有房间列表 手机端进入房间列表界面时发出该请求 类型为 REQ No Type Code 说明说明 备注备注 1 0 xF006 请求类型 报文键值码定义 0 x0009 请求类型定义 2 0 xF00C 参数数量 固定为 0 个 3 0 xF00D 详细参数 40 xF00A 设备类型 5 示例 0 xF001 1234567890 0 xF004 0 0 xF005 0 xE004 0 xF006 0 x0009 0 xF00C 0 0 xF00D 0 xF00A 4 14 响应所有房间列表响应所有房间列表 ICON 回应手机端 0 x0009 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x0009 3 0 xF010 信息码 系统通讯信息码定义 4 0 xF00F 具体数据信息 交互设计书 xx 软件股份有限公司 第22 页 No Type Code 说明说明 备注备注 50 xF025 房间唯一编号 60 xF026 房间名称 70 xF027 房间类型 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x0009 0 xF010 200 0 xF00F 0 xF025 1 0 xF026 roomname1 0 xF027 1 0 xF025 2 0 xF026 roomname2 0 xF027 1 4 15 请求指定房间的所有设备列表请求指定房间的所有设备列表 手机端指定房间设备列表界面时发出该请求 类型为 REQ No Type Code 说明说明 备注备注 1 0 xF006 请求类型 报文键值码定义 0 x000A 请求类型定义 2 0 xF00C 参数数量 固定为 1 个 3 0 xF00D 详细参数 40 xF025 房间唯一编号 5 示例 0 xF001 1234567890 0 xF004 0 0 xF005 0 xE004 0 xF006 0 x000A 0 xF00C 1 0 xF00D 0 xF025 1 4 16 响应指定房间的所有设备列表响应指定房间的所有设备列表 ICON 回应手机端 0 x000A 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x000A 3 0 xF010 信息码 系统通讯信息码定义 4 0 xF00F 具体数据信息 50 xF023 设备唯一编号 6 0 xF00A 设备类型 1 灯 2 窗帘 3 空调 4 摄像 头 5 传感器 6 电源插座 70 xF024 设备名称 80 xF00B 设备序列号 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x000A 0 xF010 200 0 xF00F 0 xF023 1 0 xF00A 1 0 xF024 lamp1 0 xF00B 112233112233 交互设计书 xx 软件股份有限公司 第23 页 0 xF023 2 0 xF00A 1 0 xF024 lamp2 0 xF00B 112233112255 4 17 请求指定类型的所有设备列表请求指定类型的所有设备列表 手机端进入照明 温湿度 智能插座设备界面时发出该请求 类型为 REQ No Type Code 说明说明 备注备注 1 0 xF006 请求类型 报文键值码定义 0 x000B 请求类型定义 2 0 xF00C 参数数量 固定为 1 个 3 0 xF00D 详细参数 4 0 xF00A 设备类型 1 灯 2 窗帘 3 空调 4 摄像头 5 传感器 6 电 源插座 5 示例 0 xF001 1234567890 0 xF004 0 0 xF005 0 xE004 0 xF006 0 x000B 0 xF00C 1 0 xF00D 0 xF00A 1 4 18 响应指定类型的所有设备列表响应指定类型的所有设备列表 ICON 回应手机端 0 x000B 报文 类型为 RSP No Type Code 说明说明 备注备注 1 0 xF00E 针对回复的信息序列号 RequestSn 报文键值码定义 2 0 xF006 请求类型 请求类型定义 0 x000B 3 0 xF010 信息码 系统通讯信息码定义 4 0 xF00F 具体数据信息 50 xF023 设备唯一编号 60 xF024 设备名称 70 xF00B 设备序列号 备注 如 0 xF010 不为 200 具体数据 0 xF00F 可为空 示例 0 xF001 987654321 0 xF004 0 0 xF005 0 xE005 0 xF00E 1234567890 0 xF006 0 x000B 0 xF010 200 0 xF00F 0 xF023 1 0 xF024 lamp1 0 xF00B 112233112233 0 xF023 2 0 xF024 lamp2 0 xF00B 112233112255 4 19 请求文件操作请求文件操作 No Type Code 说明说明备注备注 10 xF001 命令序列号 随即生成 20 xF005 文件类型命令标识 固定为 0 xE008 交互设计书 xx 软件股份有限公司 第24 页 No Type Code 说明说明备注备注 30 x2001 详细文件操作类型标识 40 x2008 可选参数 50 x2009 可选参数 示例 请求根目录所有文件列表 0 xF001 1234567890 0 xF005 0 xE008 0 x2001 0 x3001 示例 修改文件名称 0 xF001 1234567890 0 xF005 0 xE008 0 x2001 0 x3008 0 x2008 local sdag xiha txt 0 x2009 好抿子 4 20 响应获取文件列表响应获取文件列表 获取文件总个数 需要分包发送 以 0 x2007 标识一共有多少个 然后获取分包中的具体数据信息 并计算是否达到文件总个数 如果达到 则说明本次请求操作结束 No Type Code 说明说明备注备注 1 0 xF00E回应的 Sn 序列号 2 0 x2007 文件总个数 3 0 x200A 具体数据信息 40 x2002 文件类型 0 文件 1 文件夹 50 x2003 文件名称 60 x2004 文件路径 0 x2005 文件大小 0 x2006 文件创建时间 时间戳 示例 0 xF00E 1234567890 0 x2007 23 0 x200A 0 x2002 1 0 x2003 lamp1 0 x2004 local demo 0 x2005 112233 0 x2006 11223311333 0 x2002 0 0 x2003 lamp2 0 x2004 local test 0 x2005 11233 0 x2006 112233112233 5 5 ICONICON 与与 BOABOA 服务器交互数据详细定义服务器交互数据详细定义 本章定义了 ICON 设备收到手机端发送的请求后与 BOA 服务器之间的交互数据格式 主动发送方均 为 ICON CGI 传入值总长度不能超过 2000 5 1房间增加房间增加 命令类型 room create 参数 房间名 room name 传入的房间名不能用中文 且不能包含 示例 cgi bin Action cgi get rooms im2 5 8获取摄像头安全等级 待定 获取摄像头安全等级 待定 命令类型 security level 参数 设备 id eq id 返回值 1 low 2 med 3 high 失败返回 error 示例 获取 id 为 123 的摄像头安全等级 cgi bin Action cgi security level im2 eq id 123 设备 id 设备名 设备序列号 示例 获取所有灯的列表 cgi bin Action cgi equip list im2 eq type 1 设备 id 设备类型 设备名 设备序列号 示例 获取 123 房间里的设备列表 cgi bin Action cgi room list im2 room id 123 设备序列号 设备类型 设备序列号 设备序列号 示例 获取 zigbee 设备列表 cgi bin Action cgi dev list im2 dev type 1 文件名称 下载状态 文件大小 已下载大小 交互设计书 xx 软件股份有限公司 第28 页 示例 cgi bin Action cgi downloadlist im2 sn 123 1234567890 1 oi off关闭 2 oi on 开启 3 摄像头互联网不可见 4 摄像头互联网可见 9 空调制冷 11 空调制热 以下暂时不用 3 oi heating 空调加热 4 oi cooling 空调制冷 5 oi fan 空调抽风 6 oi dehumidification 空调除湿 7 oi swing on 空调摆风开 8 oi swing off 空调摆风关 9 oi air qa auto 空调自动风量 10 oi air qa high 空调高风量 11 oi air qa med 空调中风量 12 oi air qa low 空调低风量 13 oi temp cool 遥控学习后的制冷温度 14 oi temp heat 遥控学习后的制热温度 15 oi temp plus 驱动下载后的温度增加 16 oi temp minus 驱动下载后的温度降低 17 oi study on 空调学习开 18 oi study off 空调学习关 19 oi study cool 空调学习制冷 20 oi study heat 空调学习制热 21 oi electricity on 智能插座开 22 oi electricity off 智能插座关 返回值 char op result buf 示例 cgi bin Action cgi zigbee operation im2 sn 123 1234567890 error 示例 查询所有任务 cgi bin Action cgi dlManagerd im2 dlmode 8 28 0 123 456 http 172 16 8 10 0 dl2 zip dl003 zip 3 100 6 6 报文键值码定义报文键值码定义 No Type Code 说明说明 备注备注 1 0 xF001Sn信息序列号 UAC ID timestamp 2 0 xF002Src信息发送方 sip myicon 10 20 30 3 3 0 xF003Dst信息接收方 sip myphone 202 20 12 4 4 0 xF004CipherFlag0 5 0 xF005CommandID 报文类型 6 0 xF006RequestCode 请求类型 7 0 xF007CtrCmdCount 控制命令数量 8 0 xF008CtrCmdBody 详细控制命令 9 0 xF009CmdType控制命令类型 10 0 xF00AEquipType设备类型 11 0 xF00BEquipNo设备 ID 12 0 xF00CParamCount 参数数量 13 0 xF00DParamBody 详细参数 14 0 xF00ERequestSn 指定回复的信息序列号 15 0 xF00FReturnValue返回值 16 0 xF010ReturnCode返回信息码 17 0 xF011EquipCount设备数量 18 0 xF012EquipOnOff设备开关状态 19 0 xF013ACCtrMode空调控制模式 20 0 xF014ACTemp空调设定温度 21 0 xF015ACMode空调模式 22 0 xF016ACSwing空调摆风 23 0 xF017ACFanPower空调风量 24 0 xF018Ability空调学习能力 自己解析 25 0 xF019RoomTemp房间温度 26 0 xF01ARoomHumi房间湿度 交互设计书 xx 软件股份有限公司 第33 页 No Type Code 说明说明 备注备注 27 0 xF01BElectricity电量消耗 28 0 xF01CCamFiledir监控视频目录列表 自己解析 29 0 xF01DFileName下载文件名称 不用 30 0 xF01EDownloadStatus下载状态 不用 31 0 xF01FFileSize文件大小 不用 32 0 xF020FileDownloaded已下载大小 不用 33 0 xF021ACTypeId空调型号 ID 34 0 xF022ACModel空调型号名称 35 0 xF023EquipUuid设备唯一编号 36 0 xF024EquipName设备名称 37 0 xF025RoomUuid房间唯一编号 38 0 xF026RoomName房间名称 39 0 xF027RoomType房间类型 40 0 xF028NetConfigStatus上网方式 自己解析 wll 41 0 xF029WifiConfigStatus无线状态 自己解析 wll 42 0 xF02ACameraSecurity摄像头互联网可见性 wll 43 0 xF02BCmdReturnParam控制命令返回参数 wll 44 0 xF02CIndexMode无线选项 2 4G 5G wll 45 0 xF02DFileDownLoadInfo下载任务信息 自己解析 wll 46 0 x2001SocketOpenOrClose文件操作详细 关闭或开启 socket 47 0 xF02ECamFileInfo监控视频文件信息列表 自己解析 48 0 xF02FCamFileDate摄像头时间信息 No Type Code 说明说明 备注备注 10 xE001INV 20 xE002ACK 30 xE003NAK 40 xE004REQ 50 xE005RSP 60 xE006CTR 70 xE007BYE 80 xE008FILE 新增文件操作标识符 90 xE009VIDEO新增请求流媒体操作标识符 10 0 xE00A 7 7 请求类型定义请求类型定义 No Type Code 说明说明 备注备注 1 0 x0001 设备序列号列表 EquipList 2 0 x0002 普通设备状态 EquipStatus 交互设计书 xx 软件股份有限公司 第34 页 No Type Code 说明说明 备注备注 3 0 x0003 摄像头历史数据文件夹 CamHisDir 4 0 x0004icon 下载任务信息DownloadList 5 0 x0005 空调驱动列表 ACDriverList 6 0 x0006 空调状态 ACStatus