Skip to content

Add shared rainbird device lock and increase calendar timeout#172002

Open
allenporter wants to merge 1 commit into
home-assistant:devfrom
allenporter:rainbird-coordinator-lock
Open

Add shared rainbird device lock and increase calendar timeout#172002
allenporter wants to merge 1 commit into
home-assistant:devfrom
allenporter:rainbird-coordinator-lock

Conversation

@allenporter
Copy link
Copy Markdown
Contributor

Proposed change

Rain Bird LNK Wi-Fi modules are extremely resource-constrained and can only reliably handle a single HTTP request at a time. The background coordinators (RainbirdUpdateCoordinator and RainbirdScheduleUpdateCoordinator) run on independent update intervals and can execute overlapping requests concurrently, causing the device to return busy warnings (NAKs) or go unavailable.

This PR:

  1. Instantiates a shared asyncio.Lock() (device_lock) inside the config entry's setup to prevent concurrent coordinator requests.
  2. Synchronizes updates by wrapping both coordinator background update blocks in async with self._device_lock.
  3. Increases the schedule fetch timeout from 20 to 30 seconds (CALENDAR_TIMEOUT_SECONDS = 30) to accommodate slower responses from certain controller models when retrieving calendar/schedule timeline data.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings May 23, 2026 23:57
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @konikvranik, mind taking a look at this pull request as it has been labeled with an integration (rainbird) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of rainbird can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign rainbird Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

@allenporter allenporter changed the title rainbird: Add shared device lock and increase calendar timeout Add shared rainbird device lock and increase calendar timeout May 23, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Rain Bird integration to better handle controller modules that can only process one request at a time by serializing coordinator I/O and extending the schedule fetch timeout.

Changes:

  • Create a shared asyncio.Lock() during config entry setup and pass it to both update coordinators.
  • Wrap both coordinators’ _async_update_data calls with the shared lock to prevent concurrent polling.
  • Increase the schedule/calendar fetch timeout to 30 seconds.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
homeassistant/components/rainbird/coordinator.py Adds a shared lock to both coordinators’ update paths and increases the schedule fetch timeout constant.
homeassistant/components/rainbird/__init__.py Instantiates the shared lock during entry setup and wires it into the coordinators.

Comment thread homeassistant/components/rainbird/coordinator.py
Comment thread homeassistant/components/rainbird/coordinator.py
Comment thread homeassistant/components/rainbird/__init__.py
Comment thread homeassistant/components/rainbird/__init__.py
Comment thread homeassistant/components/rainbird/coordinator.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rain Bird ESP-TM2: integration loads schedule for 22 zones on a 4-zone controller, NAK on overshoot marks entity Unavailable

2 participants