Merge branch 'master' into test-break

Author: kylegordon

custom_components/pettracer/binary_sensor.py

@@ -36,27 +36,30 @@ class PetTracerAtHomeBinarySensor(CoordinatorEntity, BinarySensorEntity):
     """Representation of a PetTracer at home binary sensor."""
 
     _attr_device_class = BinarySensorDeviceClass.PRESENCE
+    _attr_has_entity_name = True
 
     def __init__(self, coordinator, device):
         """Initialize the binary sensor."""
         super().__init__(coordinator)
         self._device = device
         self._device_id = device.id
-        self._device_name = (
-            device.details.name if device.details else f"PetTracer {device.id}"
-        )
         self._attr_unique_id = f"pettracer_{device.id}_at_home"
-        self._attr_name = f"{self._device_name} At Home"
+        self._attr_name = "At Home"
+        self._attr_suggested_object_id = f"pettracer_{device.id}_at_home"
 
     @property
     def device_info(self) -> dict[str, Any]:
         """Return device information about this sensor."""
+        device = self._get_device_data() or self._device
+        device_name = (
+            device.details.name if device.details else f"PetTracer {self._device_id}"
+        )
         return {
             "identifiers": {(DOMAIN, self._device_id)},
-            "name": self._device_name,
+            "name": device_name,
             "manufacturer": "PetTracer",
             "model": "GPS Collar",
-            "sw_version": self._device.sw if self._device.sw else None,
+            "sw_version": device.sw if device.sw else None,
         }
 
     def _get_device_data(self):
@@ -79,27 +82,30 @@ class PetTracerChargingBinarySensor(CoordinatorEntity, BinarySensorEntity):
     """Representation of a PetTracer charging binary sensor."""
 
     _attr_device_class = BinarySensorDeviceClass.BATTERY_CHARGING
+    _attr_has_entity_name = True
 
     def __init__(self, coordinator, device):
         """Initialize the binary sensor."""
         super().__init__(coordinator)
         self._device = device
         self._device_id = device.id
-        self._device_name = (
-            device.details.name if device.details else f"PetTracer {device.id}"
-        )
         self._attr_unique_id = f"pettracer_{device.id}_charging"
-        self._attr_name = f"{self._device_name} Charging"
+        self._attr_name = "Charging"
+        self._attr_suggested_object_id = f"pettracer_{device.id}_charging"
 
     @property
     def device_info(self) -> dict[str, Any]:
         """Return device information about this sensor."""
+        device = self._get_device_data() or self._device
+        device_name = (
+            device.details.name if device.details else f"PetTracer {self._device_id}"
+        )
         return {
             "identifiers": {(DOMAIN, self._device_id)},
-            "name": self._device_name,
+            "name": device_name,
             "manufacturer": "PetTracer",
             "model": "GPS Collar",
-            "sw_version": self._device.sw if self._device.sw else None,
+            "sw_version": device.sw if device.sw else None,
         }
 
     def _get_device_data(self):

custom_components/pettracer/device_tracker.py

