diff --git a/README.md b/README.md index 47c391b..efeb5c0 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ +Since the event where my spa emptied when it was -30°C outside and it took me a while to find out (luckily, more fear than harm!)... I tried to find a solution to better supervise my spa! Initially, I wanted to replicate my iPhone's **Coast Spas** App in Home Assistant so that I could create notifications, track, control and automate/script some stuff. I was also looking to replicate my home automation in the **Home** App to simplify my family's access to all my different platforms. Home Assistant was the perfect fit for that! + +**Spa Client** is inspired by several similar projects and the work of many people. With version 2.0, several elements have been improved in order to represent the App **Coast Spas** as faithfully as possible. During installation, all the components are created according to the configuration of your spa! + ## What you need - A Hot Tub Equipped with a Balboa BP System @@ -14,9 +18,9 @@ ## Custom component setup -1-Copy these project files into your Home Assistant ```/config/custom_components``` directory. +1-Copy these project files into your Home Assistant ```/config/custom_components``` directory. -2-Install **Spa Client** integration through the Home Assistant integrations menu (you may need to press F5 in your browser to refresh Home Assistant cache files so that it appears in the menu of available integrations). +2-Install **Spa Client** integration through the Home Assistant integrations menu (you may need to press F5 in your browser to refresh Home Assistant cache files so that it appears in the menu of available integrations). 3-Enjoy! @@ -30,6 +34,39 @@ +Several elements have already been validated (with my spa), but several remain to be validated **with your help**. The following table shows what is known to be functional: + +Entity | Type | Tested | Programmed entity attributes +------ | ---- | ------ | ---------------------------- +Auxiliary 1 | Switch | ? | N/A +Auxiliary 2 | Switch | ? | N/A +Blower | Switch | ? | N/A +Circulation Pump | Binary sensor | ? | N/A +Filter Cycle 1 Status | Binary sensor | ✓ | Begins, Runs, Ends +Filter Cycle 2 | Switch | ✓ | N/A +Filter Cycle 2 Status | Binary sensor | ✓ | Begins, Runs, Ends +Heat Mode | Switch | ✓ | Ready, Rest, Ready in Rest +Light 1 | Light | ✓ | N/A +Light 2 | Light | ? | N/A +Mister | Switch | ? | N/A +Pump 1 | Switch | ✓ | Off, Low, High +Pump 2 | Switch | ✓ | Off, Low, High +Pump 3 | Switch | ✓ | Off, Low, High +Pump 4 | Switch | ? | Off, Low, High +Pump 5 | Switch | ? | Off, Low, High +Pump 6 | Switch | ? | Off, Low, High +Spa Thermostat | Climate | ✓ | N/A +Temperature Range | Switch | ✓ | Low, High +bwa Wi-Fi Module | Binary sensor | ✓ | N/A + +Option | Tested +------ | ------ +Entities polling rate (seconds) | Not yet implemented! +Time sync with Home Assistant | ✓ + +✓ = Tested and working properly (represents my spa options) +? = Need your help to validate if this working properly (I don't have these options on my spa) + ## Task List - [x] Create an icon and logo for this custom component