From e67901d85697fb140b8b733080bbba3311f33599 Mon Sep 17 00:00:00 2001 From: Marko Oldenburg Date: Tue, 4 Feb 2020 14:09:47 +0100 Subject: [PATCH] add wunderground documentation in commandref --- 59_Weather.pm | 94 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 89 insertions(+), 5 deletions(-) diff --git a/59_Weather.pm b/59_Weather.pm index 8eb7c25..710f5fe 100755 --- a/59_Weather.pm +++ b/59_Weather.pm @@ -32,7 +32,8 @@ package main; use strict; use warnings; use Time::HiRes qw(gettimeofday); -use HttpUtils; +#use HttpUtils; +use FHEM::Meta; use vars qw($FW_ss); # use Data::Dumper; # for Debug only @@ -273,7 +274,7 @@ sub Weather_Initialize($) { . $readingFnAttributes; $hash->{NotifyFn} = 'Weather_Notify'; - #Weather_DebugCodes('de'); + return FHEM::Meta::InitMod( __FILE__, $hash ); } ################################### @@ -645,6 +646,9 @@ sub Weather_Notify($$) { sub Weather_Define($$) { my ( $hash, $def ) = @_; + return $@ unless ( FHEM::Meta::SetInternals($hash) ); + use version 0.60; our $VERSION = FHEM::Meta::Get( $hash, 'version' ); + my $usage = "syntax: define Weather [API=] [apikey=] [location=] [interval=] [lang=]"; @@ -691,11 +695,11 @@ sub Weather_Define($$) { $hash->{MODEL} = $api; $hash->{APIKEY} = $apikey; $hash->{APIOPTIONS} = $apioptions; + $hash->{VERSION} = version->parse($VERSION)->normal; + $hash->{fhem}->{allowCache} = 1; + readingsSingleUpdate($hash,'current_date_time',TimeNow(),0); readingsSingleUpdate($hash,'current_date_time','none',0); - #$hash->{READINGS}->{current_date_time}->{TIME} = TimeNow(); - #$hash->{READINGS}->{current_date_time}->{VAL} = "none"; - $hash->{fhem}->{allowCache} = 1; readingsSingleUpdate( $hash, 'state', 'Initialized', 1 ); Weather_LanguageInitialize( $hash->{LANG} ); @@ -974,6 +978,7 @@ sub WeatherCheckOptions($@) {
Such a virtual Weather device periodically gathers current and forecast @@ -1009,6 +1014,7 @@ sub WeatherCheckOptions($@) { 
       define Forecast Weather apikey=987498ghjgf864
       define MyWeather Weather API=OpenWeatherMapAPI,cachemaxage:600 apikey=09878945fdskv876 location=52.4545,13.4545 interval=3600 lang=de
+      define  Weather API=wundergroundAPI,stationId:IHAUIDELB111 apikey=ed64ccc80f004556a4e3456567800b6324a
@@ -1040,6 +1046,20 @@ sub WeatherCheckOptions($@) { of the global device are taken, if these exist.

+ + Wunderground

+ + + + + +
APIwundergroundAPI
apioptionscachemaxage=<cachemaxage>
duration + in seconds to retrieve the forecast from the cache instead from the API
stationId:ID-Num +
Station ID of the station to be read.
location<latitude,longitude>
+ geographic coordinates in degrees of the location for which the + weather is forecast; if missing, the values of the attributes + of the global device are taken, if these exist.
+

The module provides four additional functions WeatherAsHtml, WeatherAsHtmlV, WeatherAsHtmlH and @@ -1148,6 +1168,7 @@ sub WeatherCheckOptions($@) {


Eine solche virtuelle Wetterstation sammelt periodisch aktuelle Wetterdaten @@ -1186,6 +1207,7 @@ sub WeatherCheckOptions($@) { 
       define Forecast Weather apikey=987498ghjgf864
       define MyWeather Weather API=OpenWeatherMapAPI,cachemaxage:600 apikey=09878945fdskv876 location=52.4545,13.4545 interval=3600 lang=de
+      define  Weather API=wundergroundAPI,stationId:IHAUIDELB111 apikey=ed64ccc80f004556a4e3456567800b6324a
Es folgt die API-spezifische Dokumentation.

@@ -1218,6 +1240,21 @@ sub WeatherCheckOptions($@) { des global-Device genommen, sofern vorhanden.

+ + Wunderground

+ + + + + +
APIwundergroundAPI
apioptionscachemaxage=<cachemaxage> Zeitdauer in + Sekunden, innerhalb derer die Wettervorhersage nicht neu abgerufen + sondern aus dem Cache zurück geliefert wird.
stationId:ID-Num +
die ID der Station von welcher die Daten gelesen werden sollen.
location<latitude,longitude> Geographische Breite + und Länge des Ortes in Grad, für den das Wetter vorhergesagt wird. + Bei fehlender Angabe werden die Werte aus den gleichnamigen Attributen + des global-Device genommen, sofern vorhanden.
+

Das Modul unterstützt zusätzlich vier verschiedene Funktionen WeatherAsHtml, WeatherAsHtmlV, @@ -1315,4 +1352,51 @@ sub WeatherCheckOptions($@) { =end html_DE + +=for :application/json;q=META.json 59_Weather.pm +{ + "abstract": "Modul to provides current weather condition and forecast", + "x_lang": { + "de": { + "abstract": "" + } + }, + "keywords": [ + "fhem-mod-device", + "fhem-core", + "Weather", + "DarkSky", + "OpenWeatherMap", + "Underground" + ], + "release_status": "stable", + "license": "GPL_2", + "version": "v2.1.3", + "author": [ + "Marko Oldenburg " + ], + "x_fhem_maintainer": [ + "CoolTux" + ], + "x_fhem_maintainer_github": [ + "LeonGaultier" + ], + "prereqs": { + "runtime": { + "requires": { + "FHEM": 5.00918799, + "perl": 5.016, + "Meta": 0, + "JSON": 0, + "Date::Parse": 0 + }, + "recommends": { + }, + "suggests": { + } + } + } +} +=end :application/json;q=META.json + =cut