.github/workflows/pytest.yaml

@@ -15,7 +15,8 @@ jobs:
         python-version:
           # - "3.10"
           # - "3.11"
-          - "3.12"
+          # - "3.12"
+          - "3.13"
 
     steps:
       - name: 📥 Checkout the repository

.gitignore

@@ -12,7 +12,6 @@ custom_components/mail_and_packages/.backup/__init__.py
 custom_components/mail_and_packages/.backup/camera.py
 custom_components/mail_and_packages/.backup/manifest.json
 custom_components/mail_and_packages/.backup/sensor.py
-custom_components/mail_and_packages/images/*
 notes.txt
 
 # Test files

custom_components/mail_and_packages/__init__.py

@@ -2,15 +2,20 @@
 
 import asyncio
 import logging
+import os
 from datetime import timedelta
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_HOST, CONF_RESOURCES
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryNotReady
+from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import (
+    ATTR_AMAZON_IMAGE,
+    ATTR_IMAGE_NAME,
+    ATTR_IMAGE_PATH,
     CONF_AMAZON_DAYS,
     CONF_AMAZON_DOMAIN,
     CONF_AMAZON_FWDS,
@@ -29,7 +34,7 @@
     PLATFORMS,
     VERSION,
 )
-from .helpers import process_emails
+from .helpers import default_image_path, hash_file, process_emails
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -54,6 +59,9 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
     # Sort the resources
     updated_config[CONF_RESOURCES] = sorted(updated_config[CONF_RESOURCES])
 
+    if CONF_PATH not in updated_config:
+        updated_config[CONF_PATH] = "custom_components/mail_and_packages/images/"
+
     if updated_config != config_entry.data:
         hass.config_entries.async_update_entry(config_entry, data=updated_config)
 
@@ -79,6 +87,18 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
     return True
 
 
+async def async_remove_config_entry_device(  # pylint: disable-next=unused-argument
+    hass: HomeAssistant, config_entry: ConfigEntry, device_entry: dr.DeviceEntry
+) -> bool:
+    """Remove config entry from a device if its no longer present."""
+    return not any(
+        identifier
+        for identifier in device_entry.identifiers
+        if identifier[0] == DOMAIN
+        and config_entry.runtime_data.get_device(identifier[1])
+    )
+
+
 async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
     """Handle removal of an entry."""
     _LOGGER.debug("Attempting to unload sensors from the %s integration", DOMAIN)
@@ -210,4 +230,52 @@ async def _async_update_data(self):
 
             if data:
                 self._data = data
+                await self._binary_sensor_update()
             return self._data
+
+    async def _binary_sensor_update(self):
+        """Update binary sensor states."""
+        attributes = (ATTR_IMAGE_NAME, ATTR_IMAGE_PATH)
+        if set(attributes).issubset(self._data.keys()):
+            image = self._data[ATTR_IMAGE_NAME]
+            path = default_image_path(self.hass, self.config)
+            usps_image = f"{path}/{image}"
+            usps_none = f"{os.path.dirname(__file__)}/mail_none.gif"
+            usps_check = os.path.exists(usps_image)
+            _LOGGER.debug("USPS Check: %s", usps_check)
+            if usps_check:
+                image_hash = await self.hass.async_add_executor_job(
+                    hash_file, usps_image
+                )
+                none_hash = await self.hass.async_add_executor_job(hash_file, usps_none)
+
+                _LOGGER.debug("USPS Image hash: %s", image_hash)
+                _LOGGER.debug("USPS None hash: %s", none_hash)
+
+                if image_hash != none_hash:
+                    self._data["usps_update"] = True
+                else:
+                    self._data["usps_update"] = False
+        attributes = (ATTR_AMAZON_IMAGE, ATTR_IMAGE_PATH)
+        if set(attributes).issubset(self._data.keys()):
+            image = self._data[ATTR_AMAZON_IMAGE]
+            path = f"{default_image_path(self.hass, self.config)}/amazon/"
+            amazon_image = f"{path}{image}"
+            amazon_none = f"{os.path.dirname(__file__)}/no_deliveries.jpg"
+            amazon_check = os.path.exists(amazon_image)
+            _LOGGER.debug("Amazon Check: %s", amazon_check)
+            if amazon_check:
+                image_hash = await self.hass.async_add_executor_job(
+                    hash_file, amazon_image
+                )
+                none_hash = await self.hass.async_add_executor_job(
+                    hash_file, amazon_none
+                )
+
+                _LOGGER.debug("Amazon Image hash: %s", image_hash)
+                _LOGGER.debug("Amazon None hash: %s", none_hash)
+
+                if image_hash != none_hash:
+                    self._data["amazon_update"] = True
+                else:
+                    self._data["amazon_update"] = False

custom_components/mail_and_packages/binary_sensor.py

@@ -1,8 +1,6 @@
 """Binary sensors for Mail and Packages."""
 
-import asyncio
 import logging
-import os
 
 from homeassistant.components.binary_sensor import (
     BinarySensorEntity,
@@ -15,16 +13,7 @@
     DataUpdateCoordinator,
 )
 
-from .const import (
-    ATTR_AMAZON_IMAGE,
-    ATTR_IMAGE_NAME,
-    ATTR_IMAGE_PATH,
-    BINARY_SENSORS,
-    COORDINATOR,
-    DOMAIN,
-    VERSION,
-)
-from .helpers import default_image_path, hash_file
+from .const import BINARY_SENSORS, COORDINATOR, DOMAIN, VERSION
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -77,55 +66,9 @@ def should_poll(self) -> bool:
         """No need to poll. Coordinator notifies entity of updates."""
         return False
 
-    @property
-    def available(self) -> bool:
-        """Return if entity is available."""
-        return self.coordinator.last_update_success
-
     @property
     def is_on(self) -> bool:
         """Return True if the image is updated."""
-        if self._type == "usps_update":
-            attributes = (ATTR_IMAGE_NAME, ATTR_IMAGE_PATH)
-            if set(attributes).issubset(self.coordinator.data.keys()):
-                image = self.coordinator.data[ATTR_IMAGE_NAME]
-                path = default_image_path(self.hass, self._config)
-                usps_image = f"{path}/{image}"
-                usps_none = f"{os.path.dirname(__file__)}/mail_none.gif"
-                usps_check = os.path.exists(usps_image)
-                _LOGGER.debug("USPS Check: %s", usps_check)
-                if usps_check:
-                    loop = asyncio.get_running_loop()
-                    image_hash = loop.run_in_executor(None, hash_file, usps_image)
-                    none_hash = loop.run_in_executor(None, hash_file, usps_none)
-
-                    _LOGGER.debug("USPS Image hash: %s", image_hash)
-                    _LOGGER.debug("USPS None hash: %s", none_hash)
-
-                    if image_hash != none_hash:
-                        return True
-                return False
-
-        if self._type == "amazon_update":
-            attributes = (ATTR_AMAZON_IMAGE, ATTR_IMAGE_PATH)
-            if set(attributes).issubset(self.coordinator.data.keys()):
-                image = self.coordinator.data[ATTR_AMAZON_IMAGE]
-                path = f"{default_image_path(self.hass, self._config)}/amazon/"
-                amazon_image = f"{path}{image}"
-                amazon_none = f"{os.path.dirname(__file__)}/no_deliveries.jpg"
-                amazon_check = os.path.exists(amazon_image)
-                _LOGGER.debug("Amazon Check: %s", amazon_check)
-                if amazon_check:
-                    loop = asyncio.get_running_loop()
-                    image_hash = loop.run_in_executor(None, hash_file, amazon_image)
-                    none_hash = loop.run_in_executor(None, hash_file, amazon_none)
-
-                    _LOGGER.debug("Amazon Image hash: %s", image_hash)
-                    _LOGGER.debug("Amazon None hash: %s", none_hash)
-
-                    if image_hash != none_hash:
-                        return True
-                return False
         if self._type in self.coordinator.data.keys():
             _LOGGER.debug(
                 "binary_sensor: %s value: %s",

custom_components/mail_and_packages/camera.py

@@ -116,7 +116,7 @@ async def async_camera_image(
             file = await self.hass.async_add_executor_job(open, self._file_path, "rb")
             return file.read()
         except FileNotFoundError:
-            _LOGGER.warning(
+            _LOGGER.info(
                 "Could not read camera %s image from file: %s",
                 self._name,
                 self._file_path,
@@ -125,7 +125,7 @@ async def async_camera_image(
     def check_file_path_access(self, file_path: str) -> None:
         """Check that filepath given is readable."""
         if not os.access(file_path, os.R_OK):
-            _LOGGER.warning(
+            _LOGGER.info(
                 "Could not read camera %s image from file: %s", self._name, file_path
             )
 
@@ -208,8 +208,3 @@ def should_poll(self) -> bool:
     async def async_update(self):
         """Update camera entity and refresh attributes."""
         self.update_file_path()
-
-    @property
-    def available(self) -> bool:
-        """Return if entity is available."""
-        return self._coordinator.last_update_success

custom_components/mail_and_packages/config_flow.py

@@ -22,15 +22,16 @@
     CONF_AMAZON_FWDS,
     CONF_CUSTOM_IMG,
     CONF_CUSTOM_IMG_FILE,
-    CONF_STORAGE,
     CONF_DURATION,
     CONF_FOLDER,
+    CONF_GENERATE_GRID,
     CONF_GENERATE_MP4,
     CONF_IMAGE_SECURITY,
     CONF_IMAP_SECURITY,
     CONF_IMAP_TIMEOUT,
     CONF_PATH,
     CONF_SCAN_INTERVAL,
+    CONF_STORAGE,
     CONF_VERIFY_SSL,
     CONFIG_VER,
     DEFAULT_ALLOW_EXTERNAL,
@@ -230,6 +231,9 @@ def _get_default(key: str, fallback_default: Any = None) -> None:
             vol.Optional(
                 CONF_DURATION, default=_get_default(CONF_DURATION)
             ): vol.Coerce(int),
+            vol.Optional(
+                CONF_GENERATE_GRID, default=_get_default(CONF_GENERATE_GRID)
+            ): cv.boolean,
             vol.Optional(
                 CONF_GENERATE_MP4, default=_get_default(CONF_GENERATE_MP4)
             ): cv.boolean,
@@ -295,7 +299,9 @@ def _get_default(key: str, fallback_default: Any = None) -> None:
 
     return vol.Schema(
         {
-            vol.Required(CONF_STORAGE, default=_get_default(CONF_STORAGE)): cv.string,
+            vol.Required(
+                CONF_STORAGE, default=_get_default(CONF_STORAGE, DEFAULT_STORAGE)
+            ): cv.string,
         }
     )
 
@@ -382,6 +388,7 @@ async def _show_config_2(self, user_input):
             CONF_DURATION: DEFAULT_GIF_DURATION,
             CONF_IMAGE_SECURITY: DEFAULT_IMAGE_SECURITY,
             CONF_IMAP_TIMEOUT: DEFAULT_IMAP_TIMEOUT,
+            CONF_GENERATE_GRID: False,
             CONF_GENERATE_MP4: False,
             CONF_ALLOW_EXTERNAL: DEFAULT_ALLOW_EXTERNAL,
             CONF_CUSTOM_IMG: DEFAULT_CUSTOM_IMG,
@@ -531,9 +538,6 @@ async def async_step_reconfig_2(self, user_input=None):
 
     async def _show_reconfig_2(self, user_input):
         """Step 2 setup."""
-        if self._data[CONF_AMAZON_FWDS] == []:
-            self._data[CONF_AMAZON_FWDS] = "(none)"
-
         return self.async_show_form(
             step_id="reconfig_2",
             data_schema=_get_schema_step_2(self._data, user_input, self._data),
@@ -584,6 +588,9 @@ async def async_step_reconfig_amazon(self, user_input=None):
 
     async def _show_reconfig_amazon(self, user_input):
         """Step 3 setup."""
+        if self._data[CONF_AMAZON_FWDS] == []:
+            self._data[CONF_AMAZON_FWDS] = "(none)"
+
         return self.async_show_form(
             step_id="reconfig_amazon",
             data_schema=_get_schema_step_amazon(user_input, self._data),