Day 08 如何使用 SDK (Part 3)

ChameleonUltra 這個硬體目前還很新，所以難免會有不穩定或是不相容的情況，這時候如果我們能從除錯訊息中找到問題，就可以更快的解決。今天筆者打算來介紹如何開啟除錯訊息以及如何解讀除錯訊息。

打開除錯訊息

筆者有在這個專案中加入除錯訊息，如果你想要看到 SDK 的除錯訊息，你可以在初始化 Chameleon Ultra 時傳入 true 作為參數：

const ultra = new ChameleonUltra(true)

如果你是在 Node.js 的環境內，你還需要透過 DEBUG 環境變數來開啟除錯訊息：

DEBUG=ultra:* node index.js

如果你成功開啟除錯訊息後，你應該就會看到如下的畫面：

如果你是在瀏覽器中使用，你還需要在開發者工具的 Console 頁籤中輸入以下指令來開啟除錯訊息：

localStorage.debug = 'ultra:*'

然後可能還需要在開發者工具的 Console 頁籤上方，選擇顯示 Verbose 來看到除錯訊息。

如果你成功開啟除錯訊息後，你應該就會看到如下的畫面：

除錯訊息說明

筆者在這個專案內是使用 debug 這個套件來印出除錯訊息的，除錯訊息會分成三個部分，分別是「名稱空間」、「除錯訊息」、「間隔時間」，在 debug | npm 的文件上有更多相關的說明。

這個 SDK 會使用命名空間 ultra:send 來記錄發送給 ChameleonUltra 的十六進位資料，使用命名空間 ultra:resp 來記錄從 ChameleonUltra 所接收的十六進位資料，這兩種記錄的格式都是 SOF CMD STATUS LEN LRC2 DATA LRC3，筆者在接下來的文章中會詳細介紹 ChameleonUltra 所使用的指令格式，所以在此先快速帶過。

另外根據你所使用的 Adapter，也會有對應的記錄訊息，例如 ultra:serial 代表 SerialPort 所記錄的資料，他會在連線成功時記錄該硬體的資訊。

參考連結

• debug | npm