> For the complete documentation index, see [llms.txt](https://docs.ruuvi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ruuvi.com/ruuvi-gateway-firmware/examples/home-assistant.md).

# Home Assistant

The Ruuvi Gateway integration was introduced in Home Assistant 2023.2, see <https://www.home-assistant.io/integrations/ruuvi_gateway/>

## Setup

Install [Home Assistant OS 9.5](https://github.com/home-assistant/operating-system/releases/tag/9.5) or newer.

Configure Ruuvi Gateway to use [Polling mode](/ruuvi-gateway-firmware/examples/polling-mode.md) (configure a Bearer token for read-only access).

Adding Ruuvi Gateway to your Home Assistant instance can easily be done by simply clicking on this [link](https://my.home-assistant.io/redirect/config_flow_start?domain=ruuvi_gateway). After that, you'll see the following confirmation:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-8ab46e02a1a6a6cddda2b45f64f0c87400cdbec0%2Fimage.png?alt=media)

After you click the **OPEN LINK** button, you may be prompted to log in:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-1c82c0fb69be5a5dee1c453293ec57e87cba3a5d%2Fimage.png?alt=media)

Then you will see a confirmation to set up the Ruuvi Gateway in Home Assistant:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-a995b6b12437d2efbf9bc9c9e8cef557e52a1e26%2Fimage.png?alt=media)

After that, you will need to enter the IP address of Ruvvi Gateway and the Bearer token specified when configuring the Gateway:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-e58741e8c7f817855ec66c84491905e9b476666d%2Fimage.png?alt=media)

That's it, then you will see a confirmation that Ruuvi Gateway has been successfully added:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-167e3b53f5ee6e46bcf3adbd9cfa4be76ff7d7d9%2Fimage.png?alt=media)

After that, the **Integrations** tab will open, where you can find the Ruuvi Gateway and a set of sensors:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-6d1413a7a0038cb3d246954d5c39d7a611771853%2Fimage.png?alt=media)

You can manually open the **Integrations** tab:

* In the sidebar click on **Settings**
* From the configuration menu select: **Devices & Services**

You will then need to configure the discovered sensors, select one of them and press the **CONFIGURE** button:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-714096818b929637561341124a9365dd8a3e23e7%2Fimage.png?alt=media)

Then press the **SUBMIT** button:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-1a599cac5dc564155ae6288d0c651d1f3c96db40%2Fimage.png?alt=media)

Configure **Area** for the sensor and press the **FINISH** button:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-1b0e6e8f74c7f755ab63a5b289e31168dbd3a293%2Fimage.png?alt=media)

After that, the configured sensor will appear on the **Overview** page:

![](https://1423309131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LsPjfnhNj3v37AZtF-d%2Fuploads%2Fgit-blob-fa9313a1ededf535c8313e4b0feb7fe8c0b70c70%2Fimage.png?alt=media)

That's all.