https://github.com/eschava/psmqtt
Utility reporting system health and status via MQTT
https://github.com/eschava/psmqtt
home-automation internet-of-things iot mqtt mqtt-client psutil python
Last synced: 5 months ago
JSON representation
Utility reporting system health and status via MQTT
- Host: GitHub
- URL: https://github.com/eschava/psmqtt
- Owner: eschava
- License: mit
- Created: 2016-03-23T16:05:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2026-01-15T16:06:44.000Z (5 months ago)
- Last Synced: 2026-01-15T19:31:55.014Z (5 months ago)
- Topics: home-automation, internet-of-things, iot, mqtt, mqtt-client, psutil, python
- Language: Python
- Homepage:
- Size: 343 KB
- Stars: 178
- Watchers: 13
- Forks: 39
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
- awesome-mqtt - psmqtt - Utility reporting system health and status via MQTT. (Interfaces / Operating System)
README
=======
Summary
=======
**PSMQTT** is a cross-platform utility for reporting system and processes
metrics (CPU, memory, disks, network, S.M.A.R.T. disk data, etc) to an MQTT broker.
It integrates seamlessly with `HomeAssistant `_
thanks to the support for `MQTT discovery messages `_.
**PSMQTT** is written in Python and is based on:
* `paho-mqtt `_ to communicate with the MQTT broker;
* `psutil `_ to collect metrics;
* `pySMART `_ to collect SMART data from HDDs/SSDs;
* `recurrent `_ to describe scheduling expressions;
* `jinja2 `_ to format the data.
============
Installation
============
The suggested installation method is to use the provided `Docker image `_.
However alternative installation methods are available for Linux, FreeBSD and Windows:
* Installing from **pypi**: see `Install from pypi doc `_
* Installing from **sources**: see `Install from source doc `_
* Installing on **FreeBSD**: see `FreeBSD doc `_
* Installing on **Windows**: see `Windows doc `_
=======================
Configuration and usage
=======================
**PSMQTT** is strongly configuration-file-driven.
Please check the `Usage page `_ which contains all documentation on the configuration options for psmqtt.
============
Known issues
============
See `Known issues `_.
=======
Support
=======
Please use the `GitHub issue tracker `_
to report bugs or request features.