软著设计说明书

XXXXXX调试程序软件V1.0XXXXXX调试程序软件设计说明书软件功能主要功能:完成XXXXXX调试功能,调试完成后保存电机驱动器的参数至电机驱动控制板的flash存储器中,保存本地参数至本地文档中。主要是通过串口进行调试指令的下发、反馈状态的读取、参数的读写等。功能模块划分:核心主模块、参数读写模块、账户管理模块、协议封装模块、辅助通讯模块、控制指令发送模块、状态反馈模块。编程环境软件使用C++语言进行编程,在Windows10系统下使用VisualStudio2015编译器编译实现。版本号本软件说明书的版本号为v1.0。软件架构设计软件根据功能模块划分为7个部分。其关系如下图所示:核心主模块、参数读写模块、账户管理模块、协议封装模块、辅助通讯模块、控制指令发送模块、状态反馈模块。账户管理模块控制指令发送模块账户管理模块控制指令发送模块参数读写模块辅助通讯模块核心主模块参数读写模块辅助通讯模块核心主模块协议封装模块状态反馈状态反馈模块其中核心主模块是整个程序的中心,完成主要各个功能模块的协调与配合功能,是整个程序的重点。其他通讯方面的模块程序则在底层通讯的基础上进行用户协议封装以及PC应用级的使用,其中最主要的UI交互接口由控制指令发送模块和状态反馈模块完成。为优化程序结构,所有程序采用层次化编程思路,多文件功能配合编写和实现。功能模块描述核心主模块此模块是整个程序的中心,核心主模块负责协调和沟通其他各个功能模块之间的配合,是各个模块交互的纽带。参数读写模块此模块负责设备运行参数的读写功能,不但包括调试时的各个具体参数的设置调试,也包括此设备整套运行参数的保存和读取,为了方便用户使用,一共设置了2套参数,分别为出厂参数表和用户参数表,参数表格内容相同而参数值不同。出厂参数为自己工厂的出厂调试人员调试完成后保存的参数列表,用户参数为客户拿到设备后根据实际使用情况可能调整部分参数值后的参数表,更加适用于具体的使用场景。默认的用户参数表与出厂参数表是一致的,使用用户账户登录后仅可以对用户参数表进行操作,使用调试账户登录后可以对出厂参数表进行操作。后附参数保存列表。账户管理模块此模块负责账户的修改、登录、注销等操作,主要有用户账户和调试账户两个账户,此软件开启时默认是用户账户登录,用户账户仅可以对用户参数进行修改,调试参数登录后可以对部分高级参数进行设置修改。用户账户无密码保护,调试账户有密码保护,登录调试账户时需要输入正确的密码后才能进入。协议封装模块此模块是整个程序通讯的基础,PC调试软件与电机驱动控制板之间的通讯为串口通讯方式。通讯需要按照一定格式的协议匹配进行,所有的通讯数据都通过该模块进行封装后逐字节按位依次发送和接收。该模块还完成通讯参数的配置,主要有以下参数需要配置:波特率、数据位、停止位和奇偶校验。同时为了确保PC调试软件与电机驱动控制板之间进行可靠的通讯,两端需要约定匹配的参数组。此模块按照不同的使用目的和用途进行分类协议封装定义。后附协议封装的分类和格式规约。辅助通讯模块此模块负责协调应用层和驱动层的通讯接口,建立内部重发机制,发送控制指令或者查询指令后如果在一定时间内未收到正确的响应,则进行指令重发。辅助通讯模块自动记录连续通讯失败次数,通讯成功时,连续失败次数清零重新计数,当通讯失败次数达到3次时才会真正触发通讯失败故障。用户通过软件提示界面收到通讯失败故障后需要进行相关的通讯检查,在排查并处理了故障后确认故障,重新激活通讯连接。控制指令发送模块当用户从PC调试软件进行调试动作时,PC软件会根据控制指令的不同,向对应的控制指令通讯地址表中发送指令值,以达到把调试控制指令从PC机发送给电机驱动控制器的目的,电机驱动控制器接收到控制指令时,根据协议格式进行指令解析,然后再送至相应的响应程序进行操作响应。状态反馈模块当PC调试软件需要查询设备状态信息时,状态反馈模块根据所查询的不同参数的状态,向对应的状态反馈地址表发送查询指令,电机驱动控制器根据查询反馈地址表从内部状态寄存器中调取反馈数据进行反馈通讯帧的封装和发送,以达到把反馈状态从电机驱动控制器读取到PC调试软件的目的。程序控制流程图本章节主要描述和说明XXXXXX调试软件各个功能模块的控制流程,主要以程序控制流程图的方式说明各部分功能的实现原理和流程处理方法。

上电初始化程序控制流程图此流程图描述XXXXXX调试软件在上电加载时的初始化工作,实现上电的初始化设置和通讯串口的配置工作等。

通讯关闭程序控制流程图此流程图描述程序退出时的通讯关闭退出处理流程,主要完成通讯端口的关闭工作。

调试账户登录程序控制流程图此流程图描述XXXXXX调试软件调试高级账户登录程序的处理过程,输入正确的调试账户密码后成功登录,如果连续输入密码错误达到3次,则登录失败,不允许再试,直到下次重新启动软件。

调试账户修改密码程序控制流程图此流程图描述XXXXXX调试软件调试高级账户密码修改程序的处理过程,输入正确的旧密码并且2遍新密码一致后,密码修改成功。如果连续输入密码错误或2遍新密码不一致达到3次,则修改失败,不允许再试,直到下次重新启动软件。

