developers.home-assistant/docs/integration_quality_scale_index.md

title
Integration quality scale

The Integration Quality Scale scores each integration based on the code quality and user experience. Each level of the quality scale consists of a list of requirements. If an integration matches all requirements, it's considered to have reached that level.

:::info Suggestions for changes can be done by creating an issue in the architecture repo. :::

No score

This integration passes the bare minimum requirements to become part of the index.

• Satisfy all requirements for creating components and creating platforms.
• Configurable via configuration.yaml

Silver 🥈

This integration can be set up via the user interface and is able to cope when things go wrong. It will not print any exceptions nor will it fill the log with retry attempts.

• Satisfying all No score level requirements.
• Configuration:
  • Configuration is done using config entries and data is stored in config_entry.runtime_data.
  • Raise ConfigEntryNotReady if unable to connect during platform setup (if appropriate)
• Devices and entities:
  • Set an appropriate SCAN_INTERVAL (if a polling integration)
  • 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.
  • Set available property to False if appropriate (docs)
  • Entities have unique ID (if available) (docs)
• Services:
  • Operations like service calls and entity methods (e.g. Set HVAC Mode) have proper exception handling. Raise ServiceValidationError on invalid user input and raise HomeAssistantError for other failures such as a problem communicating with a device. Read more about raising exceptions.
• Tests:
  • Full test coverage for the config flow

Gold 🥇

This is a solid integration that offers the best possible user experience that Home Assistant has to offer.

• Satisfying all Silver level requirements.
• Configuration:
  • Don't allow configuring already configured device/service (example: no 2 entries for same hub). If possible, set a unique ID on the config flow.
  • Discoverable (if available)
  • Support config entry unloading and removal
  • 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)
• Devices and entities:
  • Entities have device info and uses has_entity_name = True
  • Entities have correct device classes where appropriate (docs)
  • Supports entities being disabled and leverages Entity.entity_registry_enabled_default to disable less popular entities (docs)
  • If the device/service API can remove entities, the integration should make sure to clean up the entity and device registry.
  • Entities only subscribe to updates inside async_added_to_hass and unsubscribe via self.async_on_remove or inside async_will_remove_from_hass (docs)
  • Set appropriate PARALLEL_UPDATES constant (docs)
• Tests
  • Above average test coverage for all integration modules
  • Tests for fetching data from the integration and controlling it (docs)
• Has a code owner (docs)
• Implement the diagnostics platform with sensitive information redacted (if appropriate)

Platinum 🏆

Best of the best. The integration implements all the best Home Assistant performance best practices. Integrations that reach platinum level will require approval by the code owner for each PR.

• Satisfying all Gold level requirements.
• Integration + dependency are async (docs)
• Uses aiohttp or httpx and allows passing in websession (if making HTTP requests)

Internal 🏠

Integrations which are part of Home Assistant are not rated but marked as internal.