Skip to content

Commit

Permalink
Add Avri documentation (home-assistant#11867)
Browse files Browse the repository at this point in the history
* Add Avri documentation

* Bump version

* Update description to new style

* Code review comments

* Update source/_integrations/sensor.avri.markdown

Co-Authored-By: springstan <[email protected]>

* Update source/_integrations/sensor.avri.markdown

Co-Authored-By: springstan <[email protected]>

* Remove empty default

* Bump ha release version

* ✏️ Tweak

Co-authored-by: springstan <[email protected]>
Co-authored-by: Klaas Schoute <[email protected]>
  • Loading branch information
3 people authored Mar 2, 2020
1 parent c27bc18 commit 70cb584
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions source/_integrations/sensor.avri.markdown
Original file line number Diff line number Diff line change
@@ -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 added source/images/supported_brands/avri.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 70cb584

Please sign in to comment.