pbutterworth / astralpool_chlorinator

Home Assistant custom component to interface with Astra Pool Viron Equilibrium pool chlorinators
MIT License
5 stars 2 forks source link
bluetooth custom-component home-assistant homeassistant python

Astral Pool Viron eQuilibrium Chlorinator

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance

Community Forum

BuyMeCoffee

**This component will set up the following platforms.**

Platform Description
binary_sensor Show something True or False.
sensor Show info from Astral Pool Viron eQuilibrium Chlorinator API.
select Control the chlorinator mode (off/auto/manual)

Installation

  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 astralpool_chlorinator.
  4. Download all the files from the custom_components/astralpool_chlorinator/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. Wait paitently for your chlorinator to be discovered (should only be a few seconds once HA has started up)

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

custom_components/astralpool_chlorinator/translations/en.json
custom_components/astralpool_chlorinator/translations/fr.json
custom_components/astralpool_chlorinator/translations/nb.json
custom_components/astralpool_chlorinator/translations/sensor.en.json
custom_components/astralpool_chlorinator/translations/sensor.fr.json
custom_components/astralpool_chlorinator/translations/sensor.nb.json
custom_components/astralpool_chlorinator/translations/sensor.nb.json
custom_components/astralpool_chlorinator/__init__.py
custom_components/astralpool_chlorinator/api.py
custom_components/astralpool_chlorinator/binary_sensor.py
custom_components/astralpool_chlorinator/config_flow.py
custom_components/astralpool_chlorinator/const.py
custom_components/astralpool_chlorinator/manifest.json
custom_components/astralpool_chlorinator/sensor.py
custom_components/astralpool_chlorinator/switch.py

Configuration is done in the UI

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