軟著設計說明書

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

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

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

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

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

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

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

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

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

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

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

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

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

0：4800

1：9600

2：19200

3：38400

4：57600

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

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

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

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

1:參數(shù)讀取中

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

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

4:參數(shù)寫入中

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

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