diff --git a/source/_components/air_pollutants.opensensemap.markdown b/source/_components/air_pollutants.opensensemap.markdown new file mode 100644 index 00000000000..7c79058e35e --- /dev/null +++ b/source/_components/air_pollutants.opensensemap.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "OpenSenseMap" +description: "Instructions on how to setup openSenseMap sensors in Home Assistant." +date: 2018-12-15 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: opensensemap.png +ha_category: Health +ha_release: 0.85 +ha_iot_class: "Cloud Polling" +--- + +The `opensensemap` air pollutants platform will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station. + +## {% linkable_title Setup %} + +To get the ID of a station you need to select it on the [openSense map](https://opensensemap.org/) and find it in the addressbar of your browser. It's the last part of the URL, e.g., `5b450e565dc1ec001bf7cd1d` [https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d](https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d). + +## {% linkable_title Manual Configuration %} + +To enable this platform, add the following lines to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +air_pollutants: + - platform: opensensemap + station_id: STATION_ID +``` + +{% configuration %} +station_id: + description: The ID of the station to monitor. + required: true + type: string +name: + description: Name of the sensor to use in the frontend. + required: false + default: Station name + type: string +{% endconfiguration %} + diff --git a/source/images/supported_brands/opensensemap.png b/source/images/supported_brands/opensensemap.png new file mode 100644 index 00000000000..3fa7a7f14b6 Binary files /dev/null and b/source/images/supported_brands/opensensemap.png differ