v3.5.0 (#99)

- Added a new sensor that countdown to payout day

Author: UnoSite

custom_components/isitpayday/const.py

@@ -93,11 +93,13 @@
 # Sensor and binary sensor entity names (fixed to required format)
 SENSOR_NEXT_PAYDAY = "sensor.payday_next"
 BINARY_SENSOR_IS_IT_PAYDAY = "binary_sensor.payday"
+SENSOR_DAYS_TO_PAYDAY = "sensor.days_to_payday"
 
 # Sensor icons
 ICON_NEXT_PAYDAY = "mdi:calendar-clock"
 ICON_IS_IT_PAYDAY_TRUE = "mdi:cash-fast"
 ICON_IS_IT_PAYDAY_FALSE = "mdi:cash-clock"
+ICON_DAYS_TO = "mdi:calendar-end"
 
 # Log messages (standardized to use across all files)
 LOG_INIT = "Initializing IsItPayday integration."

custom_components/isitpayday/payday_calculator.py

@@ -35,12 +35,19 @@ async def async_calculate_next_payday(country: str, pay_frequency: str, pay_day=
     if pay_frequency == PAY_FREQ_MONTHLY:
         payday = await async_calculate_month_based(today, 1, pay_day, bank_offset, bank_holidays)
 
-    elif pay_frequency in (PAY_FREQ_28_DAYS, PAY_FREQ_14_DAYS, PAY_FREQ_BIMONTHLY, PAY_FREQ_QUARTERLY, PAY_FREQ_SEMIANNUAL, PAY_FREQ_ANNUAL):
+    elif pay_frequency in (
+        PAY_FREQ_28_DAYS,
+        PAY_FREQ_14_DAYS,
+        PAY_FREQ_BIMONTHLY,
+        PAY_FREQ_QUARTERLY,
+        PAY_FREQ_SEMIANNUAL,
+        PAY_FREQ_ANNUAL,
+    ):
         interval_days = {
             PAY_FREQ_14_DAYS: 14,
             PAY_FREQ_28_DAYS: 28,
             PAY_FREQ_BIMONTHLY: 60,
-            PAY_FREQ_QUARTERLY: 90,
+            PAY_FREQ_QUARTERLY: 91,
             PAY_FREQ_SEMIANNUAL: 182,
             PAY_FREQ_ANNUAL: 365,
         }[pay_frequency]

custom_components/isitpayday/sensor.py

@@ -1,19 +1,25 @@
 import logging
-from datetime import date, timedelta
-from homeassistant.components.sensor import SensorEntity
+from datetime import date, datetime, timedelta
+from math import ceil
+from homeassistant.components.sensor import SensorEntity, SensorDeviceClass
+from homeassistant.helpers.entity import EntityCategory
 from homeassistant.helpers.update_coordinator import CoordinatorEntity, DataUpdateCoordinator
 from .const import *
 
 _LOGGER = logging.getLogger(__name__)
 
 ICON = "mdi:calendar-clock"
+ICON_DAYS_TO = "mdi:calendar-end"
 
 async def async_setup_entry(hass, entry, async_add_entities):
     data = hass.data[DOMAIN][entry.entry_id]
     coordinator: DataUpdateCoordinator = data["coordinator"]
     instance_name = data.get("name", "IsItPayday")
 
-    async_add_entities([IsItPaydayNextSensor(coordinator, entry.entry_id, instance_name)])
+    async_add_entities([
+        IsItPaydayNextSensor(coordinator, entry.entry_id, instance_name),
+        IsItPaydayDaysToSensor(coordinator, entry.entry_id, instance_name)
+    ])
 
 
 class IsItPaydayNextSensor(CoordinatorEntity, SensorEntity):
@@ -35,20 +41,15 @@ def state(self) -> str:
 
         today = date.today()
 
-        # Parse to date if it's a string
         if not isinstance(payday, date):
             try:
                 payday = date.fromisoformat(payday)
             except (ValueError, TypeError):
                 return "Unknown"
 
-        # If payday is today, we want to keep it until the day ends
-        if payday > today:
+        if payday >= today:
             return payday.strftime("%Y-%m-%d")
-        elif payday == today:
-            return payday.strftime("%Y-%m-%d")
-        else:
-            return "Unknown"
+        return "Unknown"
 
     @property
     def extra_state_attributes(self) -> dict:
@@ -65,3 +66,54 @@ def device_info(self):
             "manufacturer": CONF_MANUFACTURER,
             "model": CONF_MODEL,
         }
+
+
+class IsItPaydayDaysToSensor(CoordinatorEntity, SensorEntity):
+    _attr_device_class = SensorDeviceClass.DURATION
+    _attr_native_unit_of_measurement = "d"
+    _attr_state_class = "measurement"
+    _attr_entity_category = EntityCategory.DIAGNOSTIC
+
+    def __init__(self, coordinator: DataUpdateCoordinator, entry_id: str, instance_name: str):
+        super().__init__(coordinator)
+        self._attr_unique_id = f"{entry_id}_days_to"
+        self._attr_name = f"{instance_name}: Days to"
+        self._attr_icon = ICON_DAYS_TO
+        self._instance_name = instance_name
+        self._entry_id = entry_id
+
+    @property
+    def native_value(self) -> int | None:
+        payday = self.coordinator.data.get("payday_next")
+        if not payday:
+            return None
+
+        try:
+            if isinstance(payday, str):
+                payday = date.fromisoformat(payday)
+
+            now = datetime.now().date()
+            if payday <= now:
+                return 0
+
+            delta = payday - now
+            return delta.days
+        except Exception as e:
+            _LOGGER.exception("Error calculating days to payday: %s", e)
+            return None
+
+    @property
+    def extra_state_attributes(self) -> dict:
+        return {
+            "source": "IsItPayday DataUpdateCoordinator",
+            "raw_data": str(self.coordinator.data),
+        }
+
+    @property
+    def device_info(self):
+        return {
+            "identifiers": {(DOMAIN, self._entry_id)},
+            "name": self._instance_name,
+            "manufacturer": CONF_MANUFACTURER,
+            "model": CONF_MODEL,
+            }