Setup a UPS daemon for Cyberpower UPS Battery Backups

If you wish to use a Cyberpower UPS on a Linux system, then you'll want a monitoring daemon that alerts your PC when it's on battery power and does a proper shutdown before battery runs out. I have multiple cyberpower ups systems that I've verified this works on : CP1500AVR, CP1500AVRLCD, CP900AVR, PR1000LCDRTXL2Ua. It's likely it works on any cyberpower device. NOTE: this is for USB only, if you are using a rs232 serial connection - the below steps have not been verified.

You have a couple options to achieve interoperability, such as PowerPanel, upsmon, nut. The only one this article will explore at the moment is Cyberpower's Linux Power Panel Software. Although this article will most likely be updated with a NUT setup in the future.

Unless your distro comes with this package (Gentoo does not at the time of writing this), download the latest copy from their website : http://www.cyberpowersystems.com/products/management-software/ppl.html?selectedTabId=resources&imageI=#tab-box

Preferably the .tar package so you can build and customize as you see fit.

cd ~/ mkdir powerpanel cd powerpanel wget http://www.cyberpowersystems.com/software/powerpanel_123_x86_64.tar.gz tar -xvf powerpanel_123_x86_64.tar.gz cd powerpanel-1.2.3-0 sudo ./install.sh sudo /etc/init.d/pwrstatd start sudo rc-update add pwrstatd default 

You can then verify connectivity with the following command :
pwrstat -status

 You will probably want to read through this config file before customizing your own:
/etc/pwrstatd.conf

 And the following helper scripts that come stock with this application:
/etc/pwrstatd-email.sh /etc/pwrstatd-lowbatt.sh /etc/pwrstatd-powerfail.sh

The helper scripts are useful, but I started out by moving them to /usr/local/bin to maintain an orderly filesystem, then modified them as outlined below :
mv /etc/pwrstatd-email.sh /usr/local/bin mv /etc/pwrstatd-lowbatt.sh /usr/local/bin mv /etc/pwrstatd-powerfail.sh /usr/local/bin nano /etc/pwrstatd.conf

The following is my pwrstat daemon config with all notation removed.
Note: I don't have it setup to turn off my PC at the first power failure - as short power interruptions are common where I live - the below will only initiate a shutdown on low battery mode. Other notes are I have it setup to run until battery reaches 15% and then give 30s to launch script and another 60s to shutdown PC. Depending on the size of your UPS and power requirements, you might have to tweak those numbers to allot yourself enough time.
SIDE NOTE: I won't go into a huge recommendation and list of considerations, but generally speaking I measure my power usage for my PC and one monitor (other monitors, speakers, etc are all on the ups' surge protection only - not battery), and find a UPS wattage where I'd use roughly 60% of max UPS rated wattage. Most UPS' and power supplies have their peak efficiency around 50-60% utilization. Additionally I like to plan provide my desktop PC for around 20minutes of backup power time.

powerfail-delay = 60 powerfail-active = yes powerfail-cmd-path = /usr/local/bin/pwrstatd-powerfail.sh powerfail-duration = 0 powerfail-shutdown = no lowbatt-delay = 30 lowbatt-active = yes lowbatt-cmd-path = /usr/local/bin/pwrstatd-lowbatt.sh lowbatt-duration = 0 lowbatt-shutdown = yes enable-alarm = yes shutdown-sustain = 60 turn-ups-off = yes lowbatt-threshold = 15 ups-polling-rate = 1 ups-retry-rate = 10 prohibit-client-access = no allowed-device-nodes =

Afterwards you can restart the daemon and confirm the new settings have been applied :
sudo /etc/init.d/pwrstatd restart pwrstat -config

Now we'll modify the helper scripts below...
First is pwrstatd-email.sh . If you wish to send an email when a power outtage has occured continue with this config, otherwise you may skip. A good thing to know is your cell phones SMS email address, which will send you a text message, very handy for instant PC alerts. If you don't know your carriers SMS address google it, for example ATT is : 10digitnumber@txt.att.net. You'll want to keep the subjects and message bodies short for txt alerts - in the below example I've added a secondary RECEIPT address and subject section for shortened text messaging purposes.

Note: this script depends on system email settings, using `mail`. I'll go through a basic setup to use gmail's smtp servers. I recommend having a gmail account used just for smtp email sending, so you don't have to keep your primary accounts password stored in a plain text file on your filesystem.

echo "mail-mta/ssmtp mta ssl" >>/etc/portage/package.use/ssmtp.use emerge -av ssmtp nano /etc/ssmtp/ssmtp.conf
Modify the following with your login information... root=email@gmail.com mailhub=smtp.gmail.com:587 hostname=your_computer_hostname@domain UseSTARTTLS=YES AuthUser=email AuthPass=email_password FromLineOverride=yes
Note: You do not need to include @gmail.com for AuthUser. Also for hostname you can comment out, or not include the domain if you are not a member of one.

