https://github.com/michelep/raspiupsmonitor

a Python monitor script for Raspi UPS HAT
https://github.com/michelep/raspiupsmonitor

hat raspberry-pi ups

Last synced: about 8 hours ago
JSON representation

a Python monitor script for Raspi UPS HAT

• Host: GitHub
• URL: https://github.com/michelep/raspiupsmonitor
• Owner: michelep
• License: gpl-3.0
• Created: 2018-01-02T23:34:56.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-04-14T17:38:05.000Z (over 2 years ago)
• Last Synced: 2023-12-14T09:34:25.782Z (11 months ago)
• Topics: hat, raspberry-pi, ups
• Language: Python
• Size: 28.3 KB
• Stars: 4
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
RaspiUpsMonitor

===============

### a Python monitor script for Raspi UPS HAT

[Raspi UPS HAT](https://it.aliexpress.com/item/Geekworm-RPi-UPS-HAT-Board-for-Raspberry-Pi-3-Model-B-Pi-2B-B/32766227090.html) was a board for Raspberry Pi with a controller and a LiPo battery that act like an UPS. On board, there's a MAX17034 chip (connected to i2c bus) that could be asked for battery voltage and remaining capacity (0-100%).

With this simple script, far to be perfect (and you are encouraged to fix and improve it !), you can shutdown safely your RPi when battery on UPS Hat reach a critical level, avoid any potentials data loss.

### Requirements

You need to install smbus2 with *sudo pip install smbus2*

### Install

Installation is pretty simple: just do *python setup.py build* and *sudo python setup.py install*. If you want to execute as a daemon on startup, just copy `raspiupsmonitor.initd` to `/etc/init.d` (`cp raspiupsmonitor.initd /etc/init.d/raspiupsmonitor`, `sudo chmod +x /etc/init.d/raspiupsmonitor`, `sudo update-rc.d /etc/init.d/raspiupsmonitor defaults`) and the wrapper `raspiupsmonitor.sh` to `/usr/local/bin`. 

Then you can use it as other system services with:

*/etc/init.d/raspiupsmonitor [start|stop]*

### Configure

Configuration is in `raspiupsmonitor.cfg` must be copied to either 

* `/etc/raspiupsmonitor.cfg`  

* `~/.raspiupsmonitor.cfg`

* `raspiupsmonitor.cfg`

and the relevant part is [Monitor]:

    [Monitor]

    # On alert level of 10%, just alert all users...

    alert_level=10

    alert_action=/usr/bin/wall "UPS Battery is dying..."

    # When battery is dying, halt the system safely

    critical_level=5

    critical_action=/sbin/halt -p

"level" is the percentage of power remained, in a range from 0 to 100. When battery is discharging and reach the alert or critical level, "action" was executed.