Touch Key Workshop v3.0 使用手冊 版本 : V.1.00 日期 : 2014-05-23 目录 目錄 第一章 開發平台簡介與軟體安裝 .......................................................................1 特性 ...........................................................................................................................................1 系統需求 ...................................................................................................................................1 系統配置 ...................................................................................................................................1 軟體安裝 ...................................................................................................................................2 第二章 Touch Key Workshop 軟體功能介紹與操作 .........................................5 軟體開發流程 ...........................................................................................................................5 快速開始 ...................................................................................................................................5 軟體功能說明 ...........................................................................................................................8 第三章 Touch Key Tuning 軟體功能介紹與操作 ............................................ 11 快速開始 .................................................................................................................................11 軟體功能說明 .........................................................................................................................12 第四章 元件製作 .................................................................................................16 元件系統檔製作工具 .............................................................................................................16 附錄 A ..................................................................................................................21 附錄 B ..................................................................................................................22 Rev. 1.00 i 2014-05-23 Touch Key Workshop v3.0 使用手册 第一章 開發平台簡介與軟體安裝 盛群 Touch Key Workshop V3 為第三代觸控按鍵開發平台，採用直覺式的拖曳方式設定完成專 案，該專案也可以當做進階使用者的框架 (framework ) 繼續開發自己的產品專案。平台內部整 合觸控函式庫、編譯功能與按鍵訊號監測與按鍵參數調整。 特性 ● 支援 BS82xxx, BS83xxx, BS84xxx Flash 系列 MCU ● 提供友善直覺的操作介面 ● 容易調整按鍵靈敏度與參數設定 ● 內建編譯器 ● 內建觸控與週邊元件函式庫 ● 開放進階使用者自行增加元件函式庫 系統需求 ● 具有 USB 埠的個人電腦 ● 作業系統：Microsoft Windows® XP 或更新的版本 系統配置 USB 10-pin connector e-IsoLink ● 軟體 ♦ Holtek Touch Key Workshop：MCU 按鍵設定、觸控參數設定、程式產生器與編譯功能 ♦ Holtek Touch Key Tuning：按鍵信號監控、按鍵靈敏度調整與觸控參數調整 ● 硬體 ♦ e-IsoLink：OCDS、ICP、資料傳輸 ♦ Target board：功能驗證 Rev. 1.00 1 2014-05-23 Touch Key Workshop v3.0 使用手册 軟體安裝 ● 步驟一 執行安裝程式後歡迎的對話框將會顯示如下圖，點擊 “Next” 執行安裝程序。 ● 步驟二 設定安裝路徑，預設的路徑是 “C:\Program Files\Holtek MCU Development Tools\Touch Key Workshop”，點擊 “Next” 繼續進行安裝。 Rev. 1.00 2 2014-05-23 Touch Key Workshop v3.0 使用手册 ● 步驟三 設定啟動功能表程式集路徑，預設路徑為 “Holtek MCU Development Tools\Holtek Touch Key Workshop” ，點擊 “Next” 繼續下一個安裝步驟。 ● 步驟四 若要在桌面增加捷徑可勾選 “Create a desktop icon” 。 Rev. 1.00 3 2014-05-23 Touch Key Workshop v3.0 使用手册 ● 步驟五 設定確認，若要修改設定可以點擊 “Back” 回到上一個步驟，點擊 “Install” 完成安裝程序。 ● 步驟六 安裝程式完成安裝後將出現如下圖之對話框，若勾選 “Launch Holtek Touch Key Workshop”， 點擊 “Finish” 安裝程式將結束並執行 “Touch Key Workshop”。 Rev. 1.00 4 2014-05-23 Touch Key Workshop v3.0 使用手册 第二章 Touch Key Workshop 軟體功能介紹與操作 軟體開發流程 一般使用者 基本設定 功能設定 輸入專案名稱 設定專案路徑 選擇MCU 設定按鍵 添加元件功能 調校1 完成 進階使用者 HT-IDE3000 完成 註：調校需要加入Scope元件 註：調校需要加入 Tuning 元件 快速開始 創建新專案 1. 在專案視窗裡的「專案名稱欄位」輸入專案名稱 2. 於「專案位置」欄位設定專案放置路徑，預設與 HT-IDE3000 之預設路徑相同。專案建立後 將在此目錄下新建一個與專案名稱相同的子目錄存放相關檔案 3. 選擇要開發的 MCU 4. 選擇觸控函式庫版本 註：若開啟介面時有舊專案可點擊 “New” 進行新專案建立 , 再按上述 1~4 步驟進行操作。 Rev. 1.00 5 2014-05-23 Touch Key Workshop v3.0 使用手册 加入按鍵與元件 ● 加入按鍵 方法 1：從工具箱拖曳 “KEY” 元件至 IC 腳位有標示 KEY 的位置如下： 放開滑鼠左鍵後將變成下圖狀態，則原先的 PB0 將從 I/O 變成按鍵功能。 方法 2：從工具箱拖曳 “KEY” 元件至下圖虛線處，則按鍵將從 KEY1, KEY2, …依序自動設 定。 ● 加入元件 從工具箱拖曳元件至上圖藍色虛線處即可。 Rev. 1.00 6 2014-05-23 Touch Key Workshop v3.0 使用手册 設定按鍵或元件之屬性 從工具箱拖曳按鍵或元件的同時屬性視窗將顯示出該按鍵或元件的屬性設定，如下圖為按鍵之 門檻值設定。如果屬性視窗是空白的狀態代表此元件沒有屬性需要設定。 變更按鍵或元件的腳位設定 直接從已設定好之紅色腳位拖曳至其他的 I/O 腳，拖曳時顏色將變成綠色，當顏色變成紅色即 完成設定（按鍵需要拖曳至有標示 KEYx 的腳位），如果拖曳至某跟腳位時顏色沒有轉換成紅 色表示無法變更至該腳。 例如要將 Scope 元件之 SDA 腳變更至 PC7 腳，只要直接拖曳 SDA 至 PC7 腳當顏色變成紅色即可。 Rev. 1.00 7 2014-05-23 Touch Key Workshop v3.0 使用手册 軟體功能說明 選單功能說明 ● New: 建立新的專案 ● Open: 開啟既有的專案 ● Save: 儲存目前編輯的專案 ● Build: 編譯專案 ♦ Download: 若勾選編譯成功後程式將會被下載到板子裡。下載時板子不可外接電源或電池 ♦ OCDS mode: 勾選後不可將元件的腳位設定到有標示 OCDSSDA 與 OCDSSCK 的腳位 ● HT-IDE3000: 進階使用者可調用 HT-IDE3000 繼續開發專案。執行後 Touch Key Workshop 將 自行關閉。若使用者的電腦無安裝 HT-IDE3000 則為反白狀態 ● Tuning: 調用 Touch Key Tuning 進行按鍵靈敏度與觸控參數調整。若無選用 TUNING 元件 (TUNING_IIC, TUNING_UART), 此欄為反白狀態。 ● Register e-Link: 註冊 e-Link。注意 e-Link 需要註冊才可使用。若已註冊則將為反白狀態 ● Upgrade e-Link F/W: 升級 e-IsoLink 韌體或將其他用途的 e-Link 變更為專供 Touch Key 使用的 e-Link 勾選 Toolbox, Properties, Global Options, Project, MCU Resource, Output, Help 顯現相對應的視窗。 Available Language: 選擇軟體顯示的語言。目前有繁體中文、簡體中文與英文供選擇。 Rev. 1.00 8 2014-05-23 Touch Key Workshop v3.0 使用手册 工具箱視窗（Toolbox） 提供按鍵或元件供使用者添加功能。 專案視窗（Project） Project Name : 輸入專案名稱。執行「儲存」後專案名稱就不能變更。 Project Location : 設定專案路徑。預設與 HT-IDE3000 預設值相同。執行「儲存」後專案路徑就 不能變更。 MCU : 選擇要開發的 MCU。 Touch Library Version : 選擇觸控函式庫版本。 MCU Configuration Options: 對於一般使用者 MCU option 不需要設定採用預設即可，若要變更 MCU option 設定請點擊下圖紅框進行變更。 Rev. 1.00 9 2014-05-23 Touch Key Workshop v3.0 使用手册 全域設定視窗（Global Options） 全域視窗提供觸控參數供使用者設定。觸控參數： 名稱 功能 範圍 Debounce Times 按鍵去抖設定 50ms~190ms Auto Calibration Period 自動校準時間設定 62.5ms~937.5ms High Sensitive 高感度設定 0= 一般感度 1= 高感度 ( 勾選 ) Maximum Key HoldTime 按鍵最長反應時間 Disable 4 sec~60 sec One Key Active 單鍵輸出設定 0= 關閉 1= 開啟 ( 勾選 ) Fast Response 註 1 快速反應設定 0= 關閉 1= 開啟 ( 勾選 ) Auto Frequency Hopping 註 1 自動跳頻設定 0= 關閉 1= 開啟 ( 勾選 ) Power Save 註 1 省電功能設定 0= 關閉 1= 開啟 ( 勾選 ) Noise Protect 註 1 干擾保護設定 0= 關閉 1= 開啟 ( 勾選 ) Moving Calibration 註 1 動態校正設定 0= 關閉 1= 開啟 ( 勾選 ) 註：1. 需要選擇進階模式 (Advance Mode)。 2. 選項會依據觸控函式庫版本而有所差異。 屬性視窗（Properties） 拖曳元件時可順便到屬性視窗設定屬性或點擊已加入的元件更換該元件屬性，如果某元件不需 要額外設定則屬性視窗是空白的狀態。按鍵的屬性設定如下： 按鍵觸發門檻值（Threshold） : 範圍為 8 ~ 255，若勾選 “Apply all key” 後調整門檻值時將一 併調整其他按鍵之門檻值。 Rev. 1.00 10 2014-05-23 Touch Key Workshop v3.0 使用手册 第三章 Touch Key Tuning 軟體功能介紹與操作 Touch Key Tuning 為按鍵調校軟體，提供使用者觀察按鍵訊號軟體介面並提供按鍵靈敏度調整 與觸控參數調整。使用者調整後可以立即觀察到結果。Tuning 軟體除了可以透過 Holtek Touch Key Workshop 調用外也可以單獨執行。 快速開始 啟動 Touch Key Tuning ● 透過 Touch Key Workshop 調用後 Tuning 軟體的選單畫面。 ● 從啟動功能表調用後之軟體選單畫面如下，需要先選擇目標板 (Target board) 與 e-IsoLink 的傳 輸協定，可在軟體的「協定 (Protocol)」設定 ( 預設的協定為 IIC) 再選擇供應給目標板的電源。 Rev. 1.00 11 2014-05-23 Touch Key Workshop v3.0 使用手册 軟體功能說明 2 3 1 4 1. 按鍵訊號觀察區 2. 調校視窗 (Tuner Window) 3. 全域視窗 (Global Option Window) 4. 示波器 (Scope Window) Rev. 1.00 12 2014-05-23 Touch Key Workshop v3.0 使用手册 按鍵訊號觀察區 從按鍵訊號觀察區內可觀察目標板的腳位被定義為按鍵或 I/O 腳。若為 I/O 腳則顯示為灰色， 如下圖所示。若為腳位為按鍵使用者可以用滑鼠點擊切換調校視窗要觀察的按鍵。 按鍵狀態顯示 偵測到的實際差值顯示在下圖綠色裡，差值越大綠色區域越多。 當按鍵被判斷為已按下狀態則顯示為紅色，如下圖代表 KEY1 已經被按下表示程式裡的按鍵旗 標成立。 按鍵圖示之數值顯示說明，如下圖 按鍵編號 補償電容 原始信號 觸發門檻 背景信號 Rev. 1.00 13 2014-05-23 Touch Key Workshop v3.0 使用手册 調校視窗 (Tuning Window) 調校視窗可以觀察單一按鍵的信號值並可調整按鍵的靈敏度。 切換要調校的按 鍵 按鍵被判定按下 之次數 調校時間 重置時間與次數 按鍵實際差值 滑鼠拖曳調整按 鍵靈敏度 8~255 全域選項視窗 (Global Option Window) 全域選項視窗提供觸控參數供使用者變更，設定後可立即觀察到調整後的結果。觸控參數請參 考第二章說明。 示波器 (Scope Window) 示波器可以顯示按鍵的訊號值，使用者可以勾選示波器右側清單選擇要觀察哪些按鍵的波形。 功能說明： ● 自動調整範圍 (Auto scale): 勾選讓軟體自動判定 Y 軸顯示範圍，否則需要設定顯示的上下限 ● 開始／停止 (Start/Stop): 啟動或停止示波器的顯示 ● 重置 (Reset): 清除波形與重設調校視窗的按鍵次數與時間 Rev. 1.00 14 2014-05-23 Touch Key Workshop v3.0 使用手册 選單功能說明 ● 開新檔案 (New): 建立新的 Touch Key Workshop 專案檔 ● 開啟舊檔 (Open): 開啟 Touch Key Workshop 專案檔 ● 儲存到 INC/H (Save to INC/H): 觸控設定輸出到 HXT_REFERENCE.inc ● 註冊 e-Link (Register e-Link): e-Link 使用前必須註冊，若為反白狀態則表示 e-Link 已被註冊 ● 升級韌體 (Upgrade firmware): 升級 e-IsoLink 韌體或對非 Touch Key 用途的 e-Link 進行用途變 更 ● 電源 (Power): 設定 e-IsoLink 提供給目標板的電源。有 5V、3.3V 或外部供電選擇 ● 協定 (Protocol): 選擇目標板與 e-IsoLink 間的通訊協定，有 IIC 與 UART 兩種。若使用者在 Touch Key Workshop 中選擇 “TUNING_IIC” 元件則使用的協定為 IIC；如果選擇 “TUNING_ UART” 元件則使用的協定為 UART Rev. 1.00 15 2014-05-23 Touch Key Workshop v3.0 使用手册 第四章 元件製作 Touch Key Workshop 為開放性平台，進階使用者可以自行製作元件函式庫，該元件也可以分享 給其他使用者使用。 元件系統檔製作工具 元件製作需先製作系統檔。系統檔描述元件的功能與元件使用的代碼檔案，使用者可從啟動功 能表程式集執行 “Component Library System File Maker”將元件系統檔製作工具調用起來。 Rev. 1.00 16 2014-05-23 Touch Key Workshop v3.0 使用手册 製作工具使用說明 ● 步驟 1 – 腳位設定 ♦ 設定元件名稱，元件名稱將出現在 Touch Key Workshop 的工具箱 (Toolbox) 內 ♦ 指定元件函式庫放置路徑的資料夾名稱。資料夾內需要放置元件系統檔與相關的程式代碼 檔案與元件說明文件。其根目錄為平台安裝路徑下的 McuLibrary\Peripherals 目錄，例如平 台安裝路徑為 “C:\Program Files\Holtek MCU Development Tools\Touch Key Workshop” 則 資料夾要放置到 “C:\Program Files\Holtek MCU Development Tools\Touch Key Workshop\ McuLibrary\Peripherals” 裡 ♦ 「元件腳位設定」設定元件的腳位要與 MCU I/O 腳結合，這些設定也影響軟體的顯示。若 元件沒有腳位對應則不需要設定 ♦ 設定「元件腳位設定」完後，可以依序點擊至右側進行細部設定 Rev. 1.00 17 2014-05-23 Touch Key Workshop v3.0 使用手册 ● 步驟 2 – 全域選項 定義的數值 設定後軟體的顯示畫面如下圖。 Rev. 1.00 18 2014-05-23 Touch Key Workshop v3.0 使用手册 ● 步驟 3 – 函式庫 ♦ 選擇開發的程式語言 : C 語言或組合語言。C 語言的編譯器目前只能使用 V2 版 ♦ 在原始碼檔案裡面設定元件所要使用的元件程式碼檔案。「加入 HT-IDE3000 專案」若選 擇 “Yes” 等同於 HT-IDE3000 將檔案加到專案裡如下圖 ♦ 若原始碼檔案內容為空白，將在第一次執行「儲存」時產出以元件目錄名稱命名的 .C/.ASM、. AEX 與 .CEX 並且自動加入。例如：元件目錄設定為 “LEDX4_V10” 且開發語言選擇 “asm” 則將於元件目錄內產出 “LEDX4_V10.asm”, “LEDX4_V10.AEX” 與 “LEDX4_ V10.CEX” ♦ 元件需要設定支援的 MCU 請在 “Misc” 區域設定 MCU 名稱 ♦ 元件說明檔可以在「說明文件」區設定。說明文件檔案建議使用 PDF 檔建立並須放置在元 件函式庫放置路徑之資料夾內 Rev. 1.00 19 2014-05-23 Touch Key Workshop v3.0 使用手册 元件程式撰寫 ● 程式架構 : 使用者需要實作兩個副程式以元件名稱命名 ♦ < 元件名 >_INITIAL: 負責開機時元件的初始化工作 例如 LEDX4_V20_INITIAL。 ♦ < 元件名 >: 元件功能的程式進入點 例如 LEDX4_V20。 ● 檔名命名規則 : 檔名請命名與資料夾同名 ● 檔案架構 : 至少需要提供 3 種檔案，副檔名如下 : ♦ .C/.ASM: 放置元件的主程式。若開發語言為 C 則副檔名為 .C，若為組合語言則為 .ASM ♦ .AEX: 使用組合語言語法放置對外輸出的 label 例如 : EXTERN _LEDX4_V20_INITIAL:NEAR EXTERN _LEDX4_V20:NEAR ♦ .CEX: 使用 C 語言語法放置對外輸出的函式名 例如 : Rev. 1.00 extern void LEDX4_V20_INITIAL(); extern void LEDX4_V20(); 20 2014-05-23 Touch Key Workshop v3.0 使用手册 附錄 A e-IsoLink F/W 將會自動識別評估板使用的 MCU 類型自動定義 e-IsoLink 的腳位功能。如下兩種： (A) I2C Pin ICP OCDS 5 ICPDA O2D 6 ICPCK O2C 1 2 SDA 3 4 SCL 7 — — — 8 VDD VDD VDD 10 GND GND GND Pin I2C ICP SDA ICPDA SCL ICPCK 9 (B) 1 2 3 4 5 6 RESB 7 — — 8 VDD VDD GND GND 9 10 MCU 使用的腳位如下： Rev. 1.00 MCU 種類 BS82B16-3 (A) BS83A04A-3 (A) BS83A04A-4 (A) BS83B12-3 (B) BS83B12A-3 (A) BS83B12A-4 (A) BS83B16-3 (B) BS83B16A-3 (A) BS83B16A-4 (A) BS83C24-3 (B) BS84B08A-3 (A) BS84C12A-3 (A) 21 2014-05-23 Touch Key Workshop v3.0 使用手册 附錄 B 評估板底板使用注意事項： 評估板底板若接電池 , 在進行下載 ( 燒錄 ) 前或下載時不可以開啟電源否則會影響燒錄。評估板 底板接電池後啟動電源若無任何操作將於約 2 分鐘後自動關閉電源。 Rev. 1.00 22 2014-05-23 Touch Key Workshop v3.0 使用手册 Copyright© 2014 by HOLTEK SEMICONDUCTOR INC. The information appearing in this Data Sheet is believed to be accurate at the time of publication. However, Holtek assumes no responsibility arising from the use of the specifications described. The applications mentioned herein are used solely for the purpose of illustration and Holtek makes no warranty or representation that such applications will be suitable without further modification, nor recommends the use of its products for application that may present a risk to human life due to malfunction or otherwise. Holtek's products are not authorized for use as critical components in life support devices or systems. Holtek reserves the right to alter its products without prior notification. For the most up-to-date information, please visit our web site at http://www.holtek.com.tw. Rev. 1.00 23 2014-05-23