Rework for internationalisation support.

Author: jmattsson

custom_components/powersensor/config_flow.py

@@ -6,10 +6,12 @@
 import voluptuous as vol
 
 from homeassistant import config_entries
-from homeassistant.config_entries import ConfigFlowResult
+from homeassistant.core import HomeAssistant
+from homeassistant.config_entries import ConfigEntry, ConfigFlowResult
 from homeassistant.helpers.dispatcher import async_dispatcher_send
 from homeassistant.helpers.selector import selector
 from homeassistant.helpers.service_info import zeroconf
+from homeassistant.helpers.translation import async_get_cached_translations
 
 from .const import (
     CFG_DEVICES,
@@ -22,17 +24,28 @@
     ROLE_UPDATE_SIGNAL,
     ROLE_WATER,
     RT_DISPATCHER,
-    SENSOR_NAME_FORMAT,
 )
 
 _LOGGER = logging.getLogger(__name__)
 
 
+def get_translated_sensor_name(hass: HomeAssistant, config_entry: ConfigEntry, mac: str) -> str|None:
+    """Helper to neatly format the translated name, for user input."""
+    translations = async_get_cached_translations(
+        hass, hass.config.language, "device", config_entry.domain
+    )
+    format_string = translations.get(
+        "component.powersensor.device.unknown_sensor.name",
+        "Powersensor Sensor (ID: {id})"
+    )
+    return format_string.replace("{id}", mac)
+
+
 class PowersensorConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     """Handle a config flow."""
 
     VERSION = 2
-    MINOR_VERSION = 0
+    MINOR_VERSION = 2
 
     def __init__(self) -> None:
         """Initialize the config flow."""
@@ -49,9 +62,9 @@ async def async_step_reconfigure(
         if dispatcher is None:
             return self.async_abort(reason="cannot_reconfigure")
 
-        mac2name = {mac: SENSOR_NAME_FORMAT % mac for mac in dispatcher.sensors}
+        mac2name = {mac: get_translated_sensor_name(self.hass, entry, mac) for mac in dispatcher.sensors}
 
-        unknown = "<unknown>"
+        unknown = "unknown"
         if user_input is not None:
             name2mac = {name: mac for mac, name in mac2name.items()}
             for name, role in user_input.items():

custom_components/powersensor/const.py

@@ -16,9 +16,6 @@
 ZEROCONF_REMOVE_PLUG_SIGNAL = f"{DOMAIN}_zeroconf_remove_plug"
 ZEROCONF_UPDATE_PLUG_SIGNAL = f"{DOMAIN}_zeroconf_update_plug"
 
-# Formatting, would've liked to have been able to have this translatable
-SENSOR_NAME_FORMAT = "Powersensor Sensor (ID: %s)"
-
 # Config entry keys
 CFG_DEVICES = "devices"
 CFG_ROLES = "roles"

custom_components/powersensor/manifest.json

@@ -12,7 +12,7 @@
   "iot_class": "local_push",
   "issue_tracker": "https://github.com/DiUS/homeassistant-powersensor/issues",
   "requirements": [
-    "powersensor-local==2.1.0"
+    "powersensor-local==2.1.1"
   ],
   "single_config_entry": true,
   "version": "1.0.1",

custom_components/powersensor/powersensor_message_dispatcher.py

@@ -349,7 +349,7 @@ async def _plug_added(self, info):
         else:
             await self.enqueue_plug_for_adding(network_info)
 
-    async def _plug_updated(self, info):
+    async def _plug_updated(self, info) -> None:
         _LOGGER.debug("Request to update plug received: %s", info)
         mac = info["properties"][b"id"].decode("utf-8")
         await self.cancel_any_pending_removal(mac, "request to update plug")

custom_components/powersensor/sensor/__init__.py

@@ -63,6 +63,7 @@ async def async_setup_entry(
     entry.runtime_data[RT_VHH_SOLAR_ADDED] = False
 
     plug_role = ROLE_APPLIANCE
+    entry_id = entry.entry_id
 
     def with_solar():
         """Checks whether any known sensor has the solar role."""
@@ -110,19 +111,19 @@ async def handle_discovered_sensor(sensor_mac: str, sensor_role: str):
         """Registers sensor entities, signals sensor added plus VHH update if needed."""
         new_sensors = [
             PowersensorSensorEntity(
-                hass, sensor_mac, sensor_role, SensorMeasurements.BATTERY
+                hass, entry_id, sensor_mac, sensor_role, SensorMeasurements.BATTERY
             ),
             PowersensorSensorEntity(
-                hass, sensor_mac, sensor_role, SensorMeasurements.WATTS
+                hass, entry_id, sensor_mac, sensor_role, SensorMeasurements.WATTS
             ),
             PowersensorSensorEntity(
-                hass, sensor_mac, sensor_role, SensorMeasurements.SUMMATION_ENERGY
+                hass, entry_id, sensor_mac, sensor_role, SensorMeasurements.SUMMATION_ENERGY
             ),
             PowersensorSensorEntity(
-                hass, sensor_mac, sensor_role, SensorMeasurements.ROLE
+                hass, entry_id, sensor_mac, sensor_role, SensorMeasurements.ROLE
             ),
             PowersensorSensorEntity(
-                hass, sensor_mac, sensor_role, SensorMeasurements.RSSI
+                hass, entry_id, sensor_mac, sensor_role, SensorMeasurements.RSSI
             ),
         ]
         async_add_entities(new_sensors, True)
@@ -142,25 +143,25 @@ async def create_plug(plug_mac_address: str, new_plug_role: str):
         """Registers sensor entities."""
         this_plug_sensors = [
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.WATTS
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.WATTS
             ),
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.VOLTAGE
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.VOLTAGE
             ),
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.APPARENT_CURRENT
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.APPARENT_CURRENT
             ),
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.ACTIVE_CURRENT
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.ACTIVE_CURRENT
             ),
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.REACTIVE_CURRENT
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.REACTIVE_CURRENT
             ),
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.SUMMATION_ENERGY
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.SUMMATION_ENERGY
             ),
             PowersensorPlugEntity(
-                hass, plug_mac_address, new_plug_role, PlugMeasurements.ROLE
+                hass, entry_id, plug_mac_address, new_plug_role, PlugMeasurements.ROLE
             ),
         ]
 