调试账户注销程序控制流程图此流程图描述XXXXXX调试软件调试高级账户注销程序的处理过程,调试账户注销后默认登录用户账户,如果需要登录调试账户的话,另外按照调试账户登录程序执行。

控制指令与参数写入接口程序控制流程图此流程图描述XXXXXX软件向电机驱动控制器发送控制指令或者写入参数时的处理过程,根据通讯地址列表写入响应的指令或者参数设置,其中涵盖了通讯重发机制。状态与参数读取接口子程序控制流程图此流程图描述XXXXXX软件从电机驱动处理器读取设备状态和参数时的处理过程,根据通讯地址列表读取对应的状态或者参数反馈值,其中涵盖了通讯重发机制。协议封装子程序控制流程图此流程图描述XXXXXX软件通讯时的协议封装的程序处理过程,规范了通讯双方的通讯规约,保证了通讯的可靠正确实现。其中电机驱动控制器的写入和读取与XXXXXX软件的读取和写入相对应,两者互为收发的关系。

通讯解析子程序控制流程图此流程图描述XXXXXX软件接收通讯数据后的数据解析处理过程,用于解析电机驱动控制器的数据应答,包括了校验审核和数据分解对照拆分。

参数保存子程序控制流程图此流程图描述XXXXXX调试软件本身的参数和密码更新后的保存处理过程,参数保存至本机参数文档,待下次重新上电时从参数文档中读取参数使用。

协议规约XXXXXX软件与电机驱动控制器之间需要按照约定的通讯协议规约进行,PC下发设置或者查询指令,需要驱动控制器根据规约按照约定的格式进行信息回复,并增加CRC校验,以便保证数据正确传输,XXXXXX软件按照约定的协议规约进行解析获取数据。帧起始标志帧控制应用数据帧校验起始标志帧类型会话计数帧长度分包编号总的包个数数据内容CRC校验2Byte1Byte1Byte2Byte2Byte2ByteNByte2Byte起始标志:起始标志为2个0xFE。用于识别帧头。帧类型:F1:写入控制帧F2:读取控制帧F3:写入响应帧F4:读取响应帧会话计数:本次会话计数,循环累加。当传输的是控制帧时,每一帧控制指令为一次会话。当传输的是数据帧时,每一帧数据指令为一次会话。帧长度:当前帧的字节数。分包编号：每次会话中的分包计数,每一帧数据为一个分包。包的总个数:当前会画的总分包个数。数据内容:对于写入控制帧:输入内容如下:写入起始地址写入数据个数写入数据2Byte2ByteNByte对于读取控制帧:内容如下:读取起始地址读取数据个数2Byte2Byte写入响应帧写入起始地址写入数据个数2Byte2Byte读取响应帧读取起始地址读取起始个数读取起始2Byte2ByteNByte串行通讯地址表本章节主要描述和说明XXXXXX调试软件与电机驱动控制器之间的串行通讯地址表,控制指令、参数等信息均采用此表格通讯地址协议进行交互。地址寄存器名称读写功能说明备注0x1001启停调试控制寄存器R/W0:停止指令

1:启动指令0x1002参数读取控制寄存器R/W0:无指令

1:读取参数指令0x1003参数保存控制寄存器R/W0:无指令

1:保存参数指令0x1004通讯波特率设定R/W设定串口通讯的波特率,默认=1

0：4800

1：9600

2：19200

3：38400

4：57600

5：1152000x1005~0x1007输入电压校准系数设定R/W电机输入电压校准系数K设定值,用于校准参数0x1008~0x100A输入电压校准偏移量设定R/W电机输入电压校准偏移量offset设定值,用于校准参数0x100B~0x100D输出电压校准系数设定R/W电机输出电压校准系数K设定值,用于校准参数0x1011~0x1013输出电压校准偏移量设定R/W电机输出电压校准偏移量offset设定值,用于校准参数0x1014~0x1016输入电流校准系数设定R/W电机输入电流校准系数K设定值,用于校准参数0x1017~0x1019输入电流校准偏移量设定R/W电机输入电流校准偏移量offset设定值,用于校准参数0x101A~0x101C输出电流校准系数设定R/W电机输出电流校准系数K设定值,用于校准参数0x1021~0x1023输出电流校准偏移量设定R/W电机输出电流校准偏移量offset设定值,用于校准参数0x1024~0x1026系统PID控制周期时间设定R/W设定系统PID控制的采样周期时间,已达到灵活控制的目的0x1027~0x1029PID控制比例P调节设定R/W设定系统PID控制的比例调节系数Kp0x102A~0x102CPID控制积分I调节设定R/W设定系统PID控制的积分调节时间Ti0x1031~0x1033PID控制微分D调节设定R/W设定系统PID控制的微分调节时间Td0x1034~0x1036输出PWM控制频率设定R/W设定输出PWM控制的脉冲频率,单位(1KHz)

数据范围1~10000x2001电机运动状态反馈R0:停止待机状态

1:正常运行状态

2:超载状态0x2002负载档位选择反馈R5个选择拨码开关组成二进制数0~31,分别对应满载工作的1/32~32/32负载选择控制0x2003参数读写状态反馈R0:无读写状态

1:参数读取中

2:参数读取完成

3:参数读取超时

4:参数写入中

5:参数写入完成

6:参数写入超时0x2011~0x2013输入电压测量值R采样滤波校准后的输入电压测量反馈值0x2014~0x2016输出电压测量值R采样滤波校准后的输出电压测