软件设计说明书

设计说明书1引言水利方向一直是国家十分重视且投入巨大的方向，它关乎方方面面。百姓生命安全、水资源的利用、农业的灌溉等等，都与其息息相关，但是，正因为它的无处不在，导致如果使用传统的手段，将需要消耗过多的人力，效率极其低下，甚至是不可完成的，所以，水利也需要更加现代化的手段去完成预期的目标，水利自动化就是为了这一目的而提出来的。水利自动化可以大大提高数据测量的准确度和控制的可靠性，提高效率，降低劳动强度，充分利用现有设备，从而对于当地水利单位和水利公司均能带来可观的经济和社会收益。1.1编写目的a.编写本说明书的目的在于阐明用户的要求的，描述出系统的需求模型、功能和性能要求以及其他约定，为后期的软件设计等工作提供依据。b.本说明书的预期读者为用户、系统设计员及其他开发人员和相关审核检测人员。1.2背景本项目的任务提出者及开发者是北京恒宇伟业科技发展有限公司生产部开发小组：项目负责人：硬件设计工程师：系统分析员：系统设计员：编码员：软件测试员：用户为各地方招标业主单位，该软件在WINDOW7系统下，在IARFORMSP430环境下完成开发，1.3定义RTU：远程终端单元。水文监测系统：是指用于对各类水文要素实施采集、传输、处理的总体。1.4参考资料水文检测数据通信规约(SL651-2014)2设计总体2.1需求规定本软件系统的各种用户是唯一的参与者，参与者通过使用事件与系统进行交互，所有的使用事件综合起来即构成了用户的功能需求。本系统通过用户操作键盘操作及显示屏显示交互设定相关系统、通讯、传感器参数，查看历史数据和系统运行状态。2.2运行环境本软件属于工业级产品设备运行系统，运行在基于MSP430F5438ACPU芯片的自助设计的电路板上。部分操作依托于外部传感器设备。2.3基本设计概念和处理流程2.4结构初始化函数流程图Main函数流程图数据发送流程图水位数据采集流程图雨量数据采集流程图数据处理模块流程图输入数据处理模块2.5功能需求与程序的关系主程序函数main();系统滴答初始化Init_CLK();GPIO口相关映射初始化Init_Port();;UART口相关初始化Init_RSUART();键盘相关初始化Init_Keypad();菜单链表初始化Init_Menu();系统时钟读取RX8025_R();本地网络修复模块NetFix();输入数据处理模块IO_ReportDeal();菜单模块Menu_Ctrl();雨量数据处理模块Msg_RainDDeal();水位数据处理模块Msg_WaterDeal();报文拼组模块Msg_PostDeal();数据发送模块NT_SendMsg();系统参数变更存储模块SysParSave();2.6人工处理过程用户通过键盘及显示屏，依靠系统菜单，对相关内容进行设置，以达到按照具体需求运行程序获得预期效果的结果。2.7尚未解决的问题未能对摄像头图片数据进行采集及传输。3接口设计3.1用户接口通过菜单项提供用户接口,其操作简单、功能直观,故不再详述,用户接口如下：主菜单：系统参数通讯参数传感器参数历史数据当前通讯状态系统参数：终端号系统时钟密码设置次雨量清零人工置数修改密码恢复出厂设置通讯参数：起始发送时间当日发送次数GPRS设置GSM设置传感器参数：水位计类型雨量计精度水位预警值水位变化阈值水位基值历史数据：历史数据查询历史数据清空当前通讯状态：信号强度网络通讯状态实时时钟3.2内部接口按键中断响应#pragmavector=PORT1_VECTOR__interruptvoidPort1(void)雨量中断响应#pragmavector=PORT2_VECTOR__interruptvoidPort2(void)普通串口中断响应#pragmavector=USCI_A0_VECTOR__interruptvoidUSCI_A0_ISR(void)GPRS通讯串口中断响应#pragmavector=USCI_A1_VECTOR__interruptvoidUSCI_A1_ISR(void)485中断响应#pragmavector=USCI_A2_VECTOR__interruptvoidUSCI_A2_ISR(void)232中断响应#pragmavector=USCI_A3_VECTOR__interruptvoidUSCI_A3_ISR(void)3.3外部接口硬件接口：标准串口，485口，232口，格雷码口，模拟量输入口，12V供电输出口，24V供电输出接口软件接口：关联程序：编译器等4运行设计4.1运行模块组合水位采集模块→处理模块→报文拼组模块→数据发送模块→历史数据存储模块雨量采集模块→处理模块→报文拼组模块→数据发送模块→历史数据存储模块按键响应模块→菜单模块→系统参数更新存储模块输入数据处理模块→报文拼组模块→数据发送模块4.2运行控制由用户通过菜单选项进行控制。4.3运行时间根据当前时间的采集任务及发送任务量决定5系统数据结构设计5.1逻辑结构设计要点本系统各功能紧密结合，为尽量避免相互影响出现错误，系统严格按照时间顺序运行，保证数据的绝对准确，各端口数据独立接收，统一处理，保证数据不会混杂的前提下，保证更高的处理效率。6系统出错处理设计6.1出错信息当软件进行硬件运行检查，发生错误会重复启动多次避免偶然情况导致硬件运行不正常，在多次检验无法通过时，会在显示屏提示出错原因，保住维护人员排查原因。6.2补救措施故障出现后可能采取的变通措施，包括：a.通过对系统参数进行分析，自主判断问题原因，并采用预置的解决方案进行解决。b.通过在程序各函数打印运行LOG并向串口发送，帮助排查人员了解当前运行情况，便于解决问题c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。6.3系统维护设计正确性维护：在运行过程中发现错时，根据发生错误的功能项找到相应模块，对出错模块单独测试和修改。适应性维护：软件的运行平台限定特定硬件平台上，限定住可能出现问题的范围，便于排查。完善性维护：为了应对用户新提出的要求或改善性能，增加新的功能时，由于系统模块间的独立性，新功能通常可以单独形成新的模块，经测试后拼加到系统中，而对其他模块影响不大；改善某模块的性能（提高处理效率，改善程序结构等）时，只需对相应模块进行改进，然后还原到系统中。