Luatools新手必看：從下載開始的保姆級教程！

​

作為由合宙所提供的除錯工具，Luatools支援最新韌體獲取、韌體打包、trace列印、單機燒錄等功能

此工具適用於合宙所有 4G 模組和 4G + GNSS 模組。

一、下載和安裝

（一）執行環境要求

• 此工具執行於win7及以上系統;
• 不支援 Mac和 Linux。

（二）支援的模組型號

• Air724,
• 所有的 Air780 系列模組；
• 所有的 Air700 系列模組；
• Air201 系列模組；

（三）Luatools下載

點選下載：[Luatools v3 下載除錯工具]

（四）Luatools安裝

• 1. 工具下載後的檔名為：Luatools_v3.exe
• 1. 在win系統--D盤（或其他盤）推薦在根目錄下新建檔名，並重新命名為 Luatools，目錄太深可能會導致工具某些功能會出問題。
• 1. 將下載的Luatools_v3.exe複製或移動到新建的Luatools資料夾內 注意：若出現危險提醒，無需理會，繼續下載即可

​

• 1. 雙擊Luatools_v3.exe啟動程式， 關閉每日tips，點選開始後更新 注意：如果有殺軟攔截，請務必透過！！！務必透過！！！務必透過！！！

​

• 1. 更新完成後，Luatools資料夾內，會生成幾個新資料夾：

​

二、主要資料夾介紹

1， _temp 資料夾

臨時檔案

​

2. config 資料夾

對 Luatools_v3 進行的一些配置會存放到這個資料夾

​

3. log 資料夾

裡面存放有模組輸出的各種日誌資訊，當模組出現問題需要向合宙技術人員尋求技術支援的時候，就需要提交這個目錄下的檔案：

• 4gdiag 資料夾：ap和cp日誌
• ramdump 資料夾：當機dump檔案
• main_xxxxxx：模組輸出的除錯日誌
• trace_xxxxxx：Luatools工具輸出的日誌

​

4. resource 資料夾

合宙模組相關的AT韌體，LuaTask開發的Core底層韌體，Lib庫和demo指令碼

• aa_bb_lod 資料夾：aa表示晶片平臺，bb表示開發方式（at / lua）,比如 LuatOS_Air780E, AT_Air780EQ
• 8910_script 資料夾：Air724 模組的demo和Lib
• soc_script 資料夾：gitee Luatos 主倉庫更新的demo和Lib
• LuatOS_iRTU_bb：LuatOS_iRTU表示是iRTU開發方式，bb表示模組名稱

​

5. project 資料夾

使用專案管理後會自動生成這個目錄，用於管理下載專案

​

三、選單和介面介紹

1. 賬戶

• 登入

使用購買時銷售為你自動建立的erp賬號登陸，可以在合宙技術人員遠端支援客戶時協助抓取本機log

​

• 工具配置

點選Log，當配合技術人員抓取bug日誌時在此頁面開啟log功能，例如AP與CP日誌，若使用工具經常遇到藍色畫面，可先關閉底層日誌的抓取

​

• Exit：退出工具

2. LuatOS

2.1 程式碼除錯

對應各個模組的DEMO的gitee路徑

• Air780E模組gitee路徑： [Air780E]
• Air780EX模組gitee路徑：[Air780EX]
• Air724UG模組gitee路徑： [Air724UG]
• Air201模組gitee路徑：[Air201]
• Air780EPS模組gitee路徑：[Air780EPS]
• Air780EP模組gitee路徑：[Air780EP]

​

2.2 資源目錄

點選後進入對應資源所在目錄

​

2.3 韌體工具

 差分包製作工具，韌體指令碼合併工具，轉量產bin檔案工具，iot平臺賬號繫結工具 

​

• 差分包/整包升級包製作 可生成差分包或整包，用於FOTA遠端升級使用，由於部分模組不支援在該工具上生成，具體以各模組FOTA遠端升級例程上的要求為準。

  ​

  
• 韌體合併檔案工具：韌體合入bin檔案。
  對 Air780E，Air780EX 模組： 使用xxx.binpkg；
  對 Air780EP，Air780EPS，Air780EQ，Air700ECQ，Air201，Air700 模組： 使用xxx.soc；
  對 Air724 模組： 使用 xxx.pac

  ​

  

3，AT指令

3.1 韌體燒錄

 點選可以直接燒錄對應模組的AT最新韌體

