home-assistant.io/source/_components/sensor.foobot.markdown
Fabien Piuzzi f8cdbdf880 Foobot (#4670)
* Foobot sensor device documentation

* Tweaked documentation

* ✏️ Minor changes
2018-03-15 19:51:29 -07:00

52 lines
1.3 KiB
Markdown

---
layout: page
title: "Foobot Air Quality Monitor"
description: "Instructions on how to setup Foobot Air Quality sensor in Home Assistant."
date: 2018-02-14 06:00
sidebar: true
comments: false
sharing: true
footer: true
logo: foobot.png
ha_category: Health
ha_release: 0.66
ha_iot_class: "Cloud Polling"
---
The `foobot` sensor platform will fetch air quality data from your or yours [Foobot device(s)](https://foobot.io/features/).
This sensor requires an API token. Please obtain one at [Foobot API site](https://api.foobot.io/apidoc/index.html).
## {% linkable_title Configuring the Platform %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
sensor:
- platform: foobot
token: FOOBOT_SECRET_KEY
username: FOOBOT_USERNAME
```
{% configuration %}
token:
description: The token for the Foobot API.
required: true
type: string
username:
description: Your Foobot username, used to fetch devices associated with an account.
required: true
type: string
{% endconfiguration %}
## {% linkable_title Available Metrics %}
Every ten minutes, it'll fetch the last ten minutes average of the following measurements:
* Temperature
* Humidity
* Co2
* VOC
* PM2.5
* [Index](https://help.foobot.io/hc/en-us/articles/204814371-What-does-central-number-mean-)