owenvoke / hass-ohdear

An Oh Dear sensor for Home Assistant

HASS Oh Dear

An Oh Dear sensor for Home Assistant

Install

Via HACS

1. Install the Home Assistant Community Store (HACS)
2. Add Oh Dear as a custom repository. See the HACS FAQs and add https://github.com/owenvoke/hass-ohdear
3. Select integration as the category
4. You should now be able to install Oh Dear via HACS
5. Once installation is complete, restart Home Assistant
6. In the HA UI, go to Configuration -> Integrations, click + and search for Oh Dear

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 ohdear 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 Oh Dear

Dependencies

This component relies on my ohdear-sdk Python package, an unofficial client for the Oh Dear API.

Usage

This can be configured fully via the Integrations interface. Click the following link to add a new Oh Dear site.

You'll need an API key from Oh Dear, you can generate one here. You'll also need to know the id of the site, you can do this by browsing to the sites page, selecting the site you want to monitor, and copying the id from the URL. Alternatively, this is shown at the bottom of the settings page under the API section.

The "Scan interval" can also be configured, this defaults to polling the API every 5 minutes.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Owen Voke
• All Contributors

License

The MIT License (MIT). Please see License File 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.

Read more about Treeware at treeware.earth.

hass-ohdear's Issues

Only show services when they are available

Do not display disabled checks as options.

Retrieve available sites from API

This would simplify the process a lot, as it wouldn't require adding a new "device" per site. It would then only require the API token, and could pull a list of sites that the token has access to.

This would require a multi-step configuration flow. 👍🏻