https://github.com/mykhailog/hacs_waveshare_ups_hat
Waveshare UPS Hat integration for Home Assistant.
https://github.com/mykhailog/hacs_waveshare_ups_hat
hacs homeassistant ups
Last synced: 6 months ago
JSON representation
Waveshare UPS Hat integration for Home Assistant.
- Host: GitHub
- URL: https://github.com/mykhailog/hacs_waveshare_ups_hat
- Owner: mykhailog
- License: mit
- Created: 2021-04-08T23:52:23.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-29T11:47:09.000Z (over 1 year ago)
- Last Synced: 2025-01-29T12:32:44.277Z (over 1 year ago)
- Topics: hacs, homeassistant, ups
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 20
- Watchers: 3
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Waveshare UPS HAT Integration for Home Assistant
This integration allows you to monitor [Waveshare UPS Hat](https://www.waveshare.com/wiki/UPS_HAT) status in your Home Assistant instance.
## Installation
### HACS
If you use [HACS](https://hacs.xyz/) 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`
```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.
```yaml
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.
```yaml
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](https://www.home-assistant.io/common-tasks/os/#enable-i2c) or
use this [addon](https://community.home-assistant.io/t/add-on-hassos-i2c-configurator/264167)
### Home Asisstant Core
Enable I2c interface with the Raspberry Pi configuration utility:
```bash
# pi user environment: Enable i2c interface
$ sudo raspi-config
```
Select `Interfacing options->I2C` choose `` 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:
```bash
# 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:
```bash
/usr/sbin/i2cdetect -y 1
```
It will output a table like this:
```text
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