jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-18 02:37:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjust polling rate of Rituals Perfume Genie (#127544)

Browse Source
This commit is contained in:
Franck Nijhof 2024-10-04 11:21:22 +02:00
parent 1b0f731e30
commit ea8aa6b07d
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
4 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
homeassistant/components/rituals_perfume_genie/__init__.py
View File

@ -12,7 +12,7 @@ from homeassistant.exceptions import ConfigEntryNotReady
from homeassistant.helpers import entity_registry as er from homeassistant.helpers import entity_registry as er
from homeassistant.helpers.aiohttp_client import async_get_clientsession from homeassistant.helpers.aiohttp_client import async_get_clientsession
from .const import ACCOUNT_HASH, DOMAIN from .const import ACCOUNT_HASH, DOMAIN, UPDATE_INTERVAL
from .coordinator import RitualsDataUpdateCoordinator from .coordinator import RitualsDataUpdateCoordinator
PLATFORMS = [ PLATFORMS = [
@ -37,9 +37,14 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
# Migrate old unique_ids to the new format # Migrate old unique_ids to the new format
async_migrate_entities_unique_ids(hass, entry, account_devices) async_migrate_entities_unique_ids(hass, entry, account_devices)
# The API provided by Rituals is currently rate limited to 30 requests
# per hour per IP address. To avoid hitting this limit, we will adjust
# the polling interval based on the number of diffusers one has.
update_interval = UPDATE_INTERVAL * len(account_devices)
# Create a coordinator for each diffuser # Create a coordinator for each diffuser
coordinators = { coordinators = {
diffuser.hublot: RitualsDataUpdateCoordinator(hass, diffuser) diffuser.hublot: RitualsDataUpdateCoordinator(hass, diffuser, update_interval)
for diffuser in account_devices for diffuser in account_devices
} }

1
homeassistant/components/rituals_perfume_genie/config_flow.py
View File

@ -45,6 +45,7 @@ class RitualsPerfumeGenieConfigFlow(ConfigFlow, domain=DOMAIN):
try: try:
await account.authenticate() await account.authenticate()
except ClientResponseError: except ClientResponseError:
_LOGGER.exception("Unexpected response")
errors["base"] = "cannot_connect" errors["base"] = "cannot_connect"
except AuthenticationException: except AuthenticationException:
errors["base"] = "invalid_auth" errors["base"] = "invalid_auth"

6
homeassistant/components/rituals_perfume_genie/const.py
View File

@ -6,4 +6,8 @@ DOMAIN = "rituals_perfume_genie"
ACCOUNT_HASH = "account_hash" ACCOUNT_HASH = "account_hash"
UPDATE_INTERVAL = timedelta(minutes=2) # The API provided by Rituals is currently rate limited to 30 requests
# per hour per IP address. To avoid hitting this limit, the polling
# interval is set to 3 minutes. This also gives a little room for
# Home Assistant restarts.
UPDATE_INTERVAL = timedelta(minutes=3)

12
homeassistant/components/rituals_perfume_genie/coordinator.py
View File

@ -1,5 +1,6 @@
"""The Rituals Perfume Genie data update coordinator.""" """The Rituals Perfume Genie data update coordinator."""
from datetime import timedelta
import logging import logging
from pyrituals import Diffuser from pyrituals import Diffuser
@ -7,7 +8,7 @@ from pyrituals import Diffuser
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
from .const import DOMAIN, UPDATE_INTERVAL from .const import DOMAIN
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@ -15,14 +16,19 @@ _LOGGER = logging.getLogger(__name__)
class RitualsDataUpdateCoordinator(DataUpdateCoordinator[None]): class RitualsDataUpdateCoordinator(DataUpdateCoordinator[None]):
"""Class to manage fetching Rituals Perfume Genie device data from single endpoint.""" """Class to manage fetching Rituals Perfume Genie device data from single endpoint."""
def __init__(self, hass: HomeAssistant, diffuser: Diffuser) -> None: def __init__(
self,
hass: HomeAssistant,
diffuser: Diffuser,
update_interval: timedelta,
) -> None:
"""Initialize global Rituals Perfume Genie data updater.""" """Initialize global Rituals Perfume Genie data updater."""
self.diffuser = diffuser self.diffuser = diffuser
super().__init__( super().__init__(
hass, hass,
_LOGGER, _LOGGER,
name=f"{DOMAIN}-{diffuser.hublot}", name=f"{DOMAIN}-{diffuser.hublot}",
update_interval=UPDATE_INTERVAL, update_interval=update_interval,
) )
async def _async_update_data(self) -> None: async def _async_update_data(self) -> None: