Add fault binary sensor for sprinkler devices (#375)

* Add fault binary sensor for sprinkler devices

Handles websocket "fault" events with station_faults data, exposing a
PROBLEM-class binary sensor that turns on when any station reports a fault.
Fault details (station, timestamp, no_flow) are available as attributes.

Also refactors binary sensor setup to use a device_types field on each
description, replacing the hardcoded DEVICE_FLOOD filter.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Include device name in binary sensor entity names

Sets _attr_name to "{device_name} {description_name}" so entity IDs
include the device identity (e.g. binary_sensor.garden_sprinkler_fault)
instead of generic names like binary_sensor.fault.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Use has_entity_name for entity naming across all platforms

Adopts _attr_has_entity_name so Home Assistant automatically prefixes
entity names with the device name, removing manual prefixing from
sensors, switches, and binary sensors. Updates tests accordingly.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Remove unused variable

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: sebr

custom_components/bhyve/__init__.py

@@ -197,7 +197,7 @@ def __init__(
             "Creating %s: %s - %s",
             self.__class__.__name__,
             self._device_name,
-            self._device_type,
+            self.name,
         )
 
     @property

custom_components/bhyve/binary_sensor.py

@@ -13,7 +13,7 @@
 )
 
 from . import BHyveCoordinatorEntity
-from .const import DEVICE_FLOOD, DOMAIN
+from .const import DEVICE_FLOOD, DEVICE_SPRINKLER, DOMAIN
 
 if TYPE_CHECKING:
     from homeassistant.config_entries import ConfigEntry
@@ -31,6 +31,9 @@ class BHyveBinarySensorEntityDescription(BinarySensorEntityDescription):
     """Describes BHyve binary sensor entity."""
 
     unique_id_suffix: str
+    name: str = ""
+    # Device types this sensor applies to (e.g., DEVICE_FLOOD, DEVICE_SPRINKLER)
+    device_types: tuple[str, ...] = ()
     # Callable that takes device_data and returns bool
     value_fn: Any = None
     # Callable that takes device_data and returns attributes
@@ -41,9 +44,10 @@ class BHyveBinarySensorEntityDescription(BinarySensorEntityDescription):
     BHyveBinarySensorEntityDescription(
         key="flood",
         translation_key="flood",
-        name="flood sensor",
+        name="Flood sensor",
         device_class=BinarySensorDeviceClass.MOISTURE,
         unique_id_suffix="water",
+        device_types=(DEVICE_FLOOD,),
         value_fn=lambda data: (
             data.get("status", {}).get("flood_alarm_status") == "alarm"
         ),
@@ -56,14 +60,27 @@ class BHyveBinarySensorEntityDescription(BinarySensorEntityDescription):
     BHyveBinarySensorEntityDescription(
         key="temperature_alert",
         translation_key="temperature_alert",
-        name="temperature alert",
+        name="Temperature alert",
         device_class=BinarySensorDeviceClass.HEAT,
         unique_id_suffix="tempalert",
+        device_types=(DEVICE_FLOOD,),
         value_fn=lambda data: (
             "alarm" in data.get("status", {}).get("temp_alarm_status", "")
         ),
         attributes_fn=lambda data: data.get("temp_alarm_thresholds", {}),
     ),
+    BHyveBinarySensorEntityDescription(
+        key="fault",
+        translation_key="fault",
+        name="Fault",
+        device_class=BinarySensorDeviceClass.PROBLEM,
+        unique_id_suffix="fault",
+        device_types=(DEVICE_SPRINKLER,),
+        value_fn=lambda data: bool(data.get("status", {}).get("station_faults")),
+        attributes_fn=lambda data: {
+            "station_faults": data.get("status", {}).get("station_faults", []),
+        },
+    ),
 )
 
 
