luneski/mqtt-explorer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
Thomas Nordquist
2019-03-20 10:36:02 +01:00
parent c09ea4ae62
commit ea7994dad9
2 changed files with 46 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
Readme.md
View File

@@ -21,9 +21,9 @@ A MQTT Tool to get a quick overview of your MQTT topics and integrate new device
- Plot numeric topics - Plot numeric topics
- Keep a history of each topic - Keep a history of each topic
MQTT-Explorer strives to be THE swiss-army-knife tool. **MQTT Explorer** strives to be THE MQTT swiss-army-knife.
The perfect tool to integrate new services, IoT devices in your network. The perfect tool to integrate new services, IoT devices in your network.
The hierarchical view allows for a quick understanding what is going on on your broker. The hierarchical view of your broker allows for a quick understanding what is going on.
## Download ## Download
@@ -47,35 +47,43 @@ If you feel like a feature is missing or you found a bug, please leave me a [com
This App is optimized to handle thousands of topics and at hundreds of thousands messages per minute. This App is optimized to handle thousands of topics and at hundreds of thousands messages per minute.
In very large productive environments brokers may handle an exteme load of topics. Custom subscriptions can limit the amount of messages **MQTT Explorer** needs to process, subscriptions can be managed in the advanced connection settings.
Subscribing with a wildcard topic is in this scenario not adviced. In very large productive environments brokers may handle an extreme load of topics, subscribing with a wildcard topic is in this scenario not advised.
To avoid a scenario where the MQTT-Explorer would have to handle millions of updates, one can set up custom subscriptions in the "Advanced" connection settings.
## Develop ## Develop
PRs and issues are welcome PRs and issues are welcome.
Install with `npm run install`, build with `npm run build` Install with `npm run install`, build with `npm run build`
Start with `npm run start` Start with `npm run start`
The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management. The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management, `src` contains all the electron bindings. [mqttjs](https://github.com/mqttjs/MQTT.js) is used to facilitate communication to MQTT brokers.
## Automated Tests ## Automated Tests
To achieve a reliable product automated tests run regulary on travis. To achieve a reliable product automated tests run regularly on travis.
- Data model - Data model
- MQTT integration - MQTT integration
- UI-Tests (The demo is a recorded ui test) - UI-Tests (The demo is a recorded ui test)
A [mosquitto](https://mosquitto.org/) MQTT broker is required to run the ui-tests.
## IoT Applications
List of useful IoT applications using MQTT to integrate devices / services
- [Home Assistant](https://www.home-assistant.io/) - Open source home automation gateway
- [OpenHAB](https://www.openhab.org/) - Smart Home Gateway
- [Node-RED](https://nodered.org/) - Flow-based programming for the Internet of Things
- [zigbee2mqtt](https://github.com/Koenkk/zigbee2mqtt) - A ZigBee to MQTT bridge
- [Tasmota](https://github.com/arendst/Sonoff-Tasmota) - ESP8266 firmware with MQTT support
## Telemetry ## Telemetry
No personal data is processed, sent or stored. No personal data is processed, sent or stored.
The app sends telemetry and error reports, this enables me to quickly react on bugs/errors and understand what's going on. The app sends telemetry and error reports, this enables me to quickly react on bugs/errors and understand what's going on. Responding quickly to errors is one key element in producing a reliable software product.
The app runs on winows, linux and mac and has thousands of users. Responding quickly to bugs is essential.
This greatly helps to improve the software quality and reliability.
It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks. It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks.
@@ -100,7 +108,8 @@ It basically sends: app version, processor architecture, operating system, used
</details> </details>
Even thoug the data is purely technical, an option to disable telemetry is planned. [#52](https://github.com/thomasnordquist/MQTT-Explorer/issues/52) Even though the data is purely technical, an option to disable telemetry is planned. [#52](https://github.com/thomasnordquist/MQTT-Explorer/issues/52)
## License ## License
[AGPL 3](./LICENSE) [AGPL 3](./LICENSE)

35
Readme.tpl.md
View File

@@ -21,9 +21,9 @@ A MQTT Tool to get a quick overview of your MQTT topics and integrate new device
- Plot numeric topics - Plot numeric topics
- Keep a history of each topic - Keep a history of each topic
MQTT-Explorer strives to be THE swiss-army-knife tool. **MQTT Explorer** strives to be THE MQTT swiss-army-knife.
The perfect tool to integrate new services, IoT devices in your network. The perfect tool to integrate new services, IoT devices in your network.
The hierarchical view allows for a quick understanding what is going on on your broker. The hierarchical view of your broker allows for a quick understanding what is going on.
## Download ## Download
@@ -47,35 +47,43 @@ If you feel like a feature is missing or you found a bug, please leave me a [com
This App is optimized to handle thousands of topics and at hundreds of thousands messages per minute. This App is optimized to handle thousands of topics and at hundreds of thousands messages per minute.
In very large productive environments brokers may handle an exteme load of topics. Custom subscriptions can limit the amount of messages **MQTT Explorer** needs to process, subscriptions can be managed in the advanced connection settings.
Subscribing with a wildcard topic is in this scenario not adviced. In very large productive environments brokers may handle an extreme load of topics, subscribing with a wildcard topic is in this scenario not advised.
To avoid a scenario where the MQTT-Explorer would have to handle millions of updates, one can set up custom subscriptions in the "Advanced" connection settings.
## Develop ## Develop
PRs and issues are welcome PRs and issues are welcome.
Install with `npm run install`, build with `npm run build` Install with `npm run install`, build with `npm run build`
Start with `npm run start` Start with `npm run start`
The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management. The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management, `src` contains all the electron bindings. [mqttjs](https://github.com/mqttjs/MQTT.js) is used to facilitate communication to MQTT brokers.
## Automated Tests ## Automated Tests
To achieve a reliable product automated tests run regulary on travis. To achieve a reliable product automated tests run regularly on travis.
- Data model - Data model
- MQTT integration - MQTT integration
- UI-Tests (The demo is a recorded ui test) - UI-Tests (The demo is a recorded ui test)
A [mosquitto](https://mosquitto.org/) MQTT broker is required to run the ui-tests.
## IoT Applications
List of useful IoT applications using MQTT to integrate devices / services
- [Home Assistant](https://www.home-assistant.io/) - Open source home automation gateway
- [OpenHAB](https://www.openhab.org/) - Smart Home Gateway
- [Node-RED](https://nodered.org/) - Flow-based programming for the Internet of Things
- [zigbee2mqtt](https://github.com/Koenkk/zigbee2mqtt) - A ZigBee to MQTT bridge
- [Tasmota](https://github.com/arendst/Sonoff-Tasmota) - ESP8266 firmware with MQTT support
## Telemetry ## Telemetry
No personal data is processed, sent or stored. No personal data is processed, sent or stored.
The app sends telemetry and error reports, this enables me to quickly react on bugs/errors and understand what's going on. The app sends telemetry and error reports, this enables me to quickly react on bugs/errors and understand what's going on. Responding quickly to errors is one key element in producing a reliable software product.
The app runs on winows, linux and mac and has thousands of users. Responding quickly to bugs is essential.
This greatly helps to improve the software quality and reliability.
It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks. It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks.
@@ -100,7 +108,8 @@ It basically sends: app version, processor architecture, operating system, used
</details> </details>
Even thoug the data is purely technical, an option to disable telemetry is planned. [#52](https://github.com/thomasnordquist/MQTT-Explorer/issues/52) Even though the data is purely technical, an option to disable telemetry is planned. [#52](https://github.com/thomasnordquist/MQTT-Explorer/issues/52)
## License ## License
[AGPL 3](./LICENSE) [AGPL 3](./LICENSE)