Add missing translation strings for all translatable entities (#377)

* Add missing translation strings for all translatable entities

Add translation entries for sensor.state, binary_sensor.fault, and
switch.rain_delay. Also add translation_key to rain delay switch
description and fix _attr_name init order to prevent platform_data
resolution error.

* Add dynamic translation strings for zone and program entities

Use translation_placeholders for entities with dynamic names:
- sensor.zone_history: "{zone_name} zone history"
- switch.program: "{program_name} program"
- valve.zone: "{zone_name} zone"

Also add has_entity_name to BHyveZoneValve and BHyveZoneHistorySensor,
and avoid accessing self.name in base __init__ to prevent platform_data
resolution errors during entity construction.

* Remove unused args from create_program_switch_description test helper

* Set _attr_name as fallback for dynamic translation entities

HA falls back to device_class name (e.g. "Timestamp") when translation
placeholders can't be resolved at runtime. Set _attr_name explicitly
so the entity always has a readable name, while keeping translation_key
and translation_placeholders for proper i18n support.

* Fix duplicated device name in zone history and valve entities

Remove has_entity_name from BHyveZoneHistorySensor and BHyveZoneValve.
These entities include the zone name in their entity name, which gets
duplicated with the device name when has_entity_name is True. Since
translation_key requires has_entity_name, also remove the unused
translation_key and strings.json entries for these entities.

* Fix duplicated device name in zone entity names

When zone_name matches the device name (single-zone devices), use a
short entity name ("Zone", "Zone history") since has_entity_name already
prepends the device name. Multi-zone devices keep the zone name prefix
to distinguish between zones.

* Remove redundant program_name arg from BHyveProgramSwitch

Extract program name directly from the program dict in __init__ instead
of requiring it as a separate argument.

Author: sebr

custom_components/bhyve/__init__.py

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

custom_components/bhyve/sensor.py

@@ -211,9 +211,10 @@ async def async_setup_entry(
                         coordinator,
                         device,
                         zone,
+                        zone_name,
                         SensorEntityDescription(
                             key="zone_history",
-                            name=f"{zone_name} zone history",
+                            translation_key="zone_history",
                             icon="mdi:history",
                             device_class=SensorDeviceClass.TIMESTAMP,
                             entity_category=EntityCategory.DIAGNOSTIC,
@@ -338,16 +339,23 @@ class BHyveZoneHistorySensor(BHyveCoordinatorEntity, SensorEntity):
     """Define a BHyve zone history sensor."""
 
     entity_description: SensorEntityDescription
+    _attr_has_entity_name = True
 
     def __init__(
         self,
         coordinator: BHyveDataUpdateCoordinator,
         device: BHyveDevice,
         zone: dict,
+        zone_name: str,
         description: SensorEntityDescription,
     ) -> None:
         """Initialize the sensor."""
         self.entity_description = description
+        if zone_name == device.get("name"):
+            self._attr_name = "Zone history"
+        else:
+            self._attr_name = f"{zone_name} zone history"
+        self._attr_translation_placeholders = {"zone_name": zone_name}
         super().__init__(coordinator, device)
 
         self._zone = zone

custom_components/bhyve/strings.json

@@ -147,12 +147,25 @@
       "temperature_alert": {
         "name": "Temperature alert",
         "state": {
-          "on": "Problem detected",
+          "on": "Problem",
+          "off": "OK"
+        }
+      },
+      "fault": {
+        "name": "Fault",
+        "state": {
+          "on": "Fault",
           "off": "OK"
         }
       }
     },
     "sensor": {
+      "state": {
+        "name": "State"
+      },
+      "zone_history": {
+        "name": "{zone_name} zone history"
+      },
       "temperature": {
         "name": "Temperature"
       },
@@ -162,6 +175,19 @@
       "signal_strength": {
         "name": "Signal strength"
       }
+    },
+    "switch": {
+      "rain_delay": {
+        "name": "Rain delay"
+      },
+      "program": {
+        "name": "{program_name} program"
+      }
+    },
+    "valve": {
+      "zone": {
+        "name": "{zone_name} zone"
+      }
     }
   }
 }

custom_components/bhyve/switch.py