​

 會彈出如下介面，點選下載後可以直接下載對應最新的AT韌體版本（AT詳細燒錄過程見下面AT韌體燒錄部分描述）

​

3.2 除錯工具

 - 內建簡約版本的串列埠除錯工具，選擇選單：

​

 - 選擇串列埠除錯工具後，會彈出如下介面：

​

4，資料和工具

​

4.1 Web工具

• 經緯度查詢和糾偏： [GPS-Offset]
• TCP/UDP WEB測試工具： [netlab.luatos.com]

4.2 合宙 IOT平臺

• FOTA遠端升級服務：[合宙雲平臺]
• ERP模組生產記錄： [合宙ERP系統]
• 合宙DTU管理平臺： [DTU管理系統]
• LBS基站定位服務： [基站定位]

​

4.3 資料

​

5， 幫助和支援

​

5.1 購買

​

5.2 幫助

​

6. 日誌列印視窗

​

- 支援4G模組USB（預設）列印和通用串列埠列印日誌 - 在非USB列印時，可選擇通用串列埠工具在windows裝置管理器對應的埠號，例如USB-TTL： 

​

- 開始/停止列印可以暫停文字區的自動滾動列印

清除列印可以清空文字區的列印日誌，但是不會刪除log資料夾下的檔案內容

7，模組狀態顯示視窗

• 啟動原因：模組開機原因
• 系統狀態：如果文字區中存在對應的日誌，這裡會顯示SIM卡、網路註冊等資訊
• 韌體版本：這裡僅僅顯示core的版本資訊，例如AT或者Luat的版本資訊，不顯示Lib和使用者指令碼的版本號
• 小區訊號：顯示模組接入主小區 RSRQ、RSRP、SNR 訊號值
• 訊號強度：這裡顯示GSM的訊號強度。訊號強度與卡是否欠費無關，不插卡也可以有訊號強度
• 當前網路：網路型別，例如 4G網路
• 軟體型別：這裡是指Core的型別，例如Luatask或者AT
• 小區ID：顯示模組接入主小區的cellid
• 資料連結：模組對應資料連結

  ​

  

8，下載韌體入口

• 除第二步點選選擇檔案後選擇韌體外，也可以直接拖動韌體至該介面
• 除AT韌體外，可根據自己需要選擇是否操作第三步，不需要可跳過第三步

  ​

  

9， 專案管理入口

詳細操作教程在第五章，[專案管理]

​

10，搜尋列印

透過關鍵詞搜尋可直接跳轉到與之相匹配內容行

​

11，底部連結

滑鼠懸停至視窗四個邊或四個角，可對視窗進行大小縮放

​

四、日誌檢視

（一）使用Luatools文字區檢視日誌

• Luatools 會自動識別USB的虛擬埠，並開啟虛擬埠，讀取日誌，並顯示出來；
• 當使用 USB 物理連線的話，務必要勾選 “4G模組USB列印”。

​

（二）使用文字器直接檢視log日誌

• Luatools 的日誌是 USB-TTL 或者 USB-VCOM 提供的，因此可能會獨佔串列埠
• 用文字器開啟 log的時候，注意生成的 Log 檔案時間，必要時，先關閉 Luatools 再使用文字器檢視日誌

​

​

五、專案管理

（一）建立專案

​

（二）輸入TestSocket，然後確定

​

（三）單擊 單擊TestSocket專案，在右側分別填入

• 底層Core：Lua開發的底層Core
• 增加指令碼或資原始檔：新增使用者指令碼、資料及Lib庫
• 預設USB列印trace，trace三個選項是用來選擇列印輸出方式的
• 新增預設lib：不建議勾選
• 升級檔案包含core：用於專案打包，可按需選擇
• 升級檔案包含指令碼：用於專案打包，建議直接勾選
• 升級檔案無資原始檔：用於專案打包，不選
• USB BOOT下載：使用Boot模式下載
• 下載指令碼：只下載指令碼列表中的資料
• 下載底層和指令碼：底層core和指令碼列表中的資料都下載
• 語法檢查：單獨檢查使用者編寫的指令碼有無語法錯誤

（四）注意，首次下載時，強烈建議直接下載底層和指令碼

六、韌體燒錄

（一）USB 韌體燒錄

首先USB連線PC，保持上電不開機狀態。

1，AT開發方式

​

