start a real(ish) dweather webapp
[dweather.git] / Loop.pm
1 #!/usr/bin/perl
2
3 package Loop;
4
5 use strict;
6
7 use v5.10.1;
8
9 use Serial;
10 use Mojo::IOLoop;
11 use Mojo::IOLoop::Stream;
12 use JSON;
13 use Debug;
14 use SMGLog;
15 use Math::Round qw(nearest);
16
17 use constant pi => 3.14159265358979; 
18
19 our $json = JSON->new->canonical(1);
20
21 our     @crc_table = (
22                                   0x0, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
23                                   0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
24                                   0x1231, 0x210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
25                                   0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
26                                   0x2462, 0x3443, 0x420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
27                                   0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
28                                   0x3653, 0x2672, 0x1611, 0x630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
29                                   0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
30                                   0x48c4, 0x58e5, 0x6886, 0x78a7, 0x840, 0x1861, 0x2802, 0x3823,
31                                   0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
32                                   0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0xa50, 0x3a33, 0x2a12,
33                                   0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
34                                   0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0xc60, 0x1c41,
35                                   0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
36                                   0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0xe70,
37                                   0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
38                                   0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
39                                   0x1080, 0xa1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
40                                   0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
41                                   0x2b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
42                                   0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
43                                   0x34e2, 0x24c3, 0x14a0, 0x481, 0x7466, 0x6447, 0x5424, 0x4405,
44                                   0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
45                                   0x26d3, 0x36f2, 0x691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
46                                   0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
47                                   0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x8e1, 0x3882, 0x28a3,
48                                   0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
49                                   0x4a75, 0x5a54, 0x6a37, 0x7a16, 0xaf1, 0x1ad0, 0x2ab3, 0x3a92,
50                                   0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
51                                   0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0xcc1,
52                                   0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
53                                   0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0xed1, 0x1ef0
54                                  );
55
56 our %bar_trend;
57
58 $bar_trend{-60} = "Falling Rapidly";
59 $bar_trend{196} = "Falling Rapidly";
60 $bar_trend{-20} = "Falling Slowly";
61 $bar_trend{236} = "Falling Slowly";
62 $bar_trend{0} = "Steady";
63 $bar_trend{20} = "Rising Slowly";
64 $bar_trend{60} = "Rising Rapidly";
65
66 our $ending = 0;
67
68 $SIG{TERM} = $SIG{INT} = sub {++$ending; Mojo::IOLoop->stop;};
69 $SIG{HUP} = 'IGNORE';
70
71 sub new
72 {
73         my $pkg = shift;
74         my $class = ref $pkg || $pkg;
75         my $self = bless {}, $class;
76         $self->{poll_interval} ||= 2.5;
77         $self->{rain_mult} ||= 0.2;                     # 0.1 or 0.2 mm or 0.01 inches
78         $self->{devname} ||= "/dev/davis";
79         $self->{datafn} ||= ".loop_data";
80         $self->{state} ||= "ready";
81
82         open $self->{dataf}, "+>>", $self->{dataf} or die "cannot open $self->{dataf} $!";
83         $self->{dataf}->autoflush(1);
84         $self->read_ld;
85
86         dbg "last_min: " . scalar gmtime($self->{ld}->{last_min});
87         dbg "last_hour: " . scalar gmtime($self->{ld}->{last_hour});
88
89         return $self;
90 }
91
92 sub start
93 {
94         $self->{did} = Mojo::IOLoop->recurring(1 => sub {$dlog->flushall});
95         do_reopen($self->{devname});
96 }
97
98 sub stop
99 {
100         $self->write_ld;
101         close $self->{dataf} if $self->{dataf};
102         delete $self->{dataf};
103 }
104
105 sub DESTROY
106 {
107         my $self = shift;
108         $self->stop if $self->{dataf};
109 }
110
111 sub on_read
112 {
113         my ($self, $d) = @_;
114         $self->{buf} .= $d;
115         $d =~ s/([\%\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
116         dbg "read added '$d' buf lth=" . length $self->{buf} if isdbg 'raw';
117         if ($self->{state} eq 'waitnl' && $self->{buf} =~ /[\cJ\cM]+/) {
118                 dbg "Got \\n" if isdbg 'state';
119                 Mojo::IOLoop->remove($self->{tid}) if $self->{tid};
120                 delete $self->{tid};
121                 delete $self->{buf};
122                 $self->{nlcount} = 0;
123                 $self->{ser}->write("LPS 1 1\n");
124                 $self->chgstate("waitloop");
125         } elsif ($self->{state} eq "waitloop") {
126                 if ($self->{buf} =~ /\x06/) {
127                         dbg "Got ACK 0x06" if isdbg 'state';
128                         $self->chgstate('waitlooprec');
129                         delete $self->{buf};
130                 }
131         } elsif ($self->{state} eq 'waitlooprec') {
132                 if (length $self->{buf} >= 99) {
133                         dbg "got loop record" if isdbg 'chan';
134                         $self->chgstate('');
135                         $self->process;
136                         delete $self->{buf};
137                 }
138         }
139 }
140
141 sub start_loop
142 {
143         my $self = shift;
144         
145         $self->{nlcount} = 1;
146         dbg "start_loop writing $self->{nlcount} \\n" if isdbg 'state';
147         $self->{ser}->write("\n");
148         Mojo::IOLoop->remove($self->{tid}) if $self->{tid};
149         undef $self->{tid};
150         $self->{tid} = Mojo::IOLoop->recurring(0.6 => sub {
151                                                                            if (++$self->{nlcount} > 10) {
152                                                                                    dbg "\\n count > 10, closing connection" if isdbg 'chan';
153                                                                                    do_reopen($self->{devname});
154                                                                                    return;
155                                                                            }
156                                                                            dbg "writing $self->{nlcount} \\n" if isdbg 'state'; 
157                                                                            $self->{ser}->write("\n");
158                                                                    });
159         $self->chgstate("waitnl");
160 }
161
162 sub chgstate
163 {
164         my $self = shift;
165         dbg "state '$self->{state}' -> '$_[0]'" if isdbg 'state';
166         $self->{state} = $_[0];
167 }
168
169 sub do_reopen
170 {
171         my $self = shift;
172         my $name = shift;
173         dbg "do reopen on '$name' ending $ending";
174         unless ($ending) {
175                 $self->{ser} = do_open($name);
176                 start_loop();
177                 $self->chgstate('');
178                 $self->{nlcount} = 0;
179                 Mojo::IOLoop->next_tick(sub {do_reopen {
180                 } while (_); }) unless Mojo::IOLoop->is_running;
181         }
182 }
183
184 sub do_open
185 {
186         my $self = shift;
187         my $name = shift;
188
189         $self->{ser}->close if $self->{ser};
190         undef $self->{ser};
191
192         my $ob = Serial->new($name, 19200) || die "$name $!\n";
193         dbg "streaming $name fileno(" . fileno($ob) . ")" if isdbg 'chan';
194         
195         my $self->{ser} = Mojo::IOLoop::Stream->new($ob);
196         $self->{ser}->on(error=>sub {dbg "serial $_[1]"; do_reopen($name) unless $ending});
197         $self->{ser}->on(close=>sub {dbg "serial closing"; do_reopen($name) unless $ending});
198         $self->{ser}->on(timeout=>sub {dbg "serial timeout";});
199         $self->{ser}->on(read=>sub {on_read(@_)});
200         $self->{ser}->start;
201
202         Mojo::IOLoop->remove($self->{tid}) if $self->{tid};
203         undef $self->{tid};
204         Mojo::IOLoop->remove($self->{rid}) if $self->{rid};
205         undef $self->{rid};
206         $self->{rid} = Mojo::IOLoop->recurring($self->{poll_interval} => sub {
207                                                                            start_loop() if !$self->{state};
208                                                                    });
209         $self->chgstate('');
210         $self->{nlcount} = 0;
211         
212         return $self->{ser};
213 }
214
215 sub process
216 {
217         my $self = shift;
218         my $blk = $self->{buf};
219         my $loo =  substr $blk,0,3;
220         unless ( $loo eq 'LOO') {
221                 dbg "Block invalid loo -> $loo" if isdbg 'chan'; return;
222         }
223
224         my $tmp;
225         my $rain;
226         my %h;
227
228         my $crc_calc = CRC_CCITT($blk);
229
230         if ($crc_calc==0) {
231
232                 # Common ones
233                 $tmp = unpack("s", substr $blk,7,2) / 1000;
234                 $h{Pressure} = nearest(1, in2mb($tmp));
235
236                 $tmp = unpack("s", substr $blk,9,2) / 10;
237                 $h{Temp_In} = nearest(0.1, f2c($tmp));
238
239                 $tmp  = unpack("s", substr $blk,12,2) / 10;
240                 $h{Temp_Out}  = nearest(0.1, f2c($tmp));
241
242                 $tmp = unpack("C", substr $blk,14,1);
243                 $h{Wind} = nearest(0.1, mph2mps($tmp));
244                 $h{Dir}     = unpack("s", substr $blk,16,2)+0;
245
246                 my $wind = {w => $h{Wind}, d => $h{Dir}};
247                 push @{$self->{ld}->{wind_min}}, $wind;
248
249                 $h{Humidity_Out} = unpack("C", substr $blk,33,1)+0;
250                 $h{Humidity_In}  = unpack("C", substr $blk,11,1)+0;
251
252                 $tmp = unpack("C", substr $blk,43,1)+0;
253                 $h{UV} = $tmp unless $tmp >= 255;
254                 $tmp = unpack("s", substr $blk,44,2)+0; # watt/m**2
255                 $h{Solar} = $tmp unless $tmp >= 32767;
256
257                 #       $h{Rain_Rate}  = nearest(0.1,unpack("s", substr $blk,41,2) * $self->{rain_mult});
258                 $rain = $h{Rain_Day}   = nearest(0.1, unpack("s", substr $blk,50,2) * $self->{rain_mult});
259                 my $delta_rain = $h{Rain} = nearest(0.1, ($rain >= $self->{ld}->{last_rain} ? $rain - $self->{ld}->{last_rain} : $rain)) if $self->{loop_count};
260                 $self->{ld}->{last_rain} = $rain;
261
262                 # what sort of packet is it?
263                 my $sort =  unpack("C", substr $blk,4,1);
264                 if ($sort) {
265
266                         # Newer LOOP2 packet
267                         $tmp = unpack("C", substr $blk,18,2);
268                         #               $h{Wind_Avg_10} = nearest(0.1,mph2mps($tmp/10));
269                         $tmp = unpack("C", substr $blk,20,2);
270                         #               $h{Wind_Avg_2} = nearest(0.1,mph2mps($tmp/10));
271                         $tmp = unpack("C", substr $blk,22,2);
272                         #               $h{Wind_Gust_10} = nearest(0.1,mph2mps($tmp/10));
273
274                         #               $h{Dir_Avg_10} = unpack("C", substr $blk,24,2)+0;
275                         $tmp = unpack("C", substr $blk,30,2);
276                         $h{Dew_Point} = nearest(0.1, f2c($tmp));
277
278                 } else {
279
280                         # Older LOOP packet
281                         $tmp = unpack("C", substr $blk,15,1);
282                         #               $h{Wind_Avg_10} = nearest(0.1,mph2mps($tmp));
283                         $h{Dew_Point}  = nearest(0.1, dew_point($h{Temp_Out}, $h{Humidity_Out}));
284                         $h{Rain_Month}  = nearest(0.1, unpack("s", substr $blk,52,2) * $self->{rain_mult});
285                         $h{Rain_Year}  = nearest(0.1, unpack("s", substr $blk,54,2) * $self->{rain_mult});
286                 }
287
288                 my $ts = time;
289                 my $s;
290                 if ($ts >= $self->{ld}->{last_hour} + 3600) {
291                         $h{Pressure_Trend}    = unpack("C", substr $blk,3,1);
292                         $h{Pressure_Trend_txt} = $bar_trend{$h{Pressure_Trend}};
293                         $h{Batt_TX_OK}  = (unpack("C", substr $blk,86,1)+0) ^ 1;
294                         $h{Batt_Console}  = nearest(0.01, unpack("s", substr $blk,87,2) * 0.005859375);
295                         $h{Forecast_Icon}  = unpack("C", substr $blk,89,1);
296                         $h{Forecast_Rule}  = unpack("C", substr $blk,90,1);
297                         $h{Sunrise}  = sprintf( "%04d", unpack("S", substr $blk,91,2) );
298                         $h{Sunrise}  =~ s/(\d{2})(\d{2})/$1:$2/;
299                         $h{Sunset}   = sprintf( "%04d", unpack("S", substr $blk,93,2) );
300                         $h{Sunset}  =~ s/(\d{2})(\d{2})/$1:$2/;
301
302                         if ($self->{loop_count}) {      # i.e not the first
303                                 my $a = wind_average(scalar @{$self->{ld}->{wind_hour}} ? @{$self->{ld}->{wind_hour}} : {w => $h{Wind}, d => $h{Dir}});
304
305                                 $h{Wind_1h} = nearest(0.1, $a->{w});
306                                 $h{Dir_1h} = nearest(0.1, $a->{d});
307
308                                 $a = wind_average(@{$self->{ld}->{wind_min}});
309                                 $h{Wind_1m} = nearest(0.1, $a->{w});
310                                 $h{Dir_1m} = nearest(1, $a->{d});
311
312                                 ($h{Rain_1m}, $h{Rain_1h}, $h{Rain_24h}) = $self->calc_rain($rain);
313                         }
314                         $self->{ld}->{last_rain_min} = $self->{ld}->{last_rain_hour} = $rain;
315
316                         $s = genstr($ts, 'h', \%h);
317                         
318                         $self->{ld}->{last_hour} = int($ts/3600)*3600;
319                         $self->{ld}->{last_min} = int($ts/60)*60;
320                         @{$self->{ld}->{wind_hour}} = ();
321                         @{$self->{ld}->{wind_min}} = ();
322
323                         write_ld();
324                         
325                 } elsif ($ts >= $self->{ld}->{last_min} + 60) {
326                         my $a = wind_average(@{$self->{ld}->{wind_min}});
327                         my %save;
328
329                         push @{$self->{ld}->{wind_hour}}, $a;
330
331                         if ($self->{loop_count}) {      # i.e not the first
332                                 my $rm;
333                                 
334                                 $h{Wind_1m} = nearest(0.1, $a->{w});
335                                 $h{Dir_1m} = nearest(1, $a->{d});
336                                 ($h{Rain_1m}, $h{Rain_1h}, $h{Rain_24h}) = $self->calc_rain($rain);
337                         }
338                         $self->{ld}->{last_rain_min} = $rain;
339
340                         $s = genstr($ts, 'm', \%h);
341                         
342                         $self->{ld}->{last_min} = int($ts/60)*60;
343                         @{$self->{ld}->{wind_min}} = ();
344                         
345                         write_ld();
346
347                 } else {
348                         my $o = gen_hash_diff($self->{ld}->{last_h}, \%h);
349                         if ($o) {
350                                 $s = genstr($ts, 'r', $o);
351                         }
352                         else {
353                                 dbg "loop rec not changed" if isdbg 'chan';
354                         }
355                 }
356                 output_str($s) if $s;
357                 $self->{ld}->{last_h} = \%h;
358                 ++$self->{loop_count};
359         } else {
360                 dbg "CRC check failed for LOOP data!";
361         }
362         return;
363 }
364
365 sub genstr
366 {
367         my $ts = shift;
368         my $let = shift;
369         my $h = shift;
370         
371         my $j =  $json->encode($h);
372         my ($sec,$min,$hr) = (gmtime $ts)[0,1,2];
373         my $tm = sprintf "%02d:%02d:%02d", $hr, $min, $sec;
374         
375         return qq|{"tm":"$tm","t":$ts,"$let":$j}|;
376 }
377
378 sub output_str
379 {
380         my $s = shift;
381         dbg $s;
382 #       say $s;
383         $dlog->writenow($s);
384 }
385
386 sub gen_hash_diff
387 {
388         my $last = shift;
389         my $now = shift;
390         my %o;
391         my $count;
392
393         while (my ($k, $v) = each %$now) {
394                 if ($last->{$k} ne $now->{$k}) {
395                         $o{$k} = $v;
396                         ++$count;
397                 }
398         }
399         return $count ? \%o : undef;
400 }
401
402 sub dew_point
403 {
404         my $temp = shift @_;
405         my $rh   = shift @_;
406
407         #  Using the simplified approximation for dew point
408         #  Accurate to 1 degree C for humidities > 50 %
409         #  http://en.wikipedia.org/wiki/Dew_point
410
411         my $dewpoint = $temp - ((100 - $rh) / 5);
412
413         # this is the more complete one (which doesn't work)
414         #my $a = 6.1121;
415         #my $b = 18.678;
416         #my $c = 257.14;
417         #my $ytrh = log(($rh/100) + ($b * $temp) / ($c + $temp));
418         #my $dewpoint = ($c * $ytrh) / ($b - $ytrh); 
419
420         return $dewpoint;
421 }
422
423 sub CRC_CCITT
424 {
425     # Expects packed data...
426     my $data_str = shift @_;
427
428         my $crc = 0;
429         my @lst = split //, $data_str;
430         foreach my $data (@lst) {
431                 my $data = unpack("c",$data);
432
433                 my $crc_prev = $crc;
434                 my $index = $crc >> 8 ^ $data;
435                 my $lhs = $crc_table[$index];
436                 #print "lhs=$lhs, crc=$crc\n";
437                 my $rhs = ($crc << 8) & 0xFFFF;
438                 $crc = $lhs ^ $rhs;
439
440
441         }
442
443         return $crc;
444 }
445
446 sub f2c
447 {
448         return ($_[0] - 32) * 5/9;
449 }
450
451 sub mph2mps
452 {
453         return $_[0] * 0.44704;
454 }
455
456 sub in2mb
457 {
458         return $_[0] * 33.8637526;
459 }
460
461 sub wind_average
462 {
463         my ($sindir, $cosdir, $wind);
464         my $count;
465         
466         foreach my $r (@_) {
467                 $wind += $r->{w};
468                 $sindir += sin(d2r($r->{d})) * $r->{w};
469                 $cosdir += cos(d2r($r->{d})) * $r->{w};
470                 ++$count;
471         }
472
473         my $avhdg = r2d(atan2($sindir, $cosdir));
474         $avhdg += 360 if $avhdg < 0; 
475         return {w => nearest(0.1,$wind / $count), d => nearest(0.1,$avhdg)};
476 }
477
478 # radians to degrees
479 sub r2d
480 {
481     my $n = shift;
482     return ($n / pi) * 180;
483 }
484
485 # degrees to radians
486 sub d2r 
487 {
488     my $n = shift;
489     return ($n / 180) * pi;
490 }
491
492 sub calc_rain
493 {
494         my $self = shift;
495         my $rain = shift;
496         
497         $self->{ld}->{rain24} ||= [];
498         
499         my $Rain_1h = nearest(0.1, $rain >= $self->{ld}->{last_rain_hour} ? $rain - $self->{ld}->{last_rain_hour} : $rain); # this is the rate for this hour, so far
500         my $rm = $rain >= $self->{ld}->{last_rain_min} ? $rain - $self->{ld}->{last_rain_min} : $rain;
501         my $Rain_1m = nearest(0.1, $rm);
502         push @{$self->{ld}->{rain24}}, $Rain_1m;
503         $self->{ld}->{rain_24} += $rm;
504         while (@{$self->{ld}->{rain24}} > 24*60) {
505                 $self->{ld}->{rain_24} -= shift @{$self->{ld}->{rain24}};
506         }
507         my $Rain_24h = nearest(0.1, $self->{ld}->{rain_24});
508         return ($Rain_1m, $Rain_1h, $Rain_24h);
509 }
510
511 sub read_ld
512 {
513         my $self = shift;
514         
515         return unless $self->{dataf};
516
517         seek $self->{dataf}, 0, 0;
518         my $s = <$self->{dataf}>;
519         chomp $s;
520         dbg "read loop data: $s" if isdbg 'json';
521         $ld = $json->decode($s) if length $s;
522         
523         # sort out rain stats
524         my $c;
525         if (($c = @{$self->{ld}->{rain24}}) < 24*60) {
526                 my $diff = 24*60 - $c;
527                 unshift @{$self->{ld}->{rain24}}, 0 for 0 .. $diff;  
528         }
529         my $rain;
530         $rain += $_ for @{$self->{ld}->{rain24}};
531         $self->{ld}->{rain_24} = nearest(0.1, $rain);
532         delete $self->{ld}->{hour};
533         delete $self->{ld}->{min};
534 }
535
536 sub write_ld
537 {
538         my $self = shift;
539         
540         return unless $self->{dataf};
541         
542         seek $self->{dataf}, 0, 0;
543         truncate $self->{dataf}, 0;
544         $self->{ld}->{ts} = time;
545         my $s = $json->encode($ld);
546         dbg "write loop data: $s" if isdbg 'json';
547         print $self->{dataf} "$s\n";
548 }
549
550 1;