創建TouchGFX開發板配置
TouchGFX開發版配置 (TBS)是 .tpa
文件,定義了運行TouchGFX應用程式的平臺。 此方法適用於希望能夠將易於使用的 TBS 與運行在它們之上的 UI 程式碼的開發人員。 本文描述了如何使用內建工具tgfx.exe
,並將現有的TouchGFX專案封裝到可再分配的TBS中。 本文中的範例基於名為"MyApplication"的應用。
在擁有了功能完整的TouchGFX專案後,需執行下列步驟來創建TBS。
- 描述TouchGFX開發板設置呼叫
tgfx.exe
並編輯json檔(inherits from .touchgfx) - 創建TouchGFX開發板設置呼叫
tgfx.exe
以完成.tpa
- 測設& 驗證 導入設計程式,創建並驗證應用
描述TouchGFX開發板設置
tgfx.exe
工具生成設定檔(.json),該文件描述TBS的內部構件。 TouchGFX Designer讀取此資訊並將其呈現給用戶。 打開TouchGFX Environment 控制台,並在應用的 parent目錄中執行下列指令:
$ /d/TouchGFX/4.13.0/designer/tgfx.exe pack -d MyApplication
在運行指令的目錄中創建下列檔案:
在創建最終的.tpa
檔之前,在TouchGFX Designer中編輯MyApplication.json
,以便控制向使用者顯示TBS的方式。 使用者應編輯以下部分:
- 作者 使用 作者 部分中的欄位指定作者姓名、電子信箱和URL。
- 資料 使用 資料部分中的欄位指定TBS版本、圖片、開發板名稱、供應商、描述和詳細資訊連結。
MyApplication.json
...
"Author": [
{
"Name": "Chad Brody",
"Contact": "chad.brody@mycompany.com",
"URL": "http://mycompany.com/"
}
],
...
"Data": {
"Version": {
"Major": 1,
"Minor": 0,
"Build": 0
},
"Name": "MyApplication",
"HumanFriendlyName": "MyApplication",
"BoardName": "Custom STM32 Board",
"Type": "TGAT",
"Vendor": "MyCompany",
"Description": "This is a working project on which to base your UI on top of.",
"DocumentationLink": "",
"Category": "",
"Images": [
"http://mysite.com/MyCustomBoard-front.png",
"http://mysite.com/MyCustomBoard-back.png"
],
...
}
}
Tip
Tip
Tip
創建TouchGFX開發板設置
執行以下指令創建最終的“.tpa”檔,並確定TouchGFX開發板設置。
$ /d/TouchGFX/4.13.0/designer/tgfx.exe pack -rc -d MyApplication
測試& 驗證
為了驗證.tpa
檔能夠作為TBS被TouchGFX Designer讀取並用於創建新的應用,請執行下列步驟:
- 根據自己的要求重命名
.tpa
文件。 - 將
.tpa
檔複製或移動到C:\TouchGFX\4.13.0\app\packages
。 然後,用戶可以將TBS從本地資料夾導入TouchGFX Designer。
- 打開TouchGFX Designer,在By Partners 選項卡下選擇該TBS。
最終說明
下面一節包含在為TBS開發程式碼或分發TBS時要考慮的事項的提示。
一般提醒
一般情況下,在分發.tpa
之前應:
- 確保提供的所有IDE專案按預期正常工作。
- 刪除build-和generated資料夾,以便減少TBS的資料量。
- 確保在TouchGFX專案檔案
.touchgfx
中定義的自訂指令(PostGenerate-等)按預期正常工作。 - 確保TBS可以被TouchGFX Designer讀取並用於創建新的應用。
- 沒有一種直接的方式來指定TBS版本之間的升級流程。
Tip
在分發.tpa
後,應指示用戶將.tpa
檔複製到C:\TouchGFX\4.13.0\app\packages
中,並重啟TouchGFX Designer(若已打開)。
版本控制
開發者通常會將整個開發專案(開發板啟動搭建、TouchGFX AL和TouchGFX UI)保存在同一個存儲庫中,因此不需要可分發.tpa
文件。 但是,為了讓團隊成員能夠啟動新的TouchGFX應用,在進行測試和驗證時,統一的平臺程式碼會很有幫助。
如需通過分發.tpa
檔和/或使用工具(如repo
、git子模
)來模組化程式碼庫,最好按照前文所述.json
描述檔中指定的版本來命名TBS組件版本。 如果使用模組化方法,則platform程式碼在被用作主專案結構中的模組的同時,仍可用於創建可分發.tpa
文件。
"Data": {
"Version": {
"Major": 3,
"Minor": 0,
"Build": 0
},
$ git tag
v1.1.0
v2.0.0
v2.1.0
v3.0.0