@@ -78,14 +78,13 @@ def _create_program_switch(
     program: BHyveTimerProgram,
 ) -> BHyveProgramSwitch:
     """Create a program switch entity."""
-    program_name = program.get("name", "unknown")
     return BHyveProgramSwitch(
         coordinator,
         device,
         program,
         BHyveSwitchEntityDescription(
             key="program",
-            name=f"{program_name} program",
+            translation_key="program",
             icon="mdi:bulletin-board",
             entity_category=EntityCategory.CONFIG,
         ),
@@ -123,6 +122,7 @@ async def async_setup_entry(
                     device,
                     BHyveSwitchEntityDescription(
                         key="rain_delay",
+                        translation_key="rain_delay",
                         name="Rain delay",
                         icon="mdi:weather-pouring",
                         entity_category=EntityCategory.CONFIG,
@@ -182,7 +182,9 @@ def __init__(
     ) -> None:
         """Initialize the switch."""
         self.entity_description = description
-        self._attr_name = description.name
+        program_name = program.get("name", "unknown")
+        self._attr_name = f"{program_name} program"
+        self._attr_translation_placeholders = {"program_name": program_name}
 
         super().__init__(coordinator, device)
 
@@ -267,10 +269,10 @@ def __init__(
     ) -> None:
         """Initialize the switch."""
         self.entity_description = description
+        self._attr_name = description.name
 
         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

@@ -142,6 +142,7 @@ class BHyveValveEntityDescription(ValveEntityDescription):
 
 VALVE_DESCRIPTION = BHyveValveEntityDescription(
     key="zone",
+    translation_key="zone",
     device_class=ValveDeviceClass.WATER,
     reports_position=False,
 )
@@ -233,6 +234,7 @@ class BHyveZoneValve(BHyveCoordinatorEntity, ValveEntity):
     """Define a BHyve zone valve."""
 
     entity_description: BHyveValveEntityDescription
+    _attr_has_entity_name = True
     _attr_supported_features = ValveEntityFeature.OPEN | ValveEntityFeature.CLOSE
 
     def __init__(
@@ -245,7 +247,11 @@ def __init__(
     ) -> None:
         """Initialize the valve."""
         self.entity_description = VALVE_DESCRIPTION
-        self._attr_name = f"{zone_name} zone"
+        if zone_name == device.get("name"):
+            self._attr_name = "Zone"
+        else:
+            self._attr_name = f"{zone_name} zone"
+        self._attr_translation_placeholders = {"zone_name": zone_name}
 
         super().__init__(coordinator, device)
 

tests/test_sensor.py

@@ -394,7 +394,7 @@ async def test_zone_history_sensor_initialization(
         # Create description for the zone
         description = SensorEntityDescription(
             key="zone_history",
-            name="Front Lawn zone history",
+            translation_key="zone_history",
             icon="mdi:history",
             device_class=SensorDeviceClass.TIMESTAMP,
             entity_category=EntityCategory.DIAGNOSTIC,
@@ -404,11 +404,13 @@ async def test_zone_history_sensor_initialization(
             coordinator=coordinator,
             device=mock_sprinkler_device_with_battery,
             zone=zone,
+            zone_name="Front Lawn",
             description=description,
         )
 
         # Test basic properties
-        assert sensor.name == "Front Lawn zone history"
+        assert sensor._attr_name == "Front Lawn zone history"
+        assert sensor._attr_translation_placeholders == {"zone_name": "Front Lawn"}
         assert sensor.device_class == SensorDeviceClass.TIMESTAMP
         assert sensor.entity_description.entity_category == EntityCategory.DIAGNOSTIC
 
@@ -433,7 +435,7 @@ async def test_zone_history_sensor_attributes(
         # Create description for the zone
         description = SensorEntityDescription(
             key="zone_history",
-            name="Front Lawn zone history",
+            translation_key="zone_history",
             icon="mdi:history",
             device_class=SensorDeviceClass.TIMESTAMP,
             entity_category=EntityCategory.DIAGNOSTIC,
@@ -443,6 +445,7 @@ async def test_zone_history_sensor_attributes(
             coordinator=coordinator,
             device=mock_sprinkler_device_with_battery,
             zone=zone,
+            zone_name="Front Lawn",
             description=description,
         )
 

tests/test_switch.py

@@ -40,14 +40,11 @@ def create_mock_coordinator(devices: dict, programs: dict) -> MagicMock:
     return coordinator
 
 
-def create_program_switch_description(
-    _device: BHyveDevice, program: BHyveTimerProgram
-) -> BHyveSwitchEntityDescription:
+def create_program_switch_description() -> BHyveSwitchEntityDescription:
     """Create a program switch description for testing."""
-    program_name = program.get("name", "unknown")
     return BHyveSwitchEntityDescription(
         key="program",
-        name=f"{program_name} program",
+        translation_key="program",
         icon="mdi:bulletin-board",
         device_class=SwitchDeviceClass.SWITCH,
         entity_category=EntityCategory.CONFIG,
@@ -318,9 +315,7 @@ async def test_program_switch_initialization(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test program switch entity initialization."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,
@@ -329,7 +324,9 @@ async def test_program_switch_initialization(
         )
 
         # Test basic properties
-        assert switch.name == "Morning Schedule program"
+        assert switch._attr_translation_placeholders == {
+            "program_name": "Morning Schedule"
+        }
         assert switch.device_class == SwitchDeviceClass.SWITCH
         assert switch.entity_category == EntityCategory.CONFIG
         assert switch.unique_id == f"bhyve:program:{TEST_PROGRAM_ID}"
@@ -341,9 +338,7 @@ async def test_program_switch_enabled_state(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test program switch in enabled state."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,
@@ -380,9 +375,7 @@ async def test_program_switch_disabled_state(
             {TEST_PROGRAM_ID: mock_timer_program_disabled},
         )
 
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program_disabled
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=coordinator,
             device=mock_sprinkler_device,
@@ -411,9 +404,7 @@ async def test_program_switch_turn_on(
             {TEST_PROGRAM_ID: mock_timer_program_disabled},
         )
 
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program_disabled
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=coordinator,
             device=mock_sprinkler_device,
@@ -437,9 +428,7 @@ async def test_program_switch_turn_off(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test turning off a program switch."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,
@@ -463,9 +452,7 @@ async def test_program_switch_start_program(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test starting a program manually."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,
@@ -491,9 +478,7 @@ async def test_program_switch_websocket_event(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test program switch response to websocket events."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,
@@ -517,9 +502,7 @@ async def test_program_switch_event_filtering(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test program switch handles all events via coordinator."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,
@@ -846,7 +829,9 @@ def track_add_entities(entities: list) -> None:
         assert len(all_added_entities[1]) == 1
         new_entity = all_added_entities[1][0]
         assert isinstance(new_entity, BHyveProgramSwitch)
-        assert new_entity.name == "New Evening Schedule program"
+        assert new_entity._attr_translation_placeholders == {
+            "program_name": "New Evening Schedule"
+        }
 
     async def test_program_created_event_unknown_device(
         self,
@@ -945,7 +930,7 @@ async def test_switches_handle_missing_data_gracefully(
             description=description,
         )
 
-        description = create_program_switch_description(minimal_device, minimal_program)
+        description = create_program_switch_description()
         program_switch = BHyveProgramSwitch(
             coordinator=coordinator,
             device=minimal_device,
@@ -966,9 +951,7 @@ async def test_switches_handle_websocket_events_without_data(
         mock_coordinator: MagicMock,
     ) -> None:
         """Test switches handle websocket events with missing fields."""
-        description = create_program_switch_description(
-            mock_sprinkler_device, mock_timer_program
-        )
+        description = create_program_switch_description()
         program_switch = BHyveProgramSwitch(
             coordinator=mock_coordinator,
             device=mock_sprinkler_device,

tests/test_valve.py

@@ -70,7 +70,8 @@ async def test_zone_valve_initialization(
     )
 
     # Test basic properties
-    assert valve.name == f"{zone_name} zone"
+    assert valve._attr_name == f"{zone_name} zone"
+    assert valve._attr_translation_placeholders == {"zone_name": zone_name}
     expected_unique_id = (
         f"{mock_sprinkler_device['mac_address']}:"
         f"{mock_sprinkler_device['id']}:"