Add Avri documentation (#11867)

* Add Avri documentation

* Bump version

* Update description to new style

* Code review comments

* Update source/_integrations/sensor.avri.markdown

Co-Authored-By: springstan <46536646+springstan@users.noreply.github.com>

* Update source/_integrations/sensor.avri.markdown

Co-Authored-By: springstan <46536646+springstan@users.noreply.github.com>

* Remove empty default

* Bump ha release version

* ✏️ Tweak

Co-authored-by: springstan <46536646+springstan@users.noreply.github.com>
Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
Tim van Cann 2020-03-02 12:20:28 +01:00 committed by GitHub
parent c27bc18f81
commit 70cb58404d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 51 additions and 0 deletions

View File

@ -0,0 +1,51 @@
---
title: Avri
description: Instructions on how to set up Avri Waste sensor within Home Assistant.
logo: avri.jpeg
ha_category:
- Sensor
ha_iot_class: Cloud Polling
ha_release: 0.107
ha_codeowners:
- '@timvancann'
---
The `Avri Waste` platform allows you to track the next scheduled waste pickup and the type of waste from [Avri](https://www.avri.nl/).
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
- platform: avri
zip_code: YOUR_ZIP_CODE
house_number: YOUR_HOUSE_NUMBER
```
{% configuration %}
zip_code:
description: Your zip code
required: true
type: string
house_number:
description: Your house number
required: true
type: integer
house_number_extension:
description: Your house number extension
required: false
type: string
county_code:
description: Your country code
required: false
type: string
default: NL
{% endconfiguration %}
The default frequency for pulling data from the Avri API is once every 4 hours. If the Avri API does not return any pickup days the state of the sensor is set to `unknown`.
<p class='note warning'>
The Avri sensor uses an unofficial API to obtain data. Use it at your own risk.
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB