markvader / sonic

Sonic water shutoff valve Home Assistant integration by @markvader
MIT License
14 stars 4 forks source link
hero-labs herolabs home-assistant home-automation homeassistant integration leaks sonic water

Home Assistant Sonic custom integration

hacs_badge

This is a beta version of a custom integration for Sonic smart water shutoff valve, more features are still to be added. Additionally I am exploring local access to the sonic device to remove the need to communicate with the cloud API.

It utilises the herolabsapi python library that I have written to interact with Sonic devices using the official Hero Labs API (cloud based).

Integration Development

Full commit history

Installation

Ideally this will be adopted as an inbuilt integration, however while development and testing are ongoing the recommended way to install Sonic is through HACS.

To install it:

  1. Open HACS within Home Assistant
  2. Click the Integrations section, then Explore and Download Repositories button.
  3. Search for Sonic then click on the download button
  4. Select the latest version (or latest beta version) and download
  5. Then restart Home Assistant
  6. Go to Settings / Devices & Services (Integrations Tab) / Add Integration and search for Sonic (Hero Labs) then follow the configuration steps below

Configuration

  1. Log into the integration with your Hero Labs account details (Email & Password).
  2. Any sonic devices on your account should be discovered, an additional device will be setup for each property registered to your account (e.g. if you have 2 properties with a sonic device at each property you will have 4 devices setup).
  3. You can assign each device to an area within your home.

To update the integration

As development happens there will be updates to the integration, so it will be good to periodically update,

In HACS:

  1. Click on Integrations,
  2. Scroll down and find the "Sonic"
  3. Click the 3 dots on the lower right corner and click "Redownload"

How you can help?

Please file issues within the github repository for anything that you think could be broken, is broken, could be improved or is a requested feature.