Home AssistantHome AssistantContributors
On this page

This is a Gold rule. In quality_scale.yaml, it is called docs-supported-devices.

The integration page on home-assistant.io lists the devices that are known to work, and the devices that are known not to work. When a list of models is not practical, describe the group, like "every device that runs firmware 2.0 or newer".

Why it matters

Many people buy devices because Home Assistant supports them. If the documentation does not say which models work, they find out after the purchase, when setup fails. A clear list prevents that, and it saves you issues from people with a device that was never supported.

Example

Markdown
## Supported devices

These devices are known to work with the integration:

- My Thermostat 2 and 3
- My Hub, with firmware 4.1 or newer
- Every device that runs MyOS

## Unsupported devices

These devices do not work with the integration:

- My Thermostat 1: it has no local API
- Devices made before 2015

See Write integration documentation and the integration page structure for where this section goes.

How it is checked

Checked in review, usually on the documentation pull request.

Exceptions

If the integration does not connect to a device or service, or does not integrate physical devices, this rule does not apply.

Was this page helpful?

Last updated on .