jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-12 11:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

explicitly pass in the config_entry in coordinator (#2558)

Browse Source
This commit is contained in:
Michael 2025-02-10 20:04:10 +01:00 committed by GitHub
parent a8c7713e82
commit 2e7cb67bdc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/integration_fetching_data.md
View File

@ -51,11 +51,11 @@ from .const import DOMAIN
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
async def async_setup_entry(hass, entry, async_add_entities): async def async_setup_entry(hass, config_entry, async_add_entities):
"""Config entry example.""" """Config entry example."""
# assuming API object stored here by __init__.py # assuming API object stored here by __init__.py
my_api = hass.data[DOMAIN][entry.entry_id] my_api = hass.data[DOMAIN][config_entry.entry_id]
coordinator = MyCoordinator(hass, my_api) coordinator = MyCoordinator(hass, config_entry, my_api)
# Fetch initial data so we have data when entities subscribe # Fetch initial data so we have data when entities subscribe
# #
@ -75,13 +75,14 @@ async def async_setup_entry(hass, entry, async_add_entities):
class MyCoordinator(DataUpdateCoordinator): class MyCoordinator(DataUpdateCoordinator):
"""My custom coordinator.""" """My custom coordinator."""
def __init__(self, hass, my_api): def __init__(self, hass, config_entry, my_api):
"""Initialize my coordinator.""" """Initialize my coordinator."""
super().__init__( super().__init__(
hass, hass,
_LOGGER, _LOGGER,
# Name of the data. For logging purposes. # Name of the data. For logging purposes.
name="My sensor", name="My sensor",
config_entry=config_entry,
# Polling interval. Will only be polled if there are subscribers. # Polling interval. Will only be polled if there are subscribers.
update_interval=timedelta(seconds=30), update_interval=timedelta(seconds=30),
# Set always_update to `False` if the data returned from the # Set always_update to `False` if the data returned from the