HeeroYui/mqtt-stereo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix readme

Browse Source
This commit is contained in:
siscia 2016-08-05 21:58:13 +02:00
parent 05c172401d
commit 9fda4769c5
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,6 +1,6 @@
# MQTT Stereo
A simple MQTT uility to record and play back MQTT streams.
A simple MQTT utility to record and play back MQTT streams.
## Obtain
@ -14,7 +14,7 @@ if you would like to use this utility but you don't want to set up all the go en
## Usage
The binary should already provide some information, hopefully enought to get started.
The binary should already provide some information, hopefully enough to get started.
There are two modality, play and record.
@ -36,7 +36,7 @@ Finally you need to specify if you want to record or to play a MQTT stream, you
To record an MQTT stream from a remote host, suppose "mqtt-example.com", with serve MQTT on the port 1567 but we are interested only on the topic "/IoT/#" and we want to save everything on the file "IoT_log.txt" you should run:
``` bash
mqtt-player --url mqtt-example.com --port 1567 --topic /IoT/# --record IoT_log.txt record
mqtt-stereo --url mqtt-example.com --port 1567 --topic /IoT/# --record IoT_log.txt record
```
After enough messages are received you can exit with Ctrl-C
@ -44,7 +44,7 @@ After enough messages are received you can exit with Ctrl-C
Now to play back all those messages to another host "iot-mqtt.com" that serve on the port 1884 you should run:
```bash
mqtt-player --url iot-mqtt.com --port 1884 --record IoT_log.txt play
mqtt-stereo --url iot-mqtt.com --port 1884 --record IoT_log.txt play
```
This command will play all the messages only once respecting the time deltas between the messages.
@ -52,17 +52,19 @@ This command will play all the messages only once respecting the time deltas bet
If for debug reason you want to play all the messages in loop, multiple times, you can add loop subcommand.
```bash
mqtt-player --url iot-mqtt.com --port 1884 --record IoT_log.txt play --loop
mqtt-stereo --url iot-mqtt.com --port 1884 --record IoT_log.txt play --loop
```
Finally if for benchmark reason you want to run all the messages as fast as possible you can use the fast-forward reason.
```bash
mqtt-player --url iot-mqtt.com --port 1884 --record IoT_log.txt play --ff
mqtt-stereo --url iot-mqtt.com --port 1884 --record IoT_log.txt play --ff
```
Of course the `--loop` and the `--ff` subcommand can be used together.
## Motivation
At [RedBeardLab.tech][redbeardlab.tech] we are working
At [RedBeardLab.tech](redbeardlab.tech) we are getting a lot of exposure and experience about IoT and MQTT, but we didn't found any suitable tool for debugging and record MQTT messages and mqtt-stereo is our solution to this problem.
Of course this is a very simple implementation, lacking many features, feel free to contribute or open an issue.