/
70_SamsungAV.pm
1432 lines (1293 loc) · 50.8 KB
/
70_SamsungAV.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
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
##############################################################################
#
# 70_SamsungAV.pm
#
# module to send messages or commands to a Samsung TV
#
# written 2019 by kölnsolar
# based on 70_STV which supports older generation of TV's. Thanks to Zwiebel.
# extended for newer moduls. Python script samsungctl was used as reference.
#
# $Id$
#
# Version = 1.0
#
##############################################################################
package main;
use strict;
use warnings;
use IO::Socket::INET;
use Sys::Hostname;
use MIME::Base64;
use DevIo;
use HttpUtils;
my @gets = ('dummy');
sub SamsungAV_Initialize($)
{
my ($hash) = @_;
$hash->{DefFn} = "SamsungAV_Define";
$hash->{UndefFn} = "SamsungAV_Undefine";
$hash->{StateFn} = "SamsungAV_SetState";
$hash->{SetFn} = "SamsungAV_Set";
$hash->{AttrFn} = "SamsungAV_Attr";
$hash->{NotifyFn} = "SamsungAV_Notify";
$hash->{ReadFn} = "SamsungAV_Read";
$hash->{ReadyFn} = "SamsungAV_Ready";
$hash->{AttrList} = "callerURI screenURI delayRC delayMacro disable:0,1 " . $readingFnAttributes;;
$data{RC_layout}{SamsungAV_TV} = "SamsungAV_RClayout_TV";
$data{RC_layout}{SamsungAV_TV_SVG} = "SamsungAV_RClayout_TV_SVG";
$data{RC_makenotify}{SamsungAV} = "SamsungAV_RCmakenotify";
}
sub SamsungAV_Define($$)
{
my ($hash, $def) = @_;
# DevIo_CloseDev($hash);
my @args = split("[ \t]+", $def);
if (int(@args) < 4)
{
return "[SamsungAV] Define: not enough arguments. Usage:\n" .
"define <name> SamsungAV <host> <port>";
}
$hash->{Host} = $args[2];
$hash->{Port} = $args[3];
if ( $hash->{Port} ne "55000" && $hash->{Port} ne "52235" && $hash->{Port} ne "8000" && $hash->{Port} ne "8001" ){
return "[SamsungAV] Port is not supported";
}
if (defined $args[4]) {
$hash->{Mode} = $args[4];
if (!defined ReadingsVal($args[4],"state",undef)) { return "[SamsungAV] Define: optional DLNA device not known. $hash->{Mode} instead" }
$hash->{".validcommands"} .= "volume:slider,0,1,100 sayText ";
}
else { $hash->{Mode} = undef }
if ( $hash->{Port} eq 55000 || $hash->{Port} eq "8000" || $hash->{Port} eq "8001"){
$hash->{".validcommands"} .= "0:noArg 1:noArg 2:noArg 3:noArg 4:noArg 5:noArg 6:noArg 7:noArg 8:noArg 9:noArg ".
"ad:noArg aspect:noArg av1:noArg av2:noArg channel:selectnumbers,0,1,99,0,lin channelDown:noArg channelUp:noArg channelList:noArg clear:noArg component1:noArg component2:noArg ".
"contents:noArg convergence:noArg cyan:noArg down:noArg enter:noArg esaving:noArg exit:noArg ff:noArg guide:noArg green:noArg hdmi:noArg hdmi1:noArg ".
"hdmi2:noArg help:noArg home:noArg info:noArg left:noArg menu:noArg mute:noArg pause:noArg pip_chdown:noArg pip_chup:noArg pip_onoff:noArg play:noArg ".
"pmode:noArg power:noArg poweroff:noArg poweron:noArg prech:noArg program:noArg red:noArg return:noArg rec:noArg rewind:noArg right:noArg sleep:noArg ".
"source:noArg stop:noArg tools:noArg ttx_mix:noArg tv:noArg tv_mode:noArg up:noArg volumeDown:noArg volumeUp:noArg yellow:noArg statusRequest:noArg ".
"0_text_line 0_macro ".
"G_AUTO_:AUTO_ARC_ANTENNA_AIR,AUTO_ARC_ANTENNA_CABLE,AUTO_ARC_ANTENNA_SATELLITE,AUTO_ARC_ANYNET_AUTO_START,AUTO_ARC_ANYNET_MODE_OK,".
"AUTO_ARC_AUTOCOLOR_FAIL,AUTO_ARC_AUTOCOLOR_SUCCESS,AUTO_ARC_CAPTION_ENG,AUTO_ARC_CAPTION_KOR,AUTO_ARC_CAPTION_OFF,AUTO_ARC_CAPTION_ON,".
"AUTO_ARC_C_FORCE_AGING,AUTO_ARC_JACK_IDENT,AUTO_ARC_LNA_OFF,AUTO_ARC_LNA_ON,AUTO_ARC_PIP_CH_CHANGE,AUTO_ARC_PIP_DOUBLE,AUTO_ARC_PIP_LARGE,".
"AUTO_ARC_PIP_LEFT_BOTTOM,AUTO_ARC_PIP_LEFT_TOP,AUTO_ARC_PIP_RIGHT_BOTTOM,AUTO_ARC_PIP_RIGHT_TOP,AUTO_ARC_PIP_SMALL,AUTO_ARC_PIP_SOURCE_CHANGE,".
"AUTO_ARC_PIP_WIDE,AUTO_ARC_RESET,AUTO_ARC_USBJACK_INSPECT,AUTO_FORMAT,AUTO_PROGRAM ".
"G_EXTx:EXT1,EXT2,EXT3,EXT4,EXT5,EXT6,EXT7,EXT8,EXT9,EXT10,EXT11,EXT12,EXT13,EXT14,EXT15,EXT16,EXT17,EXT18,EXT19,EXT20,EXT21,EXT22,EXT23,".
"EXT24,EXT25,EXT26,EXT27,EXT28,EXT29,EXT30,EXT31,EXT32,EXT33,EXT34,EXT35,EXT36,EXT37,EXT38,EXT39,EXT40,EXT41 ".
"G_Others:3SPEED,4_3,16_9,ADDDEL,ALT_MHP,ANGLE,ANTENA,ANYNET,ANYVIEW,APP_LIST,AV3,BACK_MHP,BOOKMARK,CALLER_ID,CAPTION,CATV_MODE,".
"CLOCK_DISPLAY,CONVERT_AUDIO_MAINSUB,CUSTOM,DEVICE_CONNECT,DISC_MENU,DMA,DNET,DNIe,DNSe,DOOR,DSS_MODE,DTV,DTV_LINK,DTV_SIGNAL,".
"DVD_MODE,DVI,DVR,DVR_MENU,DYNAMIC,ENTERTAINMENT,FACTORY,FAVCH,FF_,FM_RADIO,GAME,HDMI3,HDMI4,ID_INPUT,ID_SETUP,INSTANT_REPLAY,LINK,".
"LIVE,MAGIC_BRIGHT,MAGIC_CHANNEL,MDC,MIC,MORE,MOVIE1,MS,MTS,NINE_SEPERATE,OPEN,PANNEL_CHDOWN,PANNEL_CHUP,PANNEL_ENTER,PANNEL_MENU,".
"PANNEL_POWER,PANNEL_SOURCE,PANNEL_VOLDOW,PANNEL_VOLUP,PANORAMA,PCMODE,PERPECT_FOCUS,PICTURE_SIZE,".
"PIP_SCAN,PIP_SIZE,PIP_SWAP,PLUS100,POWER,PRINT,QUICK_REPLAY,REC,REPEAT,RESERVED1,REWIND_,RSS,RSURF,SCALE,SEFFECT,".
"SETUP_CLOCK_TIMER,SOUND_MODE,SOURCE,SRS,STANDARD,STB_MODE,STILL_PICTURE,SUB_TITLE,SVIDEO1,SVIDEO2,SVIDEO3,TOPMENU,TTX_SUBFACE,".
"TURBO,VCHIP,VCR_MODE,WHEEL_LEFT,WHEEL_RIGHT,W_LINK,ZOOM1,ZOOM2,ZOOM_IN,ZOOM_MOVE,ZOOM_OUT ";
if($hash->{Port} ne "8000" && $hash->{Port} ne "8001") {
my $rc = eval
{
require Net::Address::IP::Local;
require IO::Interface::Simple;
Net::Address::IP::Local->import();
IO::Interface::Simple->import();
1;
};
if($rc) {
$hash->{MyIP} = getIP();
$hash->{MAC} = getMAC4IP($hash->{MyIP});
}
else{
Log3 $args[0], 3, "[SamsungAV] $args[0] You are using a deprecated MAC detection mechanism using ifconfig.";
Log3 $args[0], 3, "[SamsungAV] $args[0] Please install Pearl Modules libnet-address-ip-local-perl and libio-interface-perl";
my $system = $^O;
my $result = "";
if($system =~ m/Win/) {
$result = `ipconfig /all`;
my @myarp=split(/\n/,$result);
foreach (@myarp){
if ( /([0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2})$/i ) {
$result = $1;
$result =~ s/-/:/g;
}
}
}
if($system eq "linux") {
$result = `ifconfig -a eth0`;
my @myarp=split(/\n/,$result);
foreach (@myarp){
if ( /(ether|lan|eth0) .*(..:..:..:..:..:..) .*$/ ) {
$result = $2;
}
}
}
# Fritzbox "? (192.168.0.1) at 00:0b:5d:91:fc:bb [ether] on lan"
# debian "192.168.0.1 ether c0:25:06:1f:3c:14 C eth0"
#$result = "? (192.168.0.1) at 00:0b:5d:91:fc:bb [ether] on lan";
$hash->{MAC} = $result;
$hash->{MyIP} = getIP_old();
}
}
else {
eval {require JSON; 1;}
or do {
return "[SamsungAV] Define: Module JSON not installed. Run 'sudo apt-get install libjson-perl'";
};
eval {require Time::HiRes; 1;}
or do {
return "[SamsungAV] Define: Module Time:HiRes not installed. Check perl libraries'";
};
# import Time::HiRes qw(usleep);
}
my $dev = $hash->{DeviceName};
}
else {
$hash->{".validcommands"} = "mute:on,off volume:slider,0,1,100 call sms date ";
}
$hash->{".validcommands"} .= "caller:noArg " if (defined(AttrVal($args[0], "callerURI", undef)));
$hash->{".validcommands"} .= "screen:noArg " if (defined(AttrVal($args[0], "screenURI", undef)));
Log3 $args[0], 3, "[SamsungAV] $args[0] defined with host: $hash->{Host} port: $hash->{Port}";
readingsSingleUpdate($hash,"state","defined",1);
return undef;
}
sub SamsungAV_Undefine($$)
{
my ($hash,$arg) = @_;
RemoveInternalTimer($hash);
return undef;
}
sub SamsungAV_Attr(@)
{
my @a = @_;
my $hash = $defs{$a[1]};
my $cmd = $a[0];
my $attrName = $a[2];
my $attrParm = $a[3];
my $mac = AttrVal($a[1], "MAC", undef);
$hash->{MAC} = $mac if (defined($mac));
if( defined(index($attrName,"URI"))) {
if( $cmd eq "set" ) {
$hash->{".validcommands"} .= "caller:noArg " if ($attrName eq "callerURI");
$hash->{".validcommands"} .= "screen:noArg " if ($attrName eq "screenURI");
}
}
if($cmd eq "set" && $attrName eq "disable") {
if($attrParm eq "0") {
readingsSingleUpdate($hash, "state", "defined",0) if(exists($hash->{helper}{DISABLED}) && $hash->{helper}{DISABLED} == 1);
SamsungAV_Init($hash);
}
elsif($attrParm eq "1") {
RemoveInternalTimer($hash);
readingsSingleUpdate($hash, "presence", "absent",1);
readingsSingleUpdate($hash, "state", "disabled",1);
}
$hash->{helper}{DISABLED} = $attrParm;
}
elsif($cmd eq "del" && $attrName eq "disable") {
readingsSingleUpdate($hash, "state", "defined",0) if(exists($hash->{helper}{DISABLED}) && $hash->{helper}{DISABLED} == 1);
SamsungAV_Init($hash);
$hash->{helper}{DISABLED} = 0;
}
return undef;
}
sub SamsungAV_Init($)
{
my ($hash) = @_;
SamsungAV_State($hash);
RemoveInternalTimer($hash, "SamsungAV_Init");
InternalTimer(gettimeofday()+60, "SamsungAV_Init", $hash, 0);
}
sub SamsungAV_State($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my $port = $hash->{Port};
my $param = {
url => "http://$hash->{Host}:$port/",
timeout => 5,
hash => $hash,
method => "GET",
header => "",
callback => \&SamsungAV_ParseState
};
HttpUtils_NonblockingGet($param);
}
sub SamsungAV_ParseState($)
{
my ($param, $err, $data) = @_;
my $hash = $param->{hash};
my $name = $hash->{NAME};
# Log3 $name, 1, "[SamsungAV] $name parameter - code: $param->{code} - error: $err";
my ($state, $stateAV, $presence) = "";
$param->{code} = "" if(!defined($param->{code}));
if($err ne "" && index($err,"empty") < 0) { # workaround for C/D/E/F-Series still to figure out http server Port 7676(ne "" $param->{code} ne "40")
Log3 $name, 4, "[SamsungAV] $name not able to connect to $hash->{Host}:$hash->{Port} with $param->{url} - code: $param->{code} - error: $err";
$state = $stateAV = $presence = "absent";
}
else {
Log3 $name, 4, "[SamsungAV] $name online with $hash->{Host}:$hash->{Port} - HTTP-Response: $param->{code}";
$state = $stateAV = "on";
$presence = "present";
}
readingsBeginUpdate($hash);
readingsBulkUpdateIfChanged($hash, "state", $state,1);
if (defined($hash->{Mode})) {
my $mute = ReadingsVal($hash->{Mode},"mute","not found");
if($mute eq "1") {$mute = "on"}
elsif ($mute eq "0") {$mute = "off"}
if ($presence ne "absent") {
my $DLNAstate = ReadingsVal($hash->{Mode},"state","not found");
if ($mute eq "on") { $stateAV = "muted" }
elsif ($DLNAstate ne "online") { $stateAV = $DLNAstate }
}
readingsBulkUpdateIfChanged($hash, "stateAV", $stateAV);
readingsBulkUpdateIfChanged($hash, "presence", $presence);
readingsBulkUpdateIfChanged($hash, "mute", $mute);
readingsBulkUpdateIfChanged($hash, "volume", ReadingsVal($hash->{Mode},"volume","not found"));
readingsBulkUpdateIfChanged($hash, "friendlyName", ReadingsVal($hash->{Mode},"friendlyName","not found"));
readingsBulkUpdateIfChanged($hash, "modelName", ReadingsVal($hash->{Mode},"modelName","not found"));
}
readingsEndUpdate($hash, 1);
}
sub SamsungAV_Notify($$)
{
my ($hash,$dev) = @_;
return undef if(!defined($hash) or !defined($dev));
my $name = $hash->{NAME};
my $dev_name = $dev->{NAME};
return undef if(!defined($dev_name) || !defined($name));
my $events = deviceEvents($dev,1);
if($dev_name eq "global" && grep(m/^INITIALIZED|REREADCFG$/, @{$events})) {
if(!exists($hash->{helper}{DISABLED}) || $hash->{helper}{DISABLED} == 0) {
Log3 $name, 3, "[SamsungAV] device $name initialising....";
SamsungAV_Init($hash);
SamsungAV_Tizen_App_list($hash) if ($hash->{Port} ne "8000");
}
}
}
sub SamsungAV_Ready($)
{
my ($hash) = @_;
if(AttrVal($hash->{NAME},'fork','disable') eq 'enable') {
}
else {
Log3 $hash->{NAME}, 5, "[SamsungAV] $hash->{NAME} SamsungAV_Ready(connection seems to be closed) OpenDev for DeviceName: $hash->{DeviceName}";
}
return undef;
}
sub SamsungAV_SetState($$$$)
{
my ($hash, $tim, $vt, $val) = @_;
$val = $1 if($val =~ m/^(.*) \d+$/);
# return "Undefined value $val" if(!defined($it_c2b{$val}));
return undef;
}
sub SamsungAV_Read($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
Log3 $name, 3, "[SamsungAV] $name SamsungAV_Read: connection DeviceName $hash->{DeviceName} may be closed";
}
sub SamsungAV_Set($@)
{
my ($hash, @a) = @_;
my $nam = shift @a;
my $name = $hash->{NAME};
my $Port = $hash->{Port};
my $Mode = $hash->{Mode};
my $cmd = (defined($a[0]) ? shift @a : ""); #command
my $par = (defined($a[0]) ? shift @a : ""); #1 parameter
my %translate = ("channelDown" => "CHDOWN",
"channelUp" => "CHUP",
"channelList" => "CH_LIST",
"volumeDown" => "VOLDOWN",
"volumeUp" => "VOLUP" );
if ($cmd eq "?" || $cmd eq "") {
return $hash->{".validcommands"};
}
$cmd = $par if (substr($cmd,0,2) eq "G_" );
if ($hash->{".validcommands"} =~ /$cmd/) {
$cmd = $translate{$cmd} if (defined($translate{$cmd}));
if ($cmd eq "statusRequest") {
SamsungAV_Tizen_App_list($hash) if ($hash->{Port} ne "8000");
return SamsungAV_State($hash); # query connection state
}
# screen message via DLNA caller or individual
return "$name currently not available. Try later. " if (ReadingsVal($name,"state","not found") ne "on" && !($cmd eq "power" || $cmd eq "poweron" ));
# screen message, absolute volume, TTS via DLNARenderer
if (defined $Mode) {
my $command = "";
if ($cmd eq "caller" ||
$cmd eq "screen") {
my $URI ="";
if ( $cmd ne "caller" ) {$URI = AttrVal($name, "screenURI", undef)}
else {$URI = AttrVal($name, "callerURI", undef)}
$command = "set ".$hash->{Mode}." stream ".$URI;
readingsSingleUpdate($hash, "currentMedia", $URI, 1);
}
elsif ($cmd eq "volume") {
$command = "set ".$hash->{Mode}." volume ".$par;
}
elsif ($cmd eq "sayText") {
$par = '"'.$par.' '.join(" ", @a).'"';
$command = "set ".$hash->{Mode}." speak ".$par;
}
if ($command ne "") {
Log3 $name, 4, "[SamsungAV] $name call DLNA-Renderer. Command: $command";
return SamsungAV_DLNA($hash,$command)
}
}
if ($cmd eq "channel") {
if($par < 10){$cmd = $par}
else {
$cmd = "0_macro";
$par = substr($par,0,1). "," . substr($par,1,1);
}
}
# App functionality for Samsung Tizen since K-Series
return SamsungAV_Tizen_App($hash,$name,$cmd,$par) if (substr($cmd,0,5) eq "0_App" );
# RC commands
if ($Port eq 55000 ){
return SamsungAV_55000($hash,$name,$cmd,$par);
}
elsif ($Port eq 52235 ){
return SamsungAV_52235($hash,@_);
}
elsif ($Port eq 8001 ){
return SamsungAV_Tizen_RC($hash,$name,$cmd,$par);
}
elsif ($Port eq 8000 ){
return SamsungAV_Tizen_RC($hash,$name,$cmd,$par);
}
}
else {
my $ret = "[SamsungAV] Invalid command $cmd. Use any of:\n";
my @cmds = split(" ",$hash->{".validcommands"});
foreach my $line (0..$#cmds) {
$ret .= "\n" if ($line > 1 && $line/10 == int($line/10));
$ret .= $cmds[$line]." ";
}
return $ret;
}
return undef;
}
# Samsung Tizen Models
sub SamsungAV_Tizen_RC($$$$)
{
my ($hash,$name,$cmd,$par) = @_;
Log3 $name, 5, "[SamsungAV] $name command ".$cmd. " parameter ".$par;
my $dev = $hash->{Host};
my $wsport = $hash->{Port};
my ($payload);
if($cmd ne "0_macro") {@ARGV = split(" ",$cmd)}
else {@ARGV = split(",",$par)}
# screen message caller or individual via Webbrowser
if ( $cmd eq "caller" ||
$cmd eq "screen") {
return SamsungAV_7676($hash,$cmd) if ($wsport ne "8001");
return SamsungAV_Tizen_App($hash, $name,$cmd,"Internet");
}
(my $msg, my $socket) = &SamsungAV_Tizen_websocket_open($hash,$name);
if ($msg ne "101") {return $msg}
else {
syswrite $socket, build_frame (0, 1, 0, 0, 0, 0x1, '1::/com.samsung.companion') if ($wsport != 8001);
eval {require Time::HiRes; 1;}
or do {
return "[SamsungAV] Module Time:HiRes not installed. Check perl libraries";
};
foreach my $argnum (0 .. $#ARGV) {
if ($argnum > 0) {
Time::HiRes::usleep(AttrVal($name, 'delayMacro', 300000));
}
else {Time::HiRes::usleep(AttrVal($name, 'delayRC', 0)); }
if ($ARGV[$argnum] ne "") {
# Send remote key(s)
Log3 $name, 4, "[SamsungAV] $name sending ".uc($ARGV[$argnum]);
if ($wsport != 8001) {
$payload = $hash->{".commands"}[$argnum];
}
else {
$payload = JSON::encode_json({
"method" => "ms.remote.control",
"params" => {
"Cmd" => "Click",
"DataOfCmd" => "KEY_".uc($ARGV[$argnum]),
"Option" => "false",
"TypeOfRemote" => "SendRemoteKey"
}
});
}
SamsungAV_Tizen_write_payload($socket, $payload, $name);
# BlockingCall("SamsungAV_execSamsungCtl", $name."|".$hash->{Host}."|".$ARGV[$argnum]);
}
else {Log3 $name, 4, "[SamsungAV] $name sending pause"}
}
SamsungAV_Tizen_websocket_close($socket);
}
return undef;
}
# Samsung Tizen open websocket
sub SamsungAV_Tizen_websocket_open($$)
{
my ($hash,$name) = @_;
my $dev = $hash->{Host};
my $port = $hash->{Port};
my ($msg,$webclient_header,$path,$socket);
my $token = ReadingsVal($name,".token",undef); # (my $error, my $token) = getKeyValue($name."token"); #
if ($port != 8001) {
# $hash->{Port} = 8443;
$path = SamsungAV_Tizen_Encrypt_Init($hash,$name);
# $hash->{Port} = $port;
return $path if (substr($path,0,11) eq "[SamsungAV]");
$webclient_header = "GET " . $path ." HTTP/1.1\r\n";
$socket = IO::Socket::INET->new(PeerAddr=>"$dev:$port", Timeout=>2, Blocking=>1, ReuseAddr=>1);
# $port = 8443; # secure port 8002 since K-series, 8443 for H-/J-Series
Log3 $name, 4, "[SamsungAV] HTTP socket-connection to $name. Reply: ". $socket->error();
}
else {
eval {require IO::Socket::SSL; 1;}
or do {
return "[SamsungAV] Set: Module IO::Socket::SSL not installed. Check perl libraries";
};
# $webclient_header = "GET /api/v2/channels/samsung.remote.control?name=RkhFTVJlbW90ZQ== HTTP/1.1\r\n";
$webclient_header = "GET /api/v2/channels/samsung.remote.control?name=RkhFTVJlbW90ZQ==";
# $webclient_header .= "&token=$hash->{token}" if (defined($hash->{token})) ; #temporary
readingsSingleUpdate($hash, ".token", $hash->{token},0) if (defined($hash->{token})); #temporary
$webclient_header .= "&token=$token" if (defined($token));
$webclient_header .= " HTTP/1.1\r\n";
$port = 8002; # secure port 8002 since K-series, 8443 for H-/J-Series
$IO::Socket::SSL::DEBUG = 3 if(AttrVal($name,"verbose","0") eq "5");
$IO::Socket::SSL::DEBUG = 2 if(AttrVal($name,"verbose","0") eq "4");
$socket = IO::Socket::SSL->new(PeerAddr=>"$dev:$port", SSL_verify_mode=>0,Timeout=>2, Blocking=>1, ReuseAddr=>1);
Log3 $name, 4, "[SamsungAV] HTTP socket-connection to $name. SSL_Reply: ". IO::Socket::SSL::errstr();
$IO::Socket::SSL::DEBUG = 0; # stop detailed debug lines
}
if($socket) {
Log3 $name, 4, "[SamsungAV] HTTP socket-connection to $name successful.";
$webclient_header .= "Upgrade: websocket" . "\r\n" .
"Connection: Upgrade" . "\r\n" .
"Host: $dev:$port" . "\r\n" .
# "Origin: $dev:$port" . "\r\n" .
"Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==" . "\r\n" .
"Sec-WebSocket-Version: 13" . "\r\n\r\n";
Log3 $name, 5, "[SamsungAV] $name send to TV: " . $webclient_header;
my $written = syswrite $socket, $webclient_header;
Log3 $name, 3, "[SamsungAV] $name header written with error $!" if (!defined($written));
my $read = sysread $socket, my $buf, 10240;
Log3 $name, 3, "[SamsungAV] $name read response with error $!" if (!defined($read));
Log3 $name, 5, "[SamsungAV] $name first websocket response: $buf";
$buf =~ /^[^ ]+ ([\d]{3})/;
if (!defined($1)) {
$msg = "[SamsungAV] HTTP websocket-connection to $name not successful; undefined response $buf of device";
Log3 $name, 2, $msg;
return $msg;
}
my $sysbytes ="";
$buf = "";
if ($port != 8000) {
do {
$sysbytes .= $buf;
$read = sysread $socket, $buf, 1;
Log3 $name, 3, "[SamsungAV] $name read response with error $!" if (!defined($read));
} until $buf eq "{";
Log3 $name, 5, "[SamsungAV] $name Statusbytes of second websocket response: " . unpack('H*', $sysbytes);
}
$read = sysread $socket, $buf, 10240;
Log3 $name, 3, "[SamsungAV] $name read response with error $!" if (!defined($read));
$buf = "{" . $buf;
Log3 $name, 5, "[SamsungAV] $name data of second websocket response: $buf";
# $read = sysread $socket, $buf, 3;
# Log3 $name, 3, "[SamsungAV] $name data of third read websocket error response: $!, data: ".unpack('H*', $buf)." , bytecount = $read";
# $read = sysread $socket, $buf, 10240;
# Log3 $name, 3, "[SamsungAV] $name data of fourth read websocket response: $buf, bytecount = $read";
if ($1 eq '101') {
if ($port != 8000) {
# my $line = '{"data":{"clients":[{"attributes":{"name":"RkhFTVJlbW90ZQ==","token":"14576607"},"connectTime":1542049383707,"deviceName":"RkhFTVJlbW90ZQ==","id":"c376a63e-61aa-4e73-b72e-7cb26596f9e7","isHost":false}],"id":"c376a63e-61aa-4e73-b72e-7cb26596f9e7","token":"11142450"},"event":"ms.channel.connect"}';
my $json = eval{JSON::decode_json($buf)};
if (defined($json->{data}->{token})) {
# $hash->{token} = $json->{data}->{token}; #temporary
readingsSingleUpdate($hash, ".token", $json->{data}->{token},0); # setKeyValue($name."token", $json->{data}->{token}); #
Log3 $name, 5, "[SamsungAV] $name token: $json->{data}->{token} saved";
}
}
if ($buf =~ /timeOut/) {
$msg = "[SamsungAV] $name connected but authorization timed out. Didn't you see the pop-up on TV ? ";
}
elsif ($buf =~ /unauthorized/) {
$msg = "[SamsungAV] $name connected but authorization failed. Check authorizations of TV";
}
elsif ($buf =~ /touchDisabled/) { # Trs received events ms.remote.touchDisable after committing new authorization request
$msg = "[SamsungAV] $name connected but authorization failed as touchDisabled. Check authorizations of TV. Token deleted.";
readingsDelete($hash, ".token") if (defined($token));
}
else {return ("101", $socket);}
Log3 $name, 3, $msg;
SamsungAV_Tizen_websocket_close($socket);
return $msg;
}
else {
$msg = "[SamsungAV] HTTP websocket-connection to $name not successful; invalid response to websocket upgrade request";
Log3 $name, 2, $msg;
return $msg;
}
}
else {
$msg = "[SamsungAV] HTTP socket-connection to $name not successful. ";
$msg .= "SSL_Error: ". IO::Socket::SSL::errstr() if ($port != 8000);
# $msg = "[SamsungAV] HTTP socket-connection to $name not successful. SSL_Error: ". $IO::SOCKET::SSL::SSL_Error . " SSL_Error: " .$SSL_Error . " IO_Error: " .$socket->error();
Log3 $name, 2, $msg;
return $msg;
}
}
# Samsung Tizen close websocket
sub SamsungAV_Tizen_websocket_close($)
{
my ($socket) = @_;
syswrite $socket, build_frame (0, 1, 0, 0, 0, 0x8, '');
shutdown $socket, 2;
}
# Samsung Tizen write_payload
sub SamsungAV_Tizen_write_payload($$$)
{
my ($socket, $payload, $name) = @_;
syswrite $socket, build_frame (0, 1, 0, 0, 0, 0x1, $payload);
Log3 $name, 5, "[SamsungAV] $name send payload: " . $payload;
}
# Initialization of H-, J-Series with encrypted websocket access
sub SamsungAV_Tizen_Encrypt_Init($$)
{
my ($hash,$name) = @_;
my $dev = $hash->{Host};
my $wsport = $hash->{Port};
my $msg = SamsungAV_Tizen_Encrypt($hash,$name);
return $msg if (defined($msg));
my $millis = int ([gettimeofday] * 1000);
my ($err, $ret) = HttpUtils_BlockingGet ({
url => "http://$dev:$wsport/socket.io/1/?t=$millis",
method => 'GET'
});
if( defined($err) && $err ) {
$msg = "[SamsungAV] $name: Error getting websocket url";
Log3 $name, 2, $msg;
return $msg;
}
unless ($ret =~ m/:websocket,/i) {
$msg = "[SamsungAV] $name: Content error in websocket url $err";
Log3 $name, 2, $msg;
return $msg;
}
my $websocket_url = "ws://$dev:$wsport/socket.io/1/websocket/" . (split(':', $ret))[0];
unless ( $websocket_url =~ /^ws:\/\/([^:\/]+):(\d+)(\/.+)$/ ) {
$msg = "[SamsungAV] $name: Error websocket url $websocket_url";
Log3 $name, 2, $msg;
return $msg;
}
my ($host, $port, $path) = ($1, $2, $3);
Log3 $name, 4, "[SamsungAV] $name: websocket path $path";
return $path;
}
# command encryption of H-, J-Series
sub SamsungAV_Tizen_Encrypt($$)
{
my ($hash,$name) = @_;
my $dev = $hash->{Host};
my $msg;
my $KEYfile = $hash->{NAME} . "_session_key.txt";
#====================================================================================
#Read key and session-id from file, previously created with regapp.pl
my $json; my $enc_key; my $line; my $session = '';
unless ( -e $KEYfile) {
$KEYfile = "samsung_session_key.txt";
}
if (open (KEY, $KEYfile)) {
$line = <KEY>;
close (KEY);
}
else {
$msg = "[SamsungAV] $name: ERROR cannot open file for input the session key.";
Log3 $name, 1, $msg;
return $msg;
}
eval {require Crypt::Rijndael; 1;}
or do {
$msg = "[SamsungAV] $name: Module Crypt::Rijndael not installed. Run 'sudo apt-get install libcrypt-rijndael-perl'";
Log3 $name, 1, $msg;
return $msg;
};
if (JSON::decode_json($line)) {
$json = JSON::decode_json($line);
$enc_key = $json->{session_key}; Log3 $name, 5, "session_key: ".$enc_key;
$session = $json->{session_id}; Log3 $name, 5, "session_id: ".$session;
}
else {
$msg = "[SamsungAV] $name: ERROR: $line is no JSON.";
Log3 $name, 1, $msg;
return $msg;
}
# unhexlify key
$enc_key =~ s/([a-fA-F0-9]{2})/chr(hex($1))/eg;
my ($cipher, $command_bytes, @chars, $int_array, $command);
undef $hash->{".commands"};
foreach (@ARGV) { # generate command array
if ($_ ne "") {
$_ = 'KEY_' . uc($_) if ( $_ !~ m/^KEY_/ );
Log3 $name, 5, "[SamsungAV] $name: generate command for key '$_'";
# generate json
$json = '{"method":"POST","body":{"plugin":"RemoteControl","param1":"uuid:12345","param2":"Click","param3":"' . $_ . '","param4":false,"api":"SendRemoteKey","version":"1.000"}}';
# encrypt json
$json = $json . chr(16 - length($json)%16) x ( 16 - length($json)%16 ); # padding
$cipher = Crypt::Rijndael->new( $enc_key, Crypt::Rijndael::MODE_ECB() );
$command_bytes = $cipher->encrypt($json);
# generate command
@chars = $command_bytes =~ /./sg; foreach (@chars) { $_ = ord($_); }
$int_array = join (',', @chars);
$command = '5::/com.samsung.companion:{"name":"callCommon","args":[{"Session_Id":' . $session . ',"body":"[' . $int_array . ']"}]}';
}
else {$command = $_}
Log3 $name, 5, "[SamsungAV] $name: command: '$command'";
push @{$hash->{".commands"}} , $command; # save command to array
}
return undef;
}
sub build_frame {
my ($masked, $fin, $rsv1, $rsv2, $rsv3, $op, $payload) = @_;
# Head
my $head = $op + ($fin ? 128 : 0);
$head |= 0b01000000 if $rsv1;
$head |= 0b00100000 if $rsv2;
$head |= 0b00010000 if $rsv3;
my $frame = pack 'C', $head;
# Small payload
my $len = length $payload;
if ($len < 126) {
$frame .= pack 'C', $masked ? ($len | 128) : $len;
}
# Extended payload (16-bit)
elsif ($len < 65536) {
$frame .= pack 'Cn', $masked ? (126 | 128) : 126, $len;
}
# Extended payload (64-bit with 32-bit fallback)
else {
$frame .= pack 'C', $masked ? (127 | 128) : 127;
$frame .= pack('NN', 0, $len & 0xffffffff);
#$frame .= MODERN ? pack('Q>', $len) : pack('NN', 0, $len & 0xffffffff);
}
# Mask payload
if ($masked) {
my $mask = pack 'N', int(rand 9 x 7);
$payload = $mask . xor_encode($payload, $mask x 128);
}
return $frame . $payload;
}
# Samsung Tizen Model App list
sub SamsungAV_Tizen_App_list($)
{
my ($hash) = @_;
my $dev = $hash->{Host};
my $port = $hash->{Port};
my $name = $hash->{NAME};
return undef if ($hash->{STATE} ne "on");
my ($msg, $payload, $webclient_header, $socket, $appnames);
($msg, $socket) = &SamsungAV_Tizen_websocket_open($hash,$name);
if ($msg ne "101") {return $msg}
else {
$payload = JSON::encode_json({
"method" => "ms.channel.emit",
"params" => {
"event" => "ed.installedApp.get",
"to" => "host",
"TypeOfRemote" => "SendRemoteKey"
}
});
SamsungAV_Tizen_write_payload($socket, $payload, $name);
sysread $socket, my $buf, 4; # read hex header first
Time::HiRes::usleep(500000); # just to get all data, otherwise crashing FHEM
sysread $socket, $buf, 10240;
Log3 $name, 5, "[SamsungAV] response $name to write_payload: $buf";
SamsungAV_Tizen_websocket_close($socket);
my $json = eval {decode_json($buf)};
if ( ref($json->{data}{data}) eq "ARRAY" ) {
Log3 $name, 5, "[SamsungAV] ARRAY found";
foreach my $rec (@{$json->{data}{data}}) {
# Log3 $name, 3, "[SamsungAV] Application: $rec";
# Log3 $name, 3, "[SamsungAV] Application: $rec->appId";
Log3 $name, 5, '[SamsungAV] Application: ' . $rec->{"name"} . ' Id: ' . $rec->{"appId"};
$rec->{"name"} =~ tr/A-Za-z0-9#.-_//cd; # remove spaces an other characters
$appnames .= $rec->{"name"} . ",";
$hash->{helper}{app}{$rec->{"name"}} = $rec->{"appId"};
}
$hash->{".validcommands"} .= "0_App_start:" . $appnames . " 0_App_state:" . $appnames . " ";
}
else {
Log3 $name, 3, "[SamsungAV] $name timelag to reach all json data for app list might be too small";
}
}
return undef;
}
# Samsung Tizen Model App commands
sub SamsungAV_Tizen_App($$$$)
{
my ($hash, $name, $cmd, $par) = @_;
my $dev = $hash->{Host};
my $port = $hash->{Port};
my ($msg, $payload, $socket,$method,$action_type);
if (substr($cmd,0,5) eq "0_App" && #App command, otherwise internal call(e.g. caller, screen...)
substr($cmd,9,1) ne "r") { #not start command
if (substr($cmd,9,1) ne "p") { #status command
$method = "GET"
}
else {$method = "GET"} #stop command
my $param = {url => "http://$dev:$port/ws/apps/$par",
timeout => 5,
# hash => $hash,
method => $method,
header => "",
# callback => \&SamsungAV_Tizen_App_callback
};
# HttpUtils_NonblockingGet($param);
my ($err, $data) = HttpUtils_BlockingGet($param);
if ($method eq "GET") {
my $stateapp;
if ($data =~ m/running/) {$stateapp = "running"}
else {$stateapp = "stopped"}
$msg = "[SamsungAV] $name: state of app $par: $stateapp";
Log3 $name, 4, $msg;
return $msg;
}
}
else {
# $method = "POST"} #start command ; only useable for selected Apps(Netflix, YouTube) to be used with simple http_request
($msg, $socket) = &SamsungAV_Tizen_websocket_open($hash,$name);
if ($msg ne "101") {return $msg}
else {
# if ($hash->app_type ne "4") {$action_type = "DEEP_LINK"}
# else {$action_type = "NATIVE_LAUNCH"}
my $URI = "";
if ($par ne "Internet") {$action_type = "DEEP_LINK"}
else {
if ( $cmd eq "caller" ) {$URI = AttrVal($name, "callerURI", undef)}
elsif ( $cmd eq "screen" ) {$URI = AttrVal($name, "screenURI", undef)}
Log3 $name, 4, "[SamsungAV] $name browser access with URI: $URI";
$action_type = "NATIVE_LAUNCH"
}
$payload = JSON::encode_json({
"method" => "ms.channel.emit",
"params" => {
"event" => "ed.apps.launch",
"to" => "host",
"data" => {
"appId" => $hash->{helper}{app}{$par},
### "appId" => "org.tizen.browser", # app_type 4 --> $action_type = "NATIVE_LAUNCH"; with link in metaTag possible
## "appId" => "3201710015067", # app_type 1 --> $action_type = "DEEP_LINK"; Universal Guide
## "appId" => "3201710015016", # app_type 1 --> $action_type = "DEEP_LINK"; SmartThings
## "appId" => "3201710015037", # app_type 1 --> $action_type = "DEEP_LINK"; Gallery
# "appId" => "111299001912", # app_type 2 --> $action_type = "DEEP_LINK"; YouTube
# "name" => "YouTube", #doesn't work
"action_type" => $action_type,
"metaTag" => $URI
},
"TypeOfRemote" => "SendRemoteKey"
}
});
SamsungAV_Tizen_write_payload($socket, $payload, $name);
sysread $socket, my $buf, 10240;
Log3 $name, 5, "[SamsungAV] response $name to write_payload: $buf";
SamsungAV_Tizen_websocket_close($socket);
}
}
return undef;
}
# old Samsung Models
sub SamsungAV_52235($@)
{
my ($hash, @a) = @_;
my $name = $hash->{NAME};
my $TV = $hash->{Host};
my $count = @a;
my $arg = lc($a[2]); # mute volume
my $cont1 = ucfirst($arg); # Mute
my $cont2 = "";
my $cont3 = "";
my $cont4 = "";
my $cont5 = "";
my $cont6 = "";
my $cont7 = "";
my $cont8 = "";
my $cont9 = "";
if (defined $a[3]) { $cont2 = $a[3]}
if (defined $a[4]) { $cont3 = $a[4]}
if (defined $a[5]) { $cont4 = $a[5]}
if (defined $a[6]) { $cont5 = $a[6]}
if (defined $a[7]) { $cont6 = $a[7]}
if (defined $a[8]) { $cont7 = $a[8]}
if (defined $a[9]) { $cont8 = $a[9]}
my $head = "";
my $callsoap = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n".
"<s:Envelope s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" >\r\n".
"<s:Body>\r\n";
my $kind = 0;
if ( $arg eq "mute" )
{
$kind = 1;
if ( $cont2 eq "off" ){
$cont2 = 0 ;
}else {
$cont2 = 1 ;
}
}
if ( $arg eq "volume")
{
if ( $cont2 > 0 and $cont2 < 100 ){
$kind = 1;
}else {
Log3 $name, 3, "[SamsungAV] $name Volume: not correct";
$kind = 0;
}
}
if ( $kind eq 1){
$callsoap .= "<ns0:Set$cont1 xmlns:ns0=\"urn:schemas-upnp-org:service:RenderingControl:1\">\r\n";
$callsoap .= "<InstanceID>0</InstanceID>\r\n";
$callsoap .= "<Desired$cont1>$cont2</Desired$cont1>\r\n";
$callsoap .= "<Channel>Master</Channel>\r\n";
$callsoap .= "</ns0:Set$cont1>\r\n";
$head .= "POST /upnp/control/RenderingControl1 HTTP/1.1\r\n";
$head .= "Content-Type: text/xml; charset=\"utf-8\"\r\n";
$head .= "SOAPACTION: \"SoapAction:urn:schemas-upnp-org:service:RenderingControl:1#Set$cont1\"\r\n";
}
else {
my $body = "";
my $operator = "";
my $calldate=`date +"%Y-%m-%d"`;
chomp($calldate);
my $calltime=`date +"%H:%M:%S"`;
chomp($calltime);
# if ( $arg ne "del")
# {
$operator = "Add";
# }
# else
# {
# $kind = 5;
# $operator = "Remove";
# }
$head .= "POST /PMR/control/MessageBoxService HTTP/1.1\r\n";
$head .= "Content-Type: text/xml; charset=\"utf-8\"\r\n";
$head .= "SOAPACTION: \"urn:samsung.com:service:MessageBoxService:1#".$operator."Message\"\r\n";
$callsoap .= "<u:".$operator."Message xmlns:u=\"urn:samsung.com:service:MessageBoxService:1\\\">\r\n";
$callsoap .= "<MessageType>text/xml</MessageType>\r\n";
$callsoap .= "<MessageID>1334799348</MessageID>\r\n";
$callsoap .= "<Message>\r\n";
if ( $arg eq "call")
{
$kind = 2;
$callsoap .= "<Category>Incoming Call</Category>\r\n";
$callsoap .= "<DisplayType>Maximum</DisplayType>\r\n";
$callsoap .= "<CallTime>\r\n";
$callsoap .= "<Date>$calldate</Date>\r\n";
$callsoap .= "<Time>$calltime</Time>\r\n";
$callsoap .= "</CallTime>\r\n";
$callsoap .= "<Callee>\r\n";
$callsoap .= "<Name>An: $cont4</Name>\r\n";
$callsoap .= "<Number>Nr: $cont5</Number>\r\n";
$callsoap .= "</Callee>\r\n";
$callsoap .= "<Caller>\r\n";
$callsoap .= "<Name>Von: $cont2</Name>\r\n";
$callsoap .= "<Number>Nr: $cont3</Number>\r\n";
$callsoap .= "</Caller>\r\n";
}
if ( $arg eq "sms")
{
$kind = 3;
for my $i (6..$count){
$body .= $a[$i];
$body .= " ";
}
$callsoap .= "<Category>SMS</Category>\r\n";