public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Tankerkoenig]: Lower minimum refresh interval (#10070) 

As per https://creativecommons.tankerkoenig.de (in the "Terms"-section) we should not make more than 1 request per 5 minutes, this changes the limit accordingly and allows doing so.

Signed-off-by: Flole <flole@flole.de>
This commit is contained in:
Flole998 2021-02-08 23:03:58 +01:00 committed by GitHub
parent 7898f4f911
commit c01f5ceb72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
bundles/org.openhab.binding.tankerkoenig/README.md
View File

@ -4,7 +4,7 @@ The binding uses the Tankerkönig API <https://www.tankerkoenig.de> for collecti
Special thanks to the creators of Tankerkönig for providing an easy way to get data from the &lsqb;MTS-K&rsqb; (Markttransparenzstelle für Kraftstoffe). Special thanks to the creators of Tankerkönig for providing an easy way to get data from the &lsqb;MTS-K&rsqb; (Markttransparenzstelle für Kraftstoffe).
Tankerkönig is providing this service for free, however they request to prevent overloading of their server by reducing the number of web-requests. Tankerkönig is providing this service for free, however they request to prevent overloading of their server by reducing the number of web-requests.
This binding handles those requests (minimum Refresh Interval is 10 minutes, a webserver does handle a maximum of 10 stations). This binding handles those requests (minimum Refresh Interval is 5 minutes, a webserver does handle a maximum of 10 stations).
The data will be updated for each Station individually after the initialization and after each Refresh Interval for all (open) stations (Note: changing the Webservice will cause the Refresh Interval to restart). The data will be updated for each Station individually after the initialization and after each Refresh Interval for all (open) stations (Note: changing the Webservice will cause the Refresh Interval to restart).
Additionally one may select the mode Opening-Times in which only those Stations get polled which are actually open. Additionally one may select the mode Opening-Times in which only those Stations get polled which are actually open.
For a correct usage of opening times the binding needs the information if the actual day is a holiday. For a correct usage of opening times the binding needs the information if the actual day is a holiday.
@ -49,7 +49,7 @@ The binding has no configuration options itself, all configuration is done at 'B
## Thing configuration ## Thing configuration
The Webservice (bridge) needs to be configured with the personal API-Key, the desired Refresh Interval (the time interval between price-updates, default 60 minutes, minimum 10 minutes) and the Opening-Times mode selection (in this mode price-updates are only requested from stations that are actually open). The Webservice (bridge) needs to be configured with the personal API-Key, the desired Refresh Interval (the time interval between price-updates, default 60 minutes, minimum 5 minutes) and the Opening-Times mode selection (in this mode price-updates are only requested from stations that are actually open).
A single Webservice can handle up to 10 Stations. A single Webservice can handle up to 10 Stations.
Each Station needs to be configured with a LocationID and the Webservice to which it is linked. Each Station needs to be configured with a LocationID and the Webservice to which it is linked.

2
bundles/org.openhab.binding.tankerkoenig/src/main/resources/OH-INF/i18n/tankerkoenig_de.properties
View File

@ -8,7 +8,7 @@ thing-type.tankerkoenig.webservice.description = Der Tankerk
thing-type.config.tankerkoenig.webservice.apikey.label=API-Key thing-type.config.tankerkoenig.webservice.apikey.label=API-Key
thing-type.config.tankerkoenig.webservice.apikey.description=Tankerkönig API-Key. Der Schlüssel ist auf der Tankerkönig Webseite erhältlich. thing-type.config.tankerkoenig.webservice.apikey.description=Tankerkönig API-Key. Der Schlüssel ist auf der Tankerkönig Webseite erhältlich.
thing-type.config.tankerkoenig.webservice.refresh.label=Aktualisierungsintervall thing-type.config.tankerkoenig.webservice.refresh.label=Aktualisierungsintervall
thing-type.config.tankerkoenig.webservice.refresh.description=Spezifiziert das Aktualisierungsintervall in Minuten. Minimum 10 Minuten. thing-type.config.tankerkoenig.webservice.refresh.description=Spezifiziert das Aktualisierungsintervall in Minuten. Minimum 5 Minuten.
thing-type.config.tankerkoenig.webservice.modeOpeningTime.label=Öffnungszeiten thing-type.config.tankerkoenig.webservice.modeOpeningTime.label=Öffnungszeiten
thing-type.config.tankerkoenig.webservice.modeOpeningTime.description=Im Mode Öffnungszeiten werden nur die zur Zeit geöffneten Tankstellen abgefragt. thing-type.config.tankerkoenig.webservice.modeOpeningTime.description=Im Mode Öffnungszeiten werden nur die zur Zeit geöffneten Tankstellen abgefragt.
thing-type.tankerkoenig.station.label=Tankstelle thing-type.tankerkoenig.station.label=Tankstelle

4
bundles/org.openhab.binding.tankerkoenig/src/main/resources/OH-INF/thing/webservice.xml
View File

@ -15,9 +15,9 @@
<label>API-Key</label> <label>API-Key</label>
<description>API-Key. Necessary registration on the Tankerkönig website.</description> <description>API-Key. Necessary registration on the Tankerkönig website.</description>
</parameter> </parameter>
<parameter name="refresh" type="integer" min="10" unit="min"> <parameter name="refresh" type="integer" min="5" unit="min">
<label>Refresh Time</label> <label>Refresh Time</label>
<description>Sets the refresh time. Minimum is 10 minutes.</description> <description>Sets the refresh time. Minimum is 5 minutes.</description>
<default>60</default> <default>60</default>
</parameter> </parameter>
<parameter name="modeOpeningTime" type="boolean"> <parameter name="modeOpeningTime" type="boolean">