buergerportal: add docs

This commit is contained in:
Mirko Lenz
2022-12-23 16:22:58 +01:00
parent b1cb5c3bd6
commit 890cb063d9
3 changed files with 69 additions and 2 deletions

View File

@@ -100,6 +100,7 @@ Currently the following service providers are supported:
- [Abfallwirtschaft Stuttgart](./doc/source/stuttgart_de.md)
- [Abfallwirtschaft Südholstein](./doc/source/awsh_de.md)
- [Abfallwirtschaft Zollernalbkreis](./doc/source/abfall_zollernalbkreis_de.md)
- [Alb-Donau-Kreis](./doc/source/buergerportal_de.md)
- [ART Trier](./doc/source/art_trier_de.md)
- [AVL Ludwigsburg](./doc/source/avl_ludwigsburg_de.md)
- [AWB Bad Kreuznach](./doc/source/awb_bad_kreuznach_de.md)
@@ -111,9 +112,10 @@ Currently the following service providers are supported:
- [AWIDO-online.de](./doc/source/awido_de.md)
- [Berlin-Recycling.de](./doc/source/berlin_recycling_de.md)
- [Bogenschuetz-Entsorgung.de](./doc/source/infeo_at.md)
- [Biedenkopf MZF](./doc/source/buergerportal_de.md)
- [BSR.de / Berliner Stadtreinigungsbetriebe](./doc/source/bsr_de.md)
- [C-Trace.de](./doc/source/c_trace_de.md)
- [Cochem-Zell](./doc/source/cochem_zell_online_de.md)
- [Cochem-Zell](./doc/source/buergerportal_de.md)
- [EGN-Abfallkalender.de](./doc/source/egn_abfallkalender_de.md)
- [Erlangen-Höchstadt](./doc/source/erlangen_hoechstadt_de.md)
- [Jumomind.de](./doc/source/jumomind_de.md)

View File

@@ -0,0 +1,63 @@
# Bürgerportal
Source for waste collection in multiple service areas.
## Configuration via configuration.yaml
```yaml
waste_collection_schedule:
sources:
- name: buergerportal_de
args:
operator: OPERATOR
district: DISTRICT
subdistrict: SUBDISTRICT
street: STREET_NAME
number: HOUSE_NUMBER
```
## Supported Operators
- `cochem_zell`: <https://buerger-portal-cochemzell.azurewebsites.net>
- `alb_donau`: <https://buerger-portal-albdonaukreisabfallwirtschaft.azurewebsites.net>
- `biedenkopf`: <https://biedenkopfmzv.buergerportal.digital>
### Configuration Variables
**operator**\
_(string) (required)_
**district**\
_(string) (required)_
**street**\
_(string) (required)_
**number**\
_(string|int) (required)_
**subdistrict**\
_(string) (optional) (default: null)_
## Example
```yaml
waste_collection_schedule:
sources:
- name: buergerportal_de
args:
operator: cochem_zell
district: Bullay
subdistrict: Bullay
street: Layenweg
number: 3
```
## How to get the source arguments
1. Open the URL of your operator and click on the menu option `Abfuhrkalender` in the left sidebar.
2. Select your `district` (Ort). _Note_: If your district contains two values separated by a comma, you also have to specify the `subdistrict` (Ortsteil): Enter the first part into the field `district` and the second part into the field `subdistrict`. This is necessary even if your `district` and `subdistrict` have the same value (e.g., `Bullay, Bullay`). Subdistrict may only be left empty if there is no comma in the field value.
3. Select your `street` (Straße).
4. Select your `number` (Hausnummer).
All parameters are _case-sensitive_.

View File

@@ -86,6 +86,7 @@ Currently the following service providers are supported:
- [Abfallwirtschaft Stuttgart](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/stuttgart_de.md)
- [Abfallwirtschaft Südholstein](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/awsh_de.md)
- [Abfallwirtschaft Zollernalbkreis](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/abfall_zollernalbkreis_de.md)
- [Alb-Donau-Kreis](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/buergerportal_de.md)
- [ART Trier](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/art_trier_de.md)
- [AVL Ludwigsburg](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/avl_ludwigsburg_de.md)
- [AWB Bad Kreuznach](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/awb_bad_kreuznach_de.md)
@@ -95,10 +96,11 @@ Currently the following service providers are supported:
- [AWBKoeln.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/awbkoeln_de.md)
- [AWIDO-online.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/awido_de.md)
- [Berlin-Recycling.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/berlin_recycling_de.md)
- [Biedenkopf MZV](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/buergerportal_de.md)
- [Bogenschuetz-Entsorgung.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/infeo_at.md)
- [BSR.de / Berliner Stadtreinigungsbetriebe](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/bsr_de.md)
- [C-Trace.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/c_trace_de.md)
- [Cochem-Zell](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/cochem_zell_online_de.md)
- [Cochem-Zell](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/buergerportal_de.md)
- [EGN-Abfallkalender.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/egn_abfallkalender_de.md)
- [Erlangen-Höchstadt](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/erlangen_hoechstadt_de.md)
- [Jumomind.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/jumomind_de.md)