{"id":13583325,"url":"https://github.com/fabaff/mqtt-panel","last_synced_at":"2025-05-15T19:08:26.640Z","repository":{"id":54396605,"uuid":"12266054","full_name":"fabaff/mqtt-panel","owner":"fabaff","description":"A web interface for MQTT","archived":false,"fork":false,"pushed_at":"2025-01-21T12:37:18.000Z","size":930,"stargazers_count":436,"open_issues_count":4,"forks_count":117,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-04-08T01:36:05.862Z","etag":null,"topics":["iot","mqtt","mqtt-broker","mqtt-client","mqtt-panel","panel","websockets"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fabaff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-08-21T09:13:04.000Z","updated_at":"2025-03-16T17:01:37.000Z","dependencies_parsed_at":"2024-06-11T18:59:17.770Z","dependency_job_id":"b0000774-1105-42ea-8d93-878e7f7bc50f","html_url":"https://github.com/fabaff/mqtt-panel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabaff%2Fmqtt-panel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabaff%2Fmqtt-panel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabaff%2Fmqtt-panel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabaff%2Fmqtt-panel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fabaff","download_url":"https://codeload.github.com/fabaff/mqtt-panel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254404357,"owners_count":22065641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["iot","mqtt","mqtt-broker","mqtt-client","mqtt-panel","panel","websockets"],"created_at":"2024-08-01T15:03:24.226Z","updated_at":"2025-05-15T19:08:26.620Z","avatar_url":"https://github.com/fabaff.png","language":"JavaScript","funding_links":[],"categories":["Visualization, Dashboards","JavaScript"],"sub_categories":["Misc"],"readme":"[\u003cimg src=\"https://api.gitsponsors.com/api/badge/img?id=12266054\" height=\"20\"\u003e](https://api.gitsponsors.com/api/badge/link?p=M6YTOZpYXP5QfsPAcN1WtjxBeUMoAYG1hSbALWg+0ACRLfuU00JzAshil3XKiVKDCWmq8GYaEA1Y0KMUMbow+NBX0Y9Pi41tgCFXM9FerKn/dyzHyrXl5KFh0xDcLA5R)\n\n# mqtt-panel\n\nA simple web interface which is able to subscribe to a MQTT topic and display\nthe information.\n\nThe screenshot shows an example how to keep track on what's going in your\napartment or your house. It's not about controlling, this setup is about\nobserving various states.\n\n![screenshot](screenshot.png)\n\n![screenshot](screenshot-mobile.png)\n\nWhat to see `mqtt-panel` in action -\u003e http://youtu.be/Qb0UJa9kf2g\n\nThe web page is using [bootstrap](http://getbootstrap.com/) with\n[jQuery](http://jquery.com/).\n\n## Prerequisites/Installation\n\n### Get the files\n\nClone the `mqtt-panel` [repository](https://github.com/fabaff/mqtt-panel)\n\n```bash\n$ git clone git@github.com:fabaff/mqtt-panel.git\n```\n\n### Dependencies\n\n`mqtt-panel` is using the listed projects to provide its functionality:\n\n- [paho-mqtt](https://www.eclipse.org/paho/clients/python/)\n- [mqtt](https://github.com/adamvr/MQTT.js/)\n\nIf you are using Fedora and want to generate MQTT messages, install the\n`paho-mqtt` Python bindings for `test-messages.py`.\n\n```bash\n$ sudo dnf -y install python-paho-mqtt\n```\n\n### MQTT broker/server\n\nA MQTT broker/server with Websocket support is needed.\n\n- [mosquitto](http://mosquitto.org/) - An Open Source MQTT v3.1/3.11 broker\n- [mosca](http://mcollina.github.io/mosca/) - A multi-transport MQTT broker\n  for node.js (Project seems abandoned)\n\n## Running mqtt-panel\n\n1. Make sure that your MQTT broker/server is running and listening.\n2. Adjust `var host = '127.0.0.1';` and `var port = 3000;` in the file\n   `js/index.js` to match your setup. Also, `var topic = '#';`.\n3. Open `index.html` in a modern web browser.\n\n## Generate MQTT messages\n\nStart the `./test-messages.py` script to publish test messages if you have\nno other source for messages. Depending on your broker you may need to set\nthe supported version, on line 33: `protocol=mqtt.MQTTv311` and adjust\nthe broker and its port.\n\nFor manually sending messages to your MQTT broker/server you can use\n`mosquitto_pub` from `mosquitto`.\n\n```bash\n$ mosquitto_pub -V mqttv311 -h localhost -d -t home/front/door -m \"false\"\n```\n\nTo check if the messages are are ok, subscribe to the topic **home/#** with\n`mosquitto_sub`.\n\n```bash\n$ mosquitto_sub -V mqttv311 -h localhost -d -t home/#\n```\n\n## Credits\n\n`mqtt-panel` was inspired by the ideas of:\n\n- [mqtt-svg-dash](https://github.com/jpmens/mqtt-svg-dash) by [Jan-Piet Mens](http://jpmens.net/)\n- [Robert Hekkers](http://blog.hekkers.net/2012/10/13/realtime-data-with-mqtt-node-js-mqtt-js-and-socket-io/)\n\n## License\n\n`mqtt-panel` licensed under MIT, for more details check LICENSE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabaff%2Fmqtt-panel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffabaff%2Fmqtt-panel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabaff%2Fmqtt-panel/lists"}