軟著設(shè)計(jì)說明書

XXXXXX調(diào)試程序軟件V1.0XXXXXX調(diào)試程序軟件設(shè)計(jì)說明書軟件功能主要功能:完成XXXXXX調(diào)試功能,調(diào)試完成后保存電機(jī)驅(qū)動(dòng)器的參數(shù)至電機(jī)驅(qū)動(dòng)控制板的flash存儲(chǔ)器中,保存本地參數(shù)至本地文檔中。主要是通過串口進(jìn)行調(diào)試指令的下發(fā)、反饋狀態(tài)的讀取、參數(shù)的讀寫等。功能模塊劃分:核心主模塊、參數(shù)讀寫模塊、賬戶管理模塊、協(xié)議封裝模塊、輔助通訊模塊、控制指令發(fā)送模塊、狀態(tài)反饋模塊。編程環(huán)境軟件使用C++語言進(jìn)行編程,在Windows10系統(tǒng)下使用VisualStudio2015編譯器編譯實(shí)現(xiàn)。版本號(hào)本軟件說明書的版本號(hào)為v1.0。軟件架構(gòu)設(shè)計(jì)軟件根據(jù)功能模塊劃分為7個(gè)部分。其關(guān)系如下圖所示:核心主模塊、參數(shù)讀寫模塊、賬戶管理模塊、協(xié)議封裝模塊、輔助通訊模塊、控制指令發(fā)送模塊、狀態(tài)反饋模塊。賬戶管理模塊控制指令發(fā)送模塊賬戶管理模塊控制指令發(fā)送模塊參數(shù)讀寫模塊輔助通訊模塊核心主模塊參數(shù)讀寫模塊輔助通訊模塊核心主模塊協(xié)議封裝模塊狀態(tài)反饋狀態(tài)反饋模塊其中核心主模塊是整個(gè)程序的中心,完成主要各個(gè)功能模塊的協(xié)調(diào)與配合功能,是整個(gè)程序的重點(diǎn)。其他通訊方面的模塊程序則在底層通訊的基礎(chǔ)上進(jìn)行用戶協(xié)議封裝以及PC應(yīng)用級(jí)的使用,其中最主要的UI交互接口由控制指令發(fā)送模塊和狀態(tài)反饋模塊完成。為優(yōu)化程序結(jié)構(gòu),所有程序采用層次化編程思路,多文件功能配合編寫和實(shí)現(xiàn)。功能模塊描述核心主模塊此模塊是整個(gè)程序的中心,核心主模塊負(fù)責(zé)協(xié)調(diào)和溝通其他各個(gè)功能模塊之間的配合,是各個(gè)模塊交互的紐帶。參數(shù)讀寫模塊此模塊負(fù)責(zé)設(shè)備運(yùn)行參數(shù)的讀寫功能,不但包括調(diào)試時(shí)的各個(gè)具體參數(shù)的設(shè)置調(diào)試,也包括此設(shè)備整套運(yùn)行參數(shù)的保存和讀取,為了方便用戶使用,一共設(shè)置了2套參數(shù),分別為出廠參數(shù)表和用戶參數(shù)表,參數(shù)表格內(nèi)容相同而參數(shù)值不同。出廠參數(shù)為自己工廠的出廠調(diào)試人員調(diào)試完成后保存的參數(shù)列表,用戶參數(shù)為客戶拿到設(shè)備后根據(jù)實(shí)際使用情況可能調(diào)整部分參數(shù)值后的參數(shù)表,更加適用于具體的使用場景。默認(rèn)的用戶參數(shù)表與出廠參數(shù)表是一致的,使用用戶賬戶登錄后僅可以對用戶參數(shù)表進(jìn)行操作,使用調(diào)試賬戶登錄后可以對出廠參數(shù)表進(jìn)行操作。后附參數(shù)保存列表。賬戶管理模塊此模塊負(fù)責(zé)賬戶的修改、登錄、注銷等操作,主要有用戶賬戶和調(diào)試賬戶兩個(gè)賬戶,此軟件開啟時(shí)默認(rèn)是用戶賬戶登錄,用戶賬戶僅可以對用戶參數(shù)進(jìn)行修改,調(diào)試參數(shù)登錄后可以對部分高級(jí)參數(shù)進(jìn)行設(shè)置修改。用戶賬戶無密碼保護(hù),調(diào)試賬戶有密碼保護(hù),登錄調(diào)試賬戶時(shí)需要輸入正確的密碼后才能進(jìn)入。協(xié)議封裝模塊此模塊是整個(gè)程序通訊的基礎(chǔ),PC調(diào)試軟件與電機(jī)驅(qū)動(dòng)控制板之間的通訊為串口通訊方式。通訊需要按照一定格式的協(xié)議匹配進(jìn)行,所有的通訊數(shù)據(jù)都通過該模塊進(jìn)行封裝后逐字節(jié)按位依次發(fā)送和接收。該模塊還完成通訊參數(shù)的配置,主要有以下參數(shù)需要配置:波特率、數(shù)據(jù)位、停止位和奇偶校驗(yàn)。同時(shí)為了確保PC調(diào)試軟件與電機(jī)驅(qū)動(dòng)控制板之間進(jìn)行可靠的通訊,兩端需要約定匹配的參數(shù)組。此模塊按照不同的使用目的和用途進(jìn)行分類協(xié)議封裝定義。后附協(xié)議封裝的分類和格式規(guī)約。輔助通訊模塊此模塊負(fù)責(zé)協(xié)調(diào)應(yīng)用層和驅(qū)動(dòng)層的通訊接口,建立內(nèi)部重發(fā)機(jī)制,發(fā)送控制指令或者查詢指令后如果在一定時(shí)間內(nèi)未收到正確的響應(yīng),則進(jìn)行指令重發(fā)。輔助通訊模塊自動(dòng)記錄連續(xù)通訊失敗次數(shù),通訊成功時(shí),連續(xù)失敗次數(shù)清零重新計(jì)數(shù),當(dāng)通訊失敗次數(shù)達(dá)到3次時(shí)才會(huì)真正觸發(fā)通訊失敗故障。用戶通過軟件提示界面收到通訊失敗故障后需要進(jìn)行相關(guān)的通訊檢查,在排查并處理了故障后確認(rèn)故障,重新激活通訊連接?？刂浦噶畎l(fā)送模塊當(dāng)用戶從PC調(diào)試軟件進(jìn)行調(diào)試動(dòng)作時(shí),PC軟件會(huì)根據(jù)控制指令的不同,向?qū)?yīng)的控制指令通訊地址表中發(fā)送指令值,以達(dá)到把調(diào)試控制指令從PC機(jī)發(fā)送給電機(jī)驅(qū)動(dòng)控制器的目的,電機(jī)驅(qū)動(dòng)控制器接收到控制指令時(shí),根據(jù)協(xié)議格式進(jìn)行指令解析,然后再送至相應(yīng)的響應(yīng)程序進(jìn)行操作響應(yīng)。狀態(tài)反饋模塊當(dāng)PC調(diào)試軟件需要查詢設(shè)備狀態(tài)信息時(shí),狀態(tài)反饋模塊根據(jù)所查詢的不同參數(shù)的狀態(tài),向?qū)?yīng)的狀態(tài)反饋地址表發(fā)送查詢指令,電機(jī)驅(qū)動(dòng)控制器根據(jù)查詢反饋地址表從內(nèi)部狀態(tài)寄存器中調(diào)取反饋數(shù)據(jù)進(jìn)行反饋通訊幀的封裝和發(fā)送,以達(dá)到把反饋狀態(tài)從電機(jī)驅(qū)動(dòng)控制器讀取到PC調(diào)試軟件的目的。程序控制流程圖本章節(jié)主要描述和說明XXXXXX調(diào)試軟件各個(gè)功能模塊的控制流程,主要以程序控制流程圖的方式說明各部分功能的實(shí)現(xiàn)原理和流程處理方法。

