MQTT X 桌面客戶端使用指南

在介紹和使用前,讀者可以訪問我們項目開源地址 (https://github.com/emqx/MQTTX) 瞭解並獲取到最新的版本信息,MQTT X 正在快速開發迭代階段,使用最新版本有助於提高使用體驗。

下 載

請從 GitHub Releases (https://github.com/emqx/MQTTX/releases) 下載符合您的版本並安裝使用。

MQTT Broker 準備

  • 如果您沒有本地部署的 MQTT Broker,那麼可以使用由 (https://cloud.emqx.io) 提供的公共 MQTT 服務進行快速測試:
<code>Broker 地址: broker.emqx.ioBroker TCP 端口: 1883Broker SSL 端口: 8883/<code>
  • 如果您打算本地部署 MQTT Broker,推薦您 下載 https://github.com/emqx/emqx/releases) 進行安裝使用。它是一款完全開源,高可用低時延的百萬級分佈式物聯網 MQTT 5.0 消息服務器。
  • 使用 Docker 快速安裝 EMQ X:
<code>docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx/<code>

連接配置

在準備好 MQTT Broker 後,進入到主程序頁面,可點擊左側菜單欄中的 + 號,如果頁面沒有數據,還可以直接點擊右側的 新建連接 按鈕,快速配置一個新的客戶端連接。

MQTT X 桌面客戶端使用指南


進入到創建頁面後,需配置或填寫連接客戶端的相關信息,讀者可以在此處配置定義 Broker 連接的所有設置,例如:Broker Host, Broker Port, Client ID , Username, Password, Clean Session 等基礎配置信息。

MQTT X 桌面客戶端使用指南


  1. Broker 信息配置 Broker 信息時,Client ID、Host 和 Port 已經默認填寫,您也可根據實際的 Broker 信息自行修改。點擊 Client ID 右側的刷新按鈕,可快速生成新的 Client ID。
  2. 用戶認證信息如果您的 Broker 開啟了用戶認證,配置項中可填寫 Username 和 Password 信息。
  3. SSL/TLS當需要開啟 SSL/TLS 認證時,只需要將配置中的 SSL/TLS 配置項設置為 true,並提供了 CA signed self 和 Self signed 兩種方式。如果選擇了 Self signed,可進行證書配置,點擊最右側的文件夾按鈕,選擇您已經生成好的各項證書,單向連接只需要選擇您的 CA File 即可,對於雙向認證,還需要選擇配置 Client Certificate File 和 Client key file。
  4. 高級配置高級配置中,可以配置 Connect Timeout、 KeepAlive、Clean Session、Auto Reconnect、MQTT Version 等信息。
  5. MQTT v5.0在高級配置中,可以選擇 MQTT 的協議版本,支持 MQTT v3.1.1 和 MQTT v5.0 版本,默認為 v3.1.1,如果選擇了 v5.0 版本後,還可配置 Session Expiry Interval、Receive Maximum(可選)。
  6. 遺囑消息在高級配置下方的配置卡片中,可以配置遺囑消息,Last-Will-QoS 和 Last-Will-Retain 的值默認填充為 0 和 False,輸入 Last-Will-Topic 和 Last-Will-Payload 的值便可完成對遺囑消息的配置。

發 布

連接創建成功後,即可進入到連接的主界面,點擊頂部連接名稱旁的摺疊按鈕,可以展開並顯示該配置的幾個基礎信息,快速修改該連接的常用配置,修改時需斷開連接,重新點擊連接後即可生效。在斷開連接的狀態下,也可點擊右邊配置按鈕,進行更多的連接配置修改。

連接建立後,可以在連接主頁面的下方的輸入框內,簡單輸入 Topic 和 Payload 後,點擊右下角按鈕,發送測試消息了。macOS 用戶可以使用 command + enter 快捷鍵,其它用戶可以使用 control + enter 快捷鍵來快速發送消息。

MQTT X 桌面客戶端使用指南


訂 閱

點擊左下角的 New Subscription 按鈕,可以快速訂閱一個 Topic,Topic 訂閱成功後將立即開始接受消息。

每個 Topic 都會隨機分配一個色彩標記,你也可以打開顏色選擇器自定義標記的顏色。點擊頁面訂閱列表頂部的最右側的按鈕,可以隱藏訂閱列表以顯示更多的空間。

鼠標懸浮到 Topic 列表的卡片上時,點擊右上角紅色按鈕,可以快速取消訂閱。

我們再新建一個測試連接用於消息發佈測試。在頁面右下角填入剛才所訂閱的 Topic 信息,輸入 Payload 的內容後,點擊最右側的發送按鈕,就向訂閱了該 Topic 的連接客戶端發送了一條消息。

MQTT X 桌面客戶端使用指南

MQTT X 桌面客戶端使用指南

如果發送消息的連接客戶端也訂閱了相同的 topic ,發送成功後該客戶端也將即時接收到剛才所發送的消息。注意,在消息框內,右邊欄為發送的消息。左邊欄為接收到的消息。


其 它

  1. 設置點擊左側菜單欄底部的設置按鈕,或使用快捷鍵,macOS 用戶可以使用 command + , 快捷鍵,其它用戶可以使用 control + , 快捷鍵來跳轉到設置頁面。目前支持設置語言,是否自動檢查更新和選擇主題。
  2. 消息頁面的下拉菜單在消息欄右上角的 All,Received, Published 按鈕可以過濾出 全部消息,已接收的消息,和已發佈的消息。點擊頂部的操作欄按鈕,選擇 Search by Topic 項,或使用快捷鍵,macOS 用戶可以使用 command + f 快捷鍵,其它用戶可以使用 control + f 快捷鍵,打開按 Topic 搜索過濾消息的的功能。選擇 Clear Histroy 項,可以快速清空當前連接中所有發送和接收的消息。選擇 Disconnect 和 Delete Connection 項,可以快速斷開連接,刪除當前連接。
  3. 檢查更新點擊左側底部的 i 按鈕,可進入到 About 頁面,瞭解 MQTT X 的版本信息。點擊 Check for Updates 可以檢查是否有更新版本。
MQTT X 桌面客戶端使用指南

以上為 MQTT X 使用方法的簡單概述。讀者可以通過在 GitHub 上的 使用手冊 (https://github.com/emqx/MQTTX/blob/master/docs/manual.md) 來完整的使用 MQTT X。

本項目基於 Apache 2.0 開源協議,使用過程中,有任何問題都可以到 GitHub issues (https://github.com/emqx/MQTTX/issues) 來發表問題,討論觀點或是向我們提交 PR,我們會認真查閱並回復所有問題。


分享到:


相關文章: