pynut3 2.2.1

A Python3 abstraction class to access NUT servers for uninterruptible power supplies (UPS).

(DEPRECATED) pynut3

(aka python-nut3)

This is a Python3 library to allow communication with NUT (Network UPS Tools) Uninterruptible Power Supply servers following RFC-9271

Note: This is an unofficial project, and is in no way supported or endorsed by the Network UPS Tools developers.

Requirements

Development of this package is done in Python 3.11. The package is considered forwards compatible probably upto Python 3.12 and possibly also beyond. Backwards compatibility is not guaranteed on versions prior to 3.9; if it works on Python 3.8 or before consider yourself lucky. Python versions that are end-of-life are not supported.

Installation

On Linux systems pynut3 requires telnet to be installed. If it is not available on your system you'll need to install it first.

sudo apt install telnet

On macOS telnet is not needed; nc will be used automatically. Then install using:

python -m pip install pynut3

This software was not tested on systems other than Linux (Debian) and macOS. If you have access to another OS, feel free to contribute improvements for support.

Usage

See demo/upsdemo.py for a usage example.

Please note that this module has completely and intentionally broken backwards compatibility with (previous) versions of pynut3.

Acknowledgements

Based on various NUT Client related Python scripts, written by David Goncalves as PyNUT, and released under GPL v3. Later overhauled by rshipp with Python3 modifications by hordurk, george2 and mezz64. Others will have contributed along the way. I was not able to reliably find their names.

Further updates are by me (Mausy5043) and based/inspired on prior work from timurlenk07, StSAV012, rshipp & Rojer-X86.

License

The GPL v3 license continues to apply. See LICENSE.