上電初始化程序控制流程圖此流程圖描述XXXXXX調(diào)試軟件在上電加載時(shí)的初始化工作,實(shí)現(xiàn)上電的初始化設(shè)置和通訊串口的配置工作等。

通訊關(guān)閉程序控制流程圖此流程圖描述程序退出時(shí)的通訊關(guān)閉退出處理流程,主要完成通訊端口的關(guān)閉工作。

調(diào)試賬戶登錄程序控制流程圖此流程圖描述XXXXXX調(diào)試軟件調(diào)試高級(jí)賬戶登錄程序的處理過程,輸入正確的調(diào)試賬戶密碼后成功登錄,如果連續(xù)輸入密碼錯(cuò)誤達(dá)到3次,則登錄失敗,不允許再試,直到下次重新啟動(dòng)軟件。

調(diào)試賬戶修改密碼程序控制流程圖此流程圖描述XXXXXX調(diào)試軟件調(diào)試高級(jí)賬戶密碼修改程序的處理過程,輸入正確的舊密碼并且2遍新密碼一致后,密碼修改成功。如果連續(xù)輸入密碼錯(cuò)誤或2遍新密碼不一致達(dá)到3次,則修改失敗,不允許再試,直到下次重新啟動(dòng)軟件。

調(diào)試賬戶注銷程序控制流程圖此流程圖描述XXXXXX調(diào)試軟件調(diào)試高級(jí)賬戶注銷程序的處理過程,調(diào)試賬戶注銷后默認(rèn)登錄用戶賬戶,如果需要登錄調(diào)試賬戶的話,另外按照調(diào)試賬戶登錄程序執(zhí)行。

