psmqtt 2.5.1

Utility reporting system health and status via MQTT

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.