Skip to main content

Python driver for TrippLite UPS battery backups.

Project description

tripplite

Python USB interface and command-line tool for TrippLite UPS battery backups.

Background

TrippLite offers UI software for monitoring its batteries. However, most of its batteries don't have network access, and the existing TrippLite software requires a local install.

I wanted to monitor the UPS from a remote headless Linux server, so I wrote this tool.

Installation

apt install gcc libusb-1.0-0-dev libudev-dev
pip install tripplite

Connect a USB cable from the UPS to your headless server, and you should be ready to run. If you don't want to run as root, see Note on Permissions below.

Command Line

$ tripplite
{
    "config": {
        "frequency": 60,  # Hz
        "power": 1500,  # VA
        "voltage": 120  # V
    },
    "health": 100,  # %
    "input": {
        "frequency": 59.7,  # Hz
        "voltage": 117.2  # V
    },
    "output": {
        "power": 324,  # W
        "voltage": 117.2  # V
    },
    "status": {
        "ac present": true,
        "below remaining capacity": true,
        "charging": false,
        "discharging": false,
        "fully charged": true,
        "fully discharged": false,
        "needs replacement": false,
        "shutdown imminent": false
    },
    "time to empty": 1004  # s
}

If you have multiple TrippLite devices connected to the server, you'll need to specify a product id (findable on lsusb). See tripplite --help for more.

To use in shell scripts, parse the json output with something like jq. For example, tripplite | jq '.status."ac present"' will return whether or not the unit detects AC power.

Python

If you'd like to link this to more complex behavior (e.g. data logging, text alerts), consider using a Python script.

from tripplite import Battery
with Battery() as battery:
    print(battery.get())

The state variable will contain an object with the same format as above. Use state['status']['ac present'] and state['status']['shutdown imminent'] for alerts, and consider logging voltage, frequency, and power.

Note on Permissions

To read the TrippLite, you need access to the USB port. You have options:

  • Run everything as root
  • Add your user to the dialout group to access all serial ports
  • Create a group restricted to accessing TrippLite USB devices through udev

For the last option, the rule looks like:

echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="09ae", GROUP="tripplite"' > /etc/udev/rules.d/tripplite.rules
udevadm control --reload-rules

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tripplite-0.2.3.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

tripplite-0.2.3-py2.py3-none-any.whl (11.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tripplite-0.2.3.tar.gz.

File metadata

  • Download URL: tripplite-0.2.3.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.1

File hashes

Hashes for tripplite-0.2.3.tar.gz
Algorithm Hash digest
SHA256 72bbabe0dcf5afa76f18e5e7884e13bc1417720e3ddf9d80130d32a8e5298878
MD5 c9446480126e18b58412c396ccfb1f2c
BLAKE2b-256 1e0c535803da6f5df37a856fb36831b80e8f79778ace445ad9f8b87107e8eabc

See more details on using hashes here.

File details

Details for the file tripplite-0.2.3-py2.py3-none-any.whl.

File metadata

  • Download URL: tripplite-0.2.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.1

File hashes

Hashes for tripplite-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 903fa35e2bc8d9357eebf39678bed9930886bfed74a9bbb5af9f21bf785f0c94
MD5 e7d6024e3e2370cdaf08b869390e9377
BLAKE2b-256 810d77b71aa871e063c3c5fd7e0bd7fa9798f67b6df6ad7411e8995884d1c339

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page