Record Overkiz quality scale

[iMicknl]

Proposed change

Bronze

• config-flow - Integration needs to be able to be set up via the UI
  • Uses data_description to give context to fields
  • Uses ConfigEntry.data and ConfigEntry.options correctly
• test-before-configure - Test a connection in the config flow
  

  core/homeassistant/components/overkiz/config_flow.py

  Line 64 in a3febc4

  await client.login(register_event_listener=False)

• unique-config-entry - Don't allow the same device or service to be able to be set up twice
  

  core/homeassistant/components/overkiz/config_flow.py

  Line 79 in a3febc4

  await self.async_set_unique_id(gateway_id, raise_on_progress=False)

  
  

  core/homeassistant/components/overkiz/config_flow.py

  Line 186 in a3febc4

  self._abort_if_unique_id_configured()

• config-flow-test-coverage - Full test coverage for the config flow
• runtime-data - Use ConfigEntry.runtime_data to store runtime data
  

  core/homeassistant/components/overkiz/__init__.py

  Lines 129 to 131 in 619aed3

  	entry.runtime_data = HomeAssistantOverkizData(
  	coordinator=coordinator, platforms=platforms, scenarios=scenarios
  	)

• test-before-setup - Check during integration initialization if we are able to set it up correctly
  

  core/homeassistant/components/overkiz/__init__.py

  Lines 82 to 83 in a3febc4

  	try:
  	await client.login()

• appropriate-polling - If it's a polling integration, set an appropriate polling interval
  

  core/homeassistant/components/overkiz/const.py

  Lines 46 to 47 in a3febc4

  	UPDATE_INTERVAL: Final = timedelta(seconds=30)
  	UPDATE_INTERVAL_ALL_ASSUMED_STATE: Final = timedelta(minutes=60)

• entity-unique-id - Entities have a unique ID
  

  core/homeassistant/components/overkiz/entity.py

  Line 39 in a3febc4

  self._attr_unique_id = self.device.device_url

• has-entity-name - Entities use has_entity_name = True
  

  core/homeassistant/components/overkiz/entity.py

  Line 22 in a3febc4

  _attr_has_entity_name = True

• entity-event-setup - Entities event setup
  Handled in coordinator.py
• dependency-transparency - Dependency transparency
  https://github.com/iMicknl/python-overkiz-api
• action-setup - Service actions are registered in async_setup
• common-modules - Place common patterns in common modules
  coordinator.py, entity.py
• docs-high-level-description - The documentation includes a high-level description of the integration brand, product, or service
  https://www.home-assistant.io/integrations/overkiz/
• docs-installation-instructions - The documentation provides step-by-step installation instructions for the integration, including, if needed, prerequisites
• docs-removal-instructions - The documentation provides removal instructions
• docs-actions - The documentation describes the provided service actions that can be used
• brands - Has branding assets available for the integration

Silver

• config-entry-unloading - Support config entry unloading
• log-when-unavailable - If internet/device/service is unavailable, log once when unavailable and once when back connected
• entity-unavailable - Mark entity unavailable if appropriate
• action-exceptions - Service actions raise exceptions when encountering failures
• reauthentication-flow - Reauthentication flow
• parallel-updates - Set Parallel updates
• test-coverage - Above 95% test coverage for all integration modules
• integration-owner - Has an integration owner
• docs-installation-parameters - The documentation describes all integration installation parameters
• docs-configuration-parameters - The documentation describes all integration configuration options

Gold

• entity-translations - Entities have translated names
• entity-device-class - Entities use device classes where possible
• devices - The integration creates devices
• entity-category - Entities are assigned an appropriate EntityCategory
• entity-disabled-by-default - Integration disables less popular (or noisy) entities
• discovery - Can be discovered
• stale-devices - Clean up stale devices
• diagnostics - Implements diagnostics
• exception-translations - Exception messages are translatable
• icon-translations - Icon translations
• reconfiguration-flow - Integrations should have a reconfigure flow
• dynamic-devices - Devices added after integration setup
• discovery-update-info - Integration uses discovery info to update network information
• repair-issues - Repair issues and repair flows are used when user intervention is needed
• docs-use-cases - The documentation describes use cases to illustrate how this integration can be used
• docs-supported-devices - The documentation describes known supported / unsupported devices
• docs-supported-functions - The documentation describes the supported functionality, including entities, and platforms
• docs-data-update - The documentation describes how data is updated
• docs-known-limitations - The documentation describes known limitations of the integration (not to be confused with bugs)
• docs-troubleshooting - The documentation provides troubleshooting information
• docs-examples - The documentation provides automation examples the user can use.

Platinum

• async-dependency - Dependency is async
  

  core/homeassistant/components/overkiz/__init__.py

  Lines 86 to 87 in 619aed3

  	await client.login()
  	setup = await client.get_setup()

• inject-websession - The integration dependency supports passing in a websession
  

  core/homeassistant/components/overkiz/__init__.py

  Line 238 in 619aed3

  session = async_create_clientsession(hass, verify_ssl=verify_ssl)

  
  

  core/homeassistant/components/overkiz/__init__.py

  Lines 255 to 259 in 619aed3

  	session = async_create_clientsession(hass)
  	return OverkizClient(
  	username=username, password=password, session=session, server=server
  	)

• strict-typing - Strict typing
  

  core/.strict-typing

  Line 364 in 619aed3

  homeassistant.components.overkiz.*

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
• 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.

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.

To help with the load of incoming pull requests:

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

[home-assistant]

Hey there @vlebourl, @tetienne, @nyroDev, @Tronix117, @alexfp14, mind taking a look at this pull request as it has been labeled with an integration (overkiz) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of overkiz can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign overkiz Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.