A Network UPS Tools daemon to allow you to easily manage battery backup (UPS) devices connected to your Home Assistant machine.
The primary goal of the Network UPS Tools (NUT) project is to provide support for Power Devices, such as Uninterruptible Power Supplies, Power Distribution Units, Automatic Transfer Switch, Power Supply Units and Solar Controllers.
NUT provides many control and monitoring features, with a uniform control and management interface.
More than 140 different manufacturers, and several thousands models are compatible.
The Network UPS Tools (NUT) project is the combined effort of many individuals and companies.
Be sure to add a NUT Sensor to your configuration.yaml
after starting the
add-on:
sensor:
- platform: nut
name: "CyberPower 1500"
host: a0d7b954-nut
username: nutty
password: changeme
resources:
- battery.charge
- battery.runtime
- ups.load
- ups.status
Note: The host a0d7b954-nut
is required to allow Home Assistant to
communicate directly with the addon
For more information on how to configure the NUT Sensor in Home Assistant see the NUT Sensor documentation.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
- Search for the "Network UPS Tools" add-on in the Home Assistant add-on store and install it.
- Install the "Network UPS Tools" add-on.
- Configure the
users
anddevices
options. - Start the "Network UPS Tools" add-on.
- Check the logs of the "Network UPS Tools" add-on to see if everything went well.
- Configure NUT Sensor in your
configuration.yaml
file.
The add-on can be used with the basic configuration, with other options for more advanced users.
Note: Remember to restart the add-on when the configuration is changed.
Network UPS Tools add-on configuration:
users:
- username: nutty
password: changeme
instcmds:
- all
actions: []
devices:
- name: myups
driver: usbhid-ups
port: auto
config: []
mode: netserver
shutdown_host: 'false'
Note: This is just an example, don't copy and paste it! Create your own!
The log_level
option controls the level of log output by the add-on and can
be changed to be more or less verbose, which might be useful when you are
dealing with an unknown issue. Possible values are:
trace
: Show every detail, like all called internal functions.debug
: Shows detailed debug information.info
: Normal (usually) interesting events.warning
: Exceptional occurrences that are not errors.error
: Runtime errors that do not require immediate action.fatal
: Something went terribly wrong. Add-on becomes unusable.
Please note that each level automatically includes log messages from a
more severe level, e.g., debug
also shows info
messages. By default,
the log_level
is set to info
, which is the recommended setting unless
you are troubleshooting.
This option allows you to specify a list of one or more users. Each user can have its own privileges like defined in the sub-options below.
Refer to the upsd.users(5)
documentation for more information.
The username the user needs to use to login to the NUT server. A valid username
contains only a-z
, A-Z
, 0-9
and underscore characters (_
).
Set the password for this user.
A list of instant commands that a user is allowed to initiate. Use all
to
grant all commands automatically.
A list of actions that a user is allowed to perform. Valid actions are:
set
: change the value of certain variables in the UPS.fsd
: set the forced shutdown flag in the UPS. This is equivalent to an "on battery + low battery" situation for the purposes of monitoring.
The list of actions is expected to grow in the future.
Add the necessary actions for a upsmon
process to work. This is either set to
master
or slave
. If creating an account for a netclient
setup to connect
this should be set to slave
.
This option allows you to specify a list of UPS devices attached to your system.
Refer to the ups.conf(5)
documentation for more information.
The name of the UPS. The name default
is used internally, so you canβt use
it in this file.
This specifies which program will be monitoring this UPS. You need to specify
the one that is compatible with your hardware. See nutupsdrv(8)
for more information on drivers in general and pointers to the man pages of
specific drivers.
This is the serial port where the UPS is connected. The first serial port
usually is /dev/ttyS0
. Use auto
to automatically detect the port.
A list of additional options to configure for this UPS. The common
usbhid-ups
driver allows you to distinguish between devices by
using a combination of the vendor
, product
, serial
, vendorid
, and
productid
options:
devices:
- name: mge
driver: usbhid-ups
port: auto
config:
- vendorid = 0463
- name: apcups
driver: usbhid-ups
port: auto
config:
- vendorid = 051d*
- name: foocorp
driver: usbhid-ups
port: auto
config:
- vendor = "Foo.Corporation.*"
- name: smartups
driver: usbhid-ups
port: auto
config:
- product = ".*(Smart|Back)-?UPS.*"
Recognized values are netserver
and netclient
.
netserver
: Runs the components needed to manage a locally connected UPS and allow other clients to connect (either as slaves or for management).netclient
: Only runsupsmon
to connect to a remote system running asnetserver
.
When this option is set to true
on a UPS shutdown command, the host system
will be shutdown. When set to false
only the add-on will be stopped. This is to
allow testing without impact to the system.
When this option is set to true
, a list of connected USB devices will be
displayed in the add-on log when the add-on starts up. This option can be used
to help identify different UPS devices when multiple UPS devices are connected
to the system.
When running in netclient
mode, the name of the remote UPS.
When running in netclient
mode, the host of the remote UPS.
When running in netclient
mode, the user of the remote UPS.
When running in netclient
mode, the password of the remote UPS.
Note: When using the remote option, the user and device options must still be present, however they will have no effect
Creates fake USB devices to fix problems with Cyber Power UPSes. Only enable this if you sure you are affected. More info
Allows setting the MAXAGE value in upsd.conf to increase the timeout for specific drivers, should not be changed for the majority of users.
Adding this option to the add-on configuration allows to you bypass the
HaveIBeenPwned password requirement by setting it to true
.
Note: We STRONGLY suggest picking a stronger/safer password instead of using this option! USE AT YOUR OWN RISK!
Adding this option to the add-on configuration allows you to disable
authentication on the NUT server by setting it to true
and leaving the
username and password empty.
Note: We STRONGLY suggest, not to use this, even if this add-on is only exposed to your internal network. USE AT YOUR OWN RISK!
Whenever your UPS changes state, an event named nut.ups_event
will be fired.
It's payload looks like this:
Key | Value |
---|---|
ups_name |
The name of the UPS as you configured it |
notify_type |
The type of notification |
notify_msg |
The NUT default message for the notification |
notify_type
signifies what kind of notification it is.
See the below table for more information as well as the message that will be in
notify_msg
. %s
is automatically replaced by NUT with your UPS name.
Type | Cause | Default Message |
---|---|---|
ONLINE |
UPS is back online | "UPS %s on line power" |
ONBATT |
UPS is on battery | "UPS %s on battery" |
LOWBATT |
UPS has a low battery (if also on battery, it's "critical") | "UPS %s battery is low" |
FSD |
UPS is being shutdown by the master (FSD = "Forced Shutdown") | "UPS %s: forced shutdown in progress" |
COMMOK |
Communications established with the UPS | "Communications with UPS %s established" |
COMMBAD |
Communications lost to the UPS | "Communications with UPS %s lost" |
SHUTDOWN |
The system is being shutdown | "Auto logout and shutdown proceeding" |
REPLBATT |
The UPS battery is bad and needs to be replaced | "UPS %s battery needs to be replaced" |
NOCOMM |
A UPS is unavailable (can't be contacted for monitoring) | "UPS %s is unavailable" |
NOPARENT |
The process that shuts down the system has died (shutdown impossible) | "upsmon parent process died - shutdown impossible" |
This event allows you to create automations to do things like send a critical notification to your phone:
automations:
- alias: 'UPS changed state'
trigger:
- platform: event
event_type: nut.ups_event
action:
- service: notify.mobile_app_<your_device_id_here>
data_template:
title: "UPS changed state"
message: "{{ trigger.event.data.notify_msg }}"
data:
push:
sound:
name: default
critical: 1
volume: 1.0
If you are using the NUT integration in Home Assistant, then you can also use this event to trigger it to push/update the status in realtime:
automations:
- alias: 'UPS Pushed State Update'
trigger:
- platform: event
event_type: nut.ups_event
action:
- service: homeassistant.update_entity
data:
entity_id:
- sensor.my_ups_status
For more information, see the NUT docs here and here.
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH
. In a nutshell, the version will be incremented
based on the following:
MAJOR
: Incompatible or major changes.MINOR
: Backwards-compatible new features and enhancements.PATCH
: Backwards-compatible bugfixes and package updates.
Got questions?
You have several options to get them answered:
- The Home Assistant Community Add-ons Discord chat server for add-on support and feature requests.
- The Home Assistant Discord chat server for general Home Assistant discussions and questions.
- The Home Assistant Community Forum.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved! π
The original setup of this repository is by Dale Higgs.
For a full list of all authors and contributors, check the contributor's page.
Want some more functionality to your Home Assistant instance?
We have created multiple add-ons for Home Assistant. For a full list, check out our GitHub Repository.
MIT License
Copyright (c) 2018-2020 Dale Higgs
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.