Fixes for starting with no existing battery notes

Author: andrew-codechimp

README.md

@@ -30,20 +30,30 @@ Platform | Description
 Or  
 Search for `Battery Notes` in HACS and install it under the "Integrations" category.  
 Restart Home Assistant  
+Add the following entry to your ```configuration.yaml```  
+```
+battery_notes:
+  enable_autodiscovery: true
+```
+Restart Home Assistant a final time
 In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Battery Notes"  
 
 ### Manual Installation
 
-<details>
-<summary>Show detailed instructions</summary>
-1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
-1. If you do not have a `custom_components` directory (folder) there, you need to create it.
-1. In the `custom_components` directory (folder) create a new folder called `battery_notes`.
-1. Download _all_ the files from the `custom_components/battery_notes/` directory (folder) in this repository.
-1. Place the files you downloaded in the new directory (folder) you created.
-1. Restart Home Assistant
-1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Battery Notes"
-</details>
+Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).  
+If you do not have a `custom_components` directory (folder) there, you need to create it.  
+In the `custom_components` directory (folder) create a new folder called `battery_notes`.  
+Download _all_ the files from the `custom_components/battery_notes/` directory (folder) in this repository.  
+Place the files you downloaded in the new directory (folder) you created.  
+Restart Home Assistant  
+Add the following entry to your ```configuration.yaml```  
+```
+battery_notes:
+  enable_autodiscovery: true
+```
+Restart Home Assistant a final time  
+In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Battery Notes"  
+
 
 ## Configuration is done in the UI
 
@@ -52,8 +62,8 @@ The battery type will then be displayed as a diagnostic sensor on the device.
 
 ## Automatic discovery
 
-By default Battery Notes will automatically discover devices that it has in its library and create a notification to add a battery note.
-If you wish to disable this functionality then add the following to your ```configuration.yaml```  
+Battery Notes will automatically discover devices (as long as you have followed the installation instructions above) that it has in its library and create a notification to add a battery note.
+If you wish to disable this functionality then change your ```configuration.yaml``` to set enable_autodiscovery to false
 ```
 battery_notes:
   enable_autodiscovery: false

custom_components/battery_notes/__init__.py

@@ -51,6 +51,8 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     if domain_config.get(CONF_ENABLE_AUTODISCOVERY):
         discovery_manager = DiscoveryManager(hass, config)
         await discovery_manager.start_discovery()
+    else:
+        _LOGGER.debug("Auto discovery disabled")
 
     return True
 

custom_components/battery_notes/config_flow.py

@@ -87,13 +87,20 @@ async def async_step_user(
             device_registry = dr.async_get(self.hass)
             device_entry = device_registry.async_get(device_id)
 
-            library = Library(self.hass)
+            _LOGGER.debug(
+                "Looking up device %s %s", device_entry.manufacturer, device_entry.model
+            )
+
+            library = Library.factory(self.hass)
 
             device_battery_details = await library.get_device_battery_details(
                 device_entry.manufacturer, device_entry.model
             )
 
             if device_battery_details:
+                _LOGGER.debug(
+                    "Found device %s %s", device_entry.manufacturer, device_entry.model
+                )
                 self.data[
                     CONF_BATTERY_TYPE
                 ] = device_battery_details.battery_type_and_quantity

custom_components/battery_notes/const.py

@@ -31,6 +31,7 @@
 DATA_CONFIGURED_ENTITIES = "configured_entities"
 DATA_DISCOVERED_ENTITIES = "discovered_entities"
 DATA_DOMAIN_ENTITIES = "domain_entities"
+DATA_LIBRARY = "library"
 
 PLATFORMS: Final = [
     Platform.SENSOR,

custom_components/battery_notes/discovery.py

@@ -75,14 +75,13 @@ def __init__(self, hass: HomeAssistant, ha_config: ConfigType) -> None:
         """Init."""
         self.hass = hass
         self.ha_config = ha_config
-        self.manually_configured_entities: list[str] | None = None
 
     async def start_discovery(self) -> None:
         """Start the discovery procedure."""
         _LOGGER.debug("Start auto discovering devices")
         device_registry = dr.async_get(self.hass)
 
-        library = Library(self.hass)
+        library = Library.factory(self.hass)
 
         if library.loaded():
             for device_entry in list(device_registry.devices.values()):
@@ -105,6 +104,8 @@ async def start_discovery(self) -> None:
                     continue
 
                 self._init_entity_discovery(device_entry, device_battery_details)
+        else:
+            _LOGGER.error("Library not loaded")
 
         _LOGGER.debug("Done auto discovering devices")
 

custom_components/battery_notes/library.py

@@ -10,6 +10,7 @@
 
 from .const import (
     DOMAIN,
+    DATA_LIBRARY,
     DOMAIN_CONFIG,
     CONF_LIBRARY,
 )
@@ -41,11 +42,24 @@ def __init__(self, hass: HomeAssistant) -> None:
 
         except FileNotFoundError:
             _LOGGER.error(
-                "%s file not found in directory %s",
-                hass.data[DOMAIN][DOMAIN_CONFIG].get(CONF_LIBRARY, "library.json"),
+                "library.json file not found in directory %s",
                 BUILT_IN_DATA_DIRECTORY,
             )
 
+    @staticmethod
+    def factory(hass: HomeAssistant) -> Library:
+        """Return the library or create."""
+
+        if DOMAIN not in hass.data:
+            hass.data[DOMAIN] = {}
+
+        if DATA_LIBRARY in hass.data[DOMAIN]:
+            return hass.data[DOMAIN][DATA_LIBRARY]  # type: ignore
+
+        library = Library(hass)
+        hass.data[DOMAIN][DATA_LIBRARY] = library
+        return library
+
     async def get_device_battery_details(
         self,
         manufacturer: str,