客户端通讯 Spec智能家居系统客户端Version 0.12019年2月26日XX软件股份有限公司 交互设计书目录xx软件股份有限公司 第37页 读者清单5 参考文档51 概述61.1 目的61.2 名词解释62 系统通讯框架72.1 网络拓扑结构72.2 网络传输协议（SIP）72.3 数据传输定义82.3.1 会话状态描述82.3.2 数据类型应用场景82.3.3 数据格式92.4 数据传输流程92.4.1 手机客户端注册流程92.4.2 手机客户端与ICON连接流程102.4.3 手机客户端控制家电流程112.4.4 手机查看监控流程112.4.5 客户端登录流程123 数据类型定义133.1 INVITE133.2 ACK143.3 NACK143.4 REQUEST_MSG153.5 RESPONSE_MSG153.6 CTR_MSG153.7 BYE164 手机与ICON交互数据体详细定义164.1 请求指定类型的所有设备序列号列表164.2 响应指定类型的所有设备序列号列表174.3 请求指定设备的具体状态174.4 响应指定普通设备的具体状态174.5 响应指定空调的具体状态184.6 响应指定温湿度设备的具体状态194.7 响应指定智能插座的具体状态194.8 响应指定摄像头的历史记录204.9 响应ICON下载信息204.10 响应空调驱动列表信息214.11 手机发送设备控制命令214.12 ICON返回控制命令执行结果214.13 请求所有房间列表224.14 响应所有房间列表224.15 请求指定房间的所有设备列表234.16 响应指定房间的所有设备列表234.17 请求指定类型的所有设备列表234.18 响应指定类型的所有设备列表244.19 请求文件操作244.20 响应获取文件列表255 ICON与BOA服务器交互数据详细定义255.1 房间增加255.2 房间删除265.3 房间修改265.4 设备增加265.5 设备删除265.6 设备修改275.7 获取所有房间信息275.8 获取摄像头安全等级（待定）275.9 获取指定类型的所有设备列表275.10 获取指定房间的所有设备列表285.11 获取设备列表285.12 获取指定开关类设备的状态285.13 获取指定摄像头的历史记录295.14 获取ICON下载信息295.15 获取空调驱动列表信息295.16 获取房间温度295.17 获取房间湿度305.18 获取智能插座信息（接线板功率）305.19 对ZIGBEE设备发送控制命令（待定）305.20 空调开始学习315.21 设置上网方式DHCP315.22 设置上网方式STATIC_IP325.23 设置上网方式PPPOE325.24 设置WLAN325.25 添加下载任务（待定）335.26 删除下载任务335.27 开始下载任务335.28 停止下载任务335.29 查询所有下载任务346 报文键值码定义347 请求类型定义358 控制命令类型定义369 设备类型定义3710 系统通讯信息码定义38修改记录Revision NumberRevision DateSummary of ChangesAuthor0.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 NameVersionAuthorLink1 概述1.1 目的针对智能家居的需求分解，编写移动终端与icon设备通讯接口，以方便合作开发设计软件1.2 名词解释Icon：P2P: peer to peer2 系统通讯框架2.1 网络拓扑结构 Note:2.2 网络传输协议（SIP）本系统采用SIP(Session Initiation Protocol)信令控制协议2.3 数据传输定义2.3.1 会话状态描述手机客户端与ICON设备会话存在三种状态，分别是：打开、绑定、关闭。定义如下：l 打开状态（open）：手机客户端向ICON设备发送INVITE，此时不能直接进行数据交互；l 绑定状态（bound）：由ICON设备回复200 OK，完成连接，此时可进行数据交互；l 关闭状态（close）：手机客户端发送控制/请求命令收到回复后发送BYE。客户端（手机客户端与ICON）状态描述如下：打开关闭绑定发送命令enquire_link心跳机制建立SIP会话建立SIP会话INVITEFigure 2.3.1-1 客户端状态2.3.2 数据类型应用场景数据类型要求会话状态手机端发送ICON端发送INVITEOpenYesNoACKOpenNoYesNACKOpenNoYesREQUEST_MSGBoundYesNoRESPONSE_MSGBoundNoYesCTR_MSGBoundYesNoBYEBoundYesNoENQUIRE_LINKBoundYesYesENQUIRE_LINK_ACKBoundYesYes2.3.3 数据格式数据交换格式采用JSON(JavaScript Object Notation) ，具体定义如下：KeyDescription数据头Sn信息序列号，UAC ID_timestampSrc信息发送方，“sip:myphone10.20.30.3”Dst信息接收方，“sip:myicon202.20.12.4”,CipherFlag加密标识，0：不加密；1：加密CommandID数据类型数据体（可选）MessageBodyMAC (可选)备注：是否需要加密及算法待定2.4 数据传输流程2.4.1 手机客户端注册流程Figure 2.4.1-1 手机客户端注册流程2.4.2 手机客户端与ICON连接流程Figure 2.4.2-1 手机客户端与ICON设备交互时序图2.4.3 手机客户端控制家电流程Figure 2.4.3-1 手机客户端通过ICON设备控制家电时序图Note：2.4.4 手机查看监控流程建立连接后，用户点击任一摄像头设备时，手机端向ICON发送一条请求信息（4.3），ICON根据4.4格式回复一条信息（执行成功/失败），如成功则通过RTP直接发送流媒体视频，手机端收到成功的回复后则开始接收并解码显示。当用户退出监控界面时手机端发送BYE（3.7）信息通知ICON结束会话Figure 2.4.4-1 手机客户端通过ICON设备查看监控视频时序图2.4.5 客户端登录流程手机端登录时首先根据配置文件定义（内网/外网各一台sip服务器）查找可连接的服务器，如果均无法连接则不能登录，只有一台可连接时直接登录该服务器，如果两台服务器均可连接时提供用户选择界面，根据用户选择登录相应服务器。3 数据类型定义3.1 INVITE手机端通过服务器向ICON发送连线请求KeyDescription数据头Sn信息序列号，UAC ID_timestampSrc信息发送方，“sip:myphone10.20.30.3”Dst信息接收方，“sip:myicon202.20.12.4”CipherFlag0 CommandIDINV数据体MAC (可选)3.2 ACKICON通过服务器向手机端发送回应信息（成功），回应类型包括INVITE，CTR_MSG，BYEKeyDescription数据头Sn信息序列号，UAC ID_timestampSrc信息发送方，“sip: myicon10.20.30.3”Dst信息接收方，“sip: myphone 202.20.12.4”,CipherFlag0 CommandIDACK数据体RequestSn指定回复的信息序列号信息码200MAC (可选)3.3 NACKICON通过服务器向手机端发送回应信息（失败），回应类型包括INVITE，CTR_MSG，BYEKeyDescription数据头Sn信息序列号，UAC ID_timestampSrc信息发送方，“sip: myicon10.20.30.3”Dst信息接收方，“sip: myphone 202.20.12.4”,CipherFlag0 CommandIDNAK数据体RequestSn指定回复的信息序列号ErrorCode错误码（系统通讯信息码定义）MAC (可选)3.4 REQUEST_MSG手机端通过服务器向ICON发送请求（设备列表，设备状态等）KeyDescription数据头Sn信息序列号，UAC ID_timestampSrc信息发送方，“sip:myphone10.20.30.3”Dst信息接收方，“sip:myicon202.20.12.4”CipherFlag0 CommandIDREQ数据体RequestCode请求类型MsgMAC (可选)3.5 RESPONSE_MSGICON通过服务器回应手机端请求KeyDescription数据头Sn信息序列号，UAC ID_timestampSrc信息发送方，“sip: myicon