sascha_hemi/hacs_waste_collection_schedule
1
0
Fork 0
mirror of https://github.com/sascha-hemi/hacs_waste_collection_schedule.git synced 2026-03-21 04:06:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

add documentation

Browse Source
This commit is contained in:
Russell Hall
2022-07-17 19:18:33 +01:00
parent a7bac70f8a
commit a4dce055c2
1 changed files with 41 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/source/wiltshire_gov_uk.md
View File

@@ -1 +1,41 @@
TODO:
# Wiltshire Council
Support for schedules provided by [Wiltshire Council](https://wiltshire.gov.uk/).
If collection data is available for the address provided, it will return household and recycling waste collection dates.
## Configuration via configuration.yaml
```yaml
waste_collection_schedule:
sources:
- name: wiltshire_gov_uk
args:
postcode: POSTCODE
uprn: UPRN
```
### Configuration Variables
**postcode**<br>
*(string) (required)*
**uprn**<br>
*(string) (required)*
Both the postcode and the UPRN should be supplied in the arguments.
## Examples
```yaml
waste_collection_schedule:
sources:
- name: wiltshire_gov_uk
args:
postcode: BA149QP
uprn: 100121085972
```
## How to find your UPRN
An easy way to discover your Unique Property Reference Number (UPRN) is by going to [Find My Address](https://www.findmyaddress.co.uk/) and providng your address details.