Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 4.96 KB

README.md

File metadata and controls

104 lines (78 loc) · 4.96 KB
Raw

Sutro

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance

Discord Community Forum

This component integrates Home Assistant with Sutro (https://mysutro.com/), a device that enables automated remote monitoring of the temperature as well as the chlorine/bromine, pH, and alkalinity levels.

This component will set up the following platforms.

Platform Description
sensor Show measurements from Sutro.
binary_sensor Show device state from Sutro.
todo Show recommendations from Sutro.

example

Installation

You can install the Sutro integration in one of two ways - using HACS or by manually copying the files into the custom_integrations folder of your Home Assistant. The HACS option is significantly quicker and allows for easy updating in the future.

Using HACS

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Click the link above to open the Sutro integration in HACS or just search for it by name in the HACS UI and click on it
  2. Click on the "Download" button
  3. Restart Home Assistant
  4. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Sutro"

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 (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called sutro.
  4. Download all the files from the custom_components/sutro/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Sutro"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/sutro/translations/en.json
custom_components/sutro/__init__.py
custom_components/sutro/api.py
custom_components/sutro/binary_sensor.py
custom_components/sutro/config_flow.py
custom_components/sutro/const.py
custom_components/sutro/entity.py
custom_components/sutro/manifest.json
custom_components/sutro/sensor.py
custom_components/sutro/todo.py

Configuration is done in the UI

To configure the integration, you need to provide the e-mail and password for your Sutro account: login

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template