Merge pull request #68 from vincentwolsink/relay-updates

Update name of relay entity and add some entities

Author: vincentwolsink

custom_components/enphase_envoy/binary_sensor.py

@@ -50,12 +50,12 @@ async def async_setup_entry(
         elif sensor_description.key == "relays":
             if coordinator.data.get("relays") is not None:
                 for relay in coordinator.data["relays"]:
-                    device_name = f"{sensor_description.name} {relay}"
-                    entity_name = f"{name} {device_name}"
+                    device_name = f"Relay {relay}"
+                    entity_name = f"{device_name} {sensor_description.name}"
 
                     serial_number = relay
                     entities.append(
-                        EnvoyRelayEntity(
+                        EnvoyRelayContactEntity(
                             sensor_description,
                             entity_name,
                             device_name,
@@ -66,6 +66,28 @@ async def async_setup_entry(
                         )
                     )
 
+        elif sensor_description.key.startswith("relays_"):
+            sensor_key = sensor_description.key.split("_", 1)[-1]
+            if coordinator.data.get("relays") != None:
+                for serial_number, data in coordinator.data["relays"].items():
+                    if data.get(sensor_key, None) == None:
+                        continue
+
+                    device_name = f"Relay {serial_number}"
+                    entity_name = f"{device_name} {sensor_description.name}"
+
+                    entities.append(
+                        EnvoyRelayGenericEntity(
+                            sensor_description,
+                            entity_name,
+                            device_name,
+                            serial_number,
+                            None,
+                            coordinator,
+                            config_entry.unique_id,
+                        )
+                    )
+
         elif sensor_description.key == "firmware":
             if coordinator.data.get("update_status") is not None:
                 entity_name = f"{name} {sensor_description.name}"
@@ -312,24 +334,65 @@ class EnvoyRelayEntity(EnvoyBinaryEntity):
 
     MODEL = "Relay"
 
+    @property
+    def relay(self):
+        return self.coordinator.data.get("relays", {}).get(
+            self._device_serial_number, {}
+        )
+
+    @property
+    def value_key(self):
+        if "_" in self.entity_description.key:
+            return self.entity_description.key.split("_", 1)[-1]
+        return self.entity_description.key
+
+    @property
+    def available(self) -> bool:
+        """Return if entity is available."""
+        if not self.coordinator.last_update_success:
+            return False
+
+        if self.value_key != "communicating":
+            return self.relay.get("communicating")
+
+        return True
+
     @property
     def is_on(self) -> bool | None:
         """Return true if the binary sensor is on."""
-        relays = self.coordinator.data.get("relays")
-        if relays is None:
+        if self.relay is None:
             return None
 
-        return relays.get(self._serial_number).get("relay") == "closed"
+        return self.relay.get("relay") == "closed"
 
     @property
     def extra_state_attributes(self) -> dict | None:
         """Return the state attributes."""
-        if self.coordinator.data.get("relays") is not None:
-            relay = self.coordinator.data.get("relays").get(self._serial_number)
-            return {
-                "last_reported": relay.get("report_date"),
-                "reason_code": relay.get("reason_code"),
-                "reason": relay.get("reason"),
-            }
+        if self.relay is None:
+            return None
+
+        return {
+            "last_reported": self.relay.get("report_date"),
+            "reason_code": self.relay.get("reason_code"),
+            "reason": self.relay.get("reason"),
+        }
+
+
+class EnvoyRelayContactEntity(EnvoyRelayEntity):
+    @property
+    def icon(self):
+        return "mdi:electric-switch-closed" if self.is_on else "mdi:electric-switch"
 
+
+class EnvoyRelayGenericEntity(EnvoyRelayEntity):
+    @property
+    def is_on(self) -> bool | None:
+        """Return true if the binary sensor is on."""
+        if self.relay is None:
+            return None
+
+        return self.relay.get(self.value_key)
+
+    @property
+    def extra_state_attributes(self) -> dict | None:
         return None

custom_components/enphase_envoy/const.py

@@ -314,9 +314,19 @@
     ),
     BinarySensorEntityDescription(
         key="relays",
-        name="Relay",
+        name="Contact",
         device_class=BinarySensorDeviceClass.POWER,
     ),
+    BinarySensorEntityDescription(
+        key="relays_communicating",
+        name="Communicating",
+        device_class=BinarySensorDeviceClass.CONNECTIVITY,
+    ),
+    BinarySensorEntityDescription(
+        key="relays_forced",
+        name="Forced",
+        device_class=BinarySensorDeviceClass.TAMPER,
+    ),
     BinarySensorEntityDescription(
         key="firmware",
         name="Firmware",

custom_components/enphase_envoy/envoy_reader.py

@@ -474,7 +474,7 @@ def relays(self):
         )
         if not status:
             # fallback to the information which is available with owner token.
-            status = self.relay_info
+            status = self.get("relay_info")
         return status
 
     @envoy_property(required_endpoint="endpoint_ensemble_json_results")