Skip to content

Commit b782c88

Browse files
lichtteilfabaff
authored andcommitted
Add documentation for new platform luftdaten sensor (home-assistant#3857)
* Add documentation for luftdaten sensor * Minor adjustments
1 parent 6cffb2c commit b782c88

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: page
3+
title: "Luftdaten Sensor"
4+
description: "Instructions how to setup Luftdaten sensor in Home Assistant."
5+
date: 2017-11-01 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: home-assistant.png
11+
ha_category: Health
12+
ha_release: 0.57
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station.
17+
18+
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
19+
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
20+
21+
To enable this sensor, add the following lines to your `configuration.yaml` file:
22+
23+
```yaml
24+
# Example configuration.yaml entry
25+
sensor:
26+
- platform: luftdaten
27+
sensorid: 3123
28+
monitored_conditions:
29+
- P1
30+
- P2
31+
- platform: luftdaten
32+
sensorid: 155
33+
monitored_conditions:
34+
- temperature
35+
- humidity
36+
```
37+
38+
Configuration variables:
39+
40+
- **sensorid** (*Required*): The ID of the sensor.
41+
- **monitored_conditions** (*Required*): A list of conditions you want to monitor. The following conditions can be monitored:
42+
- `P1` for particle sensors (particles 10 microns and below).
43+
- `P2` for particle sensors (particles 2.5 microns and below).
44+
- `temperature` for weather sensors.
45+
- `humidity` for weather sensors.
46+
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Luftdaten Sensor`.
47+
- **resource** (*Optional*): The URL of the API endpoint. Usually this has not to be changed. The default is `https://api.luftdaten.info/v1/sensor/`.
48+
- **verify_ssl** (*Optional*): Verify SSL connection. Defaults to `true`.

0 commit comments

Comments
 (0)