LabVIEW VIPM 工具包封裝教程

1. VIPM簡介
VI Package Manager(VIPM)是一個JKI組織開發(fā)的,對LabVIEW工具包進行搜索、創(chuàng)建、共享的包管理工具。對應(yīng)LabVIEW開發(fā)工程師來說,到VIPM里搜索和安裝工具包是一個必備技能,一些非常常用的工具包,如OpenG Library等都是通過VIPM進行發(fā)布和管理的。
本教程主要講解如何利用VIPM來打包自己寫的工具,以方便分享,或安裝到其他電腦中進行使用。

2. 打開 Open VI Package Builder
通過左上角

圖標,可以打開?Open VI Package Builder
?窗口,如下圖:

?該界面可通過?Create New
?按鈕創(chuàng)建新的打包項目,也可通過?Open Existing
?按鈕打開已保存的打包項目文件(*.vipb)。同時也支持直接雙擊下方列表的近期項目來直接打開打包項目文件。
下面,本教程將以個人項目?CLAN Tools - Common
?為例子,一步一步進行工具包打包操作。
3. CLAN Tools - Common項目打包
3.1. 項目結(jié)構(gòu)
Common項目包含用于前面板的控件和用于后面板的函數(shù)模塊,整個項目樹結(jié)構(gòu)如下:

?
3.2. 創(chuàng)建VI Package Builder項目文件
點擊?VI Package Builder
?中的?Create New
?按鈕后,如下圖,填入對應(yīng)的項目信息,并點擊?Finish
?按鈕。

?Source Directory
?- 工具包源路徑
Product Name
?- 工具包名稱Company Name
?- 公司/組織名稱
3.3. 配置VI Package Builder項目文件
項目文件配置主界面:

?基本配置:
Build Information
?- 構(gòu)建信息Display Informtion
?- 顯示信息Description
?- 項目簡介Palettes
?- 選板配置Destinations
?- 目標路徑配置Source File Settings
?- 源文件配置
高級配置:
Package Dependencies
?- 工具包依賴Licensing & Activation
?- 授權(quán)和激活Install Requirements
?- 安裝環(huán)境要求Incompatible Packages
?- 不兼容工具包配置Custom Actions
?- 安裝/卸載的前/后操作Pre/Post Build Actions
?- 構(gòu)建前/后操作Package Filname
?- 工具包文件名
3.3.1.?Build Information
?- 構(gòu)建信息
如上圖所示:
Source Directory
?:選擇源文件目錄Build Output Directory
?:選擇構(gòu)建打包文件輸出目錄Version Number of Next Build
?:生成的工具包版本號(構(gòu)建后會自動遞增,無需手動修改)Release Notes / Change Log
?:發(fā)布說明/修改記錄,主要是記錄該版本的修改發(fā)布說明
3.3.2.?Display Informtion
?- 顯示信息

?如上圖所示,該頁面信息主要顯示在工具包安裝頁面上。
Product Name
?:工具包名稱Product Icon
?:工具包圖標,右擊圖標彈出菜單,可選擇編輯、導(dǎo)入和自動生成圖標。其他信息:其他如公司名稱、版權(quán)信息、作者名稱、許可證等等
3.3.3.?Description
?- 項目簡介

如上圖所示,該頁面主要填寫工具包的詳細介紹,支持?<b></b>
?(粗體)、<s></s>
?(刪除線)、<i></i>
(斜體) 、<u></u>
?(下劃線)、<font=[FontName]></font>
?(設(shè)置字體)、<size=[SizeNo]></size>
?(設(shè)置字號)、<color=[ColorName or ColorHex]></color>
?(設(shè)置顏色)等富文本標簽。
3.3.4.?Palettes
?- 選板配置

