Waveshare UPS HAT Integration for Home Assistant

This integration allows you to monitor Waveshare UPS Hat status in your Home Assistant instance.

Installation

HACS

If you use HACS you can install and update this component.

1. Go into HACS -> CUSTOM REPOSITORIES and add url: https://github.com/mykhailog/hacs_waveshare_ups_hat with type "integration"
2. Go to integration, search "waveshare_ups_hat" and click Install.

Manual

Download and unzip or clone this repository and copy custom_components/waveshare_ups_hat/ to your configuration directory of Home Assistant, e.g. ~/.homeassistant/custom_components/.

In the end your file structure should look like that:

~/.homeassistant/custom_components/waveshare_ups_hat/__init__.py
~/.homeassistant/custom_components/waveshare_ups_hat/manifest.json
~/.homeassistant/custom_components/waveshare_ups_hat/sensor.py
~/.homeassistant/custom_components/waveshare_ups_hat/binary_sensor.py
~/.homeassistant/custom_components/waveshare_ups_hat/const.py
~/.homeassistant/custom_components/waveshare_ups_hat/ina219.py

Configuration

Sensor

Create a new sensor entry in your configuration.yaml

sensor:
  - platform: waveshare_ups_hat
    name: UPS                    # Optional
    unique_id: waveshare_ups     # Optional

Following data can be read:

• SoC (State of Charge)
• PSU Voltage
• Shunt Voltage
• Current
• Power
• Charging Status
• Online Status
• Is Low Battery (< 20%)

If you consistently experience capacity below 100% when the device is fully charged, you can adjust it using the max_soc property.

sensor:
  - platform: waveshare_ups_hat
    max_soc: 91                      

Binary Sensor

In addition to the sensor devices, you may also create a device which is simply “on” when the UPS status is online and “off” at all other times.

binary_sensor:
  - platform: waveshare_ups_hat

Directions for installing smbus support on Raspberry Pi

HassOS

To enable i2c in Home Assistant OS System follow this instruction or use this addon

Home Asisstant Core

Enable I2c interface with the Raspberry Pi configuration utility:

# pi user environment: Enable i2c interface
$ sudo raspi-config

Select Interfacing options->I2C choose <Yes> and hit Enter, then go to Finish and you'll be prompted to reboot.

Install dependencies for use the smbus-cffi module and enable your homeassistant user to join the i2c group:

# pi user environment: Install i2c dependencies and utilities
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev

# pi user environment: Add homeassistant user to the i2c group
$ sudo addgroup homeassistant i2c

# pi user environment: Reboot Raspberry Pi to apply changes
$ sudo reboot

Check the i2c address of the sensor

After installing i2c-tools, a new utility is available to scan the addresses of the connected sensors:

/usr/sbin/i2cdetect -y 1

It will output a table like this:

     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
00:          -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- 77

License

MIT 2023