Skip to content

Commit

Permalink
Modify MQTT X to MQTTX
Browse files Browse the repository at this point in the history
  • Loading branch information
Swilder-M authored and ysfscream committed May 12, 2023
1 parent c148a72 commit ae8cb01
Show file tree
Hide file tree
Showing 144 changed files with 799 additions and 799 deletions.
14 changes: 7 additions & 7 deletions en/202002/mqtt-x-elegant-cross-platform-mqtt5-desktop-client.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
**MQTT X** is a cross-platform MQTT 5.0 desktop client open sourced by the world's leading open source IoT middleware provider [EMQ](https://github.com/emqx/emqx), which supports macOS, Linux, Windows. The user interface of **MQTT X** simplifies the operation logic of the page with the help of chatting software. The user can quickly create a connection to save and establish multiple connection clients at the same time. It is convenient for the user to quickly test the connection of MQTT/TCP、MQTT/TLS, Publish / Subscribe functions and other features .
**MQTTX** is a cross-platform MQTT 5.0 desktop client open sourced by the world's leading open source IoT middleware provider [EMQ](https://github.com/emqx/emqx), which supports macOS, Linux, Windows. The user interface of **MQTTX** simplifies the operation logic of the page with the help of chatting software. The user can quickly create a connection to save and establish multiple connection clients at the same time. It is convenient for the user to quickly test the connection of MQTT/TCP、MQTT/TLS, Publish / Subscribe functions and other features .