如上圖所示,該頁面主要用于配置前面板或程序框圖的控件和函數(shù)選板。
Palette Set
?:選板配置,默認為Default,可根據(jù)需要建立不同的選板配置。Custom Category
?:自定義類別。勾選后,該類別作為頂層一級分類置于選板中。為了方便使用和維護,建議勾選該選項。Palette Defaults
?:選板默認配置。Apply Short Names to VI Titles
?勾選后,將會把選板設(shè)置的Short Name作為VI Title,應(yīng)用到VI中。Add Palette to Library or Class
?勾選后并選擇庫文件或類文件后,會把該選板配置以文件形式添加到庫或類中。Functions Palette
?&?Controls Palette
?:位于程序框圖的函數(shù)選板 & 位于前面板的控件選板。如勾選了自定義類別,則該分類作為二級分類置于選板中。如不勾選自定義類別,則該分類作為一級分類至于選板中。點擊選板圖標,可以進入下一級選板分類
VIPM默認以源文件目錄為根目錄,自動按文件夾對選板進行歸類。其中,以下橫線?
_
?為文件名首字符的文件不作歸類。(LabVIEW約定俗成,以下橫線為文件名首字符的VI/CTL為私有子VI,所有菜單、選板等均不納入歸類)所有vi文件放置于函數(shù)選板,所有ctl文件放置于控件選板。
右擊文件夾圖標彈出菜單,可選擇修改圖標、插入空格/空行/空列、重命名、修改幫助簡介、刪除等操作。也可通過左鍵拖動圖標進行位置排布。如下圖所示。

?
右擊VI圖標彈出菜單,也可通過勾選?
Place VI Contents
?,放置VI內(nèi)容(直接放置程序框圖中的內(nèi)容),而不是直接調(diào)用VI。通過該功能可把常用的框圖結(jié)構(gòu),做成模板,方便使用。如下圖所示。

?
選板編輯器與實際選板關(guān)系如下:

3.3.5.?Destinations
?- 目標路徑配置

如上圖所示,該頁面主要用于配置目標路徑,由VIPM自動根據(jù)項目生成,一般建議保持默認即可。如果需要增加自定義目標路徑,可點擊下方

按鈕進行添加。
?以下為常用目標路徑說明:
Toolkit VIs
?:工具包主路徑,打包的庫、函數(shù)、自定義控件均應(yīng)放置在該路徑中。Examples
?:例程路徑,放置在該路徑的VI可被?NI范例查找器
?檢索到。Custom Probes
?:自定義探針路徑,放置在該路徑的探針VI可通過自定義探針調(diào)用。Custom Errors
?:自定義錯誤路徑,放置在該路徑的自定義錯誤文件(.txt)可直接通過自定義錯誤調(diào)用。Tools Menu
?:工具菜單路徑,放置在該路徑中的VI,可直接在工具菜單中顯示和調(diào)用。QuickDrop Plugins
?:QuickDrop插件路徑,放置在該路徑的QuickDrop VI,可通過QuickDrop快捷鍵直接調(diào)用。
3.3.6.?Source File Settings
?- 源文件配置

如上圖所示,該頁面主要用于配置項目源文件的目標路徑。VIPM默認將整個項目源文件放置于?Toolkit VIs
?路徑中。
以下為常用選項說明:
Exclude From Package
?:打包時不包含。勾選該項后,在構(gòu)建打包文件時將不包含該文件/文件夾。Use Destination of Parent Folder
?:使用父文件夾的目標路徑。默認勾選該項,目標路徑遵循上一級路徑設(shè)置。如取消勾選該項,則可單獨對其設(shè)置目標路徑。Place Folder Contents in Destination
?:放置文件夾內(nèi)容到目標路徑。勾選該項后,將文件夾的內(nèi)容放置到目標路徑,而不是把該文件夾放置到目標路徑。(即勾選后實際目錄將少了一層)
3.3.7.?Package Dependencies
?- 工具包依賴

如上圖所示,該頁面主要用于設(shè)置工具包的依賴項。使其在安裝時自動搜索VIPM,如VIPM中沒有安裝該依賴項,則會進行自動安裝,以確保工具包可正常使用。
點擊下方

