64 lines
4.8 KiB
Markdown
64 lines
4.8 KiB
Markdown
# MQTT-Explorer
|
|
[](https://travis-ci.org/thomasnordquist/MQTT-Explorer/releases)
|
|
[](https://travis-ci.org/thomasnordquist/MQTT-Explorer/releases)
|
|
[](https://travis-ci.org/thomasnordquist/MQTT-Explorer)
|
|
|
|
### Version 0.1.3
|
|
See the whole picture of your message queue.
|
|
The perfect tool to integrate new services, IoT devices in your network.
|
|
This application subscribes to all topics on your MQTT-Server and displays your message queue hierarchy, allowing you to drill-down to the topics that are of interest.
|
|
|
|
## Download
|
|
The app is prebuilt for Windows ([portable](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-Setup-0.1.3.exe)), Linux ([AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3-x86_64.AppImage)) and Mac ([dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.dmg)).
|
|
|
|
| Platform | | Downloads |
|
|
|:----------|:-------------:|:------:|
|
|
|  | Windows | [portable](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-Setup-0.1.3.exe) |
|
|
|  | Linux | [AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3-x86_64.AppImage)<br>*Run AppImage:<br>Make it executable and double-click it.* |
|
|
|  | Mac | [dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.dmg) |
|
|
|
|
More architectures and package types: [Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Develop
|
|
PRs and issues are welcome
|
|
|
|
Install with `npm run install`, build with `npm run build`
|
|
|
|
Start with `npm run start`
|
|
|
|
The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management.
|
|
|
|
## Telemetry
|
|
The App sends telemetry and error reports, this enables me to quickly react on bugs/errors I produced.
|
|
This is a difficutlt task since this App runs on three different operating systems and architectures.
|
|
|
|
It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks.
|
|
|
|
This greatly helps to improve the software quality and reliability.
|
|
No data about you or your data is send or stored.
|
|
Even thoug the data is purely technical, an option to disable telemetry is planned. [#52](https://github.com/thomasnordquist/MQTT-Explorer/issues/52)
|
|
|
|
Example telemetry:
|
|
```javascript
|
|
{ system: { arch: 'x64', platform: 'darwin' },
|
|
appVersion: '0.0.7',
|
|
events: { HELLO_EVENT: [ 1547714886134 ] },
|
|
now: 1547714886135,
|
|
transactionId: '1767d251-f492-4f2c-aa62-88add3acc26b' }
|
|
{ errors:
|
|
[ { time: 1547714887921,
|
|
message: 'He\'s dead Jim!',
|
|
stack:
|
|
'Error: He\'s dead Jim!\n at ./src/tracking.ts.exports.default (./mqtt-explorer/app/build/bundle.js:142765:11)\n at new Promise (<anonymous>)\n at Object../src/tracking.ts (./mqtt-explorer/app/build/bundle.js:142764:1)\n at __webpack_require__ (./mqtt-explorer/app/build/bundle.js:20:30)\n at Object../src/index.tsx (./mqtt-explorer/app/build/bundle.js:142618:1)\n at __webpack_require__ (./mqtt-explorer/app/build/bundle.js:20:30)\n at ../backend/node_modules/charenc/charenc.js.charenc.utf8.stringToBytes (./mqtt-explorer/app/build/bundle.js:84:18)\n at ./mqtt-explorer/app/build/bundle.js:87:10' } ],
|
|
now: 1547714887921,
|
|
transactionId: '53bf9aac-e695-40cc-9a81-b1cf3398843d' }
|
|
```
|
|
|
|
## License
|
|
Not yet decided which license exactly, but the basic idea is: "You may do whatever you want with this tool, except sell it."
|