控制指令與參數(shù)寫入接口程序控制流程圖此流程圖描述XXXXXX軟件向電機(jī)驅(qū)動(dòng)控制器發(fā)送控制指令或者寫入?yún)?shù)時(shí)的處理過程,根據(jù)通訊地址列表寫入響應(yīng)的指令或者參數(shù)設(shè)置,其中涵蓋了通訊重發(fā)機(jī)制。狀態(tài)與參數(shù)讀取接口子程序控制流程圖此流程圖描述XXXXXX軟件從電機(jī)驅(qū)動(dòng)處理器讀取設(shè)備狀態(tài)和參數(shù)時(shí)的處理過程,根據(jù)通訊地址列表讀取對應(yīng)的狀態(tài)或者參數(shù)反饋值,其中涵蓋了通訊重發(fā)機(jī)制。協(xié)議封裝子程序控制流程圖此流程圖描述XXXXXX軟件通訊時(shí)的協(xié)議封裝的程序處理過程,規(guī)范了通訊雙方的通訊規(guī)約,保證了通訊的可靠正確實(shí)現(xiàn)。其中電機(jī)驅(qū)動(dòng)控制器的寫入和讀取與XXXXXX軟件的讀取和寫入相對應(yīng),兩者互為收發(fā)的關(guān)系。

通訊解析子程序控制流程圖此流程圖描述XXXXXX軟件接收通訊數(shù)據(jù)后的數(shù)據(jù)解析處理過程,用于解析電機(jī)驅(qū)動(dòng)控制器的數(shù)據(jù)應(yīng)答,包括了校驗(yàn)審核和數(shù)據(jù)分解對照拆分。

參數(shù)保存子程序控制流程圖此流程圖描述XXXXXX調(diào)試軟件本身的參數(shù)和密碼更新后的保存處理過程,參數(shù)保存至本機(jī)參數(shù)文檔,待下次重新上電時(shí)從參數(shù)文檔中讀取參數(shù)使用。

協(xié)議規(guī)約XXXXXX軟件與電機(jī)驅(qū)動(dòng)控制器之間需要按照約定的通訊協(xié)議規(guī)約進(jìn)行,PC下發(fā)設(shè)置或者查詢指令,需要驅(qū)動(dòng)控制器根據(jù)規(guī)約按照約定的格式進(jìn)行信息回復(fù),并增加CRC校驗(yàn),以便保證數(shù)據(jù)正確傳輸,XXXXXX軟件按照約定的協(xié)議規(guī)約進(jìn)行解析獲取數(shù)據(jù)。幀起始標(biāo)志幀控制應(yīng)用數(shù)據(jù)幀校驗(yàn)起始標(biāo)志幀類型會(huì)話計(jì)數(shù)幀長度分包編號(hào)總的包個(gè)數(shù)數(shù)據(jù)內(nèi)容CRC校驗(yàn)2Byte1Byte1Byte2Byte2Byte2ByteNByte2Byte起始標(biāo)志:起始標(biāo)志為2個(gè)0xFE。用于識(shí)別幀頭。幀類型:F1:寫入控制幀F(xiàn)2:讀取控制幀F(xiàn)3:寫入響應(yīng)幀F(xiàn)4:讀取響應(yīng)幀會(huì)話計(jì)數(shù):本次會(huì)話計(jì)數(shù),循環(huán)累加。當(dāng)傳輸?shù)氖强刂茙瑫r(shí),每一幀控制指令為一次會(huì)話。當(dāng)傳輸?shù)氖菙?shù)據(jù)幀時(shí),每一幀數(shù)據(jù)指令為一次會(huì)話。幀長度:當(dāng)前幀的字節(jié)數(shù)。分包編號(hào)：每次會(huì)話中的分包計(jì)數(shù),每一幀數(shù)據(jù)為一個(gè)分包。包的總個(gè)數(shù):當(dāng)前會(huì)畫的總分包個(gè)數(shù)。數(shù)據(jù)內(nèi)容:對于寫入控制幀:輸入內(nèi)容如下:寫入起始地址寫入數(shù)據(jù)個(gè)數(shù)寫入數(shù)據(jù)2Byte2ByteNByte對于讀取控制幀:內(nèi)容如下:讀取起始地址讀取數(shù)據(jù)個(gè)數(shù)2Byte2Byte寫入響應(yīng)幀寫入起始地址寫入數(shù)據(jù)個(gè)數(shù)2Byte2Byte讀取響應(yīng)幀讀取起始地址讀取起始個(gè)數(shù)讀取起始2Byte2ByteNByte串行通訊地址表本章節(jié)主要描述和說明XXXXXX調(diào)試軟件與電機(jī)驅(qū)動(dòng)控制器之間的串行通訊地址表,控制指令、參數(shù)等信息均采用此表格通訊地址協(xié)議進(jìn)行交互。地址寄存器名稱讀寫功能說明備注0x1001啟停調(diào)試控制寄存器R/W0:停止指令

