-
Notifications
You must be signed in to change notification settings - Fork 0
/
98_LEDStripe2.pm
900 lines (831 loc) · 39.8 KB
/
98_LEDStripe2.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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
=head1
98_LEDStripe2.pm
# $Id: $
Version 0.1
=head1 SYNOPSIS
FHEM Module and firmware for controlling WS2812b LED stripes
contributed by Stefan Willmeroth 2016
- adopted and changed by Toby 2018 - 2021
=head1 DESCRIPTION
98_LEDStripe2.pm is a perl module controlling a configurable LED Stripe incl WS2812FX library and should be copied into the FHEM directory.
=head1 AUTHOR - Stefan Willmeroth / Toby
swi@willmeroth.com / tobi931@googlemail.com (forum.fhem.de)
=cut
##############################################
package main;
use strict;
use warnings;
use HTTP::Request;
use LWP::UserAgent;
use Switch;
use Color;
use JSON;
use HttpUtils;
#require 'HttpUtils.pm';
my %Commands = (
"on:noArg" => "on",
"off:noArg" => "off"
);
my @gets = sort keys(%Commands); ## just the basic. gets updated dynamically during define (with non blocking http call)
my $callDelay = 1; ### number of seconds a call is delayed using an internal Timer....
##############################################
sub LEDStripe2_Initialize($)
{
my ($hash) = @_;
$hash->{SetFn} = "LEDStripe2_Set";
$hash->{DefFn} = "LEDStripe2_Define";
$hash->{GetFn} = "LEDStripe2_Get";
$hash->{NotifyFn} = "LEDStripe2_Notify";
$hash->{ReadFn} = "LEDStripe2_Read";
$hash->{ReadyFn} = "LEDStripe2_Ready";
$hash->{AttrList} = "power_switch disable:0,1 backwardCompatibility:0,1 ".$readingFnAttributes;
$hash->{cmds} = ();
$hash->{backwardCompatibility} = 0;
$hash->{firstInit} = 1;
#$hash->{sets} = [];
Log(2, "LEDStripe2_Initialize called");
}
###################################
sub LEDStripe2_Read
{
my ($hash) = @_;
my $name = $hash->{NAME};
Log3($name, 3, "LEDStripe2_Read $name LEDStripe2_Read called!");
}
###################################
sub LEDStripe2_Ready
{
my ($hash) = @_;
my $name = $hash->{NAME};
Log3($name, 3, "LEDStripe2_Ready $name LEDStripe2_Ready called!");
}
###################################
sub LEDStripe2_SetParameters
{
my ($hash, @a) = @_;
my $name = $hash->{NAME};
@gets = ();
@gets = sort keys(%Commands);
$hash->{sets} = [];
return "" if(IsDisabled($name));
Log3($name, 3, "LEDStripe2_SetParameters $name LEDStripe2_SetParameters called!");
foreach (%{$hash->{cmds}} )
{
if ( ref eq 'HASH' and exists $_->{type} )
{
if($_->{type} eq "num")
{
my $inc = $_->{inc};
if($_->{max} >= 100)
{
if($_->{max} <= 1000)
{
$inc = 1;
}
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:slider,$_->{min},$inc,$_->{max}");
push(@gets, "$_->{name}:slider,$_->{min},$inc,$_->{max}");
}
elsif($_->{max} < 50)
{
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:selectnumbers,$_->{min},$inc,$_->{max},0,lin");
push(@gets, "$_->{name}:selectnumbers,$_->{min},$inc,$_->{max},0,lin");
}
else
{
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:slider,$_->{min},$inc,$_->{max}");
push(@gets, "$_->{name}:slider,$_->{min},$inc,$_->{max}");
}
}
elsif($_->{type} eq "bool")
{
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:uzsuToggle,on,off");
push(@gets, "$_->{name}:uzsuToggle,on,off");
}
elsif($_->{type} eq "list")
{
my @pList = sort { $_->{options}{$a} <=> $_->{options}{$b} } keys(%{$_->{options}});
my $pNames = join(",",@pList);
if(scalar(@pList) <= 4)
{
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:select,$pNames");
push(@gets, "$_->{name}:select,$pNames");
}
else
{
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:$pNames");
push(@gets, "$_->{name}:$pNames");
}
}
elsif($_->{type} eq "rgbColor")
{
Log3($name, 4, "LEDStripe2_SetParameters $name $_->{name}:colorpicker");
push(@gets, "$_->{name}:colorpicker");
}
}
else
{
Log3($name, 4, "LEDStripe2_SetParameters $name Nothing to do for $_ as it is no hash and/or does not contain type");
}
}
my $bwComp = AttrVal($name, "backwardCompatibility", 0);
if($bwComp)
{
Log3($name, 4, "LEDStripe2_SetParameters $name We do have backwardCompatibility, setting additional commands!");
my @addgets = split(" ","fire:noArg rainbow:noArg sparks:noArg white_sparks:noArg sunrise sunset range solid_rgb pixel ");
push(@gets, @addgets);
}
push(@{$hash->{sets}}, @gets);
}
####
sub LEDStripe2_delayedCall
{
my ($command) = @_;
fhem ("set $command");
}
###################################
sub LEDStripe2_Set($@)
{
my ($hash, @a) = @_;
my $rc = undef;
my $reDOUBLE = '^(\\d+\\.?\\d{0,2})$';
my $remote_ip = $hash->{remote_ip};
my $remote_port = $hash->{remote_port};
my $name = $hash->{NAME};
my $URL = "http://" . $remote_ip . (defined $remote_port?":".$remote_port:"");
return "" if(IsDisabled($name));
if(!defined($hash->{sets}))
{
Log3($name, 2, "\n\nLEDStripe2_Set $name List of Arguments (Hash) not yet defined. going to update commands!");
LEDStripe2_UpdateCommands($hash);
return "";
}
#return "Unknown argument $a[0] choose one of ".join(' ', @gets) unless(defined($a[1]) && $a[1] ne "?");
return "Unknown argument $a[0] choose one of ".join(' ', @{$hash->{sets}}) unless(defined($a[1]) && $a[1] ne "?");
Log3($name, 5, "LEDStripe2_Set $name List of Arguments (Array):\n\t".join(' ', @gets));
Log3($name, 4, "LEDStripe2_Set $name List of Arguments (Hash) :\n\t".join(' ', @{$hash->{sets}}));
shift @a;
my $command = shift @a;
Log3($name, 3, "LEDStripe2_Set $name command: $command");
if($command =~ /^(\b([Oo]n)\b|\b([Oo]ff)\b)/)
{
Log3($name, 4, "LEDStripe2_Set $name command is on/off: $command");
push(@a, $command);
$command = "power";
}
else
{
Log3($name, 4, "LEDStripe2_Set $name command is something else: $command");
}
if(AttrVal($name, "backwardCompatibility", 0) == 1) { ### backward compatibility (not shown on setlist)
if($command eq "fire")
{
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name effect Fire_2012_-_Specific_Colors");
return undef;
}
if($command eq "rainbow")
{
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name effect Rainbow_Cycle");
return undef;
}
if($command eq "knightrider")
{
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name effect Scan");
return undef;
}
if($command eq "sparks")
{
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name effect Twinkle_Fox");
return undef;
}
if($command eq "white_sparks")
{
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name effect Twinkle_Fox");
InternalTimer(gettimeofday()+2*$callDelay, "LEDStripe2_delayedCall", "$name solidColor ffffff");
return undef;
}
if($command eq "sunrise")
{
return "Set sunrise needs one parameter: <duration in minutes>" if ( @a != 1);
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name sunriseset $a[0]");
InternalTimer(gettimeofday()+2*$callDelay, "LEDStripe2_delayedCall", "$name effect Sunrise");
return undef;
}
if($command eq "sunset")
{
return "Set sunset needs one parameter: <duration in minutes>" if ( @a != 1);
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name sunriseset $a[0]");
InternalTimer(gettimeofday()+2*$callDelay, "LEDStripe2_delayedCall", "$name effect Sunset");
return undef;
}
## pixel will (may?) not work right now...
if($command eq "pixel")
{
return "Set pixel needs four or one parameters: <desired_led> <red> <green> <blue>" if ( @a != 4 && @a != 2);
my $desired_led=$a[0];
$desired_led=($desired_led=~ m/$reDOUBLE/) ? $1:undef;
return "desired_led value ".$a[0]." is not a valid number" if (!defined($desired_led));
if(@a == 4)
{
my $red=$a[1];
$red=($red=~ m/$reDOUBLE/) ? $1:undef;
return "red value ".$a[1]." is not a valid number" if (!defined($red));
my $green=$a[2];
$green=($green=~ m/$reDOUBLE/) ? $1:undef;
return "green value ".$a[2]." is not a valid number" if (!defined($green));
my $blue=$a[3];
$blue=($blue=~ m/$reDOUBLE/) ? $1:undef;
return "blue value ".$a[3]." is not a valid number" if (!defined($blue));
$URL .= "/set?pi=" . $desired_led . "&solidColor=".sprintf("%02x%02x%02x",$red,$green,$blue); #re=" . $red . "&gr=" . $green . "&bl=" . $blue;
}
else
{
$URL .= "/set?pi=" . $desired_led . "&solidColor=" . $a[1];
}
Log3($name, 4, "LEDStripe2_Set $name set command: " . $command ." desired:". $desired_led);
$hash->{mode} = $command;
LEDStripe2_request_nonBlocking($hash,$URL, "LEDStripe2_ParseHttpResponse");
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name power on");
return undef;
}
if($command eq "range")
{
return "Set range needs five or three parameters: <first_led> <last_led> <red> <green> <blue> or <RGB>" if ( @a != 5 && @a !=3 );
my $first_led=$a[0];
$first_led=($first_led=~ m/$reDOUBLE/) ? $1:undef;
return "first_led value ".$a[0]." is not a valid number" if (!defined($first_led));
my $last_led=$a[1];
$last_led=($last_led=~ m/$reDOUBLE/) ? $1:undef;
return "last_led value ".$a[1]." is not a valid number" if (!defined($last_led));
if(@a == 5)
{
my $red=$a[2];
$red=($red=~ m/$reDOUBLE/) ? $1:undef;
return "red value ".$a[2]." is not a valid number" if (!defined($red));
my $green=$a[3];
$green=($green=~ m/$reDOUBLE/) ? $1:undef;
return "green value ".$a[3]." is not a valid number" if (!defined($green));
my $blue=$a[4];
$blue=($blue=~ m/$reDOUBLE/) ? $1:undef;
return "blue value ".$a[4]." is not a valid number" if (!defined($blue));
$URL .= "/set?rnS=" . $first_led . "&rnE=" . $last_led . "&solidColor=".sprintf("%02x%02x%02x",$red,$green,$blue); ##"&re=" . $red . "&gr=" . $green . "&bl=" . $blue;
}
else
{
$URL .= "/set?rnS=" . $first_led . "&rnE=" . $last_led . "&solidColor=" . $a[2];
}
Log3($name, 4, "LEDStripe2_Set $name set command: " . $command ." desired:". $first_led . " to " . $last_led);
#$hash->{mode} = $command;
LEDStripe2_request_nonBlocking($hash,$URL, "LEDStripe2_ParseHttpResponse");
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name power on");
return undef;
}
if($command eq "solid_rgb")
{
my $rgbval;
#$rgbval = $hash->{READINGS}{rgb}{VAL} if defined($hash->{READINGS}{rgb}{VAL});
$rgbval = $a[0] if ( @a == 1 && length($a[0]) == 6);
return "Set rgb needs a color parameter: <red><green><blue> e.g. ffaa00" if !defined($rgbval);
$URL .= "/set?rgb=1&solidColor=$rgbval";
#$hash->{mode} = $command;
LEDStripe2_request_nonBlocking($hash,$URL, "LEDStripe2_ParseHttpResponse");
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name power on");
return undef;
}
}### end backward compatibility
my $reftype = ref ($hash->{cmds}->{$command});
if ($reftype && $reftype eq 'HASH') {
Log3($name, 4, "LEDStripe2_Set $name: We found ".$hash->{cmds}->{$command}->{name}." of type ".$hash->{cmds}->{$command}->{type});
Log3($name, 4, "LEDStripe2_Set $name: The value to be set for ".$hash->{cmds}->{$command}->{name}." is ".$a[0]);
if($hash->{cmds}->{$command}->{type} eq "bool")
{
if($a[0] eq "on")
{
$URL .= "/set?".$command."=1";
}
elsif($a[0] eq "off")
{
$URL .= "/set?".$command."=0";
}
else
{
return "Wrong Parameter $a[0]. $command needs one parameter: <on> or <off>";
}
}
elsif($hash->{cmds}->{$command}->{type} eq "list")
{
if(exists($hash->{cmds}->{$command}->{options}->{$a[0]}))
{
$URL .= "/set?".$command."=".$hash->{cmds}->{$command}->{options}->{$a[0]};
InternalTimer(gettimeofday()+$callDelay, "LEDStripe2_delayedCall", "$name power on") if($command eq "effect");
}
else
{
return "Wrong Parameter \"$a[0]\" for \"$command\" Please use one of :\n\t".join("\n\t", sort { $hash->{cmds}->{$command}->{options}{$a} <=> $hash->{cmds}->{$command}->{options}{$b} } keys(%{$hash->{cmds}->{$command}->{options}}));
Log3($name, 3, "LEDStripe2_Set $name No Entry for $a[0]");
}
}
elsif($hash->{cmds}->{$command}->{type} eq "num")
{
if(($a[0] =~ /^[+-]?\d+$/) and ($a[0] <= $hash->{cmds}->{$command}->{max}) and ($a[0] >= $hash->{cmds}->{$command}->{min}))
{
Log3($name, 4, , "LEDStripe2_Set $name: valid number found in $a[0] for $command");
$URL .= "/set?".$command."=".$a[0];
}
else
{
return "Wrong Parameter $a[0] for $command Please use a numerical (integer) value between ".$hash->{cmds}->{$command}->{min}." and ".$hash->{cmds}->{$command}->{max};
}
}
elsif($hash->{cmds}->{$command}->{type} eq "rgbColor")
{
my $rgbval;
$rgbval = $a[0] if ( @a == 1 && length($a[0]) == 6);
return "Wrong Parameter \"$a[0]\" for \"$command\" Please use a hexadecimal color value: <red><green><blue> e.g. ffaa00" if !defined($rgbval);
$URL .= "/set?".$command."=".$rgbval;
}
Log3($name, 4, , "LEDStripe2_Set $name: will now call $URL");
LEDStripe2_request_nonBlocking($hash,$URL, "LEDStripe2_ParseHttpResponse");
}
else
{
Log3($name, 1, , "LEDStripe2_Set $name: The command $command with value $a[0] is not in the list of commands");
#return "Unknown argument $command with parameter $a[0]: choose one of ".join(' ', @gets);
return "Unknown argument $command with parameter $a[0]: choose one of ".join(' ', @{$hash->{sets}});
}
return undef;
}
#####################################
sub LEDStripe2_Define($$)
{
my ($hash, $def) = @_;
my($a, $h) = parseParams($def);
my $name = $hash->{NAME};
return "wrong syntax. need at least ip: define <name> LEDStripe2 ip=<ip-address> optional: port=<port> interval=<interval>" if(!defined($h->{ip}));
if(!goodDeviceName($hash->{NAME}))
{
return "This is not a good device name. You can however try this one: ".makeDeviceName($hash->{NAME});
}
$hash->{remote_ip} = $h->{ip};
$hash->{remote_port} = $h->{port} if(defined($h->{port}));
$hash->{interval} = $h->{interval} if(defined($h->{interval}));
$hash->{interval} = 120 if(!defined($hash->{interval}) || $hash->{interval} < 5);
$hash->{firstInit} = 1;
$attr{$name}{"devStateIcon"} = "{\"on:light_led_stripe_rgb\\\@#\".(ReadingsVal(\$name,\"rgb\",\"000000\")).\" off:light_led_stripe_rgb\\\@black\"}";
$attr{$name}{"webCmd"} = "power:autoPalette:autoPlay:speed:colorPalette:effect:autoPalInterval:autoPlayInterval:brightness:solidColor";
$attr{$name}{"webCmdLabel"} = "Power:Autopalette:Automode:Speed:Colorpalette\n:Effect:Autopal Interval:Automode Interval:Brightness:Solid Color";
my $URL = "http://" . $hash->{remote_ip} . (defined $hash->{remote_port}?":".$hash->{remote_port}:"") . "/status";
Log3($name, 4, "LEDStripe2_Define $name defined LEDStripe2 at $hash->{remote_ip}:$hash->{remote_port} with interval $hash->{interval}") if(defined($h->{port}));
Log3($name, 4, "LEDStripe2_Define $name defined LEDStripe2 at $hash->{remote_ip} with interval $hash->{interval}") if(!defined($h->{port}));
LEDStripe2_UpdateCommands($hash);
return undef;
}
#####################################
sub LEDStripe2_Notify($$)
{
my ($own_hash, $dev_hash) = @_;
my $ownName = $own_hash->{NAME}; # own name / hash
return "" if(IsDisabled($ownName)); # Return without any further action if the module is disabled
my $devName = $dev_hash->{NAME}; # Device that created the events
my $events = deviceEvents($dev_hash, 1);
if($devName eq $ownName)
{
Log3($ownName, 5, "LEDStripe2_Notify $ownName notified itself with @{$events}");
my $bwComp = AttrVal($ownName, "backwardCompatibility", 0);
Log3($ownName, 5, "LEDStripe2_Notify $ownName backwardCompatibility was set to $own_hash->{backwardCompatibility} and read to be $bwComp now!");
if($own_hash->{backwardCompatibility} != $bwComp)
{
Log3($ownName, 3, "LEDStripe2_Notify $ownName Attr BackwardCompatibility changed from $own_hash->{backwardCompatibility} to $bwComp");
$own_hash->{backwardCompatibility} = $bwComp;
LEDStripe2_UpdateCommands($own_hash);
}
Log3($ownName, 5, "LEDStripe2_Notify $ownName firstInit is currently $own_hash->{firstInit}");
if($own_hash->{firstInit})
{
Log3($ownName, 3, "LEDStripe2_Notify $ownName Module firstInit triggerd!");
$own_hash->{firstInit} = 0;
LEDStripe2_UpdateCommands($own_hash);
}
}
if($devName eq "global" && grep(m/^INITIALIZED|REREADCFG$/, @{$events}))
{
Log3($ownName, 0, "LEDStripe2_Notify $ownName notified by global with @{$events}");
my $bwComp = AttrVal($ownName, "backwardCompatibility", 0);
if($own_hash->{backwardCompatibility} != $bwComp)
{
Log3($ownName, 0, "LEDStripe2_Notify $ownName Attr BackwardCompatibility changed from $own_hash->{backwardCompatibility} to $bwComp");
$own_hash->{backwardCompatibility} = $bwComp;
#LEDStripe2_UpdateCommands($own_hash);
}
if($own_hash->{firstInit})
{
Log3($ownName, 0, "LEDStripe2_Notify $ownName Module firstInit triggerd!");
$own_hash->{firstInit} = 0;
#LEDStripe2_UpdateCommands($own_hash);
}
Log3($ownName, 0, "LEDStripe2_Notify $ownName Updating Commands on INITIALIZED|REREADCFG...");
LEDStripe2_UpdateCommands($own_hash);
}
}
#####################################
sub LEDStripe2_Undef($$)
{
my ( $hash, $arg ) = @_;
my $name = $hash->{NAME};
RemoveInternalTimer($hash);
Log3($name, 3, "LEDStripe2_Undef ".$hash->{name}. " removed ---");
return undef;
}
#####################################
sub LEDStripe2_UpdateCommands($@)
{
my ($hash, @args) = @_;
my $name = $hash->{NAME};
return "" if(IsDisabled($name));
if(!$init_done)
{
Log3($name, 2, "LEDStripe2_UpdateCommands $name: Not yet initialized. Waiting another 5 seconds...");
InternalTimer(gettimeofday()+2, "LEDStripe2_UpdateCommands", $hash);
return undef;
}
my $URL = "http://" . $hash->{remote_ip} . (defined $hash->{remote_port}?":".$hash->{remote_port}:"") . "/all";
Log3($name, 3, "LEDStripe2_UpdateCommands $name going to update the command list now by calling $URL");
LEDStripe2_request_nonBlocking($hash,$URL, "LEDStripe2_ParseUpdateResponse");
return undef;
}
#####################################
sub LEDStripe2_ParseUpdateResponse
{
my ($param, $err, $data) = @_;
my $hash = $param->{hash};
my $name = $hash->{NAME};
return undef unless($init_done); #should not happen but who knows...
return "" if(IsDisabled($name));
if($err ne "") # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist
{
Log3($name, 1, "LEDStripe2_ParseUpdateResponse $name error while requesting $param->{url}. - $err");
## Lets do this again in a few seconds....
InternalTimer(gettimeofday()+5, "LEDStripe2_UpdateCommands", $hash);
return undef;
}
elsif($data ne "")
{
Log3($name, 3, "LEDStripe2_ParseUpdateResponse $name LEDStripe2_ParseUpdateResponse $param->{url} returned quite some data");
eval {decode_json($data) };
if($@) {
Log3($name, 1, "LEDStripe2_ParseUpdateResponse $name will quit becasue of: $@");
Log3($name, 2, "data was: \n\t: $data");
return undef;
}
my $json = undef;
$json = decode_json($data);
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name -> goint to extract Keys in JSON $data");
for my $item( @{$json} )
{
if($item->{type} == 0)
{
my $iInc = 1;
if( $item->{max} > 255)
{
$iInc = int( $item->{max}/100);
}
$hash->{cmds}->{$item->{name}}->{"name"} = $item->{name};
$hash->{cmds}->{$item->{name}}->{"type"} = "num";
$hash->{cmds}->{$item->{name}}->{"min"} = $item->{min};
$hash->{cmds}->{$item->{name}}->{"inc"} = $iInc;
$hash->{cmds}->{$item->{name}}->{"max"} = $item->{max};
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name ->\t ".sprintf ("%-20s :\t %-27s :\t %s", $item->{name}, "Type", "num"));
}
elsif($item->{type} == 1)
{
$hash->{cmds}->{$item->{name}}->{"name"} = $item->{name};
$hash->{cmds}->{$item->{name}}->{"type"} = "bool";
$hash->{cmds}->{$item->{name}}->{"on"} = 0;
$hash->{cmds}->{$item->{name}}->{"off"} = 1;
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name ->\t ".sprintf ("%-20s :\t %-27s :\t %s", $item->{name}, "Type", "bool"));
}
elsif($item->{type} == 2)
{
my $id = 0;
$hash->{cmds}->{$item->{name}}->{"type"} = "list";
$hash->{cmds}->{$item->{name}}->{"name"} = $item->{name};
foreach my $arrVal (@{$item->{options}})
{
$hash->{cmds}->{$item->{name}}->{"options"}->{makeReadingName($arrVal)} = $id;
$id++;
}
while ( (my $mOption, my $mValue) = each %{$hash->{cmds}->{$item->{name}}->{options}} )
{
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name ->\t ".sprintf ("%-20s :\t %-27s :\t %s", $item->{name}, $mOption, $mValue));
}
}
elsif($item->{type} == 3)
{
$hash->{cmds}->{$item->{name}}->{"name"} = $item->{name};
$hash->{cmds}->{$item->{name}}->{"type"} = "rgbColor";
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name ->\t ".sprintf ("%-20s :\t %-27s :\t %s", $item->{name}, "Type", "rgbColor"));
}
elsif($item->{type} == 4)
{
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name ->\t ".sprintf ("%-20s :\t %-27s :\t %s", $item->{name}, "Type", "OverallLabel"));
}
elsif($item->{type} == 5)
{
Log3($name, 5, "LEDStripe2_ParseUpdateResponse $name ->\t ".sprintf ("%-20s :\t %-27s :\t %s", $item->{name}, "Type", "Sectionlabel"));
}
}
}
else
{
Log3($name, 1, "LEDStripe2_ParseUpdateResponse $name error while requesting $param->{url} - no data received in answer!");
return undef;
}
## We have updated the hash with the fields. So we update the commandlist
LEDStripe2_SetParameters($hash);
# if we get this far, the command was successfull and we can start polling
LEDStripe2_Get($hash);
}
#####################################
sub LEDStripe2_Get($@)
{
my ($hash, @args) = @_;
my $name = $hash->{NAME};
return undef unless($init_done);
return "" if(IsDisabled($name));
my $bwComp = AttrVal($name, "backwardCompatibility", 0);
if($hash->{backwardCompatibility} != $bwComp)
{
Log3($name, 3, "LEDStripe2_Get $name Attr BackwardCompatibility changed from $hash->{backwardCompatibility} to $bwComp");
$hash->{backwardCompatibility} = $bwComp;
LEDStripe2_UpdateCommands($hash);
}
if($hash->{firstInit})
{
Log3($name, 3, "LEDStripe2_Get $name Module firstInit triggerd!");
$hash->{firstInit} = 0;
LEDStripe2_UpdateCommands($hash);
}
my $URL = "http://" . $hash->{remote_ip} . (defined $hash->{remote_port}?":".$hash->{remote_port}:"") . "/status";
RemoveInternalTimer($hash); # is this required?
InternalTimer(gettimeofday()+$hash->{interval}, "LEDStripe2_Get", $hash);
$hash->{NEXTUPDATE}=localtime(gettimeofday()+$hash->{interval});
Log3($name, 4, "LEDStripe2_Get $name Get: Timer Restarted, Calling Noblocking Request with LEDStripe2_ParseHttpResponse");
## maybe we start the next time from the callback to ensure we actually received data?
LEDStripe2_request_nonBlocking($hash,$URL, "LEDStripe2_ParseHttpResponse");
return undef;
}
######################################
sub LEDStripe2_power
{
my ($hash, $command) = @_;
my $name = $hash->{NAME};
my $switch = AttrVal($name, "power_switch", undef);
Log3($name, 4, "LEDStripe2_power $name Power Switch called with $command");
return "" if(IsDisabled($name));
if (defined $switch) {
my $currentpower = Value($switch);
if($command ne $currentpower) {
fhem "set $switch $command";
if ($command eq "on") {
select(undef, undef, undef, 1.5);
}
}
}
}
#####################################
sub LEDStripe2_ParseHttpResponse
{
my ($param, $err, $data) = @_;
my $hash = $param->{hash};
my $name = $hash->{NAME};
return undef unless($init_done);
return "" if(IsDisabled($name));
Log3($name, 5, "LEDStripe2_ParseHttpResponse $name url $param->{url} returned: $data");
if($err ne "") # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist
{
Log3($name, 1, "LEDStripe2_ParseHttpResponse $name error while requesting $param->{url}. - $err");
readingsSingleUpdate($hash, "_ERROR_STATE", "ERROR: $err", 1);
return;
}
elsif($data ne "")
{
Log3($name, 5, "LEDStripe2_ParseHttpResponse $name going to extract json data...");
eval {decode_json($data) };
if($@) {
Log3($name, 1, "LEDStripe2_ParseHttpResponse $name will quit becasue of: $@");
Log3($name, 2, "data was: \n\t: $data");
return;
}
my $json = undef;
$json = decode_json($data);
readingsBeginUpdate($hash);
readingsBulkUpdate($hash, "_ERROR_STATE", "No Error");
## ToDo: Simplyfy: loop through all and only make difference to RGB
foreach my $skey (sort keys %{$json})
{
foreach my $key (sort keys %{$json->{$skey}})
{
if(($key eq "rgb") or (exists($hash->{cmds}->{$key}->{type}) and ($hash->{cmds}->{$key}->{type} eq "rgbColor")))
#if($key eq "rgb")
{
Log3($name, 5, "LEDStripe2_ParseHttpResponse $name updating ".sprintf ("%-25s :\t %06x", "rgb", $json->{$skey}->{$key}));
##rgb with:\t ".sprintf("%06x", $json->{$skey}->{$key}));
readingsBulkUpdateIfChanged($hash, $key, sprintf("%06x", $json->{$skey}->{$key}));
}
elsif(exists($hash->{cmds}->{$key}->{type}))
{
Log3($name, 5, "LEDStripe2_ParseHttpResponse $name updating ".sprintf ("%-25s :\t %s", $key, makeReadingName($json->{$skey}->{$key})));
readingsBulkUpdateIfChanged($hash, $key, makeReadingName($json->{$skey}->{$key}));
}
else
{
Log3($name, 5, "LEDStripe2_ParseHttpResponse $name updating ".sprintf ("%-25s :\t %s", $key, $json->{$skey}->{$key}));
readingsBulkUpdateIfChanged($hash, $key, $json->{$skey}->{$key});
}
}
}
readingsEndUpdate($hash, 1);
## we got this far, everything was OK. Why not updating the STATE?
$hash->{STATE} = $hash->{READINGS}{power}{VAL};
readingsSingleUpdate($hash, "state", $hash->{READINGS}{power}{VAL}, 1);
LEDStripe2_power($hash,$hash->{STATE});
}
else
{
Log3($name, 1, "LEDStripe2_ParseHttpResponse $name error while requesting $param->{url} - no data received in answer!");
readingsSingleUpdate($hash, "_ERROR_STATE", "Did not receive any data!", 1);
}
}
#####################################
sub LEDStripe2_request_nonBlocking
{
my ($hash, $URL, $callBack) = @_;
my $name = $hash->{NAME};
return "" if(IsDisabled($name));
my $param = {
url => $URL,
timeout => 15,
incrementalTimout => 1,
keepalive => 1,
hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat
method => "GET", # Lesen von Inhalten
header => HTTP::Request->new( GET => $URL ), # Den Header gemäss abzufragender Daten ändern
callback => \&$callBack #LEDStripe2_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten
};
Log3($name, 3, "LEDStripe2_request_nonBlocking $name request: $param->{url} $callBack");
HttpUtils_NonblockingGet($param);
}
1;
=pod
=begin html
<a name="LEDStripe2"></a>
<h3>LEDStripe2</h3>
<ul>
<a name="LEDStripe2_define"></a>
<h4>Define</h4>
<ul>
<code>define <name> LEDStripe2 <ip=ip_address> <interval=poll interval in seconds (optional)> </code>
<br/>
<br/>
Defines a module for controlling WS2812b LED stripes connected to an an ESP8266.
The ESP8266 with LED Strip needs this SW: https://github.com/tobi01001/LED_Stripe_Dynamic_web_conf
<br/>
If one will have a closer look / understanding of the different settings, please open the devices Webpage control interface directly!
<br/>
Example:
<ul>
<code>define LED_Wohnzimmer LEDStripe2 ip=192.168.1.21 interval=100</code><br>
<code>attr LED_Wohnzimmer power_switch RL23_LED_WZ</code><br>
<code>set LED_Wohnzimmer Effect pride</code> will activate the pride effect<br>
</ul>
</ul>
<a name="LEDStripe2_Attr"></a>
<h4>Attributes</h4>
<ul>
<li><a name="backwardCompatibility"><code>attr <name> backwardCompatibility <0|1></code></a>
<br />Some old commands remain available when set to 1.</li>
<li><a name="power_switch"><code>attr <name> power_switch <integer></code></a>
<br />Control LED power on/off using s switch channel</li>
</ul>
<a name="LEDStripe2_set"></a>
<h4>Set</h4>
<ul>
<br/><b>Power / Effects</b>
<li><a name="on"><code>set <name> on</code></a>
<br />Resume last LED setting or effect<br/></li>
<li><a name="off"><code>set <name> off</code></a>
<br />Switch all LEDs off and stop any effects<br/></li>
<li><a name="power"><code>set <name> power <on /off></code></a>
<br />Switches the LED-Stripe on or off (redundant to directly setting on or off<br/></li>
<li><a name="effect"><code>set <name> effect <Static, Ease, iNoise8, Plasma, Juggle_Pixels, Color_Fill, FILL_Wave, Dots, Dots_Color_Wipe, Wipe_Sawtooth, Wipe_Sine, Wipe_Quad, Wipe_Triwave, Centering, Breath, Dynamic, Rainbow, Rainbow_Cycle, Pride, Scan, Dual_Scan, Fade, Theater_Chase, Theater_Chase_Dual_palette, Theater_Chase_Rainbow, Running_Lights, Twinkle_Fade, Twinkle_Fox, Wave_Bright, Firework, Fire_2012_-_Specific_Colors, Larson_Scanner, Comet, Fire_Flicker, Bubble_Sort, Shooting_Star, Sine_glows, Pixel_Stack, 1/2_Bar_Sine, 1/2_Bar2, 1/2_Bar3, 1/2_Bar, Popcorn, Firework_Rocket, Heart_Beat, Meteor_Shower, Ease_Bar, Pacifica_-_Specific_Colors, Color_Waves, Twinkle_Base_Color, Void_DOES_NOTHING, Phone_Ring, Sunrise, Sunset></code></a>
<br />Activates the effect with the provided name.<br/></li>
<li><a name="brightness"><code>set <name> brightness <#value></code></a>
<br />Sets the strips overall Brightness from 0 (off) to 255 (maximum brightness. Brightness might be limited by other settings like currentLimit, colorTemperature or colorCorrection.<br/></li>
<li><a name="speed"><code>set <name> speed <#value></code></a>
<br />sets the effect speed between 10 and 1000.<br/></li>
<li><a name="colorPalette"><code>set <name> colorPalette <Rainbow, Lava, Iced_Water, RainbowStripe, Forest, Ocean, Heat, Party, Cloud, Ice, Retro, Snow, Fairy_Light, Blue_White, Red_White, Holly, Red_Green_White, Red_Shades, Green_Shades, Blue_Shades, Pacific_Blue, Random, Custom></code></a>
<br />Activates the color palette with the provided name<br/></li>
<li><a name="running"><code>set <name> running <on /off></code></a>
<br />When off, the effect will "pause", on will keep it "running"<br/></li>
<br/><b>Structure</b>
<li><a name="segments"><code>set <name> segments <#value></code></a>
<br />Sets the number of (equally distributed) segments on the strip. The max possible segments depends on the overall number of LEDs<br/></li>
<li><a name="numEffectBars"><code>set <name> numEffectBars</code></a>
<br />If an effect has several "effect items", their count can be set here (depends on the overall number of LEDs)<br/></li>
<li><a name="reversed"><code>set <name> reversed <on /off></code></a>
<br />Will reverse the current effect on the strip<br/></li>
<li><a name="mirrored"><code>set <name> mirrored <on /off></code></a>
<br />If activated and there are more than one segment, the even segment effects will be mirrored (try it to see it)<br/></li>
<br/><b>AutoPlay</b>
<li><a name="autoPlay"><code>set <name> autoPlay <Off, Up, Down, Random></code></a>
<br />Activates "Effect Autoplay" in the given direction (as the order of effects) or random<br/></li>
<li><a name="autoPlayInterval"><code>set <name> autoPlayInterval <#value></code></a>
<br />When Autoplay is activated, a new effect is applied every #value seconds (from 5s to 1000s)<br/></li>
<li><a name="autoPalette"><code>set <name> autoPalette <Off, Up, Down, Random<</code></a>
<br />Activates "Effect Autoplay" in the given direction (as the order of effects) or random<br/></li>
<li><a name="autoPalInterval"><code>set <name> autoPalInterval <#value5,max:1000,step:1,></code></a>
<br />When Autopalette is activated, a new color palette is applied every #value seconds (from 5s to 1000s)<br/></li>
<br/><b>BackgroundColor</b>
<li><a name="backgroundHue"><code>set <name> backgroundHue <#value></code></a>
<br />Changes the hue (hsv) of the background color.<br/></li>
<li><a name="backgroundSat"><code>set <name> backgroundSat <#value0,max:255,step:1,></code></a>
<br />Sets the saturation of the background color effect.<br/></li>
<li><a name="backgroundBri"><code>set <name> backgroundBri:slider,0,1,80</code></a>
<br />Will set the background-brightness if a backgroundcolor is set (HSV) and likewise activate the background color (value > 0, 0 means no background color)<br/></li>
<br/><b>Advanced Settings</b>
<li><a name="blendType"><code>set <name> blendType <NoBlend, LinearBlend></code></a>
<br />Sets if a color palette is blending between values (interpolation) or not. Good to be seen with the rainbow or rainbow_stripe palette.<br/></li>
<li><a name="colorTemperature"><code>set <name> colorTemperature <Candle, Tungsten40W, Tungsten100W, Halogen, CarbonArc, HighNoonSun, DirectSunlight, OvercastSky, ClearBlueSky, UncorrectedTemperature></code></a>
<br />Sets the color temperature filter - applied to the whole strip.<br/></li>
<li><a name="ledBlur"><code>set <name> ledBlur <#value></code></a>
<br />Sets how much the led effect is blurred (255 not at all, low values will blur the drawn effect)<br/></li>
<br/><b>Solid Color</b>
<li><a name="solidColor"><code>set <name> solidColor colorpicker</code></a>
<br />Sets the color as palette which is then used to draw the effects (except fire2012 and pacifica)<br/></li>
<br/><b>Glitter</b>
<li><a name="addGlitter"><code>set <name> addGlitter <on /off></code></a>
<br />adds glitter to the active effect. Glitter itself is controlled by whiteGlitter, onBlackOnly, syncGlitter<br/></li>
<li><a name="whiteGlitter"><code>set <name> whiteGlitter <on /off></code></a>
<br />Setting to switch between White Glitter (if addGlitter is on) and Palette based glitter<br/></li>
<li><a name="onBlackOnly"><code>set <name> onBlackOnly <on /off></code></a>
<br />Glitter will only be added to black pixels (pixels currently off). So this does not work for all effects.<br/></li>
<li><a name="syncGlitter"><code>set <name> syncGlitter <on /off></code></a>
<br />When active and there are more than one segments, the glitter will be equal on both segments. When off, glitter will be random on the complete strip.<br/></li>
<br/><b>Hue Change</b>
<li><a name="hueTime"><code>set <name> hueTime <#value></code></a>
<br />The time interval the "hue" (color palette index) will change for quite some effects. You may try it with the "rainbow stripe" palette and the static effect to see how that works.<br/></li>
<li><a name="deltaHue"><code>set <name> deltaHue <#value></code></a>
<br />Sets a fixed hue offset (color palette index) for quite some effects. You may try it with the "rainbow stripe" palette and the static effect to see how that works.<br/></li>
<br/><b>Effect Settings</b>
<li><a name="cooling"><code>set <name> cooling <#value20,max:100,step:1,></code></a>
<br />Setting which affects the cooling of the flames of the fire 2012 effect.<br/></li>
<li><a name="sparking"><code>set <name> sparking <#value></code></a>
<br />Used for the fire2012 effect as how many new sparks the fire will have (min: 50 max:200)<br/></li>
<li><a name="twinkleSpeed"><code>set <name> twinkleSpeed <#value></code></a>
<br />Will change the speed of some twinkle effects.<br/></li>
<li><a name="twinkleDensity"><code>set <name> twinkleDensity <#value></code></a>
<br />Will change how many twinkles are emitted for some twinkle effects.<br/></li>
<li><a name="damping"><code>set <name> damping <#value></code></a>
<br />used to set the damping (between 1 - full damping and 100 - no damping) for "bouncing" effects like "popcorn"<br/></li>
<li><a name="sunriseset"><code>set <name> sunriseset <#value></code></a>
<br />Sets the time a sunrise or sunset effect will take (in minutes - minimum 1 and maximum 120)<br/></li>
<br/><b>Other Settings</b>
<li><a name="wifiDisabled"><code>set <name> wifiDisabled <on /off></code></a>
<br />can be uised to switch WiFi off on devi´ces with knob/display control on them. <b>Attention:</b>Once activated, the device is no longer accessible via network!<br/></li>
<li><a name="currentLimit"><code>set <name> currentLimit <#value></code></a>
<br />Will set the maximum current the LED stripe should draw. <b>Attention:</b> this value is calculated only. The maximum is bound to the number of LEDs in the strip. The current should not exceed your power supply rating nor your cabling rating!<br/></li>
<li><a name="colorCorrection"><code>set <name> colorCorrection <TypicalLEDStrip, TypicalPixelString, UncorrectedColor></code></a>
<br />Will set the overall color correction (as red, green and blue leds do not equally emit light.<br/></li>
<li><a name="fps"><code>set <name> fps <#value></code></a>
<br />set the maximum frames per seconds for the effects.<br/></li>
<li><a name="dithering"><code>set <name> dithering <on /off></code></a>
<br />Switches LED-dithering on or off (interpolation to somehow deflicker at low brightness levels.<br/></li>
<li><a name="resetdefaults"><code>set <name> resetdefaults <on /off></code></a>
<br />Will reset everything (except WiFi settings) to the default values.<br/></li>
<br/><b>If the attribute "backwardCompatibility" is set (1), some additional commands are available (from earlier implementations):</b>
<li><a name="sunrise"><code>set <name> sunrise <#value></code></a>
<br />Will activate a sunrise effect taking #value minutes.<br/></li>
<li><a name="sunset"><code>set <name> sunset <#value></code></a>
<br />Will activate a sunset effect taking #value minutes.<br/></li>
<li><a name="solid_rgb"><code>set <name> solid_rgb <color hex></code></a>
<br />Will set the complete strip to the color being provided.<br/></li>
<li><a name="pixel"><code>set <name> pixel <led id> <red> <green> <blue></code></a>
<br />Set the color of a single LED, index starts at 0, color values are from 0-255<br/></li>
<li><a name="range"><code>set <name> range <start id> <end id> <red> <green> <blue></code></a>
<br />Set the color of a range of LEDs, start and end are inclusive beginning with 0<br/></li>
<li><a name="pixels"><code>set <name> pixels <color data></code></a>
<br />Define the color of all LEDs, the color data consists of three hex digits per LED containing the three colors,
e.g. 000 would be off, F00 would be all red, 080 would be 50% green, 001 a faint blue<br/></li>
<li><a name="fire"><code>set <name> fire</code></a>
<br />Start a 'fire' light effect on all LEDs<br/></li>
<li><a name="rainbow"><code>set <name> rainbow <string></code></a>
<br />Start a 'rainbow color chase' light effect on all LEDs<br/></li>
<li><a name="sparks"><code>set <name> sparks <string></code></a>
<br />Start sparkling dots (random color) light effect on all LEDs<br/></li>
<li><a name="white_sparks"><code>set <name> white_sparks <string></code></a>
<br />Start sparkling dots (white) light effect on all LEDs<br/></li>
<li><a name="knightrider"><code>set <name> knightrider <string></code></a>
<br />Start knightrider light effect on all LEDs<br/></li>
</ul>
</ul>
=end html
=cut