https://github.com/owenvoke/hass-bristol-water
A Bristol Water sensor for Home Assistant
https://github.com/owenvoke/hass-bristol-water
bristol bristol-water hass home-assistant water water-quality
Last synced: 4 months ago
JSON representation
A Bristol Water sensor for Home Assistant
- Host: GitHub
- URL: https://github.com/owenvoke/hass-bristol-water
- Owner: owenvoke
- License: mit
- Created: 2025-06-06T12:52:37.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-06-06T15:26:54.000Z (5 months ago)
- Last Synced: 2025-06-26T01:40:59.371Z (4 months ago)
- Topics: bristol, bristol-water, hass, home-assistant, water, water-quality
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# HASS Bristol Water
[![Latest Version][ico-version]][link-releases]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
A [Bristol Water](https://bristolwater.co.uk) sensor for Home Assistant
## Install
### Via HACS
1. Install the [Home Assistant Community Store (HACS)](https://hacs.xyz/docs/setup/download)
2. Add Bristol Water as a custom repository. See [the HACS FAQs](https://hacs.xyz/docs/faq/custom_repositories) and
add `https://github.com/owenvoke/hass-bristol-water`
3. Select `integration` as the category
4. You should now be able to install Bristol Water via HACS
5. Once installation is complete, restart Home Assistant
6. In the HA UI, go to `Configuration -> Integrations`, click `+` and search for `Bristol Water`
### Manual
1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`)
2. If you do not have a `custom_components` directory there, you need to create it
3. Add the `bristol_water` directory and its contents from this repository to the `custom_components` directory in your Home
Assistant configuration directory
4. Restart Home Assistant
5. In the HA UI, go to `Configuration -> Integrations`, click `+` and search for `Bristol Water`
## Usage
This can be configured fully via the Integrations interface. Click the following link to add a new Bristol Water site.
[](https://my.home-assistant.io/redirect/config_flow_start?domain=bristol_water)
The "Scan interval" can also be configured, this defaults to polling the API every 30 minutes.
## Security
If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.
## Credits
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Treeware
You're free to use this package, but if it makes it to your production environment please consider buying the world a
tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising
above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating
employment for local families and restoring wildlife habitats.
You can buy trees [here][link-treeware-gifting].
Read more about Treeware at [treeware.earth][link-treeware].
[ico-version]: https://img.shields.io/github/v/release/owenvoke/hass-bristol-water.svg?style=flat-square&sort=semver
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/owenvoke/hass-bristol-water/tests.yml?branch=main&style=flat-square
[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square
[link-releases]: https://github.com/owenvoke/hass-bristol-water/releases
[link-github-actions]: https://github.com/owenvoke/hass-bristol-water/actions
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: ../../contributors