Add Recollect Waste platform documentation (#8171)

* Added Recollect Waste platform documentation.

* Using configuration tags now.

* Fixed invalid formatting of configuration section.

* Fixed invalid formatting of configuration section.

* Adjusted scan_interval description as platform has been updated to use built-in scan_interval.

* ✏️ Tweaks
This commit is contained in:
Stealth Hacker 2019-01-29 04:29:34 -08:00 committed by Franck Nijhof
parent 2ef1ea72aa
commit 1f718d2f3a
2 changed files with 59 additions and 0 deletions

View File

@ -0,0 +1,59 @@
---
layout: page
title: Recollect Waste Sensor
description: "Instructions on how to set up Recollect Waste sensor within Home Assistant."
date: 2019-01-14 13:30
sidebar: true
comments: false
sharing: true
footer: true
logo: recollect-waste.png
ha_category: Sensor
ha_release: 0.87
ha_iot_class: "Cloud Polling"
---
The `Recollect Waste` platform allows you to track the next scheduled waste pickup and what type of waste from [Recollect](https://recollect.net/solutions/waste/). To use this sensor your city's waste company must be Recollect and you will need to find your place_id and service_id.
1. In Chrome open developer tools and go to the network tab.
2. Go to your city's Recollect collection calendar.
3. Search for and select your address in the UI.
4. Watch for a request that looks like
ht<span>tps://api.recollect.net/api/places/**(place_id)**/services/**(service_id)**/events?nomerge ...
5. Use the place_id and service_id when configuring the sensor.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
- platform: recollect_waste
place_id: YOUR_PLACE_ID
service_id: YOUR_SERVICE_ID
```
{% configuration %}
place_id:
description: The place_id used for your neighbourhood.
required: true
type: string
service_id:
description: The service_id used for your city.
required: true
type: string
name:
description: Name the sensor.
required: false
type: string
default: recollect_waste
{% endconfiguration %}
The default frequency for pulling data from Recollect Waste is once a day (86400 seconds).
<p class='note warning'>
The Recollect Waste sensor uses the Recollect API <strong>URL</strong> to obtain data not an official API from Recollect. Use at your own risk.
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB