forked from fhem/Weather
-
Notifications
You must be signed in to change notification settings - Fork 0
/
YahooWeatherAPI.pm
374 lines (315 loc) · 13.7 KB
/
YahooWeatherAPI.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# $Id: YahooWeatherAPI.pm 16641 2018-04-21 12:28:38Z neubert $
##############################################################################
#
# YahooWeatherAPI.pm
# Copyright by Dr. Boris Neubert
# e-mail: omega at online dot de
#
# This file is part of fhem.
#
# Fhem is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# Fhem is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with fhem. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
package main;
use strict;
use warnings;
use HttpUtils;
use JSON; # apt-get install libperl-JSON on Debian and derivatives
#use Data::Dumper; # for Debug only
# Yahoo! Weather API: http://developer.yahoo.com/weather/
use constant URL => "https://query.yahooapis.com/v1/public/yql?q=select%%20*%%20from%%20weather.forecast%%20where%%20woeid=%s%%20and%%20u=%%27c%%27&format=%s&env=store%%3A%%2F%%2Fdatatables.org%%2Falltableswithkeys";
# Mapping / translation of current weather codes 0-47
my @YahooCodes_en = (
'tornado', 'tropical storm', 'hurricane', 'severe thunderstorms', 'thunderstorms', 'mixed rain and snow',
'mixed rain and sleet', 'mixed snow and sleet', 'freezing drizzle', 'drizzle', 'freezing rain' ,'showers',
'showers', 'snow flurries', 'light snow showers', 'blowing snow', 'snow', 'hail',
'sleet', 'dust', 'foggy', 'haze', 'smoky', 'blustery',
'windy', 'cold', 'cloudy',
'mostly cloudy', # night
'mostly cloudy', # day
'partly cloudy', # night
'partly cloudy', # day
'clear',
'sunny',
'fair', #night
'fair', #day
'mixed rain and hail',
'hot', 'isolated thunderstorms', 'scattered thunderstorms', 'scattered thunderstorms', 'scattered showers', 'heavy snow',
'scattered snow showers', 'heavy snow', 'partly cloudy', 'thundershowers', 'snow showers', 'isolated thundershowers');
my @YahooCodes_de = (
'Tornado', 'schwerer Sturm', 'Orkan', 'schwere Gewitter', 'Gewitter', 'Regen und Schnee',
'Regen und Graupel', 'Schnee und Graupel', 'Eisregen', 'Nieselregen', 'gefrierender Regen' ,'Schauer',
'Schauer', 'Schneetreiben', 'leichte Schneeschauer', 'Schneeverwehungen', 'Schnee', 'Hagel',
'Graupel', 'Staub', 'Nebel', 'Dunst', 'Smog', 'Sturm',
'windig', 'kalt', 'wolkig',
'überwiegend wolkig', # night
'überwiegend wolkig', # day
'teilweise wolkig', # night
'teilweise wolkig', # day
'klar', # night
'sonnig',
'heiter', # night
'heiter', # day
'Regen und Hagel',
'heiß', 'einzelne Gewitter', 'vereinzelt Gewitter', 'vereinzelt Gewitter', 'vereinzelt Schauer', 'starker Schneefall',
'vereinzelt Schneeschauer', 'starker Schneefall', 'teilweise wolkig', 'Gewitterregen', 'Schneeschauer', 'vereinzelt Gewitter');
my @YahooCodes_nl = (
'tornado', 'zware storm', 'orkaan', 'hevig onweer', 'onweer',
'regen en sneeuw',
'regen en ijzel', 'sneeuw en ijzel', 'aanvriezende motregen',
'motregen', 'aanvriezende regen' ,'buien',
'buien', 'sneeuw windstoten', 'lichte sneeuwbuien',
'stuifsneeuw', 'sneeuw', 'hagel',
'ijzel', 'stof', 'mist', 'waas', 'smog', 'onstuimig',
'winderig', 'koud', 'bewolkt',
'overwegend bewolkt', # night
'overwegend bewolkt', # day
'gedeeltelijk bewolkt', # night
'gedeeltelijk bewolkt', # day
'helder', #night
'zonnig',
'mooi', #night
'mooi', #day
'regen en hagel',
'heet', 'plaatselijk onweer', 'af en toe onweer', 'af en toe onweer', 'af en toe regenbuien', 'hevige sneeuwval',
'af en toe sneeuwbuien', 'hevige sneeuwval', 'deels bewolkt',
'onweersbuien', 'sneeuwbuien', 'af en toe onweersbuien');
my @YahooCodes_fr = (
'tornade', 'tempête tropicale', 'ouragan', 'tempête sévère', 'orage', 'pluie et neige',
'pluie et grésil', 'neige et grésil', 'bruine verglassante', 'bruine', 'pluie verglassante' ,'averse',
'averses', 'tourbillon de neige', 'légères averses de neige', 'rafale de neige', 'neige', 'grêle',
'giboulées', 'poussières', 'brouillard', 'brume', 'enfumé', 'orageux',
'venteux', 'froid', 'nuageux',
'couverte', # night
'couvert', # day
'partiellement couverte', # night
'partiellement couvert', # day
'clair',
'ensoleillé',
'douce', #night
'agréable', #day
'pluie et grêle',
'chaud', 'orages isolés', 'tempêtes éparses', 'orages épars', 'averses éparses', 'tempête de neige',
'chûtes de neiges éparses', 'tempêtes de neige', 'partielement nuageux', 'averses orageuses', 'chûte de neige', 'chûtes de neige isolées');
my @YahooCodes_pl = (
'tornado', 'burza tropikalna', 'huragan', 'porywiste burze', 'burze', 'deszcz ze śniegiem',
'deszcz i deszcz ze śniegiem', 'śnieg i deszcz ze śniegiem', 'marznąca mżawka', 'mżawka', 'marznący deszcz' ,'deszcz',
'deszcz', 'przelotne opady śniegu', 'lekkie opady śniegu', 'zamieć śnieżna', 'śnieg', 'grad',
'deszcz ze śniegiem', 'pył', 'mgła', 'mgła', 'smog', 'przenikliwie',
'wietrznie', 'zimno', 'pochmurno',
'pochmurno', # night
'pochmurno', # day
'częściowe zachmurzenie', # night
'częściowe zachmurzenie', # day
'czyste niebo',
'słonecznie',
'ładna noc', #night
'ładny dzień', #day
'deszcz z gradem',
'gorąco', 'gdzieniegdzie burze', 'burze', 'burze', 'przelotne opady śniegu', 'duże opady śniegu',
'ciężkie opady śniegu', 'dużo śniegu', 'częściowe zachmurzenie', 'burze z deszczem', 'opady śniegu', 'przejściowo burze');
my @YahooCodes_it = (
'tromba d\'aria', 'tempesta tropicale', 'uragano', 'temporali di grande intensità', 'temporali', 'pioggia mista e neve',
'pioggia mista e nevischio', 'neve mista e nevischio', 'pioggia gelata', 'pioggia leggera', 'grandine' ,'rovesci',
'piogge', 'raffiche di neve', 'deboli nevicate', 'bufera di neve', 'neve', 'grandine',
'nevischio', 'pulviscolo', 'nebbia', 'foschia', 'smog', 'ventoso',
'ventoso', 'freddo', 'nuvoloso',
'parzialmente nuvoloso', # night
'parzialmente nuvoloso', # day
'parzialmente nuvoloso', # night
'parzialmente nuvoloso', # day
'sereno',
'soleggiato',
'bel tempo', #night
'bel tempo', #day
'pioggia mista a grandine',
'caldo', 'temporali isolati', 'temporali sparsi', 'temporali sparsi', 'piogge sparse', 'forti nevicate',
'nevicate sparse', 'forti nevicate', 'parzialmente nuvoloso', 'rovesci temporaleschi', 'rovesci di neve', 'temporali isolati');
###################################
# Cache
my %YahooWeatherAPI_CachedData= ();
my %YahooWeatherAPI_CachedDataTs= ();
###################################
#
# there is a bug in the Yahoo Weather API that gets all units wrong
# these routines fix that
sub value_to_C($) {
my ($F)= @_;
return(int(($F-32)*5/9+0.5));
}
sub value_to_hPa($) {
my ($inHg)= @_;
return int($inHg/33.86390+0.5);
}
sub value_to_km($) {
my ($value)= @_;
return int($value/1.609347219+0.5);
}
###################################
# call: YahooWeatherAPI_RetrieveData(%%args)
#
# the args hash reference must contain at least
# woeid => WOEID [WHERE-ON-EARTH-ID], go to http://weather.yahoo.com to find out
# format => xml or json
# blocking => 0 or 1
# callbackFnRef => reference to callback function with arguments ($argsRef, $err, $result)
# the args hash reference is returned as first argument of the callbackFn
#
sub YahooWeatherAPI_RetrieveData($) {
my ($argsRef)= @_;
YahooWeatherAPI_RetrieveDataWithCache(0, $argsRef);
}
sub YahooWeatherAPI_RetrieveDataWithCache($$) {
my ($maxage, $argsRef)= @_;
my $woeid= $argsRef->{woeid};
Log3 undef, 5, "YahooWeatherAPI: retrieve weather for $woeid.";
# retrieve data from cache
my $ts= $YahooWeatherAPI_CachedDataTs{$woeid};
if(defined($ts)) {
my $now= time();
my $age= $now- $ts;
if($age< $maxage) {
Log3 undef, 5, "YahooWeatherAPI: data is cached, age $age seconds < $maxage seconds.";
$argsRef->{callbackFnRef}($argsRef, "", $YahooWeatherAPI_CachedData{$woeid});
return;
} else {
Log3 undef, 5, "YahooWeatherAPI: cache is expired, age $age seconds > $maxage seconds.";
}
} else {
Log3 undef, 5, "YahooWeatherAPI: no data in cache.";
}
my $format= $argsRef->{format};
my $blocking= $argsRef->{blocking};
my $callbackFnRef= $argsRef->{callbackFnRef};
my $url = sprintf(URL, $woeid, $format);
#Debug "Retrieve Yahoo Weather data for " . $argsRef->{hash}->{NAME};
if ($blocking) {
# do not use noshutdown => 0 in parameters
my $response = HttpUtils_BlockingGet({ url => $url, timeout => 15 });
my %param= (argsRef => $argsRef);
YahooWeatherAPI_RetrieveDataFinished(\%param, undef, $response);
} else {
# do not use noshutdown => 0 in parameters
HttpUtils_NonblockingGet({
url => $url,
timeout => 15,
argsRef => $argsRef,
callback => \&YahooWeatherAPI_RetrieveDataFinished,
});
}
}
sub YahooWeatherAPI_RetrieveDataFinished($$$) {
my ($paramRef, $err, $response) = @_;
my $argsRef= $paramRef->{argsRef};
#Debug "Finished retrieving Yahoo Weather data for " . $argsRef->{hash}->{NAME};
if(!$err) {
my $woeid= $argsRef->{woeid};
$YahooWeatherAPI_CachedDataTs{$woeid}= time();
$YahooWeatherAPI_CachedData{$woeid}= $response;
Log3 undef, 5, "YahooWeatherAPI: caching data.";
}
$argsRef->{callbackFnRef}($argsRef, $err, $response);
}
# this decodes a JSON result and returns the Weather Channel hash reference
sub YahooWeatherAPI_JSONReturnChannelData($) {
my ($response)= @_;
return("empty response", undef) unless($response);
#Debug "Decoding response: $response";
#Debug "response: " . Dumper($response);
my $data;
eval { $data= decode_json($response) };
return($@, undef) if($@);
my $query= $data->{query};
#Debug Dumper($query);
my $count= $query->{count};
#Debug "$count result(s).";
return("$count result(s) retrieved", undef) unless($count == 1);
my $channel= $query->{results}{channel};
return(undef, $channel);
}
sub YahooWeatherAPI_ConvertChannelData($) {
my ($data)= @_; # hash reference
$data->{wind}{chill}= value_to_C($data->{wind}{chill}); # # API delivers wrong value
$data->{atmosphere}{pressure}= value_to_hPa($data->{atmosphere}{pressure}); # API delivers wrong value
my $units= YahooWeatherAPI_units($data); # units hash reference
$data->{wind}{speed}= value_to_km($data->{wind}{speed}); # API delivers km
$data->{atmosphere}{visibility}= value_to_km($data->{atmosphere}{visibility}); # API delivers km
return 0 if($units->{temperature} eq "C");
my $item= $data->{item};
$item->{condition}{temp}= value_to_C($item->{condition}{temp});
my $forecast= $item->{forecast};
foreach my $fc (@{$forecast}) {
$fc->{low}= value_to_C($fc->{low});
$fc->{high}= value_to_C($fc->{high});
}
return 1;
}
sub YahooWeatherAPI_ParseDateTime($) {
my ($value)= @_; ### "Fri, 13 Nov 2015 8:00 am CET"
my @months= qw/Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec/;
my %monthindex;
@monthindex{@months} = (0..$#months);
if($value =~ '^(\w{3}), (\d{1,2}) (\w{3}) (\d{4}) (\d{1,2}):(\d{2}) (\w{2}) (\w{3,4})$') {
my ($wd, $d, $mon, $y, $h, $n, $p, $tz)= ($1,$2,$3,$4,$5,$6,$7,$8);
# 12 AM= 0, 12 PM= 12
$h+=12 if($h==12); if($p eq "PM") { $h= ($h+12) % 24 } else { $h%= 12 };
my $m= $monthindex{$mon};
return undef unless defined($m);
#main::Debug "###### $value -> $wd $d $m $y $h:$n $tz";
# $mday= 1..
# $month= 0..11
# $year is year-1900
# we ignore the time zone as it probably never changes for a weather device an assume
# local time zone
return fhemTimeLocal(0, $n, $h, $d, $m, $y-1900);
} else {
return undef;
}
}
sub YahooWeatherAPI_pubDate($) {
my ($channel)= @_;
### pubDate Fri, 13 Nov 2015 8:00 am CET
if(!defined($channel->{item}{pubDate})) {
return("no pubDate received", "", undef);
};
my $pubDate= $channel->{item}{pubDate};
my $ts= YahooWeatherAPI_ParseDateTime($pubDate);
if(defined($ts)) {
return("okay", $pubDate, $ts);
} else {
return("could not parse pubDate $pubDate", $pubDate, undef);
}
}
sub YahooWeatherAPI_units($) {
my ($channel)= @_;
return $channel->{units};
}
sub YahooWeatherAPI_getYahooCodes($) {
my ($lang)= @_;
if($lang eq "de") {
return @YahooCodes_de;
} elsif($lang eq "nl") {
return @YahooCodes_nl;
} elsif($lang eq "fr") {
return @YahooCodes_fr;
} elsif($lang eq "pl") {
return @YahooCodes_pl;
} elsif($lang eq "it") {
return @YahooCodes_it;
} else {
return @YahooCodes_en;
}
}
##############################################################################
1;