Please also support https://github.com/pbutterworth/astralpool_chlorinator for his initial work with the Astral Viron EQ Chlorinator.
**This component will set up the following platforms.**
| Platform | Description |
|---|---|
binary_sensor |
Show something True or False. |
sensor |
Show info from Astral Pool Halo Chlorinator API. |
select |
Control the chlorinator mode (off/auto/manual) |
- Obtain an ESP32 dev board. The M5Stack Atom Lite is a great choice for first timers.
- Connect your ESP32 to your computer with a USB Data Cable. Double-check it actually IS actually a data cable and not just a charge cable.
- Visit https://esphome.io/projects/?type=bluetooth.
- Select "Bluetooth Proxy" and your device type.
- Flash your device.
- Join it to your WiFi network.
- Add it to Home Assistant as an ESPHome device. You do not need the ESPHome server running, just the ESPHome device discovered.
- Ping your device IP to confirm it's online.
- Mount your ESP32 device close (recommend within ~1 meter for best performance) to your Halo Chlorinator and within WiFi network range.
Best experience is to install with HACS.
- Open the HACS page on your Home Assistant Dashboard.
- Select "Integrations".
- From the 3 dots menu, select "Custom Repositories".
- Add the URL of this GitHub (https://github.com/DanielNagy/astralpool_halo_chlorinator). Select "Integration" as the Category.
- Select "Astral Pool Halo Chlorinator". Download/install the latest version.
- Restart HomeAssistant when instructed.
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml). - If you do not have a
custom_componentsdirectory (folder) there, you need to create it. - In the
custom_componentsdirectory (folder) create a new folder calledastralpool_halo_chlorinator. - Download all the files from the
custom_components/astralpool_halo_chlorinator/directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Using your HA configuration directory (folder) as a starting point you should now also have this:
custom_components/astralpool_halo_chlorinator/translations/en.json
custom_components/astralpool_halo_chlorinator/translations/fr.json
custom_components/astralpool_halo_chlorinator/translations/nb.json
custom_components/astralpool_halo_chlorinator/translations/sensor.en.json
custom_components/astralpool_halo_chlorinator/translations/sensor.fr.json
custom_components/astralpool_halo_chlorinator/translations/sensor.nb.json
custom_components/astralpool_halo_chlorinator/translations/sensor.nb.json
custom_components/astralpool_halo_chlorinator/__init__.py
custom_components/astralpool_halo_chlorinator/api.py
custom_components/astralpool_halo_chlorinator/binary_sensor.py
custom_components/astralpool_halo_chlorinator/config_flow.py
custom_components/astralpool_halo_chlorinator/const.py
custom_components/astralpool_halo_chlorinator/manifest.json
custom_components/astralpool_halo_chlorinator/sensor.py
custom_components/astralpool_halo_chlorinator/switch.py
- Restart Home Assistant when instructed.
- Visit your HomeAssistant Integrations Dashboard
- Wait patiently for your chlorinator to be discovered (should only be a few seconds once HA has started up)
- When the Halo device is detected in Home Assistant, you will see a new HCHLOR integration card with button for 'Configure'.
- Go to your physical Halo Control Panel (the one near your pool) to start the pairing process.
- Take a mobile device or laptop with you so you can control Home Assistant and the Chlorinator from the same place.
- Open your Home Assistant Integrations page
- Click the 'Configure' button on the newly discovered HCHLOR device.
- Press submit to confirm 'add device'.
- Home Assistant will start polling for new pairing connections.
- On Halo Control Panel: Put your HALO into pairing mode.
- On Home Assistant: Once discovered, Home Assistant will ask you what HA Area the Halo is located. Select your area as desired.
- Your Halo should now be added to HA as 1 new device with ~19 entities.
Troubleshooting:
- The HA pairing discovery may either error or the circle might just spin forever.
- If it errors, hit config / add / confirm again (whilst the Halo is still in pairing mode).
- If it is spinning, just wait approx 30 seconds, then cancel it, and hit configure again.
- Repeat as needed until the pairing is successful.
Halo only supports one concurrent Bluetooth or Cloud connection at any point in time.
While Home Assistant is polling your Halo, you will not be able to use your mobile app to connect to the Halo either via Bluetooth or Cloud.
Likewise, while your mobile is connected, Home Assistant will not be able to poll the Halo.
If you need to access Halo from your mobile while Home Assistant is connected, you will have to wait for the poll to finish and then open your mobile connection.
- Open your mobile app and look for a 'blue dot' next to your chlorinator.
- If it is NOT there, HA is currently polling for data (takes 20 seconds to complete).
- As soon as the blue dot appears, you will be able to connect to it from your mobile.
Hidden Menu
Halo has a hidden system menu that allows you to display the actual ORP value on the Halo screen and also on the app screen. Here is a video on how to access the menu. https://www.youtube.com/watch?v=zaRFVSt8Hc4
https://github.com/wilsto/pool-monitor-card The "Pool Monitor Card" is a home assistant plugin that display information of 12 pre-defined sensors of your swimming pool : temperature, pH, ORP levels and TDS but also if you need them : salinity, CYA, calcium, phosphate, alkalinity, free chlorine, total chlorine, filter pressure
This project was forked from @pbutterworth's' AstralPool Chlorinator with a future goal to merge both Halo and EQ together.
This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.
Code template was mainly taken from @Ludeeus's integration_blueprint template