@@ -77,8 +94,8 @@ async def async_setup_entry(
     entities = [
         BHyveBinarySensor(coordinator, device, description)
         for device in devices
-        if device.get("type") == DEVICE_FLOOD
         for description in BINARY_SENSOR_TYPES
+        if device.get("type") in description.device_types
     ]
 
     async_add_entities(entities)
@@ -88,6 +105,7 @@ class BHyveBinarySensor(BHyveCoordinatorEntity, BinarySensorEntity):
     """Define a BHyve binary sensor."""
 
     entity_description: BHyveBinarySensorEntityDescription
+    _attr_has_entity_name = True
 
     def __init__(
         self,
@@ -97,6 +115,7 @@ def __init__(
     ) -> None:
         """Initialize the sensor."""
         self.entity_description = description
+        self._attr_name = description.name
         super().__init__(coordinator, device)
         self._attr_unique_id = (
             f"{self._mac_address}:{self._device_id}:{description.unique_id_suffix}"

custom_components/bhyve/const.py

@@ -20,6 +20,7 @@
 DEVICE_FLOOD = "flood_sensor"
 
 EVENT_BATTERY_STATUS = "battery_status"
+EVENT_FAULT = "fault"
 EVENT_CHANGE_MODE = "change_mode"
 EVENT_DEVICE_IDLE = "device_idle"
 EVENT_FS_ALARM = "fs_status_update"

custom_components/bhyve/coordinator.py

@@ -15,6 +15,7 @@
     EVENT_BATTERY_STATUS,
     EVENT_CHANGE_MODE,
     EVENT_DEVICE_IDLE,
+    EVENT_FAULT,
     EVENT_FS_ALARM,
     EVENT_RAIN_DELAY,
     EVENT_SET_MANUAL_PRESET_TIME,
@@ -260,6 +261,14 @@ async def async_handle_device_event(self, event_data: dict[str, Any]) -> None:
                 device_data["status"] = {}
             device_data["status"]["rain_delay"] = event_data.get("delay", 0)
 
+        elif event == EVENT_FAULT:
+            # Update station fault information
+            if "status" not in device_data:
+                device_data["status"] = {}
+            device_data["status"]["station_faults"] = event_data.get(
+                "station_faults", []
+            )
+
         elif event == EVENT_FS_ALARM:
             # Update flood sensor status
             if "status" not in device_data:

custom_components/bhyve/sensor.py

@@ -81,6 +81,7 @@ class BHyveSensorEntityDescription(SensorEntityDescription):
     """Describes BHyve sensor entity."""
 
     unique_id_suffix: str
+    name: str = ""
     # Callable that takes device_data and returns value
     value_fn: Any = None
     # Callable that takes device_data and returns attributes
@@ -95,7 +96,7 @@ class BHyveSensorEntityDescription(SensorEntityDescription):
     BHyveSensorEntityDescription(
         key="state",
         translation_key="state",
-        name="state",
+        name="State",
         icon="mdi:information",
         unique_id_suffix="state",
         entity_category=EntityCategory.DIAGNOSTIC,
@@ -107,7 +108,7 @@ class BHyveSensorEntityDescription(SensorEntityDescription):
     BHyveSensorEntityDescription(
         key="temperature",
         translation_key="temperature",
-        name="temperature sensor",
+        name="Temperature sensor",
         icon="mdi:thermometer",
         unique_id_suffix="temp",
         device_class=SensorDeviceClass.TEMPERATURE,
@@ -131,7 +132,7 @@ class BHyveSensorEntityDescription(SensorEntityDescription):
     BHyveSensorEntityDescription(
         key="battery",
         translation_key="battery",
-        name="battery level",
+        name="Battery level",
         icon="mdi:battery",
         unique_id_suffix="battery",
         device_class=SensorDeviceClass.BATTERY,
@@ -168,15 +169,13 @@ async def async_setup_entry(
     sensors = []
 
     for device in devices:
-        device_name = device.get("name", "Unknown Device")
-
         if device.get("type") == DEVICE_SPRINKLER:
             # Add state sensors
             for base_description in SENSOR_TYPES_SPRINKLER:
                 description = BHyveSensorEntityDescription(
                     key=base_description.key,
                     translation_key=base_description.translation_key,
-                    name=f"{device_name} {base_description.name}",
+                    name=base_description.name,
                     icon=base_description.icon,
                     unique_id_suffix=base_description.unique_id_suffix,
                     entity_category=base_description.entity_category,
@@ -218,7 +217,7 @@ async def async_setup_entry(
                     description = BHyveSensorEntityDescription(
                         key=base_description.key,
                         translation_key=base_description.translation_key,
-                        name=f"{device_name} {base_description.name}",
+                        name=base_description.name,
                         icon=base_description.icon,
                         unique_id_suffix=base_description.unique_id_suffix,
                         device_class=base_description.device_class,
@@ -238,7 +237,7 @@ async def async_setup_entry(
                 description = BHyveSensorEntityDescription(
                     key=base_description.key,
                     translation_key=base_description.translation_key,
-                    name=f"{device_name} {base_description.name}",
+                    name=base_description.name,
                     icon=base_description.icon,
                     unique_id_suffix=base_description.unique_id_suffix,
                     device_class=base_description.device_class,
@@ -256,7 +255,7 @@ async def async_setup_entry(
                 description = BHyveSensorEntityDescription(
                     key=base_description.key,
                     translation_key=base_description.translation_key,
-                    name=f"{device_name} {base_description.name}",
+                    name=base_description.name,
                     icon=base_description.icon,
                     unique_id_suffix=base_description.unique_id_suffix,
                     device_class=base_description.device_class,
@@ -277,6 +276,7 @@ class BHyveSensor(BHyveCoordinatorEntity, SensorEntity):
     """Define a BHyve sensor."""
 
     entity_description: BHyveSensorEntityDescription
+    _attr_has_entity_name = True
 
     def __init__(
         self,
@@ -286,6 +286,7 @@ def __init__(
     ) -> None:
         """Initialize the sensor."""
         self.entity_description = description
+        self._attr_name = description.name
         super().__init__(coordinator, device)
         self._attr_unique_id = (
             f"{self._mac_address}:{self._device_id}:{description.unique_id_suffix}"

custom_components/bhyve/switch.py

@@ -69,22 +69,23 @@
 class BHyveSwitchEntityDescription(SwitchEntityDescription):
     """Describes BHyve switch entity."""
 
+    name: str = ""
+
 
 def _create_program_switch(
     coordinator: BHyveDataUpdateCoordinator,
     device: BHyveDevice,
     program: BHyveTimerProgram,
 ) -> BHyveProgramSwitch:
     """Create a program switch entity."""
-    device_name = device.get("name", "Unknown switch")
     program_name = program.get("name", "unknown")
     return BHyveProgramSwitch(
         coordinator,
         device,
         program,
         BHyveSwitchEntityDescription(
             key="program",
-            name=f"{device_name} {program_name} program",
+            name=f"{program_name} program",
             icon="mdi:bulletin-board",
             entity_category=EntityCategory.CONFIG,
         ),
@@ -122,7 +123,7 @@ async def async_setup_entry(
                     device,
                     BHyveSwitchEntityDescription(
                         key="rain_delay",
-                        name=f"{device.get('name')} rain delay",
+                        name="Rain delay",
                         icon="mdi:weather-pouring",
                         entity_category=EntityCategory.CONFIG,
                     ),
@@ -170,6 +171,7 @@ class BHyveProgramSwitch(BHyveCoordinatorEntity, SwitchEntity):
     """Define a BHyve program switch."""
 
     entity_description: BHyveSwitchEntityDescription
+    _attr_has_entity_name = True
 
     def __init__(
         self,
@@ -180,6 +182,8 @@ def __init__(
     ) -> None:
         """Initialize the switch."""
         self.entity_description = description
+        self._attr_name = description.name
+
         super().__init__(coordinator, device)
 
         self._program_id = program.get("id", "0")
@@ -253,6 +257,7 @@ class BHyveRainDelaySwitch(BHyveCoordinatorEntity, SwitchEntity):
     """Define a BHyve rain delay switch."""
 
     entity_description: BHyveSwitchEntityDescription
+    _attr_has_entity_name = True
 
     def __init__(
         self,
@@ -262,8 +267,10 @@ def __init__(
     ) -> None:
         """Initialize the switch."""
         self.entity_description = description
+
         super().__init__(coordinator, device)
 
+        self._attr_name = description.name
         self._attr_unique_id = f"{self._mac_address}:{self._device_id}:rain_delay"
 
     @property

custom_components/bhyve/valve.py

@@ -245,17 +245,16 @@ def __init__(
     ) -> None:
         """Initialize the valve."""
         self.entity_description = VALVE_DESCRIPTION
-        super().__init__(coordinator, device)
+        self._attr_name = f"{zone_name} zone"
 
-        name = f"{zone_name} zone"
+        super().__init__(coordinator, device)
 
         self._zone: BHyveZone = zone
         self._zone_id: str = zone.get("station", "")
 
         self._attr_unique_id = (
             f"{self._mac_address}:{self._device_id}:{self._zone_id}:valve"
         )
-        self._attr_name = name
 
         self._entity_picture: str | None = zone.get("image_url")
         self._zone_name: str = zone_name