Align with core changes

Author: tomer-w

custom_components/victron_mqtt/__init__.py

@@ -73,14 +73,14 @@ async def handle_publish(call: ServiceCall) -> None:
     _LOGGER.info("Victron MQTT services registered")
 
 
-async def _update_listener(hass: HomeAssistant, entry: ConfigEntry):
+async def _update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
     """Handle options update."""
     _LOGGER.info("Options for victron_mqtt have been updated - applying changes")
     # Reload the integration to apply changes
     await hass.config_entries.async_reload(entry.entry_id)
 
 
-async def get_package_version(package_name) -> str:
+async def get_package_version(package_name: str) -> str:
     return await asyncio.get_event_loop().run_in_executor(
         None, importlib.metadata.version, package_name
     )
@@ -99,7 +99,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     return True
 
 
-def _sync_library_logging():
+def _sync_library_logging() -> None:
     """Sync the log level of the library to match integration logging."""
     lib_level = _LOGGER.getEffectiveLevel()
     _VICTRON_MQTT_LOGGER.setLevel(lib_level)

custom_components/victron_mqtt/config_flow.py

@@ -187,8 +187,8 @@ def __init__(self) -> None:
         self.hostname: str | None = None
         self.serial: str | None = None
         self.installation_id: str | None = None
-        self.friendlyName: str | None = None
-        self.modelName: str | None = None
+        self.friendly_name: str | None = None
+        self.model_name: str | None = None
 
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
@@ -197,7 +197,7 @@ async def async_step_user(
         errors: dict[str, str] = {}
         if user_input is not None:
             _LOGGER.info("User input received: %s", user_input)
-            data = {**user_input, CONF_SERIAL: self.serial, CONF_MODEL: self.modelName}
+            data = {**user_input, CONF_SERIAL: self.serial, CONF_MODEL: self.model_name}
             data = {
                 k: v for k, v in data.items() if v is not None
             }  # remove None values.
@@ -220,7 +220,7 @@ async def async_step_user(
 
                 self._abort_if_unique_id_configured()
 
-                title = self.friendlyName or f"Victron OS {unique_id}"
+                title = self.friendly_name or f"Victron OS {unique_id}"
                 return self.async_create_entry(title=title, data=data)
 
         if len(errors) > 0:
@@ -246,15 +246,15 @@ async def async_step_ssdp(
         self.hostname = str(urlparse(discovery_info.ssdp_location).hostname)
         self.serial = discovery_info.upnp["serialNumber"]
         self.installation_id = discovery_info.upnp["X_VrmPortalId"]
-        self.modelName = discovery_info.upnp["modelName"]
-        self.friendlyName = discovery_info.upnp["friendlyName"]
+        self.model_name = discovery_info.upnp["model_name"]
+        self.friendly_name = discovery_info.upnp["friendly_name"]
         _LOGGER.info(
-            "SSDP: hostname=%s, serial=%s, installation_id=%s, modelName=%s, friendlyName=%s",
+            "SSDP: hostname=%s, serial=%s, installation_id=%s, model_name=%s, friendly_name=%s",
             self.hostname,
             self.serial,
             self.installation_id,
-            self.modelName,
-            self.friendlyName,
+            self.model_name,
+            self.friendly_name,
         )
 
         await self.async_set_unique_id(self.installation_id)
@@ -273,12 +273,12 @@ async def async_step_ssdp(
             return await self.async_step_user()
 
         return self.async_create_entry(
-            title=str(self.friendlyName),
+            title=str(self.friendly_name),
             data={
                 CONF_HOST: self.hostname,
                 CONF_SERIAL: self.serial,
                 CONF_INSTALLATION_ID: self.installation_id,
-                CONF_MODEL: self.modelName,
+                CONF_MODEL: self.model_name,
             },
         )
 

custom_components/victron_mqtt/entity.py

@@ -16,7 +16,11 @@
 from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.entity import Entity
 
-from .const import ENTITIES_DISABLE_BY_DEFAULT, ENTITIES_CATEGORY_DIAGNOSTIC, ENTITY_PREFIX
+from .const import (
+    ENTITIES_CATEGORY_DIAGNOSTIC,
+    ENTITIES_DISABLE_BY_DEFAULT,
+    ENTITY_PREFIX,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -29,7 +33,7 @@ def __init__(
         device: VictronVenusDevice,
         metric: VictronVenusMetric,
         device_info: DeviceInfo,
-        type: str,
+        entity_platform: str,
         simple_naming: bool,
         installation_id: str,
     ) -> None:
@@ -38,9 +42,9 @@ def __init__(
         self._metric = metric
         self._device_info = device_info
         if simple_naming:
-            entity_id = f"{type}.{ENTITY_PREFIX}_{metric.unique_id}"
+            entity_id = f"{entity_platform}.{ENTITY_PREFIX}_{metric.unique_id}"
         else:
-            entity_id = f"{type}.{ENTITY_PREFIX}_{installation_id}_{metric.unique_id}"
+            entity_id = f"{entity_platform}.{ENTITY_PREFIX}_{installation_id}_{metric.unique_id}"
         self._attr_unique_id = entity_id
         self.entity_id = entity_id
         self._attr_native_unit_of_measurement = self._map_metric_to_unit_of_measurement(
@@ -56,8 +60,14 @@ def __init__(
         )  # same as in merge_topics.py
         self._attr_translation_placeholders = metric.key_values
         # Specific changes related to HA
-        self._attr_entity_category = EntityCategory.DIAGNOSTIC if metric.generic_short_id in ENTITIES_CATEGORY_DIAGNOSTIC else None
-        self._attr_entity_registry_enabled_default = False if metric.generic_short_id in ENTITIES_DISABLE_BY_DEFAULT else True
+        self._attr_entity_category = (
+            EntityCategory.DIAGNOSTIC
+            if metric.generic_short_id in ENTITIES_CATEGORY_DIAGNOSTIC
+            else None
+        )
+        self._attr_entity_registry_enabled_default = (
+            metric.generic_short_id not in ENTITIES_DISABLE_BY_DEFAULT
+        )
 
         _LOGGER.info("%s %s added. Based on: %s", type, self, repr(metric))
 

custom_components/victron_mqtt/hub.py

@@ -113,7 +113,7 @@ def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
 
         self.hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, self.stop)
 
-    async def start(self):
+    async def start(self) -> None:
         """Start the Victron MQTT hub."""
         _LOGGER.info("Starting hub")
         try:
@@ -123,7 +123,7 @@ async def start(self):
                 f"Cannot connect to the hub: {connect_error}"
             ) from connect_error
 
-    async def stop(self, event: Event | None = None):
+    async def stop(self, event: Event | None = None) -> None:
         """Stop the Victron MQTT hub."""
         _LOGGER.info("Stopping hub")
         await self._hub.disconnect()
@@ -133,7 +133,7 @@ def _on_new_metric(
         hub: VictronVenusHub,
         device: VictronVenusDevice,
         metric: VictronVenusMetric,
-    ):
+    ) -> None:
         _LOGGER.info("New metric received. Device: %s, Metric: %s", device, metric)
         assert hub.installation_id is not None
         device_info = Hub._map_device_info(device, hub.installation_id)
@@ -163,7 +163,7 @@ def _map_device_info(
 
     def register_add_entities_callback(
         self, async_add_entities: AddEntitiesCallback, kind: MetricKind
-    ):
+    ) -> None:
         """Register a callback to add entities for a specific metric kind."""
         _LOGGER.info(
             "Registering AddEntitiesCallback. kind: %s, AddEntitiesCallback: %s",