Skip to content

Fix default polling interval to prevent API rate limiting #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ulfschnabel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix default polling interval to prevent API rate limiting #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 48 additions & 14 deletions custom_components/govee/config_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,34 @@

_LOGGER = logging.getLogger(__name__)

# Recommended minimum delay to avoid hitting Govee API rate limits
# With 10 devices and 60s polling: ~14,400 requests/day (under 10k limit)
RECOMMENDED_MIN_DELAY = 60


def validate_delay(delay: int) -> int:
"""Validate delay and log warning if too low.

Govee API limit: 10,000 requests per 24 hours.
With N devices and delay D seconds:
- Daily requests = (86400 / D) * N

Example: 4 devices @ 10s = 34,560 requests/day (rate limited!)
Example: 4 devices @ 300s = 1,152 requests/day (safe)
"""
if delay < RECOMMENDED_MIN_DELAY:
devices_before_limit = int(10000 / (86400 / delay))
_LOGGER.warning(
"Poll interval of %s seconds may cause API rate limits. "
"With this interval, you'll hit the 10,000/day limit with ~%d devices. "
"Recommended minimum: %s seconds (1 minute) for 10+ devices, "
"300 seconds (5 minutes) is safer for most setups.",
delay,
devices_before_limit,
RECOMMENDED_MIN_DELAY,
)
return delay


async def validate_api_key(hass: core.HomeAssistant, user_input):
"""Validate the user input allows us to connect.
Expand Down Expand Up @@ -64,6 +92,8 @@ async def async_step_user(self, user_input=None):
if user_input is not None:
try:
user_input = await validate_api_key(self.hass, user_input)
# Validate delay and log warning if needed
validate_delay(user_input[CONF_DELAY])

except CannotConnect as conn_ex:
_LOGGER.exception("Cannot connect: %s", conn_ex)
Expand All @@ -83,7 +113,7 @@ async def async_step_user(self, user_input=None):
data_schema=vol.Schema(
{
vol.Required(CONF_API_KEY): cv.string,
vol.Optional(CONF_DELAY, default=10): cv.positive_int,
vol.Optional(CONF_DELAY, default=300): cv.positive_int,
}
),
errors=errors,
Expand Down Expand Up @@ -123,6 +153,8 @@ async def async_step_user(self, user_input=None):
api_key = user_input[CONF_API_KEY]
if old_api_key != api_key:
user_input = await validate_api_key(self.hass, user_input)
# Validate delay and log warning if needed
validate_delay(user_input[CONF_DELAY])

except CannotConnect as conn_ex:
_LOGGER.exception("Cannot connect: %s", conn_ex)
Expand Down Expand Up @@ -172,32 +204,34 @@ async def async_step_user(self, user_input=None):
vol.Optional(
CONF_DELAY,
default=self.config_entry.options.get(
CONF_DELAY, self.config_entry.data.get(CONF_DELAY, 10)
CONF_DELAY, self.config_entry.data.get(CONF_DELAY, 300)
),
): cv.positive_int,
# to options flow
vol.Required(
vol.Optional(
CONF_USE_ASSUMED_STATE,
default=self.config_entry.options.get(CONF_USE_ASSUMED_STATE, True),
default=self.config_entry.options.get(
CONF_USE_ASSUMED_STATE,
self.config_entry.data.get(CONF_USE_ASSUMED_STATE, True),
),
): cv.boolean,
vol.Required(
vol.Optional(
CONF_OFFLINE_IS_OFF,
default=self.config_entry.options.get(CONF_OFFLINE_IS_OFF, False),
default=self.config_entry.options.get(
CONF_OFFLINE_IS_OFF,
self.config_entry.data.get(CONF_OFFLINE_IS_OFF, False),
),
): cv.boolean,
# TODO: validator doesn't work, change to list?
vol.Optional(
CONF_DISABLE_ATTRIBUTE_UPDATES,
default=self.config_entry.options.get(
CONF_DISABLE_ATTRIBUTE_UPDATES, ""
CONF_DISABLE_ATTRIBUTE_UPDATES,
self.config_entry.data.get(CONF_DISABLE_ATTRIBUTE_UPDATES, ""),
),
): cv.string,
},
}
)

return self.async_show_form(
step_id="user",
data_schema=options_schema,
errors=errors,
step_id="user", data_schema=options_schema, errors=errors
)

async def _update_options(self):
Expand Down
8 changes: 4 additions & 4 deletions custom_components/govee/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
"user": {
"data": {
"api_key": "API Key",
"delay": "Poll Interval"
"delay": "Poll Interval (seconds)"
},
"description": "Get your API Key from the Govee Home App. For Details see https://github.com/LaggAt/hacs-govee/blob/master/README.md"
"description": "Get your API Key from the Govee Home App. For Details see https://github.com/LaggAt/hacs-govee/blob/master/README.md\n\n⚠️ Govee API Limit: 10,000 requests/24 hours. With the default 300s (5 min) interval, you can run ~30 devices safely. Lower intervals may cause rate limiting."
}
}
},
Expand All @@ -28,13 +28,13 @@
"user": {
"data": {
"api_key": "API Key (requires restart)",
"delay": "Poll Interval (requires restart)",
"delay": "Poll Interval in seconds (requires restart)",
"use_assumed_state": "Use 'assumed state' (two buttons). Default: True",
"offline_is_off": "When a led is offline, show it as off (default doesn't change state). Default: False",
"disable_attribute_updates": "DISABLE state updates. Space to disable. Read the README above!"
},
"title": "Options",
"description": "Configure the Govee integration. For Details see https://github.com/LaggAt/hacs-govee/blob/master/README.md"
"description": "Configure the Govee integration. For Details see https://github.com/LaggAt/hacs-govee/blob/master/README.md\n\n⚠️ API Rate Limits: Govee limits to 10,000 requests/24 hours. Daily requests = (86400 / delay) × device_count. Examples:\n• 4 devices @ 300s = 1,152 req/day ✓ Safe\n• 4 devices @ 60s = 5,760 req/day ✓ Safe\n• 4 devices @ 10s = 34,560 req/day ✗ Rate limited!\n\nRecommended: 300s (5 min) for background polling. Enable 'assumed state' for instant UI feedback when controlling lights."
}
}
}
Expand Down