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-08 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Link handling setup failures to integration quality scale and add expired credentials (#1361)

Browse Source
This commit is contained in:
J. Nick Koston 2022-06-11 09:51:24 -10:00 committed by GitHub
parent 5f6fcb727e
commit 754e39130d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/integration_quality_scale_index.md
View File

@ -22,7 +22,7 @@ This integration is able to cope when things go wrong. It will not print any exc
- Satisfying all No score level requirements. - Satisfying all No score level requirements.
- Connection/configuration is handled via a component. - Connection/configuration is handled via a component.
- Set an appropriate `SCAN_INTERVAL` (if a polling integration) - Set an appropriate `SCAN_INTERVAL` (if a polling integration)
- Raise `PlatformNotReady` if unable to connect during platform setup (if appropriate) - Raise [`PlatformNotReady`](integration_setup_failures/#integrations-using-async_setup_platform) if unable to connect during platform setup (if appropriate)
- Handles expiration of auth credentials. Refresh if possible or print correct error and fail setup. If based on a config entry, should trigger a new config entry flow to re-authorize. ([docs](config_entries_config_flow_handler.md#reauthentication)) - Handles expiration of auth credentials. Refresh if possible or print correct error and fail setup. If based on a config entry, should trigger a new config entry flow to re-authorize. ([docs](config_entries_config_flow_handler.md#reauthentication))
- Handles internet unavailable. Log a warning once when unavailable, log once when reconnected. - Handles internet unavailable. Log a warning once when unavailable, log once when reconnected.
- Handles device/service unavailable. Log a warning once when unavailable, log once when reconnected. - Handles device/service unavailable. Log a warning once when unavailable, log once when reconnected.
@ -39,7 +39,7 @@ This is a solid integration that is able to survive poor conditions and can be c
- Don't allow configuring already configured device/service (example: no 2 entries for same hub) - Don't allow configuring already configured device/service (example: no 2 entries for same hub)
- Discoverable (if available) - Discoverable (if available)
- Set unique ID in config flow (if available) - Set unique ID in config flow (if available)
- Raise `ConfigEntryNotReady` if unable to connect during entry setup (if appropriate) - Raise [`ConfigEntryNotReady`](integration_setup_failures/#integrations-using-async_setup_entry) if unable to connect during entry setup (if appropriate)
- Entities have device info (if available) ([docs](device_registry_index.md#defining-devices)) - Entities have device info (if available) ([docs](device_registry_index.md#defining-devices))
- Tests - Tests
- Full test coverage for the config flow - Full test coverage for the config flow
@ -60,6 +60,7 @@ Best of the best. The integration is completely async, meaning it's super fast.
- Support config entry unloading (called when config entry is removed) - Support config entry unloading (called when config entry is removed)
- Integration + dependency are async ([docs](asyncio_working_with_async.md)) - Integration + dependency are async ([docs](asyncio_working_with_async.md))
- Uses aiohttp or httpx and allows passing in websession (if making HTTP requests) - Uses aiohttp or httpx and allows passing in websession (if making HTTP requests)
- [Handles expired credentials](integration_setup_failures/#handling-expired-credentials) (if appropriate)
## Internal 🏠 ## Internal 🏠