@@ -35,15 +35,16 @@ async def async_setup_entry(
 class PetTracerDeviceTracker(CoordinatorEntity, TrackerEntity):
     """Representation of a PetTracer device tracker."""
 
+    _attr_has_entity_name = True
+    _attr_name = None
+
     def __init__(self, coordinator, device):
         """Initialize the tracker."""
         super().__init__(coordinator)
         self._device = device
         self._device_id = device.id
         self._attr_unique_id = f"pettracer_{device.id}"
-        self._attr_name = (
-            device.details.name if device.details else f"PetTracer {device.id}"
-        )
+        self._attr_suggested_object_id = f"pettracer_{device.id}"
 
     def _get_device_data(self):
         """Get updated device data from coordinator."""
@@ -55,12 +56,16 @@ def _get_device_data(self):
     @property
     def device_info(self) -> dict[str, Any]:
         """Return device information about this tracker."""
+        device = self._get_device_data() or self._device
+        device_name = (
+            device.details.name if device.details else f"PetTracer {self._device_id}"
+        )
         return {
-            "identifiers": {(DOMAIN, self._device.id)},
-            "name": self._attr_name,
+            "identifiers": {(DOMAIN, self._device_id)},
+            "name": device_name,
             "manufacturer": "PetTracer",
             "model": "GPS Collar",
-            "sw_version": self._device.sw if self._device.sw else None,
+            "sw_version": device.sw if device.sw else None,
         }
 
     @property

custom_components/pettracer/sensor.py

@@ -267,28 +267,31 @@ class PetTracerSensor(CoordinatorEntity, SensorEntity):
     """Representation of a PetTracer sensor."""
 
     entity_description: PetTracerSensorEntityDescription
+    _attr_has_entity_name = True
 
     def __init__(self, coordinator, device, description: PetTracerSensorEntityDescription):
         """Initialize the sensor."""
         super().__init__(coordinator)
         self.entity_description = description
         self._device = device
         self._device_id = device.id
-        self._device_name = (
-            device.details.name if device.details else f"PetTracer {device.id}"
-        )
         self._attr_unique_id = f"pettracer_{device.id}_{description.key}"
-        self._attr_name = f"{self._device_name} {description.display_name}"
+        self._attr_name = description.display_name
+        self._attr_suggested_object_id = f"pettracer_{device.id}_{description.key}"
 
     @property
     def device_info(self) -> dict[str, Any]:
         """Return device information about this sensor."""
+        device = self._get_device_data() or self._device
+        device_name = (
+            device.details.name if device.details else f"PetTracer {self._device_id}"
+        )
         return {
             "identifiers": {(DOMAIN, self._device_id)},
-            "name": self._device_name,
+            "name": device_name,
             "manufacturer": "PetTracer",
             "model": "GPS Collar",
-            "sw_version": self._device.sw if self._device.sw else None,
+            "sw_version": device.sw if device.sw else None,
         }
 
     def _get_device_data(self):

tests/test_binary_sensor.py

@@ -64,7 +64,9 @@ async def test_at_home_binary_sensor_true(hass, mock_device):
     sensor = PetTracerAtHomeBinarySensor(coordinator, mock_device)
 
     assert sensor.unique_id == "pettracer_12345_at_home"
-    assert sensor.name == "Fluffy At Home"
+    assert sensor.name == "At Home"
+    assert sensor._attr_has_entity_name is True
+    assert sensor._attr_suggested_object_id == "pettracer_12345_at_home"
     assert sensor.device_class == BinarySensorDeviceClass.PRESENCE
     assert sensor.is_on is True
 
@@ -77,7 +79,8 @@ async def test_at_home_binary_sensor_false(hass, mock_device_no_position):
     sensor = PetTracerAtHomeBinarySensor(coordinator, mock_device_no_position)
 
     assert sensor.unique_id == "pettracer_12346_at_home"
-    assert sensor.name == "Rex At Home"
+    assert sensor.name == "At Home"
+    assert sensor._attr_suggested_object_id == "pettracer_12346_at_home"
     assert sensor.is_on is False
 
 
@@ -111,6 +114,24 @@ async def test_at_home_binary_sensor_device_info(hass, mock_device):
     assert device_info["model"] == "GPS Collar"
 
 
+async def test_at_home_binary_sensor_device_info_reflects_pet_rename(hass, mock_device):
+    """Renaming the pet must update device_info without changing identifiers."""
+    coordinator = MagicMock()
+    coordinator.data = {"devices": [mock_device]}
+
+    sensor = PetTracerAtHomeBinarySensor(coordinator, mock_device)
+    assert sensor.device_info["name"] == "Fluffy"
+
+    mock_device.details.name = "Buddy"
+    coordinator.data = {"devices": [mock_device]}
+
+    assert sensor.device_info["name"] == "Buddy"
+    # Stable identifiers never move, regardless of the pet's current name.
+    assert sensor.unique_id == "pettracer_12345_at_home"
+    assert sensor._attr_suggested_object_id == "pettracer_12345_at_home"
+    assert sensor.device_info["identifiers"] == {(DOMAIN, 12345)}
+
+
 async def test_charging_binary_sensor_true(hass, mock_device):
     """Test charging binary sensor when collar is charging."""
     coordinator = MagicMock()
@@ -119,7 +140,8 @@ async def test_charging_binary_sensor_true(hass, mock_device):
     sensor = PetTracerChargingBinarySensor(coordinator, mock_device)
 
     assert sensor.unique_id == "pettracer_12345_charging"
-    assert sensor.name == "Fluffy Charging"
+    assert sensor.name == "Charging"
+    assert sensor._attr_suggested_object_id == "pettracer_12345_charging"
     assert sensor.device_class == BinarySensorDeviceClass.BATTERY_CHARGING
     assert sensor.is_on is True
 
@@ -132,7 +154,8 @@ async def test_charging_binary_sensor_false(hass, mock_device_no_position):
     sensor = PetTracerChargingBinarySensor(coordinator, mock_device_no_position)
 
     assert sensor.unique_id == "pettracer_12346_charging"
-    assert sensor.name == "Rex Charging"
+    assert sensor.name == "Charging"
+    assert sensor._attr_suggested_object_id == "pettracer_12346_charging"
     assert sensor.is_on is False
 
 

tests/test_device_tracker.py

@@ -64,7 +64,12 @@ async def test_device_tracker_properties(hass, mock_device):
     tracker = PetTracerDeviceTracker(coordinator, mock_device)
 
     assert tracker.unique_id == "pettracer_12345"
-    assert tracker.name == "Fluffy"
+    # name is None so has_entity_name composes the friendly name from the
+    # device name alone (the pet's name), rather than baking it into the entity.
+    assert tracker.name is None
+    assert tracker._attr_has_entity_name is True
+    assert tracker.device_info["name"] == "Fluffy"
+    assert tracker._attr_suggested_object_id == "pettracer_12345"
     assert tracker.source_type == SourceType.GPS
     assert tracker.latitude == 51.5074
     assert tracker.longitude == -0.1278
@@ -114,7 +119,8 @@ async def test_device_tracker_no_position(hass, mock_device_no_position):
     tracker = PetTracerDeviceTracker(coordinator, mock_device_no_position)
 
     assert tracker.unique_id == "pettracer_12346"
-    assert tracker.name == "Rex"
+    assert tracker.name is None
+    assert tracker.device_info["name"] == "Rex"
     assert tracker.latitude is None
     assert tracker.longitude is None
     assert tracker.location_accuracy == 0
@@ -192,8 +198,8 @@ async def test_device_tracker_multiple_devices(hass, mock_device, mock_device_no
 
     assert tracker1.unique_id == "pettracer_12345"
     assert tracker2.unique_id == "pettracer_12346"
-    assert tracker1.name == "Fluffy"
-    assert tracker2.name == "Rex"
+    assert tracker1.device_info["name"] == "Fluffy"
+    assert tracker2.device_info["name"] == "Rex"
     assert tracker1.latitude == 51.5074
     assert tracker2.latitude is None
 
@@ -221,6 +227,26 @@ async def test_device_tracker_coordinator_update(hass, mock_device):
     assert tracker.longitude == -0.1300
 
 
+async def test_device_tracker_device_info_reflects_pet_rename(hass, mock_device):
+    """Renaming the pet must update device_info without changing identifiers."""
+    from custom_components.pettracer.device_tracker import PetTracerDeviceTracker
+
+    coordinator = MagicMock()
+    coordinator.data = {"devices": [mock_device]}
+
+    tracker = PetTracerDeviceTracker(coordinator, mock_device)
+    assert tracker.device_info["name"] == "Fluffy"
+
+    mock_device.details.name = "Buddy"
+    coordinator.data = {"devices": [mock_device]}
+
+    assert tracker.device_info["name"] == "Buddy"
+    # Stable identifiers never move, regardless of the pet's current name.
+    assert tracker.unique_id == "pettracer_12345"
+    assert tracker._attr_suggested_object_id == "pettracer_12345"
+    assert tracker.device_info["identifiers"] == {(DOMAIN, 12345)}
+
+
 async def test_device_tracker_no_details(hass):
     """Test device tracker when device has no details."""
     from custom_components.pettracer.device_tracker import PetTracerDeviceTracker
@@ -238,7 +264,9 @@ async def test_device_tracker_no_details(hass):
     tracker = PetTracerDeviceTracker(coordinator, device)
 
     assert tracker.unique_id == "pettracer_99999"
-    assert tracker.name == "PetTracer 99999"
+    assert tracker.name is None
+    assert tracker.device_info["name"] == "PetTracer 99999"
+    assert tracker._attr_suggested_object_id == "pettracer_99999"
     assert tracker.latitude is None
     assert tracker.longitude is None
     assert tracker.battery_level is None