{"id":26158300,"url":"https://github.com/filipspl/meshmqttmonitor","last_synced_at":"2026-04-29T14:01:23.159Z","repository":{"id":271610324,"uuid":"850441756","full_name":"filipsPL/meshmqttmonitor","owner":"filipsPL","description":"MQTT Node Monitor for Meshtastic in console","archived":false,"fork":false,"pushed_at":"2025-01-19T08:49:31.000Z","size":343,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T10:50:50.419Z","etag":null,"topics":["console","meshtastic","meshtastic-python","monitoring-tool","mqtt"],"latest_commit_sha":null,"homepage":"","language":"Python","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/filipsPL.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":"2024-08-31T19:24:23.000Z","updated_at":"2025-02-18T22:04:08.000Z","dependencies_parsed_at":"2025-01-08T20:23:42.872Z","dependency_job_id":"fd714918-cf4b-40fd-9f27-0c55aded19db","html_url":"https://github.com/filipsPL/meshmqttmonitor","commit_stats":null,"previous_names":["filipspl/meshmqttmonitor"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/filipsPL/meshmqttmonitor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipsPL%2Fmeshmqttmonitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipsPL%2Fmeshmqttmonitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipsPL%2Fmeshmqttmonitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipsPL%2Fmeshmqttmonitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/filipsPL","download_url":"https://codeload.github.com/filipsPL/meshmqttmonitor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipsPL%2Fmeshmqttmonitor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262867726,"owners_count":23377123,"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":["console","meshtastic","meshtastic-python","monitoring-tool","mqtt"],"created_at":"2025-03-11T10:49:21.133Z","updated_at":"2026-04-29T14:01:18.135Z","avatar_url":"https://github.com/filipsPL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MQTT Node Monitor for Meshtastic\n\n## Overview\n\nThis program connects to an MQTT broker to monitor messages from [Meshtastic](https://meshtastic.org/) nodes. It displays the data in a terminal-based interface, providing both a summary of the last message from each node and a detailed table of all messages. The program uses color-coded dots to indicate the age of the last message, making it easy to see the freshness of the data at a glance.\n\n![screenshot](screenshot.png)\n\n## Features\n\n- **Real-time Monitoring**: Continuously listens to an MQTT topic and processes messages as they arrive.\n- **Alias Mapping**: Converts node IDs to human-readable names using an alias map.\n- **Message Age Indication**: Uses colored dots to indicate how recent each message is, with colors ranging from green (very recent) to black (older than 2 hours).\n- **Configurable**: All MQTT settings and node configurations are managed via a configuration file (`config.py`).\n\n## Requirements\n\nThis program requires Python 3.x. You will also need to install the following Python packages:\n\n- `paho-mqtt`: For connecting to and interacting with the MQTT broker.\n- `termcolor`: For printing colored text in the terminal.\n- `tabulate`: For formatting data into a nice-looking table.\n\n### Installation of Required Packages\n\nYou can install the required packages using pip:\n\n```bash\npip install paho-mqtt termcolor tabulate\n```\n\n## Configuration\n\nThe program relies on a configuration file (`config.py`) to specify MQTT settings, alias mappings, and color mappings. Below is an example of what your `config.py` should look like:\n\n```python\n# Define MQTT settings\nMQTT_BROKER = \"your_mqtt_broker_address\"\nMQTT_PORT = 8883\nMQTT_TOPIC = \"your/mqtt/topic/#\"\nMQTT_USERNAME = \"your_mqtt_username\"\nMQTT_PASSWORD = \"your_mqtt_password\"\n\n# SSL Usage\nUSE_SSL = True\n\n# Alias mapping for node IDs to human-readable names\nALIAS_MAP = {\n    \"!node1id\": \"Node 1\",\n    \"!node2id\": \"Node 2\",\n    # Add more node IDs and corresponding aliases here\n}\n\n# Color mapping for aliases\nCOLOR_MAP = {\n    \"Node 1\": \"yellow\",\n    \"Node 2\": \"cyan\",\n    # Add more aliases and corresponding colors here\n}\n\n# Fields to ignore in the message display\nIGNORE_FIELDS = ['from', 'to', 'type', 'id', 'timestamp', 'node_id']\n```\n\n### Explanation of Configuration Parameters\n\n- **MQTT_BROKER**: The address of your MQTT broker.\n- **MQTT_PORT**: The port used by your MQTT broker (default for MQTT over SSL is 8883).\n- **MQTT_TOPIC**: The MQTT topic to subscribe to (wildcards can be used to subscribe to multiple topics).\n- **MQTT_USERNAME**: Your MQTT username.\n- **MQTT_PASSWORD**: Your MQTT password.\n- **USE_SSL**: Boolean value to indicate if SSL should be used.\n- **ALIAS_MAP**: A dictionary mapping node IDs to human-readable names.\n- **COLOR_MAP**: A dictionary mapping node aliases to colors for terminal display.\n- **IGNORE_FIELDS**: List of fields in the MQTT message that should be ignored in the display.\n\n## Running the Program\n\nTo run the program, simply execute the Python script in your terminal:\n\n```bash\npython meshmqttmonitor.py\n```\n\nEnsure that the `config.py` file is in the same directory as your script. The file `config.py.txt` is provided as an example.\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilipspl%2Fmeshmqttmonitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffilipspl%2Fmeshmqttmonitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilipspl%2Fmeshmqttmonitor/lists"}