Improve tankerkoenig documentation (#12478)

Fix small typos
Add a recommendation to the maximum number of monitored stations
This commit is contained in:
guillempages 2020-03-22 08:18:21 +01:00 committed by GitHub
parent ca4121f656
commit 00645ce20f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -19,7 +19,9 @@ You can also add additional stations manually, referencing them via their IDs. T
## Setup
To use this sensor you need an API key from [tankerkoenig](https://creativecommons.tankerkoenig.de). Go to [tankerkoenig API](https://creativecommons.tankerkoenig.de) and click on API-KEY in the top right, fill out the form and request a key. The API is free, but requests should be limited to less than once every 5 minutes.
To use this sensor you need an API key from tankerkoenig. Go to [tankerkoenig API](https://creativecommons.tankerkoenig.de) and click on API-KEY in the top right, fill out the form and request a key. The API is free, but requests should be limited to less than once every 5 minutes.
It is recommended to choose a radius that doesn't return too many fuel stations. The Terms & Conditions of tankerkoenig.de specify that the API is not meant for massive data fetching, but it does not explicitly mention a limit. Having a maximum of 10 monitored fuel stations is recommended, and a warning will be issued otherwise.
## Configuration
@ -88,10 +90,10 @@ tankerkoenig:
- 8531b393-1e42-423b-cb4d-e4b98cff8a0c
```
Assuming there are two fuel stations within the specified range and location, you would get six sensor entities:
Assuming there are only two fuel stations within the specified range and location, you would get six sensor entities:
* sensor.tankerkoenig_berlin_paulstrasse_20_diesel
* sensor.tankerkoenig_berlin_paulstrasse_20_e10
* sensor.tankerkoenig_aral_tankstelle_diesel
* sensor.tankerkoenig_aral_tankstelle_e10
* sensor.tankerkoenig_svg_hamburg_strassen>_diesel
* sensor.tankerkoenig_svg_hamburg_strassen_diesel
* sensor.tankerkoenig_svg_hamburg_strassen_e10