Merge pull request #75 from jwillemsen/jwi-ratelimitrepair

Rate limitation changes

Author: jwillemsen

custom_components/daikin_onecta/coordinator.py

@@ -25,7 +25,7 @@ def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None:
         """Initialize."""
         self.options = config_entry.options
 
-        super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=self.determine_update_interval())
+        super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=self.determine_update_interval(hass))
 
         _LOGGER.info(
             "Daikin coordinator initialized with %s interval.",
@@ -55,7 +55,7 @@ async def _async_update_data(self):
                 device = Appliance(dev_data, daikin_api)
                 devices[dev_data["id"]] = device
 
-        self.update_interval = self.determine_update_interval()
+        self.update_interval = self.determine_update_interval(self.hass)
 
         _LOGGER.debug(
             "Daikin coordinator finished _async_update_data, interval %s.",
@@ -68,14 +68,20 @@ def update_settings(self, config_entry: ConfigEntry):
         self.update_interval = self.determine_update_interval()
         _LOGGER.info("Daikin coordinator changed interval to %s", self.update_interval)
 
-    def determine_update_interval(self):
+    def determine_update_interval(self, hass: HomeAssistant):
         # Default of low scan minutes interval
         scan_interval = self.options.get("low_scan_interval", 30)
         hs = datetime.strptime(self.options.get("high_scan_start", "07:00:00"), "%H:%M:%S").time()
         ls = datetime.strptime(self.options.get("low_scan_start", "22:00:00"), "%H:%M:%S").time()
         if self.in_between(datetime.now().time(), hs, ls):
             scan_interval = self.options.get("high_scan_interval", 10)
 
+        # When we hit our daily rate limit we skip the next update because any call which results
+        # again in just a rate limit error back is counted as call for the limit of next day
+        daikin_api = hass.data[DOMAIN][DAIKIN_API]
+        if daikin_api.rate_limits["remaining_day"] == 0:
+            scan_interval *= 2
+
         return timedelta(minutes=scan_interval)
 
     def in_between(self, now, start, end):

custom_components/daikin_onecta/daikin_api.py

@@ -9,6 +9,7 @@
 from homeassistant import config_entries
 from homeassistant import core
 from homeassistant.helpers import config_entry_oauth2_flow
+from homeassistant.helpers import issue_registry as ir
 
 from .const import DAIKIN_DEVICES
 from .const import DOMAIN
@@ -84,10 +85,16 @@ async def doBearerRequest(self, resourceUrl, options=None):
                 _LOGGER.error("REQUEST FAILED: %s", e)
                 return []
 
-            self.rate_limits["minute"] = res.headers.get("X-RateLimit-Limit-minute", 0)
-            self.rate_limits["day"] = res.headers.get("X-RateLimit-Limit-day", 0)
-            self.rate_limits["remaining_minutes"] = res.headers.get("X-RateLimit-Remaining-minute", 0)
-            self.rate_limits["remaining_day"] = res.headers.get("X-RateLimit-Remaining-day", 0)
+            self.rate_limits["minute"] = int(res.headers.get("X-RateLimit-Limit-minute", 0))
+            self.rate_limits["day"] = int(res.headers.get("X-RateLimit-Limit-day", 0))
+            self.rate_limits["remaining_minutes"] = int(res.headers.get("X-RateLimit-Remaining-minute", 0))
+            self.rate_limits["remaining_day"] = int(res.headers.get("X-RateLimit-Remaining-day", 0))
+
+            if self.rate_limits["remaining_minutes"] > 0:
+                ir.async_delete_issue(self.hass, DOMAIN, "minute_rate_limit")
+
+            if self.rate_limits["remaining_day"] > 0:
+                ir.async_delete_issue(self.hass, DOMAIN, "day_rate_limit")
 
             _LOGGER.debug("BEARER RESPONSE CODE: %s LIMIT: %s", res.status_code, self.rate_limits)
 
@@ -98,9 +105,33 @@ async def doBearerRequest(self, resourceUrl, options=None):
                 _LOGGER.error("RETRIEVE JSON FAILED: %s", res.text)
                 return False
         elif res.status_code == 429:
-            raise Exception(
-                "Rate limit: Remaining minute " + str(self.rate_limits["remaining_minutes"]) + " day " + str(self.rate_limits["remaining_day"])
-            )
+            if self.rate_limits["remaining_minutes"] == 0:
+                ir.async_create_issue(
+                    self.hass,
+                    DOMAIN,
+                    "minute_rate_limit",
+                    is_fixable=False,
+                    is_persistent=True,
+                    severity=ir.IssueSeverity.ERROR,
+                    learn_more_url="https://developer.cloud.daikineurope.com/docs/b0dffcaa-7b51-428a-bdff-a7c8a64195c0/rate_limitation",
+                    translation_key="minute_rate_limit",
+                )
+
+            if self.rate_limits["remaining_day"] == 0:
+                ir.async_create_issue(
+                    self.hass,
+                    DOMAIN,
+                    "day_rate_limit",
+                    is_fixable=False,
+                    is_persistent=True,
+                    severity=ir.IssueSeverity.ERROR,
+                    learn_more_url="https://developer.cloud.daikineurope.com/docs/b0dffcaa-7b51-428a-bdff-a7c8a64195c0/rate_limitation",
+                    translation_key="day_rate_limit",
+                )
+            if options is not None and "method" in options and options["method"] == "PATCH":
+                return False
+            else:
+                return []
         elif res.status_code == 204:
             self._last_patch_call = datetime.now()
             return True

custom_components/daikin_onecta/strings.json

@@ -35,5 +35,15 @@
         "title": "Daikin Onecta"
       }
     }
+  },
+  "issues": {
+    "day_rate_limit": {
+      "title": "The daily rate limit has been reached",
+      "description": "You have reached your daily rate limit to the Daikin Cloud, check your polling frequency in the Daikin Onecta configuration."
+    },
+    "minute_rate_limit": {
+      "title": "The minute rate limit has been reached",
+      "description": "You have reached your minute rate limit to the Daikin Cloud, don't make so many calls to your Daikin devices in one minute."
+    }
   }
 }

custom_components/daikin_onecta/translations/en.json

@@ -63,5 +63,15 @@
         }
       }
     }
+  },
+  "issues": {
+    "day_rate_limit": {
+      "title": "The daily rate limit has been reached",
+      "description": "You have reached your daily rate limit to the Daikin Cloud, check your polling frequency in the Daikin Onecta configuration."
+    },
+    "minute_rate_limit": {
+      "title": "The minute rate limit has been reached",
+      "description": "You have reached your minute rate limit to the Daikin Cloud, don't make so many calls to your Daikin devices in one minute."
+    }
   }
 }