twxstar/mqttx

MQTT X: Elegant Cross-platform MQTT 5.0 Desktop Client

English | 简体中文 | 日本語

---

MQTT X is a cross-platform MQTT 5.0 client tool open sourced by EMQ, which can run on macOS, Linux and Windows, and supports formatting MQTT payload.

MQTT X simplifies the operation logic of the page with the help of chatting software, makes it easy and quick to create multiple simultaneous online MQTT client connections, test the connection, publish, and subscribe functions of MQTT/TCP, MQTT/TLS, MQTT/WebSocket as well as other MQTT protocol features.

MQTT stands for MQ Telemetry Transport. It is a publish/subscribe, extremely simple and lightweight messaging protocol, designed for constrained devices and low-bandwidth, high-latency or unreliable networks.

Preview

Installation

Currently available for download from these app stores

macOS App Store

Homebrew

The macOS users can install MQTT X using brew cask

brew install --cask mqttx

Linux

Released Packages

Download from GitHub Releases and install it.

Alternative, you can download here.

Usage

See our blog or manual for details.

1. Get MQTT Broker Ready.

   • If you do not need to deploy the MQTT Broker locally, you can use the public MQTT 5.0 Broker provided by EMQX Cloud for testing:

     Broker IP: broker.emqx.io
     Broker TCP Port: 1883
     Broker SSL Port: 8883

   • To run MQTT Broker locally, EMQX is recommended: An Open-Source, Cloud-Native, Distributed MQTT Broker for IoT.

2. Connection configuration. Click the + button in the left menu bar and fill in the corresponding required fields in the form.

3. After the connection information is configured, click the Connect button in the upper right corner to create a connection and connect to MQTT Broker.

4. After the MQTT is connected successfully, you can perform MQTT publish and subscription tests.

Community

The MQTT X community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects.

To chat with other community members you can join the EMQX Slack or Discord.

Develop

Recommended version for Node environment:

• v14.*.*

# Clone
git clone [email protected]:emqx/MQTTX.git

# Install dependencies
cd MQTTX
yarn install

# Compiles and hot-reloads for development
yarn run electron:serve

# Compiles and minifies for production
yarn run electron:build

After the building is successful, the corresponding installation file for the successful build ing will appear in the dist_electron directory.

If you need to package it as an installation package for an independent operating system, please refer to the following command:

# For Windows
yarn run electron:build-win

# For Linux
yarn run electron:build-linux

# For macOS
yarn run electron:build-mac

Contributing

Please make sure to read the Contributing Guide before making a pull request.

Technology Stack

• Electron
• Vue + Element
• TypeScript
• TypeORM
• SQLite
• MQTT.js

License

Apache License 2.0, see LICENSE.