You can test to see if the email works now : echo "This is a test" | mail -s "Testing mail" email@gmail.com Replacing email@gmail.com with your TO: address.

Assuming that works, then next you can look over the pwrstatd-email.sh to confirm it will work with your setup:
nano /usr/local/bin/pwrstatd-email.sh .... #!/bin/bash . /etc/conf.d/pwrstatd-email.conf MYHOSTNAME=`hostname` SUBJECT="PowerPanel Notification - [$EVENT]" FROM="PowerPanel Daemon <$SENDER_ADDRESS>" TO="$RECEIPT_NAME <$RECEIPT_ADDRESS>" TO2="$RECEIPT_NAME2 <$RECEIPT_ADDRESS2>" MESSAGE="Warning: The $EVENT event has occurred on $MYHOSTNAME, system shutdown imminent!" DATE=`date +'%Y/%m/%d %p %H:%M'` test ${#DATE} MODEL_NAME=`pwrstat -status |awk '/Model/{print $3,$4}'` REMAINING_RUNTIME=`pwrstat -status |awk '/Remaining/{print $3,$4}'` BATTERY_CAPACITY=`pwrstat -status |awk '/Capacity/{print $3,$4}'` RUNTIME="" if [ "$REMAINING_RUNTIME" != "none" ] then RUNTIME="Remaining Runtime: $REMAINING_RUNTIME" else RUNTIME="Remaining Runtime: Seconds..." fi DATA=( "========================================================" " $SUBJECT" "========================================================" "" "" "$MESSAGE" "Time: $DATE" "" "" "UPS Model Name: $MODEL_NAME" "Battery Capacity: $BATTERY_CAPACITY" "$RUNTIME" ) DATA2=( "$MESSAGE" "Time: $DATE" "UPS Model Name: $MODEL_NAME" "Battery Capacity: $BATTERY_CAPACITY" "$RUNTIME" ) IFS=$'\n' echo "${DATA[*]}" | mail \ -s "$SUBJECT" \ "$TO" if [ "$ENABLE_EMAIL2" = "yes" ] then echo "${DATA2[*]}" | mail "$TO2" fi exit 0

We're going to use a centralized config file (pwrstatd-email.conf), as to not declare variables that may change inside a shell script:
nano /etc/conf.d/pwrstatd-email.conf .... ENABLE_EMAIL=yes ENABLE_EMAIL2=yes RECEIPT_NAME="System Admin" RECEIPT_ADDRESS="to_email@gmail.com" RECEIPT_NAME="System Admin" RECEIPT_ADDRESS="6146666666@txt.att.net" SENDER_ADDRESS="from_email@gmail.com"

Next we'll look at pwrstatd-powerfail.sh. This is the script that will run as soon as your UPS goes into on-battery mode (after whatever delay set in configuration).
nano /usr/local/bin/pwrstatd-powerfail.sh .... #!/bin/bash . /etc/conf.d/pwrstatd-email.conf EVENT="powerfail" echo "Warning: Utility power failure has occurred for a while, system will be shutdown soon!"| wall beep -l50 -r20 -f500 export EVENT if [ $ENABLE_EMAIL = yes ]; then /usr/local/bin/pwrstatd-email.sh fi

Next we'll look at pwrstatd-lowbatt.sh. This is the script that will run as soon as your UPS goes into "low battery" mode, whatever battery percentage specified above, after the configured delay.
nano /usr/local/bin/pwrstatd-lowbatt.sh .... #!/bin/bash . /etc/conf.d/pwrstatd-email.conf EVENT="low-battery" echo "Warning: The UPS's battery power is not enough, system will be shutdown soon!" | wall beep -l50 -r20 -f500 export EVENT if [ $ENABLE_EMAIL = YES ]; then /usr/local/bin/pwrstatd-email.sh fi
Note: This is where you might want to add any custom shutdown options for your PC (if it's setup to shutdown here). If you have a complicated shutdown procedure, IE certain daemons stopped, work saved, etc, it might be best to create a script that does it all (if you don't have one already) then simply call that script from the end of this one. Also to note if you have multiple PC's running off a UPS - like a rackmount server setup - you can setup ssh key auth and write a script that will remote into each machine to issue a shutdown command.

After all configuration is done, save all your work on your PC and start testing.

You can start by running the scripts directly to test email functionality:
/usr/local/bin/pwrstatd-powerfail.sh /usr/local/bin/pwrstatd-lowbatt.sh
If you get an error about command wall or beep not found - and you're using gentoo the following will resolve: echo "sys-apps/util-linux tty-helpers" >>/etc/portage/package.use/util-linux.use emerge -av util-linux beep
With other distro's you'll have to install the relevant packages or remove those commands from the scripts.

Next disconnect the power cord from the wall to your UPS. It should turn on the battery and start beeping. Depending on how you set it up above with a delay, email, and custom notification settings - you should see that go off. You can verify the status with the following command :

pwrstat -status

Finally, wait until power drains down below your set low-battery threshold - and you should see your PC do a normal/safe shutdown.