diff --git a/README.md b/README.md index 84e91e8..aa4e16e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # phoenix-upshid Simple driver for reading data from Phoenixtec ("Amazon Basics") UPSes written in c -## why? +## Why? A while ago I bought a UPS (Uninterruptible power supply) from Amazon Basics. I tried multiple drivers for it, but they all had their problems: - **NUT** tended to mess up the USB connection after some days to a point where you had to **unplug and re-plug the USB cable** of the UPS -- UPower had a stable connection, battery percentage was updated in real-time, but the charging state was frozen, displaying `fully-charged` when UPS was at 5% charge or displaying `charging` when UPS was already at 100% +- UPower had a stable connection, battery percentage was updated in real-time, but the **charging state was frozen**, displaying `fully-charged` when UPS was at 5% charge or displaying `charging` when UPS was already at 100% So I tried writing dirty fixes for both of those drivers, which would reset the USB connection when detecting such problem. But it wasn't as stable as I had hoped. @@ -13,7 +13,7 @@ At the end I reverse-engineered the USB-HID protocol of the UPS and wrote my own -## how to use +## How to use Download and extract source and compile: ```console $ wget https://github.com/DrMaxNix/phoenix-upshid/archive/refs/tags/1.0.0.tar.gz