按鈕,即可彈出窗口添加依賴項。如下圖所示。

點擊下方

按鈕,即可彈出窗口,自動掃描項目使用到的外部依賴項。如下圖所示。點擊?
Continue
?按鈕后,則自動把勾選到的依賴項添加到依賴項列表中,同時會在構(gòu)建打包文件輸出目錄中生成一個依賴項工具包集合文件(.vipc),該文件已集合所勾選的依賴項,可離線安裝,無需從VIPM上在線下載安裝。
點擊下方
按鈕,即自動打開上一點生成的工具包集合文件進行編輯。如下圖所示。
3.3.8.?Licensing & Activation
?- 授權(quán)和激活
如上圖所示,該頁面主要用于設(shè)置工具包的授權(quán)和激活信息,該授權(quán)激活License需向VIPM社區(qū)申請,本教程略過。
3.3.9.?Install Requirements
?- 安裝環(huán)境要求
如上圖所示,該頁面主要用于設(shè)置工具包的安裝環(huán)境要求。一般保持默認即可。
3.3.10.?Incompatible Packages
?- 不兼容工具包配置
如上圖所示,該頁面主要用于設(shè)置工具包的不兼容項。如有不兼容項,則點擊下方
按鈕進行添加。?
3.3.11.?Custom Actions
?- 安裝/卸載的前/后操作
如上圖所示,該頁面主要用于配置安裝或卸載工具包的前/后操作。
Execute the following VI Before Package Install
?:工具包安裝前執(zhí)行該VIExecute the following VI After Package Install
?:工具包安裝后執(zhí)行該VIExecute the following VI Before Package Uninstall
?:工具包卸載前執(zhí)行該VIExecute the following VI After Package Uninstall
?:工具包卸載后執(zhí)行該VI
執(zhí)行VI有嚴格的接線板限制,如需使用該功能,可點擊?Generate VI
?按鈕生成標準執(zhí)行VI,對其進行修改。
3.3.12.?Pre/Post Build Actions
?- 構(gòu)建前/后操作
如上圖所示,該頁面主要用于配置構(gòu)建工具包的前/后操作。該頁面配置方式跟上一頁?安裝/卸載的前/后操作
?配置方式一致。
3.3.13.?Package Filname
?- 工具包文件名
如上圖所示,該頁面主要用于修改構(gòu)建生成的工具包文件名,建議保持默認即可,無需設(shè)置。
3.4. 構(gòu)建安裝包
點擊上方
按鈕,即可執(zhí)行構(gòu)建安裝包操作,如下圖所示。
4. 其他說明
4.1. VIPM文件說明
常見的VIPM文件有三種:
.vip
?:工具包安裝文件。就是通過VIPM打包出來的工具包安裝文件,已包含工具包源程序,可直接雙擊進行離線安裝。(實際上該文件為按照一定規(guī)則生成的.zip壓縮文件,有興趣的讀者可用解壓縮工具直接打開研究).vipb
?:工具包構(gòu)建項目文件。該文件保存了上述所有的各項配置信息。(實際上該文件為XML格式的文本文件,有興趣的讀者可直接使用記事本等文本編輯工具直接打開研究).vipc
:工具包安裝文件集合。該文件是包含了一些列的?.vip
?工具包安裝文件的文件集合,可雙擊直接進行批量離線安裝。建議讀者使用VIPM定期把自己常用的工具包打包成安裝文件集合來作備份。通過該備份文件,在配置新的LabVIEW開發(fā)環(huán)境時,可直接雙擊進行批量離線安裝,省時省力,也可確保版本的兼容性。(實際上該文件也是按照一定規(guī)則生成的.zip壓縮文件,有興趣的讀者可用解壓縮工具直接打開研究)
5. 勘誤
5.1. 20230110 - 初次發(fā)布
暫未發(fā)現(xiàn)紕漏。