A simple UPS control tool, (currently only) to add battery testing automation to supported Synology NAS's setup with APC Back UPS.
Synology DSM's UPS capability does not support periodically testing the UPS battery. APC Back UPS models do not have built-in self-testing, so this tool's focus is to do that.
This script was validated against DSM7 OS with python2 and python3, however it should also with DSM6/python2. Its tested against an APC Back-UPS Pro 1000S, but should also work with all the other models that are supported by DSM UPS Manager (both USB and SNMP Master Mode). DSM updates seem to overwrite the edited file in step 2, resulting in an errror in the script "ERR ACCESS-DENIED". If so, update the file and restart the upsd service following steps 2 and 3.
Activate SSHd under the synology control panel if you haven't done so and SSH into it. Note: under windows you might need a decent console with ssh (git bash?) or to use PuTTY.
ssh <username>@<nas_ip> -p <ssh_port>Edit the upsd.users file and add a new user account after the existing account with permissions to run the testing commands
user@nas:/$ sudo vim /etc/ups/upsd.users
Password: <type your pwd>Be careful with the VIM editor! In case you are not familiar with it:
- Move the cursor down ↓ until you find the place where you want to add the new lines
- Press I to enter the INSERT MODE
- Edit the file as needed
- Press the Esc Key to leave the edit mode
- Press : to issue a command
- Write "wq" (write an quit) and hit Enter
So, edit the upsd.users file and add a new user with privileges to enable/disable the beeper (replace <upsd_username> and <upsd_pwd> with the desired values):
[<upsd_username>]
password = <upsd_pwd>
actions = SET
instcmds = ALLNOTE: This command no longer exists with latest DSM.
synoservice --restart ups-usb
(wait a few seconds)If the synoservice command doesn't exist, you can run
sudo upsd -c reloadClone the repo to a folder in your NAS or download the files and upload. Edit upscmd.py to set the user and pwd variables to the values created in Step 2. Edit synoups-scontroller.sh to set the full path to the upscmd.py script.
sudo chmod u+x /volume<n>/path/to/upscmd.py
sudo chmod u+x /volume<n>/path/to/synoups-scontroller.shAt this point you can test the scripts:
user@nas:/$ /volume<n>/path/to/synoups-scontroller.sh quickThe script accepts two strings for the argument, "quick" and "deep". If nothing is called, "quick" is the default.
There are some validation tests that are run to more quickly identfy errors, but I'm sure there are lots more to add later.
Go to the DSM Web interface (Control panel -> Task scheduler) and add two tasks:
- UPS Battery Quick Test
- user:
- shedule: Run on Fridays at 2am
- command:
bash /volume<n>/path/to/synoups-scontroller.sh quick - send email (your preference whether details should only be sent when the script ends abnormally)
- UPS Battery Deep Test (similar to above)
- schedule: Run on specific date and repeat every 6 months at 4am.
This schedule should ensure that the two tests would never conflict.
Test full workflow by selecting the Quick Test and clicking Run. You should hear clicking and a beep from the UPS while its testing, and in a minute or two you should receive the email report.
If the CLI testing worked but attempting to run from DSM interface doesn't work (either not hearing the testing, or receiving an email), you can troubleshoot by saving the script output results to an accessible location on the NAS, and reviewing the newest output.log.
Thanks goes to keboose on TrueNAS Forums for inspiration and @renatopanda for creating a similar tool to control the audible beeping which I heavily sourced.
- Battery Level Notifier (using triggering?)
- Beeper controller
- Check for, and fix UPS bugs (upssched.conf missing cancel-timer waittimeup online, and UPSSafeShutdown not working)