TS-BUS家居控制软件KNX通讯协议模块概要设计说明书V1.00.docx

TIANSUTS-BUS家居控制软件KNX通讯协议模块概要设计说明书文件编号TS1104-006生效日期2011-5-23受控编号保密级别一级版本号V1.00修改次数2总页数17正文13附录无编制柯于义审核批准南京天溯自动化控制系统有限公司（版权所有,翻版必究）评审记录对bS-BUS家居控制软件通讯协议模块概要设计说明书V1.00»的评审意见:上述问题修改验证后，由验证后，本文件即可发布。评审人员签字:问题修改验证结果:验证人签字：时间：年一月B变更日志编号版本修改内容修改人修改日期10.1初稿柯于义2011-5-1020.2结构修改柯于义2011-5-2030.3添加了异常类、源码示例等柯于义2011-5-2141.00定稿柯于义2011-5-231引言11.1 编写目的11.2 背景113定义11.4 参考资料12 总体设计22.1 需求规定22.1.1 主角22.1.2 系统边界22.2 运行环境22.2.1 硬件环境22.2.2 软件环境32.3 概要设计决策32.3.1 设计原则32.3.2 设计决策32.4 开发环境33 模块设计53.1 接口模块定义53.1.1 功能说明53.1.2 数据与接口的定义53.1.3 接口设计73.1.4 1.4Objective-C调用接口模块源码示例104 质量要求134.1 性能要求134.2 功能测试要求134.2.1 测试内容134.2.2 测试方法131引言1.l编写目的本文档是对TS-BUS家居控制软件的需求规格进行详细分析和讨论后得出的概要设计说明书，旨在明确TS-BUS家居控制软件通讯协议模块的设计目标。通过本概要设计说明书，可以了解到TS-BUS家居控制软件的通讯协议模块开发的技术路线、功能边界、模块设计等。本文档面向的读者是：TS-BUS家居控制软件的开发人员及测试人员，TS-BUS家居控制软件的通讯协议模块概要设计说明书的评审人员。1.2 背景软件名称：TS-BUS家居控制软件通讯协议模块。TS-BUS家居控制软件通讯协议模块，是TS-BUS家居控制软件与设备之间通讯的核心模块，主要用于实现ElB网络的互联接入、KNXnet/IP网关的配置和通信，以及设备数据的读写、设备管理等功能。1.3 定义下表列出本报告中专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇，同时继承全部的先前过程中定义过的词汇。词汇名称词汇含义备注1.4 参考资料编号资料名称说明1TS-BUS家居控制软件项目立项书2TS-BUS家居控制软件项目计划书3TS-BUS家居控制软件需求规格说明书2总体设计2.1 需求规定2.1.1 主角(1) EIB网关EIB网关包括EIB/RS232网关、EIB/USB网关以及EIB/IP网关三种。TS-BUS家居控制软件通过EIB网关实现对EIB总线系统的通讯，本软件采用IP网关。(2) EIB通讯群组在EIB总线标准中定义了实现具体通讯功能的通讯群组，TS-BUS家居控制软件也需要按照标准定义通讯群组功能并通过EIB网关收发总线数据，实现EIB总线设备状态的监视和控制。(3) Ul软件模块Ul软件模块是TS-BUS家居控制软件的用户与EIB总线的人机接口界面，它通过以太网连接到EIB网关，通过调用通讯协议模块的通讯帧，实现EIB总线设备数据的操作和管理功能。(4) 通讯协议模块TS-BUS家居控制软件通讯协议模块，实现EIB/IP网关的TCP/IP通讯管理、设备数据的读写等功能。通讯协议模块主要为TS-BUS家居控制软件的UI软件模块提供通讯接口。2.1.2 系统边界系统边界定义了本模块对其它模块提供的外部接口，应包括：(1)数据结构与回调接口的定义；(2) EIB/IP网关的TCP/IP通讯管理；(3) 逻辑组数据的读写；2.2 运行环境2.2.1 硬件环境硬件环境类别要求备注CPU2.0MHZ及以上内存IGB及以上硬盘IoGB及以上以太网口1个或更多2.2.2 软件环境软件环境类别要求备注操作系统MacOSZiOS2.3 概要设计决策2.3.1 设计原则(1) 软件需要有一个良好的设计框架。为了软件能适应未来儿年的现场需要，软件应该根据实际需要保持一定的可扩展，这就要求系统升级时对已基于该系统实施的系统兼容，软件设计必须有良好的设计框架。其中包括：第一、多采用复用技术。第二、底层业务模块相对独立，低耦合度。第三、保持业务模型稳定，表现出来就是InterfaCe稳定。(2)软件需要具有持续开发，功能完善能力，具有良好的向前兼容性。考虑到目前该软件模块使用对象的实际操作水平以及需求，软件开发不可能一步到位，但是必须考虑到未来的需求，目前系统必须为以后的功能完善，扩展留有充分的接口，系统具有良好的向前兼容性。2.3.2 设计决策本节记录对概要设计具有重要影响的软件需求和约束，描述相关的重要决策和决策的原因。这些决策一般对设计有很大影响,它们的改变很难通过设计技巧来屏蔽，例如所选用的开发语言,所选用的平台、组件和框架，对关键业务，类和方法的处理等。决策：通讯模块开发语言选择一方面，ObjeCIiVe-C是对C的扩展，它对C+的支持也很好，考虑模块与ObjeCIiVe-C程序的兼容性,应选择ObjeCtiVe-C或C或C+来实现;另一方面，考虑到模块移植与跨平台的方便性，模块使用C或C+开发无论是在MaCoS/iOS,还是WindOWS或LinUX平台均可应用。因些，该模块使用C或C+开发;再考虑到接口设计的方便性和易用性，将使用到C+中的类、虚函数等相关的概念，因此选用C+。2.4 开发环境开发用机器类别要求备注CPU2.0GHZ或以上内存最少IGB主机硬盘最少80GB网卡10/1OOMbZsUSB口至少1个软件环境类别要求备注操作系统MacOS开发软件XCode3模块设计31接口模块定义3.1.1 功能说明(1)由于TS-BUS家居控制软件的Ul软件模块与EIB/IP网关之间的通讯，两者之间需要定义公共的数据结构和接口，用于统一二者之间的通讯方式和通讯规格。(2)TS-BUS家居控制软件的UI软件模块与EIB/IP网关之间的通讯,是使用基于TCP/IP协议的UDP报文来传输KNX帧的，因此，需要在Ul软件模块与IP网关之间建立TCP/IP通讯。(3) KNX协议模块应该为TS-BUS家居控制软件的通讯相关模块(主要为Ul模块)，提供逻辑组数据的读写功能。(4) KNX协议模块在发生异常的情况下，应给其调用者一个交待，返回一定的错误码。3.1.2 数据与接口的定义(1)数据类型定义：#defineTXT_DATA_SIZE32文本值最大长度/KNXdatapointtypestypedefenum(DPT_Unknown=0,DPT_Boolean,DPT_lBitCtrhDPT_3BitCtrl,DPT_CharSet,DPT_8BitUnSign,DPT_8BitSign,DPT_2OctUnSign,DPT_2OCtSigr),DPT_2OctFloat,DPT.Time,DPT_Date,DPT_4OctUnSign,DPT_4OctSign,DPT.4OclFloat,DPT_Access,DPT_String)DATA_POINT_TYPE;/KNXdatatypestypedefenum(IDATA_TYPE_UNKNOWN=O,未知类型DATA_TYPE_BINARY,/布尔量类型DATA_TYPE_ANALOG/模拟量类型DATA_TYPE_TEXT,文本类型DATA_TYPE_DATE,日期类型DATA_TYPE_TIME/时间类型DAAJYPE;(2)数据结构定义：时间类型数据结构：typedefstruct_TIMEDATAfIintyear;年intmonth;月intday;日inthour;时intminute;分intsecond;/秒intweekday;星期TIMEDATA;数据域结构：unionDataArearlboolBinData;布尔类型值doubleAnaData;模拟量值charTxtDataTXT_DATA_SIZE;文本值TIMEDATATimeData;时间日期类型值逻辑组数据域结构：typedefstruct_GroupDataintnMainAddr;主组地址intnMidAddr;中组地址intnGrpAddr;/逻辑组地址intnGrpDPT;/KNX数据类型(17种数据类型之一)DataAreaData;GroupData;3.1.3 接口设计3.1.3.1 异常类设计为了避免命名上的冲突，保证接口方法名的唯一性，异常类我们将放在自定义的命名空间tsknx中，包括后继章节的类和接口，均放在该空间内。namespacetsknx(typedefenum(KNX_ERR_UNKNOWN=O,KNX_ERR_INPUT,KNX_ERR_NETWORK,KNX_ERR_UDP,KNX_ERR_CALLBACK,KNX_ERR_DPTCONVERTloNKNX_EXCEPTION_ID;classCKNXException(public:virtualKNX_EXCEPTION_IDGetExceptionIdO=O；/endnamespacetsknx3.1.3.2 公共接口设计公共接口(包括回调方法和提供外部模块使用的接口)的定义如下：namespacetsknx(typedefDATA_POINT_TYPE(CALLBACK*GetDPT)(intnMainAddr,intnMidAddr,intnGrpAddr);/回调方法，获取逻辑组的数据类型typedefvoid(CALLBACK*OnReadResponse)(G