Skip to content

Commit

Permalink
docs(manual): update manual
Browse files Browse the repository at this point in the history
  • Loading branch information
ysfscream authored and 0721Betty committed Oct 19, 2020
1 parent 5055f9a commit 636416e
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 4 deletions.
Binary file added assets/mqttx-advance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/mqttx-connection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/mqttx-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/mqttx-theme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mqttx-topic-alias.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/mqttx-topic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 14 additions & 2 deletions docs/manual-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,12 @@ sudo snap install mqttx

点击左下角的 `New Subscription` 按钮,可以快速添加一个 `Topic`,每个 `Topic` 都可以用一种颜色标记,可以随机生成或打开颜色选择器选择。订阅列表顶部的最右侧的按钮,可以隐藏订阅列表,来显示页面更多的空间。添加完成后,点击订阅列表中已经订阅的 Topic 项,可以实现消息过滤,消息视图内将只显示订阅了当前主题的消息内容,再次点击即可取消过滤;也可直接点击其它已订阅的 Topic 项,查看其对应的消息内容。而点击 Topic 名称,即可快速复制当前的 Topic 信息。当需要向该 Topic 发送消息时,只需快速粘贴到消息栏的 Topic 输入框内进行修改,便可快速完成该操作。

在添加 `Topic` 时,可以给每个 Topic 设置一个别名,该选项为一个可选项,当设置并添加完成订阅后,订阅列表中的 `Topic` 数据将以别名展示,鼠标悬浮到 `Topic` 项时,提示框也会同时展示出该 `Topic` 的原值。这对于需要监控查看的多个 `Topic` 过长,无法分辩 `Topic` 的具体含义时,具有较强的帮助性。

![mqttx-topic](../assets/mqttx-topic.png)

![mqttx-topic-alias](../assets/mqttx-topic-alias.png)

3. 消息发送和接收

`Topic` 订阅成功后,就可以来测试消息的收发了。在页面右下角填入刚才所订阅的 `Topic` 信息,可选择 `QoS``Retain` 的值,输入 `payload` 后,点击最右侧的发送按钮,就向刚才订阅的 `Topic` 发送了一条消息。发送成功后,也可以即时接收到刚才所发送的消息。注意,在消息框内,右边栏为发送的消息。左边栏为接收到的消息。macOS 用户可以使用 `command + enter` 快捷键,其它用户可以使用 `control + enter` 快捷键来快速发送消息。
Expand All @@ -163,15 +167,23 @@ sudo snap install mqttx

### 设置

点击左侧菜单栏底部的设置按钮,或使用快捷键,macOS 用户可以使用 `command + ,` 快捷键,其它用户可以使用 `control + ,` 快捷键来跳转到设置页面,目前支持选择语言,开启是否自动检查更新和选择主题。
点击左侧菜单栏底部的设置按钮,或使用快捷键,macOS 用户可以使用 `command + ,` 快捷键,其它用户可以使用 `control + ,` 快捷键来跳转到设置页面,目前支持选择语言,开启是否自动检查更新和选择主题,还有高级功能中的数据备份和恢复功能

![mqttx-theme](../assets/mqttx-theme.png)

#### 数据管理

高级设置中包含了数据的备份与恢复功能。用户可选择两种导入导出的方式,也可以通过连接页面中的右上角菜单,或者在设置页面中的高级功能栏里。

在设置页面里可以在最下方的高级功能中,选择点击数据备份和数据恢复两个按钮。选择数据备份时,将导出所有的连接数据,包含所有收发到的消息等。选择数据恢复时,选择完导入文件的路径,确认后即可恢复数据。

![mqttx-advance](../assets/mqttx-advance.png)

### 其它

1. 连接操作

点击顶部的操作栏按钮,可以快速断开连接,删除当前连接等
点击顶部的操作栏按钮,可以快速断开连接,删除当前连接,当前数据导入导出等

![mqttx-connection](../assets/mqttx-connection.png)

Expand Down
16 changes: 14 additions & 2 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,12 @@ After the configuration is complete, click the `Connect` button in the upper rig

Click the `New Subscription` button in the lower left corner to quickly add a Topic. Each Topic can be marked with a color, which can be randomly generated or opened by the color selector. The rightmost button at the top of the subscription list can hide the subscription list to show more space on the page. After the addition is complete, click on the subscribed Topic items in the subscription list to achieve message filtering. The message view will only display the message content subscribed to the current topic. Click again to cancel the filter; You can also directly click other subscribed Topic items to view the corresponding message content. By clicking on the topic name, you can quickly copy the current topic information. When you need to send a message to this topic, you can quickly paste it into the topic input box of the message bar to modify it, and you can quickly complete the operation.

When adding `Topic`, you can set an alias for each Topic. This option is an optional. When the subscription is set and added, the `Topic` in the subscription list will be displayed as an alias, and the mouse over the `Topic` item, the prompt box will also display the original value of the `Topic`. This is very helpful when multiple `Topics` that need to be monitored are too long to distinguish the specific meaning of `Topic`.

![mqttx-topic](../assets/mqttx-topic.png)

![mqttx-topic-alias](../assets/mqttx-topic-alias.png)

3. Sending and receiving of messages

After the `Topic` is successfully subscribed, you can test the sending and receiving of messages. Fill in the `Topic` information you just subscribed to in the lower right corner of the page. You can select the values of `QoS`, `Retain`, input `payload`, and click the send button on the far right to send a message to the `Topic` you just subscribed. After sending successfully, you can immediately receive the message just sent. Note that in the message box, the right column is the sent message, and the left column is the received message. MacOS users can use the `command + enter` shortcut to quickly send messages, and other users can use the `control + enter` shortcut to do that.
Expand All @@ -163,15 +167,23 @@ So far, the test of an `MQTT` message is completed.

### Setting

Click the settings button at the bottom of the left menu bar, or use shortcut. MacOS users can use the `command +,` shortcut, and other users can use the `control +,` shortcut to jump to the settings page. Currently, language selection is supported, and whether to automatically check for updates and select topics is enabled.
Click the settings button at the bottom of the left menu bar, or use shortcut. MacOS users can use the `command +,` shortcut, and other users can use the `control +,` shortcut to jump to the settings page. Currently, language selection is supported, whether to automatically check for updates, select topics is enabled and also data backup and recovery functions in advanced settings.

#### Data management

The advanced settings include data backup and recovery functions. Users can choose two import and export ways, or through the upper right menu in the connection page, or in the advanced bar in the settings page.

![mqttx-theme](../assets/mqttx-theme.png)

In the settings page, you can choose to click the data backup and data recovery buttons in the advanced functions at the bottom. When selecting data backup, all connection data will be exported, including all received and sent messages. When selecting data recovery, after selecting the path of the imported file, the data can be recovered after confirmation.

![mqttx-advance](../assets/mqttx-advance.png)

### Others

1. Connection operation

By clicking the action bar button at the top, you can quickly disconnect, delete the current connection.
By clicking the action bar button at the top, you can quickly disconnect, delete the current connection, import and export of current data, etc.

![mqttx-connection](../assets/mqttx-connection.png)

Expand Down

0 comments on commit 636416e

Please sign in to comment.