Project address: [GitHub](https://github.com/emqx/MQTTX)

Website: [MQTT X Website](https://mqttx.app)
Website: [MQTTX Website](https://mqttx.app)
![WX202002101233322x.png](https://assets.emqx.com/images/b0cfa74c62c6425e67c1547f4760f1a6.png)

MQTT X is suitable for users who are building their own MQTT message server to test connections, subscribing and publishing messages, etc. When using a client, the user can be either a publisher or a subscriber. It is also applicable to related users who are developing or researching MQTT Broker. In the research and application of MQTT, no matter what stage you are in, you can quickly and deeply understand the relevant characteristics of the [MQTT protocol](https://www.emqx.com/en/mqtt) through MQTT X.
MQTTX is suitable for users who are building their own MQTT message server to test connections, subscribing and publishing messages, etc. When using a client, the user can be either a publisher or a subscriber. It is also applicable to related users who are developing or researching MQTT Broker. In the research and application of MQTT, no matter what stage you are in, you can quickly and deeply understand the relevant characteristics of the [MQTT protocol](https://www.emqx.com/en/mqtt) through MQTTX.

This project is completely open source, which uses Vue.js + TypeScript + Electron technology stack for development. You can view and browse the project source code on [GitHub](https://github.com/emqx/MQTTX). Welcome to discuss and learn Electron project development technology together.

The following is a preview of the features and interface of MQTT X:
The following is a preview of the features and interface of MQTTX:

- Cross-platform, support Windows, macOS, Linux
- Fully support MQTT v3.1.1 and MQTT v5.0 protocols
Expand All @@ -24,13 +24,13 @@ The following is a preview of the features and interface of MQTT X:

![mqttxpreview.png](https://assets.emqx.com/images/c2ceb11b3c0eae3e421ad63ba721c148.png)

In the main window of MQTT X, the far left is the menu bar, which corresponds to the connection page, the about page, and the settings page from top to bottom; the middle column is the list of existing connections. After each connection is created, the new connection will appear in the list. User can click on the name in the list (composed of `name @ host: port`) to quickly switch the connection; The rightmost side is the main view interface of the connection, and you can test sending and receiving messages on this page. When the connection is successfully established, the top configuration bar will automatically collapse to show more page space.
In the main window of MQTTX, the far left is the menu bar, which corresponds to the connection page, the about page, and the settings page from top to bottom; the middle column is the list of existing connections. After each connection is created, the new connection will appear in the list. User can click on the name in the list (composed of `name @ host: port`) to quickly switch the connection; The rightmost side is the main view interface of the connection, and you can test sending and receiving messages on this page. When the connection is successfully established, the top configuration bar will automatically collapse to show more page space.

- MQTT X is a newly released product that uses Electron cross-platform technology, with beautiful interface and low resource occupation. MQTT X changes the common single client mode in interaction, allowing to save multiple connection information;
- MQTTX is a newly released product that uses Electron cross-platform technology, with beautiful interface and low resource occupation. MQTTX changes the common single client mode in interaction, allowing to save multiple connection information;
- It is easy to use, can quickly create connections, and provides a more comprehensive MQTT parameter configuration, so that users can respond to simulation test of any use scenario and pattern, including support for MQTT v5.0;
- It can send and receive messages in the form of message chat. The interaction process is simple and easy to understand. It allows multiple clients to connect at the same time and freely switch to communicate with each other. It has better interaction and greatly improves the efficiency of interactive debugging;
- It is fully open-source and supports multiple platforms.

![666.png](https://assets.emqx.com/images/336b2cd915c0e9ef8ebbe3467270ee76.png)

As of now, MQTT X has released the v1.2.3 version, and more features are still being developed.
As of now, MQTTX has released the v1.2.3 version, and more features are still being developed.
6 changes: 3 additions & 3 deletions en/202002/mqtt-x-guideline.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Before introduction and use, readers can visit our [GitHub](https://github.com/emqx/MQTTX) or [website](https://mqttx.app) to understand and get the information of latest version. MQTT X is undergoing rapid development and iterations, and the latest version will help improve the using experience.
Before introduction and use, readers can visit our [GitHub](https://github.com/emqx/MQTTX) or [website](https://mqttx.app) to understand and get the information of latest version. MQTTX is undergoing rapid development and iterations, and the latest version will help improve the using experience.

## Download

Expand Down Expand Up @@ -113,12 +113,12 @@ If the sending client also subscribes to the same `topic`, the client will immed

3. Check for updates

Click the `i` button on the left bottom to display the ` About` page to learn about the version of **MQTT X** and related information of [EMQX](https://www.emqx.com/en) . Click `Check for Updates` to check if there are newer versions.
Click the `i` button on the left bottom to display the ` About` page to learn about the version of **MQTTX** and related information of [EMQX](https://www.emqx.com/en) . Click `Check for Updates` to check if there are newer versions.

![mqttxupdate.png](https://assets.emqx.com/images/889ae0041b88ba2ac8f6fefc44a92fde.png)



The above is a brief overview of how to use MQTT X. Readers can use MQTT X entirety through the [manual](https://github.com/emqx/MQTTX/blob/main/docs/manual.md) on GitHub.
The above is a brief overview of how to use MQTTX. Readers can use MQTTX entirety through the [manual](https://github.com/emqx/MQTTX/blob/main/docs/manual.md) on GitHub.

This project is based on the Apache 2.0 open source protocol. In the process of using, you can go to [GitHub issues](https://github.com/emqx/MQTTX/issues) to submit issues, discuss opinions or submit PR to us. We will carefully review and respond to all questions.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[MQTT X](https://mqttx.app) is a cross-platform MQTT 5.0 desktop test client provided by the world's leading open source IoT middleware provider [EMQ](https://www.emqx.com/en) , which supports macOS, Linux, Windows. The user interface of **MQTT X** simplifies the operation logic of the page with the pattern of chatting software. Users can quickly create multiple simultaneous-online **MQTT clients** to test the connection/publish/subscribe functions of MQTT/TCP, MQTT/TLS, MQTT/WebSocket and other **MQTT protocol** features.
[MQTTX](https://mqttx.app) is a cross-platform MQTT 5.0 desktop test client provided by the world's leading open source IoT middleware provider [EMQ](https://www.emqx.com/en) , which supports macOS, Linux, Windows. The user interface of **MQTTX** simplifies the operation logic of the page with the pattern of chatting software. Users can quickly create multiple simultaneous-online **MQTT clients** to test the connection/publish/subscribe functions of MQTT/TCP, MQTT/TLS, MQTT/WebSocket and other **MQTT protocol** features.

MQTT X website: https://mqttx.app
MQTTX website: https://mqttx.app

MQTT X v1.3.0 download link: https://github.com/emqx/MQTTX/releases/tag/v1.3.0
MQTTX v1.3.0 download link: https://github.com/emqx/MQTTX/releases/tag/v1.3.0

![mqttxpreview.png](https://assets.emqx.com/images/d796340f0486ecccdada4a8e1962635b.png)

Expand Down Expand Up @@ -40,4 +40,4 @@ MQTT X v1.3.0 download link: https://github.com/emqx/MQTTX/releases/tag/v1.3.0

- Certificate selection is optimized , which supports to select more certificate format files.

This project is completely open sourced. If you have any questions during use, you can go to [GitHub](https://github.com/emqx/MQTTX/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to submit your questions and opinions, or Fork our MQTT X project, and submit the revised PR to us. We will carefully review and respond shortly.
This project is completely open sourced. If you have any questions during use, you can go to [GitHub](https://github.com/emqx/MQTTX/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to submit your questions and opinions, or Fork our MQTTX project, and submit the revised PR to us. We will carefully review and respond shortly.
4 changes: 2 additions & 2 deletions en/202005/esp8266-connects-to-the-public-mqtt-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this project, we will implement connecting ESP8266 to [free public MQTT broke

- ESP8266
- Arduino IDE
- [MQTT X](https://mqttx.app): Cross-platform MQTT 5.0 client tool
- [MQTTX](https://mqttx.app): Cross-platform MQTT 5.0 client tool
- The [free public MQTT broker](https://www.emqx.com/en/mqtt/public-mqtt5-broker)
- Broker: **broker.emqx.io**
- TCP Port: **1883**
Expand Down Expand Up @@ -184,7 +184,7 @@ In this project, we will implement connecting ESP8266 to [free public MQTT broke

![esp_con.png](https://assets.emqx.com/images/4c97b1546d31021cc22c64ae7ce4863b.png)

2. Establish the connection between the MQTT X client and the MQTT broker, and send messages to ESP8266
2. Establish the connection between the MQTTX client and the MQTT broker, and send messages to ESP8266

![mqttx_pub.png](https://assets.emqx.com/images/daa2c401453155045f2c068bcd57d66a.png)

Expand Down
8 changes: 4 additions & 4 deletions en/202005/mqttx-v-1-3-1-release-notes.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[MQTT X](https://mqttx.app/) is a cross-platform **MQTT 5.0** client tool open-sourced by [EMQ](https://www.emqx.com/en), supports macOS, Linux, Windows. The user interface of MQTT X simplifies the operating logic with the help of the chat software format. Users can quickly create multiple simultaneous online **MQTT client** to facilitate testing the connection/publishing/subscribing of MQTT / TCP, MQTT / TLS, MQTT / WebSocket, and other **MQTT protocol** features.
[MQTTX](https://mqttx.app/) is a cross-platform **MQTT 5.0** client tool open-sourced by [EMQ](https://www.emqx.com/en), supports macOS, Linux, Windows. The user interface of MQTTX simplifies the operating logic with the help of the chat software format. Users can quickly create multiple simultaneous online **MQTT client** to facilitate testing the connection/publishing/subscribing of MQTT / TCP, MQTT / TLS, MQTT / WebSocket, and other **MQTT protocol** features.

MQTT X website: [https://mqttx.app](https://mqttx.app/)
MQTTX website: [https://mqttx.app](https://mqttx.app/)

Download MQTT X v1.3.1: [https://github.com/emqx/MQTTX/releases/tag/v1.3.1](https://github.com/emqx/MQTTX/releases/tag/v1.3.1)
Download MQTTX v1.3.1: [https://github.com/emqx/MQTTX/releases/tag/v1.3.1](https://github.com/emqx/MQTTX/releases/tag/v1.3.1)



Expand Down Expand Up @@ -42,4 +42,4 @@ Download MQTT X v1.3.1: [https://github.com/emqx/MQTTX/releases/tag/v1.3.1](http



This project is completely open source, you can submit the problems you met when using it to [MQTT X GitHub](https://github.com/emqx/MQTTX/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc), or submit the modified PR to the project Fork MQTT X. We will view and deal with it in time.
This project is completely open source, you can submit the problems you met when using it to [MQTTX GitHub](https://github.com/emqx/MQTTX/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc), or submit the modified PR to the project Fork MQTTX. We will view and deal with it in time.
4 changes: 2 additions & 2 deletions en/202006/android-connects-mqtt-using-kotlin.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,9 @@ Firstly, you need to connect the Android client to the MQTT broker then subscrib

![MQTT connect and subscribe](https://assets.emqx.com/images/7711763b664ee9c6f0860b50bb0934c4.png)

We test with [MQTT 5.0 client tool - MQTT X](https://mqttx.app), publish messages to the topic: `a/b`, and then we can see the log of receiving messages on the client.
We test with [MQTT 5.0 client tool - MQTTX](https://mqttx.app), publish messages to the topic: `a/b`, and then we can see the log of receiving messages on the client.

![MQTT 5.0 Client Tool MQTT X](https://assets.emqx.com/images/041917427b461f7d633faf3ff205b69d.png)
![MQTT 5.0 Client Tool MQTTX](https://assets.emqx.com/images/041917427b461f7d633faf3ff205b69d.png)

![receive MQTT messages](https://assets.emqx.com/images/8451743b47f3e31fbb87377dcc0111d5.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,11 +147,11 @@ listener.ssl.external.certfile = etc/certs/emqx.crt

#### MQTT connection test

After finished configuring and restarted EMQX, we use [MQTT client tool - MQTT X](https://mqttx.app/) (this tool is cross-platform and supports [MQTT 5.0](https://www.emqx.com/en/mqtt/mqtt5)) to verify that whether TLS service is normally running.
After finished configuring and restarted EMQX, we use [MQTT client tool - MQTTX](https://mqttx.app/) (this tool is cross-platform and supports [MQTT 5.0](https://www.emqx.com/en/mqtt/mqtt5)) to verify that whether TLS service is normally running.

> The requirement of MQTT X version: v1.3.2 or higher version
> The requirement of MQTTX version: v1.3.2 or higher version
- Refer to the following picture to create `MQTT client` in the MQTT X ( `mqttx.app` in the Host input box need to be replaced by the real domain name)
- Refer to the following picture to create `MQTT client` in the MQTTX ( `mqttx.app` in the Host input box need to be replaced by the real domain name)

![mqttx-config-server](https://assets.emqx.com/images/f529c05296096c8dab1bf2f6682eda43.png)

Expand Down Expand Up @@ -226,9 +226,9 @@ listener.ssl.external.cacertfile = etc/certs/ca.pem

#### MQTT connection test (MQTTX)

After finished configuring and restarted EMQX, we use [MQTT client tool - MQTT X](https://mqttx.app) (this tool is cross-platform and supports [MQTT 5.0](https://www.emqx.com/en/mqtt/mqtt5)) to verify that whether TLS service is normally running.
After finished configuring and restarted EMQX, we use [MQTT client tool - MQTTX](https://mqttx.app) (this tool is cross-platform and supports [MQTT 5.0](https://www.emqx.com/en/mqtt/mqtt5)) to verify that whether TLS service is normally running.

- Refer to the following picture to create `MQTT client` in the MQTT X ( `127.0.0.1` in the Host input box need to be replaced by the real IP of EMQX broker)
- Refer to the following picture to create `MQTT client` in the MQTTX ( `127.0.0.1` in the Host input box need to be replaced by the real IP of EMQX broker)

![mqttx-config](https://assets.emqx.com/images/193bff6de2baeeb4fe4d0d0d21a9faf2.jpg)

Expand Down
6 changes: 3 additions & 3 deletions en/202007/enable-two-way-ssl-for-emqx.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,11 @@ listener.ssl.external.fail_if_no_peer_cert = true

### MQTT connection test

After finished configuring and restarted EMQX, we use [MQTT client tool - MQTT X](https://mqttx.app/) (this tool is cross-platform and supports [MQTT 5.0](https://www.emqx.com/en/mqtt/mqtt5)) to verify that whether TLS service is normally running.
After finished configuring and restarted EMQX, we use [MQTT client tool - MQTTX](https://mqttx.app/) (this tool is cross-platform and supports [MQTT 5.0](https://www.emqx.com/en/mqtt/mqtt5)) to verify that whether TLS service is normally running.

> The requirement of MQTT X version: v1.3.2 or higher version
> The requirement of MQTTX version: v1.3.2 or higher version
- Refer to the following picture to create `MQTT client` in the MQTT X (`127.0.0.1` in the Host input box need to be replaced by the real IP of EMQX broker)
- Refer to the following picture to create `MQTT client` in the MQTTX (`127.0.0.1` in the Host input box need to be replaced by the real IP of EMQX broker)

![mqttxconfig.png](https://assets.emqx.com/images/fc0bf47beab8f1b6b9e7d992c260e188.png)

Expand Down
4 changes: 2 additions & 2 deletions en/202007/using-mqtt-in-flutter.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ client.disconnect();

## Test

We write a simple UI interface for this project and use [MQTT 5.0 client tool - MQTT X](https://mqttx.app/) to do the following tests:
We write a simple UI interface for this project and use [MQTT 5.0 client tool - MQTTX](https://mqttx.app/) to do the following tests:

- connect

Expand All @@ -188,7 +188,7 @@ The interface of the application:

![画板1x.png](https://assets.emqx.com/images/4aeb38a0dc6b0329164a91fc38e572cc.png)

Use MQTT X as another client to send and receive messages:
Use MQTTX as another client to send and receive messages:

![mqttx_flutter.png](https://assets.emqx.com/images/b46731e7278ad148a0bfe3cc0890138b.png)

Expand Down
20 changes: 10 additions & 10 deletions en/202008/use-mqtt-with-raspberry-pi.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Calling function `publish()` can send messages to a topic. In the above code, we

## Test

We use [MQTT 5.0 client tool - MQTT X](https://mqttx.app) to do the following tests.
We use [MQTT 5.0 client tool - MQTTX](https://mqttx.app) to do the following tests.

### Test topic subscription

Expand All @@ -182,40 +182,40 @@ Run the Python code and actively send messages.
python3 subscriber.py
```

2. Use MQTT X client to connect to the MQTT broker and send messages to the topic `raspberry/topic`.
2. Use MQTTX client to connect to the MQTT broker and send messages to the topic `raspberry/topic`.

![MQTT X](https://assets.emqx.com/images/cc93d1c6d99f3bfa3a78d8472a6209af.jpg)
![MQTTX](https://assets.emqx.com/images/cc93d1c6d99f3bfa3a78d8472a6209af.jpg)

3. View the terminal information of Raspberry Pi, and you will see the messages published by MQTT X.
3. View the terminal information of Raspberry Pi, and you will see the messages published by MQTTX.


![mqtt subscriber](https://assets.emqx.com/images/9c4e5b191e9bd00317fed06f94b13850.png)

### Test publish message


1. Subscribe to the topic `raspberry/topic` in the MQTT X client.
1. Subscribe to the topic `raspberry/topic` in the MQTTX client.

2. Run Python code in the terminal.

![mqtt publisher](https://assets.emqx.com/images/9ea832adda032c9297c84fbf585fb294.png)

3. View the messages published by the Raspberry Pi in the MQTT X client.
3. View the messages published by the Raspberry Pi in the MQTTX client.

![MQTT X publish message](https://assets.emqx.com/images/07ffb81c764145100b1e21572357c675.jpg)
![MQTTX publish message](https://assets.emqx.com/images/07ffb81c764145100b1e21572357c675.jpg)

### Test the will message

Next, testing whether the will message, is set successfully.


1. Subscribe to `raspberry/status` in the MQTT X client.
1. Subscribe to `raspberry/status` in the MQTTX client.

![subscribe to mqtt topic in the MQTT X](https://assets.emqx.com/images/c704c8b0f7117079306d16b5af8c2557.jpg)
![subscribe to mqtt topic in the MQTTX](https://assets.emqx.com/images/c704c8b0f7117079306d16b5af8c2557.jpg)

2. Interrupt the program or disconnect the network of the Raspberry Pi.

3. View the messages that `raspberry/status` received, in the MQTT X client. ![receive mqtt message](https://assets.emqx.com/images/048da27682c9a86c536f85ffd6417bf2.jpg)
3. View the messages that `raspberry/status` received, in the MQTTX client. ![receive mqtt message](https://assets.emqx.com/images/048da27682c9a86c536f85ffd6417bf2.jpg)



Expand Down
Loading

0 comments on commit ae8cb01

Please sign in to comment.