custom_components/powersensor/sensor/powersensor_entity.py

@@ -35,9 +35,13 @@ class PowersensorSensorEntityDescription(SensorEntityDescription):
 class PowersensorEntity(SensorEntity, Generic[MeasurementType]):
     """Base class for all Powersensor entities."""
 
+    _attr_has_entity_name = True
+    _attr_should_poll = False
+
     def __init__(
         self,
         hass: HomeAssistant,
+        config_entry_id: str,
         mac: str,
         role: str,
         input_config: dict[MeasurementType, PowersensorSensorEntityDescription],
@@ -48,8 +52,8 @@ def __init__(
         self._role = role
         self._has_recently_received_update_message = False
         self._attr_native_value = 0.0
-        self._attr_should_poll = False
         self._hass = hass
+        self._config_entry_id = config_entry_id
         self._mac = mac
         self._model = "PowersensorDevice"
         self._device_name = f"Powersensor Device (ID: {self._mac})"
@@ -63,17 +67,11 @@ def __init__(
         self.entity_description = config
 
         self._attr_unique_id = f"{mac}_{measurement_type.name}"
-        self._attr_device_info = self.device_info
 
         self._signal = DATA_UPDATE_SIGNAL_FMT_MAC_EVENT % (mac, config.event)
         self._message_key = config.message_key
         self._message_callback = config.conversion_function
 
-    @property
-    def device_info(self) -> DeviceInfo:
-        """Abstract property to for returning DeviceInfo."""
-        raise NotImplementedError
-
     @property
     def available(self) -> bool:
         """Does data exist for this sensor type."""
@@ -119,18 +117,25 @@ def _handle_role_update(self, mac: str, role: str):
             return
 
         self._role = role
-        name_updated = self._rename_based_on_role()
+        was_updated = self._rename_based_on_role()
 
-        if name_updated:
+        if was_updated:
             device_registry = dr.async_get(self._hass)
             device = device_registry.async_get_device(identifiers={(DOMAIN, self._mac)})
-
-            if device and device.name != self._device_name:
-                # Update the device name
-                device_registry.async_update_device(device.id, name=self._device_name)
-
-            entity_registry = er.async_get(self._hass)
-            entity_registry.async_update_entity(self.entity_id, name=self._attr_name)
+            info = self.device_info
+            if device is not None and info is not None:
+                # The device registry provides no way of just updating the
+                # translation_key via dr.async_update_device(), only the
+                # name. The only way to properly apply the translation to
+                # the name is through async_get_or_create(), which also
+                # does apply the update, but requires knowing the config
+                # entry id. Hoops and roundabouts.
+                device_registry.async_get_or_create(
+                    config_entry_id = self._config_entry_id,
+                    identifiers = device.identifiers,
+                    translation_key = info["translation_key"],
+                    translation_placeholders = { "id": self._mac },
+                )
 
             self.async_write_ha_state()
 

custom_components/powersensor/sensor/powersensor_household_entity.py

@@ -66,13 +66,14 @@ def fmt_ws_to_kwh(f):
 class PowersensorHouseholdEntity(SensorEntity):
     """Powersensor Virtual Household entity."""
 
-    should_poll = False
-    _attr_has_entity_name = True
     _attr_available = True
+    _attr_has_entity_name = True
+    _attr_should_poll = False
 
     _ENTITY_CONFIGS = {
         HouseholdMeasurements.POWER_HOME_USE: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Power - Home use",
+            translation_key="power_home_use",
             device_class=SensorDeviceClass.POWER,
             native_unit_of_measurement=UnitOfPower.WATT,
             state_class=SensorStateClass.MEASUREMENT,
@@ -82,6 +83,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.POWER_FROM_GRID: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Power - From grid",
+            translation_key="power_from_grid",
             device_class=SensorDeviceClass.POWER,
             native_unit_of_measurement=UnitOfPower.WATT,
             state_class=SensorStateClass.MEASUREMENT,
@@ -91,6 +93,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.POWER_TO_GRID: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Power - To grid",
+            translation_key="power_to_grid",
             device_class=SensorDeviceClass.POWER,
             native_unit_of_measurement=UnitOfPower.WATT,
             state_class=SensorStateClass.MEASUREMENT,
@@ -100,6 +103,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.POWER_SOLAR_GENERATION: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Power - Solar generation",
+            translation_key="power_solar_generation",
             device_class=SensorDeviceClass.POWER,
             native_unit_of_measurement=UnitOfPower.WATT,
             state_class=SensorStateClass.MEASUREMENT,
@@ -109,6 +113,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.ENERGY_HOME_USE: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Energy - Home usage",
+            translation_key="energy_home_use",
             device_class=SensorDeviceClass.ENERGY,
             native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
             state_class=SensorStateClass.TOTAL_INCREASING,
@@ -118,6 +123,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.ENERGY_FROM_GRID: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Energy - From grid",
+            translation_key="energy_from_grid",
             device_class=SensorDeviceClass.ENERGY,
             state_class=SensorStateClass.TOTAL_INCREASING,
             native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
@@ -127,6 +133,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.ENERGY_TO_GRID: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Energy - To grid",
+            translation_key="energy_to_grid",
             device_class=SensorDeviceClass.ENERGY,
             state_class=SensorStateClass.TOTAL_INCREASING,
             native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
@@ -136,6 +143,7 @@ class PowersensorHouseholdEntity(SensorEntity):
         ),
         HouseholdMeasurements.ENERGY_SOLAR_GENERATION: PowersensorVirtualHouseholdSensorEntityDescription(
             key="Energy - Solar generation",
+            translation_key="energy_solar_generation",
             device_class=SensorDeviceClass.ENERGY,
             state_class=SensorStateClass.TOTAL_INCREASING,
             native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
@@ -150,10 +158,8 @@ def __init__(
     ) -> None:
         """Initialize the entity."""
         self._vhh = vhh
-        self._attr_should_poll = False
         self._config = self._ENTITY_CONFIGS[measurement_type]
 
-        self._attr_name = self._config.key
         self._attr_unique_id = f"vhh_{self._config.event}"
 
         self.entity_description = self._config
@@ -165,7 +171,7 @@ def device_info(self) -> DeviceInfo:
             "identifiers": {(DOMAIN, "vhh")},
             "manufacturer": "Powersensor",
             "model": "Virtual",
-            "name": "Powersensor Household View 🏠",
+            "translation_key": "virtual_household_view",
         }
 
     async def async_added_to_hass(self):