Skip to content

Commit 19eccf4

Browse files
bachyafrenck
authored andcommitted
Adds docs for Pollen.com sensor platform (home-assistant#4524)
* Adds docs for Pollen.com sensor platform * Updating version number
1 parent cc025a6 commit 19eccf4

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
layout: page
3+
title: "Pollen.com"
4+
description: "Instructions on how to use Pollen.com data within Home Assistant"
5+
date: 2018-01-10 19:20:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: pollen.jpg
11+
ha_category: Health
12+
ha_release: 0.63
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `pollen` sensor platform collects and displays allergy and disease
17+
information (based on a U.S. ZIP code) from [Pollen.com](https://www.pollen.com/). Data measured includes:
18+
19+
* Indicies for allergies and cold/flu measurements
20+
* Trends
21+
* Current outlook
22+
* more!
23+
24+
## {% linkable_title Configuring the Platform %}
25+
26+
To integrate `pollen` into Home Assistant, add the following section to your
27+
`configuration.yaml` file (adjusting the `monitored_conditions` list to your
28+
liking):
29+
30+
```yaml
31+
sensor:
32+
platform: pollen
33+
zip_code: ZIP_CODE
34+
monitored_conditions:
35+
- allergy_average_forecasted
36+
- allergy_average_historical
37+
- allergy_index_today
38+
- allergy_index_tomorrow
39+
- allergy_index_yesterday
40+
- disease_average_forecasted
41+
```
42+
43+
{% configuration %}
44+
zip_code:
45+
description: the U.S. ZIP code to gather data for
46+
required: true
47+
type: int
48+
monitored_conditions:
49+
description: the metric types to monitor; valid values are specified below
50+
required: true
51+
type: list
52+
{% endconfiguration %}
53+
54+
## {% linkable_title Available Metrics %}
55+
56+
The following metrics can be monitored:
57+
58+
* Allergy Index: Forecasted Average (`allergy_average_forecasted`): the average
59+
forecasted allergy index over the next 5 days
60+
* Allergy Index: Historical Average (`allergy_average_historical`): the average
61+
historical allergy index over the past 30 days
62+
* Allergy Index: Today (`allergy_index_today`): the allergy index for today
63+
* Allergy Index: Tomorrow (`allergy_index_tomorrow`): the allergy index for
64+
tomorrow
65+
* Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for
66+
yesterday
67+
* Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average
68+
forecasted cold/flu index over the next 5 days
69+
70+
## {% linkable_title Understanding the Indices %}
71+
72+
Any index-related sensor will have a value between 0.0 and 12.0. The values
73+
map to the following human-friendly ratings:
74+
75+
Range | Rating
76+
--------- | -----------
77+
0.0 - 2.4 | Low
78+
2.5 - 4.8 | Low/Medium
79+
4.9 - 7.2 | Medium
80+
7.3 - 9.6 | Medium/High
81+
9.7 - 12.0 | High
55.1 KB
Loading

0 commit comments

Comments
 (0)