1:啟動(dòng)指令0x1002參數(shù)讀取控制寄存器R/W0:無指令

1:讀取參數(shù)指令0x1003參數(shù)保存控制寄存器R/W0:無指令

1:保存參數(shù)指令0x1004通訊波特率設(shè)定R/W設(shè)定串口通訊的波特率,默認(rèn)=1

0：4800

1：9600

2：19200

3：38400

4：57600

5：1152000x1005~0x1007輸入電壓校準(zhǔn)系數(shù)設(shè)定R/W電機(jī)輸入電壓校準(zhǔn)系數(shù)K設(shè)定值,用于校準(zhǔn)參數(shù)0x1008~0x100A輸入電壓校準(zhǔn)偏移量設(shè)定R/W電機(jī)輸入電壓校準(zhǔn)偏移量offset設(shè)定值,用于校準(zhǔn)參數(shù)0x100B~0x100D輸出電壓校準(zhǔn)系數(shù)設(shè)定R/W電機(jī)輸出電壓校準(zhǔn)系數(shù)K設(shè)定值,用于校準(zhǔn)參數(shù)0x1011~0x1013輸出電壓校準(zhǔn)偏移量設(shè)定R/W電機(jī)輸出電壓校準(zhǔn)偏移量offset設(shè)定值,用于校準(zhǔn)參數(shù)0x1014~0x1016輸入電流校準(zhǔn)系數(shù)設(shè)定R/W電機(jī)輸入電流校準(zhǔn)系數(shù)K設(shè)定值,用于校準(zhǔn)參數(shù)0x1017~0x1019輸入電流校準(zhǔn)偏移量設(shè)定R/W電機(jī)輸入電流校準(zhǔn)偏移量offset設(shè)定值,用于校準(zhǔn)參數(shù)0x101A~0x101C輸出電流校準(zhǔn)系數(shù)設(shè)定R/W電機(jī)輸出電流校準(zhǔn)系數(shù)K設(shè)定值,用于校準(zhǔn)參數(shù)0x1021~0x1023輸出電流校準(zhǔn)偏移量設(shè)定R/W電機(jī)輸出電流校準(zhǔn)偏移量offset設(shè)定值,用于校準(zhǔn)參數(shù)0x1024~0x1026系統(tǒng)PID控制周期時(shí)間設(shè)定R/W設(shè)定系統(tǒng)PID控制的采樣周期時(shí)間,已達(dá)到靈活控制的目的0x1027~0x1029PID控制比例P調(diào)節(jié)設(shè)定R/W設(shè)定系統(tǒng)PID控制的比例調(diào)節(jié)系數(shù)Kp0x102A~0x102CPID控制積分I調(diào)節(jié)設(shè)定R/W設(shè)定系統(tǒng)PID控制的積分調(diào)節(jié)時(shí)間Ti0x1031~0x1033PID控制微分D調(diào)節(jié)設(shè)定R/W設(shè)定系統(tǒng)PID控制的微分調(diào)節(jié)時(shí)間Td0x1034~0x1036輸出PWM控制頻率設(shè)定R/W設(shè)定輸出PWM控制的脈沖頻率,單位(1KHz)

數(shù)據(jù)范圍1~10000x2001電機(jī)運(yùn)動(dòng)狀態(tài)反饋R0:停止待機(jī)狀態(tài)

1:正常運(yùn)行狀態(tài)

2:超載狀態(tài)0x2002負(fù)載檔位選擇反饋R5個(gè)選擇撥碼開關(guān)組成二進(jìn)制數(shù)0~31,分別對應(yīng)滿載工作的1/32~32/32負(fù)載選擇控制0x2003參數(shù)讀寫狀態(tài)反饋R0:無讀寫狀態(tài)

1:參數(shù)讀取中

2:參數(shù)讀取完成

3:參數(shù)讀取超時(shí)

4:參數(shù)寫入中

5:參數(shù)寫入完成

6:參數(shù)寫入超時(shí)0x2011~0x2013輸入電壓測量值R采樣濾波校準(zhǔn)后的輸入電壓測量反饋值0x2014~0x2016輸出電壓測量值R采樣濾波校準(zhǔn)后的輸出電壓測