{"id":22907323,"url":"https://github.com/ysfsmet/mqtt-inspector","last_synced_at":"2026-05-17T17:37:21.117Z","repository":{"id":267689989,"uuid":"902045238","full_name":"ysfsmet/mqtt-inspector","owner":"ysfsmet","description":"A desktop application for real-time monitoring and inspection of MQTT messages with automatic device-based grouping.","archived":false,"fork":false,"pushed_at":"2024-12-11T20:38:17.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-01T09:08:06.001Z","etag":null,"topics":["claude-ai","electron","inspector","mqtt","mqtt-client"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ysfsmet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-12-11T19:54:15.000Z","updated_at":"2024-12-11T20:37:00.000Z","dependencies_parsed_at":"2024-12-11T21:36:57.828Z","dependency_job_id":null,"html_url":"https://github.com/ysfsmet/mqtt-inspector","commit_stats":null,"previous_names":["ysfsmet/mqtt-inspector"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ysfsmet/mqtt-inspector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ysfsmet%2Fmqtt-inspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ysfsmet%2Fmqtt-inspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ysfsmet%2Fmqtt-inspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ysfsmet%2Fmqtt-inspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ysfsmet","download_url":"https://codeload.github.com/ysfsmet/mqtt-inspector/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ysfsmet%2Fmqtt-inspector/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268074219,"owners_count":24191522,"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","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["claude-ai","electron","inspector","mqtt","mqtt-client"],"created_at":"2024-12-14T03:14:31.758Z","updated_at":"2026-05-17T17:37:16.087Z","avatar_url":"https://github.com/ysfsmet.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MQTT Inspector\n\nA desktop application for real-time monitoring and inspection of MQTT messages with automatic device-based grouping.\n\n![MQTT Inspector Screenshot](/assets/MainWindowScreenshot.png)\n\n## Features\n\n- 🔌 Support for MQTT and WebSocket protocols\n- 📊 Automatic device-based grouping\n- 🔄 Real-time data updates\n- 📝 Message counter\n- 🔐 Username/password authentication support\n- 💻 Cross-platform support (Windows, macOS, Linux)\n- 🎨 Modern and user-friendly interface\n- 📈 Message history tracking\n- 🔍 Real-time message inspection\n- 🌐 Multi-broker support\n\n## Installation\n\n### For Users\n\n1. Download the appropriate version for your operating system from [Releases](https://github.com/ysfsmet/mqtt-inspector/releases):\n   - Windows: `MQTT Inspector Setup.exe`\n   - macOS: `MQTT Inspector.dmg`\n   - Linux: `mqtt-inspector.AppImage` or `mqtt-inspector.deb`\n\n2. Run the downloaded file:\n   - Windows: Run the setup file and follow installation steps\n   - macOS: Open the DMG file and drag the application to Applications folder\n   - Linux: Make the AppImage executable and run it, or install the .deb package\n\n### For Developers\n\nTo develop the project locally:\n\n1. Install requirements:\n   - Node.js (v14 or higher)\n   - npm (v6 or higher)\n   - Git\n\n2. Clone the project:\n```bash\ngit clone https://github.com/ysfsmet/mqtt-inspector.git\ncd mqtt-inspector\n```\n\n3. Install dependencies:\n```bash\nnpm install\n```\n\n4. Start the application:\n```bash\nnpm start\n```\n\n## Usage\n\n### Connection Settings\n\n1. Enter broker connection details:\n   - Protocol: MQTT (1883) or WebSocket (9001)\n   - Broker Address: IP address or hostname\n   - Port: Automatically filled based on protocol\n   - Username/Password (optional)\n\n2. Click \"Connect\" button\n\n### Topic Structure\n\nThe application supports the following topic structure:\n```\nsysmanager/[Device Name]/[Variable Name]\n```\n\nExample:\n```\nsysmanager/Device1/Temperature\nsysmanager/Device1/Pressure\nsysmanager/Device2/Speed\n```\n\n### Interface Features\n\n- **Connection Status**: Displayed in the top right corner\n- **Device Groups**: Separate panel for each device\n- **Variable List**: For each variable:\n  - Message counter (left)\n  - Variable name (center)\n  - Latest value (right)\n\n## Development\n\n### Project Structure\n\n```\nmqtt-inspector/\n├── assets/              # Icons and visual assets\n│   ├── icon.ico        # Windows icon\n│   ├── icon.icns       # macOS icon\n│   └── icon.png        # Linux icon\n├── src/                # Source files\n│   ├── main.js        # Electron main process\n│   └── index.html     # Main application window\n├── package.json       # Project configuration\n└── README.md         # Documentation\n```\n\n### Building\n\nFor Windows:\n```bash\nnpm run build:win\n```\n\nFor macOS:\n```bash\nnpm run build:mac\n```\n\nFor Linux:\n```bash\nnpm run build:linux\n```\n\nFor all platforms:\n```bash\nnpm run build\n```\n\n### Testing\n\nYou can use Mosquitto for testing MQTT broker connections:\n\n1. Install Mosquitto:\n   - Windows: [Mosquitto Download Page](https://mosquitto.org/download/)\n   - macOS: `brew install mosquitto`\n   - Linux: `sudo apt-get install mosquitto`\n\n2. Send test message:\n```bash\nmosquitto_pub -t \"sysmanager/TestDevice/Temperature\" -m \"25.5\"\n```\n\n## Troubleshooting\n\n1. **Connection Error**\n   - Verify broker address and port\n   - Check firewall settings\n   - Confirm broker is running\n\n2. **WebSocket Connection Error**\n   - Verify WebSocket support is enabled in broker\n   - Check correct port usage\n\n3. **Application Launch Issues**\n   - Verify Node.js version\n   - Delete node_modules folder and run `npm install`\n\n## Contributing\n\n1. Fork the project\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n### Development Guidelines\n\n- Follow the existing code style\n- Add comments for complex logic\n- Update documentation for new features\n- Add appropriate error handling\n- Test on all supported platforms\n\n## Security\n\n- Always use secure connections in production\n- Regularly update dependencies\n- Use strong passwords for MQTT authentication\n- Enable SSL/TLS when possible\n- Be cautious with topic permissions\n\n## Roadmap\n\n- [ ] Add SSL/TLS support\n- [ ] Implement message filtering\n- [ ] Add data visualization\n- [ ] Support for custom topic patterns\n- [ ] Message payload formatting\n- [ ] Export data functionality\n- [ ] Dark mode support\n- [ ] Configurable refresh rates\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Electron](https://www.electronjs.org/)\n- [MQTT.js](https://github.com/mqttjs/MQTT.js)\n- [electron-builder](https://www.electron.build/)\n\n## Contact\n\nProject Maintainer - [@ysfsmet](https://x.com/ysfsmet)\n\nProject Link: [https://github.com/ysfsmet/mqtt-inspector](https://github.com/ysfsmet/mqtt-inspector)\n\n## Changelog\n\n### Version 1.0.0 (2024-12-11)\n- Initial release\n- Basic MQTT monitoring functionality\n- Cross-platform support\n- Real-time message inspection\n- Automatic device grouping\n\n## Support\n\nFor support, email mqtt-inspector@example.com or open an issue on GitHub.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fysfsmet%2Fmqtt-inspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fysfsmet%2Fmqtt-inspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fysfsmet%2Fmqtt-inspector/lists"}