Spa Client v3.0

- Added fault log sensor (shows last fault message in list)
- Updated lighting entity to handle color mode requirements
- Code cleanup

README.md

@@ -12,7 +12,7 @@
 
 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!
+**Spa Client** is inspired by several similar projects and the work of many people. With version 2.0 and later, 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
 
@@ -64,6 +64,7 @@ Filter Cycle 2 Begins | Time | ✓ | N/A
 Filter Cycle 2 Runs | Time | ✓ | N/A
 Filter Cycle 2 Status | Binary sensor | ✓ | Begins, Runs, Ends
 Heat Mode | Switch | ✓ | Ready, Rest, Ready in Rest
+Last Known Fault | Sensor | ✓ | N/A
 Light 1 | Light | ✓ | False, True
 Light 2 | Light | ? | False, True
 Mister | Switch | ? | Off, On
@@ -90,7 +91,6 @@ Time sync with Home Assistant | ✓
 
 - [ ] Bring back the ability to configure this custom component via the entries in configuration.yaml
 - [ ] Change the way I update entities (from polling mode to subscribing to updates)
-- [ ] Implement the other spa messages (fault log, gfi test, etc.)
 
 ### Completed
 
@@ -99,6 +99,7 @@ Time sync with Home Assistant | ✓
 - [x] Allow the installation of this custom component through the Home Assistant integrations menu (use of config_flow.py)
 - [x] Create an icon and logo for this custom component
 - [x] Customize entity IDs with **Spa Client** custom name to allow multiple integrations in the same Home Assistant instance
+- [x] Implement the other spa messages (fault log, gfi test, etc.)
 - [x] Investigate why it takes so long to load the component on an RPi (~2s on docker; ~85s on RPi3)
 - [x] Manage the availability of entities while not connected
 

custom_components/spaclient/__init__.py

@@ -67,16 +67,19 @@ async def async_setup_entry(hass, config_entry):
     if not connected:
         raise ConfigEntryNotReady
 
-    await spa.send_module_identification_request()
-    await spa.send_configuration_request()
-    await spa.send_information_request()
     await spa.send_additional_information_request()
+    await spa.send_configuration_request()
+    await spa.send_fault_log_request()
     await spa.send_filter_cycles_request()
+    await spa.send_gfci_test_request()
+    await spa.send_information_request()
+    await spa.send_module_identification_request()
+    await spa.send_preferences_request()
 
     await update_listener(hass, config_entry)
 
-    hass.loop.create_task(spa.read_all_msg())
     hass.loop.create_task(spa.keep_alive_call())
+    hass.loop.create_task(spa.read_all_msg())
 
     for component in SPACLIENT_COMPONENTS:
         hass.async_create_task(hass.config_entries.async_forward_entry_setup(config_entry, component))

custom_components/spaclient/const.py

@@ -14,15 +14,39 @@
     "binary_sensor",
     "climate",
     "light",
+    "sensor",
     "switch",
     "time",
 ]
 
+FAULT_MSG = {
+    15: "Sensors are out of sync",
+    16: "The water flow is low",
+    17: "The water flow has failed",
+    18: "The settings have been reset",
+    19: "Priming Mode",
+    20: "The clock has failed",
+    21: "The settings have been reset",
+    22: "Program memory failure",
+    26: "Sensors are out of sync -- Call for service",
+    27: "The heater is dry",
+    28: "The heater may be dry",
+    29: "The water is too hot",
+    30: "The heater is too hot",
+    31: "Sensor A Fault",
+    32: "Sensor B Fault",
+    34: "A pump may be stuck on",
+    35: "Hot fault",
+    36: "The GFCI test failed",
+    37: "Standby Mode (Hold Mode)"
+}
+
 ICONS = {
     "Auxiliary 1": "mdi:numeric-1-circle-outline",
     "Auxiliary 2": "mdi:numeric-2-circle-outline",
     "Blower": "mdi:weather-windy",
     "Circulation Pump": "mdi:fan",
+    "Fault Log": "mdi:archive-alert",
     "Filter Cycle": "mdi:sync",
     "Heat Mode": "mdi:alpha-r",
     "Mister": "mdi:auto-fix",

custom_components/spaclient/light.py

@@ -3,7 +3,7 @@
 from . import SpaClientDevice
 from .const import _LOGGER, DOMAIN, SPA
 from datetime import timedelta
-from homeassistant.components.light import LightEntity
+from homeassistant.components.light import ColorMode, LightEntity
 
 SCAN_INTERVAL = timedelta(seconds=1)
 
@@ -42,6 +42,16 @@ def name(self):
         """Return the name of the device."""
         return 'Light ' + str(self._light_num)
 
+    @property
+    def color_mode(self):
+        """Return the color mode of the light."""
+        return ColorMode.ONOFF
+
+    @property
+    def supported_color_modes(self):
+        """Return supported color modes."""
+        return [ColorMode.ONOFF]
+
     @property
     def is_on(self):
         """Return true if light is on."""

custom_components/spaclient/manifest.json

@@ -6,5 +6,5 @@
     "documentation": "https://github.com/plmilord/Hass.io-custom-component-spaclient",
     "iot_class": "local_push",
     "issue_tracker": "https://github.com/plmilord/Hass.io-custom-component-spaclient/issues",
-    "version": "2.83"
+    "version": "3.0"
 }

custom_components/spaclient/sensor.py

@@ -0,0 +1,60 @@
+"""Support for Spa Client sensors."""
+# Import the device class from the component that you want to support
+from . import SpaClientDevice
+from .const import _LOGGER, DOMAIN, ICONS, FAULT_MSG, SPA
+from datetime import timedelta
+from homeassistant.components.sensor import SensorEntity
+
+SCAN_INTERVAL = timedelta(seconds=1)
+
+
+async def async_setup_entry(hass, config_entry, async_add_entities):
+    """Set up the Spa Client sensors."""
+
+    spaclient = hass.data[DOMAIN][config_entry.entry_id][SPA]
+    entities = []
+
+    entities.append(SpaFaultLog(spaclient, config_entry))
+
+    async_add_entities(entities, True)
+
+
+class SpaFaultLog(SpaClientDevice, SensorEntity):
+    """Representation of a sensor."""
+
+    def __init__(self, spaclient, config_entry):
+        """Initialize the device."""
+        super().__init__(spaclient, config_entry)
+        self._spaclient = spaclient
+        self._sensor_type = None
+        self._icon = ICONS.get('Fault Log')
+
+    @property
+    def unique_id(self) -> str:
+        """Return a unique ID."""
+        return f"{self._spaclient.get_macaddr().replace(':', '')}#fault_log"
+
+    @property
+    def device_class(self):
+        """Return the class of this sensor."""
+        return self._sensor_type
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return 'Last Known Fault'
+
+    @property
+    def icon(self):
+        """Return the icon of the device."""
+        return self._icon
+
+    @property
+    def native_value(self):
+        """Return the state of this sensor."""
+        return FAULT_MSG.get(self._spaclient.get_fault_log_msg_code())
+
+    @property
+    def available(self) -> bool:
+        """Return True if entity is available."""
+        return self._spaclient.get_gateway_status()