Refactoring and made all string translatable

Author: andrew-codechimp

custom_components/battery_notes/__init__.py

@@ -9,14 +9,12 @@
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant, callback
 
-PLATFORMS = [Platform.SENSOR]
+from .const import DOMAIN, LOGGER, PLATFORMS
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up a config entry."""
 
-    await hass.config_entries.async_forward_entry_setups(
-        entry, (Platform.SENSOR,)
-    )
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
     entry.async_on_unload(entry.add_update_listener(async_update_options))
 

custom_components/battery_notes/const.py

@@ -2,6 +2,9 @@
 import json
 from logging import Logger, getLogger
 from pathlib import Path
+from typing import Final
+
+from homeassistant.const import Platform
 
 LOGGER: Logger = getLogger(__package__)
 
@@ -22,3 +25,7 @@
 CONF_SENSORS = "sensors"
 
 DATA_CONFIGURED_ENTITIES = "configured_entities"
+
+PLATFORMS: Final = [
+    Platform.SENSOR,
+]

custom_components/battery_notes/diagnostics.py

@@ -1,10 +1,8 @@
 """Diagnostic helpers."""
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.core import HomeAssistant
 
 async def async_get_config_entry_diagnostics(
-    hass: HomeAssistant,
     entry: ConfigEntry,
 ) -> dict:
     """Return diagnostics for a config entry."""

custom_components/battery_notes/entity.py

@@ -0,0 +1,17 @@
+"""Entities for battery_notes."""
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from homeassistant.helpers.entity import EntityDescription
+
+@dataclass
+class BatteryNotesRequiredKeysMixin:
+    """Mixin for required keys."""
+
+    unique_id_suffix: str
+
+
+@dataclass
+class BatteryNotesEntityDescription(EntityDescription, BatteryNotesRequiredKeysMixin):
+    """Generic Battery Notes entity description."""

custom_components/battery_notes/manifest.json

@@ -9,5 +9,5 @@
   "integration_type": "device",
   "iot_class": "calculated",
   "issue_tracker": "https://github.com/andrew-codechimp/ha-battery-notes/issues",
-  "version": "1.0.0"
+  "version": "1.0.1"
 }

custom_components/battery_notes/sensor.py

@@ -1,11 +1,14 @@
 """Sensor platform for battery_notes."""
 from __future__ import annotations
 
+from dataclasses import dataclass
 import voluptuous as vol
 
 from homeassistant.components.sensor import (
     PLATFORM_SCHEMA,
     SensorEntity,
+    SensorEntityDescription,
+    RestoreSensor,
 )
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_ENTITY_ID
@@ -23,24 +26,38 @@
 )
 
 from homeassistant.helpers.reload import async_setup_reload_service
-from homeassistant.helpers.typing import (
-    ConfigType,
-)
 
 from homeassistant.const import (
     CONF_NAME,
-    CONF_UNIQUE_ID,
 )
 
-from . import PLATFORMS
-
 from .const import (
     DOMAIN,
+    PLATFORMS,
     CONF_BATTERY_TYPE,
     CONF_DEVICE_ID,
 )
 
-ICON = "mdi:battery-unknown"
+from .entity import (
+    BatteryNotesEntityDescription,
+)
+
+
+@dataclass
+class BatteryNotesSensorEntityDescription(
+    BatteryNotesEntityDescription,
+    SensorEntityDescription,
+):
+    """Describes Battery Notes sensor entity."""
+    unique_id_suffix: str
+
+typeSensorEntityDescription = BatteryNotesSensorEntityDescription(
+        unique_id_suffix="", # battery_type has uniqueId set to entityId in V1, never add a suffix
+        key="battery_type",
+        translation_key="battery_type",
+        icon="mdi:battery-unknown",
+        entity_category=EntityCategory.DIAGNOSTIC,
+    )
 
 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
     {
@@ -110,76 +127,68 @@ async def async_registry_updated(event: Event) -> None:
 
     device_id = async_add_to_device(hass, config_entry)
 
-    async_add_entities(
-        [
-            BatteryTypeSensor(
+    entities = [
+        BatteryNotesTypeSensor(
                 hass,
-                config_entry.title,
-                config_entry.entry_id,
-                device_id=device_id,
-                battery_type=battery_type,
-            )
-        ]
-    )
+                typeSensorEntityDescription,
+                device_id,
+                f"{config_entry.entry_id}{typeSensorEntityDescription.unique_id_suffix}",
+                battery_type
+        ),
+
+    ]
+
+    async_add_entities(entities)
+
 
 async def async_setup_platform(
     hass: HomeAssistant,
-    config: ConfigType,
-    async_add_entities: AddEntitiesCallback,
 ) -> None:
-    """Set up the battery type sensor."""
-    name: str | None = config.get(CONF_NAME)
-    unique_id = config.get(CONF_UNIQUE_ID)
-    device_id: str = config[CONF_DEVICE_ID]
-    battery_type: str = config[CONF_BATTERY_TYPE]
-
+    """Set up the battery note sensor."""
     await async_setup_reload_service(hass, DOMAIN, PLATFORMS)
 
-    async_add_entities(
-        [BatteryTypeSensor(hass, name, unique_id, device_id, battery_type)]
-    )
-
-class BatteryTypeSensor(SensorEntity):
-    """Represents a battery type sensor."""
+class BatteryNotesSensor(RestoreSensor, SensorEntity):
+    """Represents a battery note sensor."""
 
-    _attr_icon = ICON
     _attr_should_poll = False
+    entity_description: BatteryNotesSensorEntityDescription
 
     def __init__(
         self,
-        hass: HomeAssistant,
-        name: str,
-        unique_id: str,
+        hass,
+        description: BatteryNotesSensorEntityDescription,
         device_id: str,
-        battery_type: str,
+        unique_id: str,
     ) -> None:
-        """Create a battery type sensor."""
+        """Initialize the sensor."""
         device_registry = dr.async_get(hass)
 
+        self.entity_description = description
+        self._attr_has_entity_name = True
         self._attr_unique_id = unique_id
-        self._attr_name = name + " Battery type"
         self._device_id = device_id
 
-        self._device_id = device_id
         if device_id and (device := device_registry.async_get(device_id)):
             self._attr_device_info = DeviceInfo(
                 connections=device.connections,
                 identifiers=device.identifiers,
             )
-        self._attr_entity_category = EntityCategory.DIAGNOSTIC
-        self._battery_type = battery_type
-
 
     async def async_added_to_hass(self) -> None:
         """Handle added to Hass."""
+        await super().async_added_to_hass()
+        state = await self.async_get_last_sensor_data()
+        if state:
+            self._attr_native_value = state.native_value
+
         self.async_on_remove(
             async_track_state_change_event(
-                self.hass, [self._attr_unique_id], self._async_battery_type_state_changed_listener
+                self.hass, [self._attr_unique_id], self._async_battery_note_state_changed_listener
             )
         )
 
         # Call once on adding
-        self._async_battery_type_state_changed_listener()
+        self._async_battery_note_state_changed_listener()
 
         # Update entity options
         registry = er.async_get(self.hass)
@@ -190,10 +199,36 @@ async def async_added_to_hass(self) -> None:
                 {"entity_id": self._attr_unique_id},
             )
 
+    @callback
+    def _async_battery_note_state_changed_listener(self) -> None:
+        """Handle the sensor state changes."""
+
+        self.async_write_ha_state()
+        self.async_schedule_update_ha_state(True)
+
+
+class BatteryNotesTypeSensor(BatteryNotesSensor):
+    """Represents a battery note sensor."""
+
+    entity_description: BatteryNotesSensorEntityDescription
+
+    def __init__(
+        self,
+        hass,
+        description: BatteryNotesSensorEntityDescription,
+        device_id: str,
+        unique_id: str,
+        battery_type: str | None = None,
+    ) -> None:
+        """Initialize the sensor."""
+        super().__init__(hass, description, device_id, unique_id)
+
+        self._battery_type = battery_type
+
     @property
     def native_value(self) -> str:
         """Return the native value of the sensor."""
-        # return self.battery_type
+
         return self._battery_type
 
     @callback

custom_components/battery_notes/translations/en.json

@@ -36,5 +36,12 @@
         "error": {
             "unknown": "Unknown error occurred."
         }
+    },
+    "entity": {
+        "sensor": {
+            "battery_type": {
+                "name": "Battery type"
+            }
+        }
     }
 }

hacs.json

@@ -2,7 +2,7 @@
     "name": "Battery Notes",
     "filename": "battery-notes.zip",
     "hide_default_branch": true,
-    "homeassistant": "2023.3.0",
+    "homeassistant": "2023.7.0",
     "render_readme": true,
     "zip_release": true
 }