mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-17 14:26:51 +00:00
Add config flow to tankerkoenig (#22074)
This commit is contained in:
parent
9c9854f203
commit
b4eea9bde1
@ -14,93 +14,10 @@ ha_platforms:
|
||||
---
|
||||
|
||||
The `tankerkoenig` platform allows you to monitor the fuel prices with [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and setup automations based on the information.
|
||||
One sensor entity will be created for each fuel station within the given radius and for each configured fuel type in it.
|
||||
|
||||
You can also add additional stations manually, referencing them via their IDs. To find out the ID for a given fuel station, you can use the [TankstellenFinder](https://creativecommons.tankerkoenig.de/TankstellenFinder/index.html) tool.
|
||||
|
||||
## Setup
|
||||
|
||||
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.
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this platform, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tankerkoenig:
|
||||
api_key: YOUR_API_KEY
|
||||
radius: 1
|
||||
fuel_types:
|
||||
- "diesel"
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: The api key you got when you registered.
|
||||
required: true
|
||||
type: string
|
||||
fuel_types:
|
||||
description: The types of fuels you want to track. Allowed values are `e5`, `e10` and `diesel`.
|
||||
required: false
|
||||
default: ["e5", "e10", "diesel"]
|
||||
type: list
|
||||
latitude:
|
||||
description: The latitude of the gas station to list.
|
||||
required: inclusive
|
||||
type: float
|
||||
default: latitude of your home zone
|
||||
longitude:
|
||||
description: The longitude of the gas station to list.
|
||||
required: inclusive
|
||||
type: float
|
||||
default: longitude of your home zone
|
||||
radius:
|
||||
description: The radius in km. in which to search for gas stations. Cannot be less than 1.
|
||||
required: false
|
||||
default: 2
|
||||
type: integer
|
||||
scan_interval:
|
||||
description: The time interval in seconds to poll the server for new data. You should not put values lower than 5 minutes here; otherwise you risk your API key being blocked.
|
||||
required: false
|
||||
default: 1800 (30min)
|
||||
type: time
|
||||
stations:
|
||||
description: List of additional fuel stations to create entities for.
|
||||
required: false
|
||||
type: list
|
||||
show_on_map:
|
||||
description: Display all gas stations on map.
|
||||
default: true
|
||||
required: false
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
## Full example
|
||||
|
||||
This is a full example of the platform:
|
||||
|
||||
```yaml
|
||||
tankerkoenig:
|
||||
api_key: YOUR_API_KEY
|
||||
fuel_types:
|
||||
- "diesel"
|
||||
- "e10"
|
||||
latitude: 52.51627
|
||||
longitude: 13.3777
|
||||
radius: 1
|
||||
scan_interval: "0:10:01"
|
||||
stations:
|
||||
- 8531b393-1e42-423b-cb4d-e4b98cff8a0c
|
||||
show_on_map: false
|
||||
```
|
||||
|
||||
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_e10
|
||||
<div class='note'>
|
||||
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.
|
||||
</div>
|
||||
|
Loading…
x
Reference in New Issue
Block a user