• （1）點選下載韌體按鈕。
• （2）選中要下載的AT韌體
• （3）如果是開發板按住下載模式按鍵（boot 鍵）不放，同時再長按開機鍵開機，這時開發板會進入下載模式，Luatools下載進度條會開始跑，這時可以鬆開 boot 按鍵。直到工具提示下載完成。
• （4）如果是自己畫板，需要將模組boot引腳按照對應硬體手冊要求，拉高到對應電平，再按住boot按鍵，上電開機，這時板子會進入下載模式，Luatools下載進度條會開始跑，這時可以鬆開 boot 按鍵。直到工具提示下載完成。

2，LuatOS開發方式

​

• （1）在Luatools工具主介面點選"專案管理測試"
• （2）如果沒有新建過專案，需要先建立一個專案
• （3）選擇底層韌體 .soc檔案，或者其他字尾的韌體
• （4）新增指令碼以及資原始檔
• （5）勾選新增預設lib
• （6）如果模組是第一次還沒有燒錄過韌體，或韌體更換過，需要點選"下載韌體和指令碼"進行燒錄。如果韌體不需要更改，只有指令碼變動，只需要點選"下載指令碼"燒錄即可。
• （7）如果是開發板按住下載模式按鍵（boot 鍵）不放，同時再長按開機鍵開機，這時開發板會進入下載模式，Luatools下載進度條會開始跑，這時可以鬆開 boot 按鍵。直到工具提示下載完成。
• （8）如果是自己畫板，需要將模組boot引腳按照對應硬體手冊要求，拉高到對應電平，再按住boot按鍵，上電開機，這時板子會進入下載模式，Luatools下載進度條會開始跑，這時可以鬆開 boot 按鍵。直到工具提示下載完成。

如果，未能成功進入下載模式，而是進入正常開機模式，這時可以按住 boot 鍵，再短按復位按鍵，讓開發板重啟，重新進入下載模式。

如何判斷有沒有進入下載模式:可以透過 PC 端的裝置管理器中虛擬出來的 USB 斷開數量來判斷：

• 正常開機模式：

​

• 下載模式：

​

（二）影片燒錄教程

點選下方連結，觀看影片燒錄教程：

[Air780E燒錄教程]

（三）串列埠韌體燒錄

重要注意事項

• Cat.1模組只有780E/780EX/780EP/780EQ/700ECQ/780EPS/Air201,支援串列埠燒錄，
• 只能透過main_uart（uart1）串列埠進行燒錄，其他串列埠不行
• 使用串列埠燒錄的前提，是模組在正常工作，所以串列埠燒錄不能救磚。
• 救磚一定要用 USB + boot 的方式燒錄；
• AT開發模式下，如果 main_uart 可以透過115200波特率正常通訊AT指令，那麼可以不用重啟，只點選下載，模組會自動進入下載模式。
• LuatOS開發模式下，串列埠燒錄時需要重啟，才可進入下載模式。

1，AT開發模式

​

• (1)獲取對應模組的AT韌體 獲取方式（其一） ：中的resource資料夾
• (2)勾選通用串列埠列印
• (3)選擇對應的串列埠號
• (4)開啟串列埠
• (5)開始列印
• (6)點選下載韌體
• (7)點選選擇檔案，選擇對應的AT韌體
• (8)如果main_uart可以透過115200波特率正常通訊AT指令，點選下載，模組會自動進入下載模式。
• (9)如果不能通訊，請確保模組復位或者下上電透過main_uart 115200波特率可以看到"RDY"的URC上報（串列埠功能正常），隨後點選下載，如果模組沒有進入下載狀態，則按下復位或者重新上下電開機，則可以進入下載狀態。

2，LuatOS開發模式

​

​

七、AT 指令互動

開啟 AT 互動工具

Luatools 整合了一個精簡的 AT 指令互動工具。

點選 "2，AT指令"選單，選擇 “2.2 除錯工具->2.2.1 內建串列埠除錯工具(簡約)”

即可開啟串列埠互動工具。

如果模組裡面是 AT 的標準韌體的話， Luatools 會自動開啟模組的 AT 命令的串列埠，

併傳送幾條查詢指令給模組，如圖：

​

AT 命令互動

在彈出的串列埠工具框，可以輸入 AT 指令， 勾選 “增加換行”，點選傳送，

可以在 trace 介面，看到互動的 AT 命令的傳送和返回內容，如圖：

​