Use built in polling for litterrobot update entity

[natekspencer]

Proposed change

Use the built in polling per previous PR review #83590 (review)

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

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• 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
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

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

• Documentation added/updated for www.home-assistant.io

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

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

Code owner commands

Code owners of litterrobot can trigger bot actions by commenting:

• @home-assistant close Closes the issue.
• @home-assistant rename Awesome new title Change the title of the issue.
• @home-assistant reopen Reopen the issue.
• @home-assistant unassign litterrobot Removes the current integration label and assignees on the issue, add the integration domain after the command.

[tkdrob]

See above

[MartinHjelmare]

Side note: I noticed that the integration doesn't do a first refresh with the coordinator before setting up the platforms. This means the entities will have unknown state until after 5 minutes when the coordinator has fetched the first data. We recommend using coordinator.async_config_entry_first_refresh before forwarding the config entry to the platforms.

[natekspencer]

Side note: I noticed that the integration doesn't do a first refresh with the coordinator before setting up the platforms. This means the entities will have unknown state until after 5 minutes when the coordinator has fetched the first data. We recommend using coordinator.async_config_entry_first_refresh before forwarding the config entry to the platforms.

The initial login from the integration takes care of getting the most recent data of each robot, so the initial state is known before they are passed to the platforms for setup.

[MartinHjelmare]

Ok. Consider making the LitterRobotHub a coordinator child class instead and calling the login method from the update method conditionally. That may clean things up somewhat. Eg, I'm missing handling invalid credentials or other client errors after the login during regular refreshes.

Here's an example of a custom coordinator:

core/homeassistant/components/lametric/coordinator.py

Lines 16 to 41 in cb37df6

	class LaMetricDataUpdateCoordinator(DataUpdateCoordinator[Device]):
	"""The LaMetric Data Update Coordinator."""
	config_entry: ConfigEntry
	def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
	"""Initialize the LaMatric coordinator."""
	self.config_entry = entry
	self.lametric = LaMetricDevice(
	host=entry.data[CONF_HOST],
	api_key=entry.data[CONF_API_KEY],
	session=async_get_clientsession(hass),
	)
	super().__init__(hass, LOGGER, name=DOMAIN, update_interval=SCAN_INTERVAL)
	async def _async_update_data(self) -> Device:
	"""Fetch device information of the LaMetric device."""
	try:
	return await self.lametric.device()
	except LaMetricAuthenticationError as err:
	raise ConfigEntryAuthFailed from err
	except LaMetricError as ex:
	raise UpdateFailed(
	"Could not fetch device information from LaMetric device"
	) from ex

[natekspencer]

Ok. Consider making the LitterRobotHub a coordinator child class instead and calling the login method from the update method conditionally. That may clean things up somewhat. Eg, I'm missing handling invalid credentials or other client errors after the login during regular refreshes.

Would you like me to work on that for this PR or in a separate one for code cleanup?

[MartinHjelmare]

Would you like me to work on that for this PR or in a separate one for code cleanup?

No, just something to consider for the future, for another PR, possibly. 👍

[MartinHjelmare]

Thanks!