From b8d3166a32b3ad4180eaca10ea4860baefb02422 Mon Sep 17 00:00:00 2001 From: chrisd70 <> Date: Mon, 2 Nov 2015 08:26:30 +0000 Subject: [PATCH] contrib/98_SB_PLAYER: added VoiceRSS and alarm events, updated documentation, fixed cover art git-svn-id: https://svn.fhem.de/fhem/trunk@9752 2b470e98-0d58-463d-a4d8-8e2adae1ed80 --- fhem/contrib/98_SB_PLAYER.pm | 524 +++++++++++++++++++++++------------ 1 file changed, 354 insertions(+), 170 deletions(-) diff --git a/fhem/contrib/98_SB_PLAYER.pm b/fhem/contrib/98_SB_PLAYER.pm index 5b6465450..db76019e0 100644 --- a/fhem/contrib/98_SB_PLAYER.pm +++ b/fhem/contrib/98_SB_PLAYER.pm @@ -11,7 +11,7 @@ # # Written by bugster_de # -# Contributions from: Siggi85, Oliv06, ChrisD, Markus M., Matthew, KernSani +# Contributions from: Siggi85, Oliv06, ChrisD, Markus M., Matthew, KernSani, Heppel # # ############################################################################## # @@ -44,7 +44,7 @@ # DISPLAYTYPE what sort of display is there, if any # # ############################################################################## -# based on 98_SB_PLAYER.pm beta 0043 CD/MM/Matthew +# based on 98_SB_PLAYER.pm 8773 beta 0048 CD/MM/Matthew/Heppel # ############################################################################## package main; @@ -157,6 +157,7 @@ sub SB_PLAYER_Initialize( $ ) { $hash->{AttrList} .= "ttsPrefix "; # DJAlex 665 # CD 0033 $hash->{AttrList} .= "ttsMP3FileDir "; + $hash->{AttrList} .= "ttsAPIKey "; # CD 0045 # CD 0007 $hash->{AttrList} .= "syncVolume "; $hash->{AttrList} .= "amplifierDelayOff "; # CD 0012 @@ -204,6 +205,25 @@ sub SB_PLAYER_Attr( @ ) { "DelayAmplifier:$name", 0 ); } + # CD 0043 start + elsif( $args[ 0 ] eq "amplifierDelayOff" ) { + $hash->{helper}{amplifierDelayOffStop}=0; + $hash->{helper}{amplifierDelayOffPower}=0; + $hash->{helper}{amplifierDelayOffPause}=0; + if( $cmd eq "set" ) { + if (defined($args[1])) { + my @delays=split(',',$args[1]); + $hash->{helper}{amplifierDelayOffStop}=$delays[0]+0 if defined($delays[0]); + $hash->{helper}{amplifierDelayOffPower}=$delays[0]+0 if defined($delays[0]); + $hash->{helper}{amplifierDelayOffPause}=$delays[1]+0 if defined($delays[1]); + } else { + return "missing value for amplifierDelayOff"; + } + } else { + + } + } + # CD 0043 end # CD 0028 elsif( $args[ 0 ] eq "ttsVolume" ) { if( $cmd eq "set" ) { @@ -349,48 +369,50 @@ sub SB_PLAYER_Define( $$ ) { $modules{SB_PLAYER}{defptr}{$uniqueid} = $hash; AssignIoPort( $hash ); - # preset the internals - # can the player power off - $hash->{CANPOWEROFF} = "?"; - # graphical or textual display - $hash->{DISPLAYTYPE} = "?"; - # which model do we see? - $hash->{MODEL} = "?"; - # what's the ip adress of the player - $hash->{PLAYERIP} = "?"; - # the name of the player as assigned by the server - $hash->{PLAYERNAME} = "?"; - # the last alarm we did set - $hash->{LASTALARM} = 1; - # the reference to the favorites list - $hash->{FAVREF} = " "; - # the command for selecting a favorite - $hash->{FAVSET} = "favorites"; - # the entry in the global hash table - $hash->{FAVSTR} = "not,yet,defined "; - # the selected favorites - $hash->{FAVSELECT} = "not"; - # last received answer from the server - $hash->{LASTANSWER} = "none"; - # for sync group (multi-room) - $hash->{SYNCMASTER} = "?"; - $hash->{SYNCGROUP} = "?"; - $hash->{SYNCED} = "?"; - # seconds until sleeping - $hash->{WILLSLEEPIN} = "?"; - # the list of potential sync masters - $hash->{SYNCMASTERS} = "not,yet,defined"; - # is currently playing a remote stream - $hash->{ISREMOTESTREAM} = "?"; - # the server side playlists - $hash->{SERVERPLAYLISTS} = "not,yet,defined"; - # the URL to the artwork - $hash->{ARTWORKURL} = "?"; - $hash->{COVERARTURL} = "?"; - $hash->{COVERID} = "?"; - # the IP and Port of the Server - $hash->{SBSERVER} = "?"; - + if (!defined($hash->{OLDDEF})) { # CD 0044 + # preset the internals + # can the player power off + $hash->{CANPOWEROFF} = "?"; + # graphical or textual display + $hash->{DISPLAYTYPE} = "?"; + # which model do we see? + $hash->{MODEL} = "?"; + # what's the ip adress of the player + $hash->{PLAYERIP} = "?"; + # the name of the player as assigned by the server + $hash->{PLAYERNAME} = "?"; + # the last alarm we did set + $hash->{LASTALARM} = 1; + # the reference to the favorites list + $hash->{FAVREF} = " "; + # the command for selecting a favorite + $hash->{FAVSET} = "favorites"; + # the entry in the global hash table + $hash->{FAVSTR} = "not,yet,defined "; + # the selected favorites + $hash->{FAVSELECT} = "not"; + # last received answer from the server + $hash->{LASTANSWER} = "none"; + # for sync group (multi-room) + $hash->{SYNCMASTER} = "?"; + $hash->{SYNCGROUP} = "?"; + $hash->{SYNCED} = "?"; + # seconds until sleeping + $hash->{WILLSLEEPIN} = "?"; + # the list of potential sync masters + $hash->{SYNCMASTERS} = "not,yet,defined"; + # is currently playing a remote stream + $hash->{ISREMOTESTREAM} = "?"; + # the server side playlists + $hash->{SERVERPLAYLISTS} = "not,yet,defined"; + # the URL to the artwork + $hash->{ARTWORKURL} = "?"; + $hash->{COVERARTURL} = "?"; + $hash->{COVERID} = "?"; + # the IP and Port of the Server + $hash->{SBSERVER} = "?"; + } + # preset the attributes # volume delta settings if( !defined( $attr{$name}{volumeStep} ) ) { @@ -425,9 +447,9 @@ sub SB_PLAYER_Define( $$ ) { # link to the text2speech engine if( !defined( $attr{$name}{ttslink} ) ) { $attr{$name}{ttslink} = "http://translate.google.com" . - "/translate_tts?ie=UTF-8"; + "/translate_tts?ie=UTF-8&tl=&q=&client=tw-ob"; # CD 0045 Format geändert, &client=t&prev=input hinzugefügt, CD 0048 client=tw-ob verwenden } - + # turn on the server when player is used if( !defined( $attr{$name}{serverautoon} ) ) { $attr{$name}{serverautoon} = "true"; @@ -567,13 +589,26 @@ sub SB_PLAYER_Define( $$ ) { $hash->{READINGS}{state}{TIME} = $tn; } + # mrbreil 0047 start + if( !defined( $hash->{READINGS}{currentTrackPosition}{VAL} ) ) { + $hash->{READINGS}{currentTrackPosition}{VAL} = 0; + $hash->{READINGS}{currentTrackPosition}{TIME} = $tn; + } + # mrbreil 0047 end + $hash->{helper}{ttsstate}=TTS_IDLE; # CD 0028 - - SB_PLAYER_LoadPlayerStates($hash) if($SB_PLAYER_hasDataDumper==1); # CD 0036 - - $hash->{helper}{playerStatusOK}=0; # CD 0042 - $hash->{helper}{playerStatusOKCounter}=0; # CD 0042 - + + if (!defined($hash->{OLDDEF})) { # CD 0044 + SB_PLAYER_LoadPlayerStates($hash) if($SB_PLAYER_hasDataDumper==1); # CD 0036 + + $hash->{helper}{playerStatusOK}=0; # CD 0042 + $hash->{helper}{playerStatusOKCounter}=0; # CD 0042 + + $hash->{helper}{amplifierDelayOffStop}=0; # CD 0043 + $hash->{helper}{amplifierDelayOffPower}=0; # CD 0043 + $hash->{helper}{amplifierDelayOffPause}=0; # CD 0043 + } + # do and update of the status InternalTimer( gettimeofday() + 10, "SB_PLAYER_GetStatus", @@ -624,6 +659,23 @@ sub SB_PLAYER_QueryElapsedTime($) { } # CD 0014 end +# CD 0047 start +sub SB_PLAYER_tcb_QueryElapsedTime( $ ) { + my($in ) = shift; + my(undef,$name) = split(':',$in); + my $hash = $defs{$name}; + + SB_PLAYER_QueryElapsedTime($hash); + RemoveInternalTimer( "QueryElapsedTime:$name"); + if (ReadingsVal($name,"playStatus","x") eq "playing") { + InternalTimer( gettimeofday() + 5, + "SB_PLAYER_tcb_QueryElapsedTime", + "QueryElapsedTime:$name", + 0 ); + } +} +# CD 0047 end + # CD 0028 start sub SB_PLAYER_tcb_TTSRestore( $ ) { my($in ) = shift; @@ -765,7 +817,7 @@ sub SB_PLAYER_Parse( $$ ) { } elsif( $cmd eq "mode" ) { my $updateSyncedPlayers=0; # CD 0039 - # alittle more complex to fulfill FHEM Development guidelines + # a little more complex to fulfill FHEM Development guidelines Log3( $hash, 5, "SB_PLAYER_Parse($name): mode:$cmd args:$args[0]" ); if( $args[ 0 ] eq "play" ) { # CD 0014 start @@ -776,6 +828,13 @@ sub SB_PLAYER_Parse( $$ ) { readingsBulkUpdate( $hash, "playStatus", "playing" ); SB_PLAYER_Amplifier( $hash ); SB_PLAYER_QueryElapsedTime( $hash ); # CD 0014 + # CD 0047 start + RemoveInternalTimer( "QueryElapsedTime:$name"); + InternalTimer( gettimeofday() + 5, + "SB_PLAYER_tcb_QueryElapsedTime", + "QueryElapsedTime:$name", + 0 ); + # CD 0047 end } # CD 0014 # CD 0029 start if(defined($hash->{helper}{ttsOptions}{logplay})) { @@ -812,6 +871,8 @@ sub SB_PLAYER_Parse( $$ ) { # CD 0028 end readingsBulkUpdate( $hash, "playStatus", "stopped" ); SB_PLAYER_Amplifier( $hash ); + RemoveInternalTimer( "QueryElapsedTime:$name"); # CD 0047 + readingsBulkUpdate( $hash, "currentTrackPosition", 0 ); # CD 0047 $updateSyncedPlayers=1; # CD 0039 gesyncte Player aktualisieren } elsif( $args[ 0 ] eq "pause" ) { readingsBulkUpdate( $hash, "playStatus", "paused" ); @@ -1082,16 +1143,25 @@ sub SB_PLAYER_Parse( $$ ) { delete($hash->{helper}{recallPending}); SB_PLAYER_SetTTSState($hash,TTS_IDLE,1,1); IOWrite( $hash, "$hash->{PLAYERMAC} play 300\n" ); - IOWrite( $hash, "$hash->{PLAYERMAC} time $hash->{helper}{savedPlayerState}{elapsedTime}\n" ); + IOWrite( $hash, "$hash->{PLAYERMAC} time $hash->{helper}{recallPendingElapsedTime}\n" ); # CD 0047, Position setzen korrigiert + delete($hash->{helper}{recallPendingElapsedTime}); # CD 0047 } } elsif( $args[ 0 ] eq "loadtracks" ) { if(defined($hash->{helper}{recallPending})) { delete($hash->{helper}{recallPending}); SB_PLAYER_SetTTSState($hash,TTS_IDLE,1,1); IOWrite( $hash, "$hash->{PLAYERMAC} play 300\n" ); - IOWrite( $hash, "$hash->{PLAYERMAC} time $hash->{helper}{savedPlayerState}{elapsedTime}\n" ); + IOWrite( $hash, "$hash->{PLAYERMAC} time $hash->{helper}{recallPendingElapsedTime}\n" ); # CD 0047, Position setzen korrigiert + delete($hash->{helper}{recallPendingElapsedTime}); # CD 0047 } # CD 0014 end + # CD 0048 start + } elsif( $args[ 0 ] eq "path" ) { + delete $hash->{helper}{path} if defined($hash->{helper}{path}); + if(defined($args[ 1 ]) && ($args[ 1 ] eq "0")) { + $hash->{helper}{path}=$args[ 2 ] if defined($args[ 2 ]); + } + # CD 0048 end } else { } # check if this caused going to play, as not send automatically @@ -1165,12 +1235,16 @@ sub SB_PLAYER_Parse( $$ ) { } elsif( $cmd eq "alarm" ) { if( $args[ 0 ] eq "sound" ) { # fired when an alarm goes off + DoTrigger($name,"alarmSound ".SB_PLAYER_FindAlarmId($hash, $args[ 1 ])); # CD 0046 } elsif( $args[ 0 ] eq "end" ) { # fired when an alarm ends + DoTrigger($name,"alarmEnd ".SB_PLAYER_FindAlarmId($hash, $args[ 1 ])); # CD 0046 } elsif( $args[ 0 ] eq "snooze" ) { # fired when an alarm is snoozed by the user + DoTrigger($name,"alarmSnooze ".SB_PLAYER_FindAlarmId($hash, $args[ 1 ])); # CD 0046 } elsif( $args[ 0 ] eq "snooze_end" ) { # fired when an alarm comes back from snooze + DoTrigger($name,"alarmSnoozeEnd ".SB_PLAYER_FindAlarmId($hash, $args[ 1 ])); # CD 0046 } elsif( $args[ 0 ] eq "add" ) { # fired when an alarm has been added. # this setup goes wrong, when an alarm is defined manually @@ -1426,6 +1500,7 @@ sub SB_PLAYER_Parse( $$ ) { } elsif( $cmd eq "time" ) { $hash->{helper}{elapsedTime}{VAL}=$args[ 0 ]; $hash->{helper}{elapsedTime}{TS}=gettimeofday(); + readingsBulkUpdate( $hash, "currentTrackPosition",int($args[ 0 ]+0.5)); # CD 0047 delete($hash->{helper}{saveLocked}) if (($hash->{helper}{ttsstate}==TTS_IDLE) && defined($hash->{helper}{saveLocked})); } elsif( $cmd eq "playlist_tracks" ) { readingsBulkUpdate( $hash, "playlistTracks", $args[ 0 ] ); @@ -1708,7 +1783,7 @@ sub SB_PLAYER_Get( $@ ) { if( $cmd eq "?" ) { my $res = "Unknown argument ?, choose one of " . - "volume " . $hash->{FAVSET} . " savedStates "; + "volume " . $hash->{FAVSET} . " savedStates alarmPlaylists"; # CD 0045 alarmPlaylists hinzugefügt return( $res ); } elsif( ( $cmd eq "volume" ) || ( $cmd eq "volumeStraight" ) ) { @@ -1727,6 +1802,16 @@ sub SB_PLAYER_Get( $@ ) { } return( $out ); # CD 0036 end + # CD 0045 start + } elsif( $cmd eq 'alarmPlaylists' ) { + my $out=""; + if (defined($hash->{helper}{alarmPlaylists})) { + foreach my $e ( keys %{$hash->{helper}{alarmPlaylists}} ) { + $out.=$hash->{helper}{alarmPlaylists}{$e}{title}."\n"; + } + } + return( $out ); + # CD 0045 end } else { my $msg = "SB_PLAYER_Get: $name: unkown argument"; Log3( $hash, 5, $msg ); @@ -1787,7 +1872,7 @@ sub SB_PLAYER_Notify( $$ ) { } # CD 0036 start - if( grep(m/^SAVE$/, @{$dev_hash->{CHANGED}}) ) { + if( grep(m/^SAVE$|^SHUTDOWN$/, @{$dev_hash->{CHANGED}}) ) { # CD 0043 auch bei SHUTDOWN speichern SB_PLAYER_SavePlayerStates($hash) if($SB_PLAYER_hasDataDumper==1); } # CD 0036 end @@ -1864,6 +1949,7 @@ sub SB_PLAYER_Set( $@ ) { "alarmsSnooze:slider,0,1,30 alarmsTimeout:slider,0,5,90 alarmsDefaultVolume:slider,0,1,100 alarmsFadeIn:on,off alarmsEnabled:on,off " . # CD 0016, von MM übernommen, Namen geändert "cliraw talk sayText " . # CD 0014 sayText hinzugefügt "unsync:noArg " . + "currentTrackPosition " . # CD 0047 hinzugefügt "resetTTS:noArg "; # CD 0028 hinzugefügt # add the favorites $res .= $hash->{FAVSET} . ":-," . $hash->{FAVSTR} . " "; # CD 0014 '-' hinzugefügt @@ -2095,9 +2181,9 @@ sub SB_PLAYER_Set( $@ ) { # Device überhaupt verwendbar ? if(defined($extTTS[1]) && defined($defs{$extTTS[1]})) { my $ttshash=$defs{$extTTS[1]}; - if(defined($ttshash->{TYPE}) && ($ttshash->{TYPE} eq 'Text2SpeechSB')) { + if(defined($ttshash->{TYPE}) && (($ttshash->{TYPE} eq 'Text2SpeechSB') || (($ttshash->{TYPE} eq 'Text2Speech') && defined($ttshash->{helper}{supportsSBPlayer})))) { # CD 0048 Text2Speech (ohne SB) unterstützen if(defined($ttshash->{ALSADEVICE}) && ($ttshash->{ALSADEVICE} eq 'SB_PLAYER')) { - if (AttrVal($hash->{NAME}, "TTS_Ressource", "Google") eq "Google") { + if ((AttrVal($hash->{NAME}, "TTS_Ressource", "x") =~ /$(Google|VoiceRSS|SVOX-pico)^/)) { # CD 0048 Default geändert, VoiceRSS und SVOX-pico hinzugefügt $useText2Speech=1; $hash->{helper}{text2speech}{name}=$extTTS[1]; $hash->{helper}{text2speech}{pathPrefix}=join(':',@extTTS[2..$#extTTS]) if defined($extTTS[2]); @@ -2127,7 +2213,7 @@ sub SB_PLAYER_Set( $@ ) { return; } } else { - $errMsg = "SB_PLAYER_Set: ".$extTTS[1].": attribute TTS_Ressource must be set to Google"; + $errMsg = "SB_PLAYER_Set: ".$extTTS[1].": Text2Speech uses unsupported TTS_Ressource"; # CD 0048 Text angepasst } } else { $errMsg = "SB_PLAYER_Set: ".$extTTS[1].": Text2Speech uses unsupported ALSADEVICE"; @@ -2196,7 +2282,7 @@ sub SB_PLAYER_Set( $@ ) { $w =~ s/[\\|*~<>^\n\(\)\[\]\{\}[:cntrl:]]/ /g; $w =~ s/\s+/ /g; $w =~ s/^\s|\s$//g; - $w =~ s/($Sonderzeichenkeys)/$Sonderzeichen{$1}/g; + $w =~ s/($Sonderzeichenkeys)/$Sonderzeichen{$1}/g if(AttrVal( $name, "ttslink", "x" ) !~ m/voicerss/i); # CD 0045 Sonderzeichen für VoiceRSS nicht ersetzen # CD 0032 end if((length($tl)+length($w)+1)<100) { $tl.=' ' if(length($tl)>0); @@ -2245,11 +2331,41 @@ sub SB_PLAYER_Set( $@ ) { } else { $outstr =~ s/\s/+/g; $outstr = uri_escape( $outstr ); - $outstr = AttrVal( $name, "ttslink", "none" ) - . "&tl=" . AttrVal( $name, "ttslanguage", "de" ) - . "&q=". $outstr; - Log3($hash, defined($hash->{helper}{ttsOptions}{debug})?0:6,"SB_PLAYER_Set: $name: add to ttsqueue: $outstr"); # CD 0036 - push(@{$hash->{helper}{ttsqueue}},$outstr); + # CD 0045 + my $ttslink=AttrVal( $name, "ttslink", "" ); + if(defined($ttslink)) { + # Profile + my $lang=AttrVal( $name, "ttslanguage", "de" ); + if ($ttslink =~ m/voicerss/i) { # CD 0047 Sprache auch bei voicerss innerhalb der URL anpassen + $lang="de-de" if($lang eq "de"); + $lang="en-us" if($lang eq "en"); + $lang="fr-fr" if($lang eq "fr"); + } + + $ttslink="http://translate.google.com/translate_tts?ie=UTF-8&tl=&q=&client=tw-ob" if ($ttslink eq 'http://translate.google.com/translate_tts?ie=UTF-8'); # CD 0047, CD 0048 client=tw-ob verwenden + $ttslink="http://translate.google.com/translate_tts?ie=UTF-8&tl=&q=&client=tw-ob" if ($ttslink eq "Google"); # CD 0048 client=tw-ob verwenden + $ttslink="http://api.voicerss.org/?key=&src=&hl=" if ($ttslink eq "VoiceRSS"); + + # alte Links anpassen + if($ttslink !~ m//) { + $ttslink.="&tl=" if($ttslink !~ m//); + $ttslink.="&q="; + } + + $ttslink =~ s//$lang/; + $ttslink =~ s//$outstr/; + + my $apikey=AttrVal( $name, "ttsAPIKey", undef ); + if(($ttslink =~ m//) && !defined($apikey)) { + Log3($hash, 2,"SB_PLAYER_Set: $name: talk - missing API key"); + SB_PLAYER_SetTTSState($hash,TTS_IDLE,0,0); + } else { + $ttslink =~ s//$apikey/; + + Log3($hash, defined($hash->{helper}{ttsOptions}{debug})?0:6,"SB_PLAYER_Set: $name: add to ttsqueue: $ttslink"); # CD 0036 + push(@{$hash->{helper}{ttsqueue}},$ttslink); + } + } } } @@ -2518,6 +2634,12 @@ sub SB_PLAYER_Set( $@ ) { } } elsif( $cmd eq "resetTTS" ) { SB_PLAYER_SetTTSState($hash,TTS_IDLE,0,1); + # CD 0047 start + } elsif( lc($cmd) eq "currenttrackposition" ) { + if(defined($arg[0])) { + IOWrite( $hash, "$hash->{PLAYERMAC} time $arg[0]\n" ); + } + # CD 0047 end } else { my $msg = "SB_PLAYER_Set: unsupported command given"; Log3( $hash, 3, $msg ); @@ -2657,16 +2779,22 @@ sub SB_PLAYER_Recall($$) { # CD 0030 start IOWrite( $hash, "$hash->{PLAYERMAC} playlist clear\n"); my @playlistIds=split(',',$hash->{helper}{savedPlayerState}{$statename}{playlistIds}); + my $f=0; # CD 0048 for my $id (@playlistIds) { if($id>=0) { IOWrite( $hash, "$hash->{PLAYERMAC} playlistcontrol cmd:add track_id:".$id."\n"); } else { if(defined($hash->{helper}{savedPlayerState}{$statename}{playlistUrls}) && defined($hash->{helper}{savedPlayerState}{$statename}{playlistUrls}{$id})) { - IOWrite( $hash, "$hash->{PLAYERMAC} playlist add ".$hash->{helper}{savedPlayerState}{$statename}{playlistUrls}{$id}."\n"); + if (defined($hash->{helper}{savedPlayerState}{$statename}{path}) && ($f==0)) { # CD 0048 + IOWrite( $hash, "$hash->{PLAYERMAC} playlist add ".$hash->{helper}{savedPlayerState}{$statename}{path}."\n"); # CD 0048 + } else { # CD 0048 + IOWrite( $hash, "$hash->{PLAYERMAC} playlist add ".$hash->{helper}{savedPlayerState}{$statename}{playlistUrls}{$id}."\n"); + } # CD 0048 } else { Log3( $hash, 2, "SB_PLAYER_Recall: $name: no url found for id ".$id); } } + $f=1; # CD 0048 } IOWrite( $hash, "$hash->{PLAYERMAC} playlist index ".$hash->{helper}{savedPlayerState}{$statename}{playlistCurrentTrack}."\n"); # CD 0030 end @@ -2719,6 +2847,7 @@ sub SB_PLAYER_Recall($$) { # paused kann nicht aus stop erreicht werden -> Playlist starten und dann pausieren $hash->{helper}{recallPause}=1; $hash->{helper}{recallPending}=1; + $hash->{helper}{recallPendingElapsedTime}=$hash->{helper}{savedPlayerState}{$statename}{elapsedTime}; # CD 0047 } } # CD 0028 restore names @@ -2783,6 +2912,7 @@ sub SB_PLAYER_Save($$) { $hash->{helper}{savedPlayerState}{$statename}{volumeStraight}=ReadingsVal($name,"volumeStraight","?"); $hash->{helper}{savedPlayerState}{$statename}{playlist}=ReadingsVal($name,"playlists","-"); $hash->{helper}{savedPlayerState}{$statename}{favorite}=ReadingsVal($name,"favorites","-"); + $hash->{helper}{savedPlayerState}{$statename}{path}=$hash->{helper}{path}; # CD 0048 # CD 0029 start delete($hash->{helper}{ttsOptions}{logloaddone}) if(defined($hash->{helper}{ttsOptions}{logloaddone})); @@ -3158,6 +3288,8 @@ sub SB_PLAYER_GetStatus( $ ) { IOWrite( $hash, "$hash->{PLAYERMAC} playerpref syncVolume ?\n" ); # CD 0009 IOWrite( $hash, "$hash->{PLAYERMAC} playlist name ?\n" ); + # CD 0048 + IOWrite( $hash, "$hash->{PLAYERMAC} playlist path 0 ?\n" ); # CD 0014 IOWrite( $hash, "$hash->{PLAYERMAC} duration ?\n" ); SB_PLAYER_QueryElapsedTime($hash); @@ -3238,6 +3370,15 @@ sub SB_PLAYER_RecBroadcast( $$@ ) { 0 ); } elsif( $args[ 0 ] eq "IP" ) { $hash->{SBSERVER} = $args[ 1 ]; + # CD 0043 bei Änderung von Adresse oder Port COVERART aktualisieren + readingsBeginUpdate( $hash ); + SB_PLAYER_CoverArt( $hash ); + if( AttrVal( $name, "donotnotify", "false" ) eq "true" ) { + readingsEndUpdate( $hash, 0 ); + } else { + readingsEndUpdate( $hash, 1 ); + } + # CD 0043 end } else { # unkown broadcast message } @@ -3487,7 +3628,24 @@ sub SB_PLAYER_ParseAlarms( $@ ) { } } +# CD 0046 start +# ---------------------------------------------------------------------------- +# search for LMS alarm id, return FHEM alarm number +# ---------------------------------------------------------------------------- +sub SB_PLAYER_FindAlarmId( $$ ) { + my ( $hash, $id ) = @_; + my $name = $hash->{NAME}; + my $n=0; + for (my $i=0;$i<=$hash->{helper}{ALARMSCOUNT};$i++) { + if (ReadingsVal($name,"alarm".$i."_id","xxxx") eq $id) { + $n=$i; + last; + } + } + return $n; +} +# CD 0046 # ---------------------------------------------------------------------------- # used for checking, if the string contains a valid MAC adress @@ -3553,6 +3711,7 @@ sub SB_PLAYER_Amplifier( $ ) { } my $setvalue = "off"; + my $delayAmp=0.01; # CD 0043 Log3( $hash, 4, "SB_PLAYER_Amplifier($name): called" ); @@ -3562,10 +3721,16 @@ sub SB_PLAYER_Amplifier( $ ) { Log3( $hash, 5, "SB_PLAYER_Amplifier($name): with mode play " . "and status:$thestatus" ); - if( ( $thestatus eq "playing" ) || ( $thestatus eq "paused" ) ) { + if( ( $thestatus eq "playing" ) || (( $thestatus eq "paused" ) && ($hash->{helper}{amplifierDelayOffPause}==0)) ) { # CD 0043 DelayOffPause abfragen $setvalue = "on"; + # CD 0043 start + } elsif(( $thestatus eq "paused" ) && ($hash->{helper}{amplifierDelayOffPause}>0)) { + $setvalue = "off"; + $delayAmp=$hash->{helper}{amplifierDelayOffPause}; + # CD 0043 end } elsif( $thestatus eq "stopped" ) { $setvalue = "off"; + $delayAmp=$hash->{helper}{amplifierDelayOffStop}; # CD 0043 } else { $setvalue = "off"; } @@ -3579,6 +3744,7 @@ sub SB_PLAYER_Amplifier( $ ) { $setvalue = "on"; } else { $setvalue = "off"; + $delayAmp=$hash->{helper}{amplifierDelayOffPower}; # CD 0043 } } else { Log3( $hash, 1, "SB_PLAYER_Amplifier($name): ATTR amplifier " . @@ -3593,15 +3759,21 @@ sub SB_PLAYER_Amplifier( $ ) { if ( $actualState ne $setvalue) { # CD 0012 start - Abschalten über Attribut verzögern, generell verzögern damit set-Event funktioniert - my $delayAmp=($setvalue eq "off")?AttrVal( $name, "amplifierDelayOff", 0 ):0.1; + # my $delayAmp=($setvalue eq "off")?AttrVal( $name, "amplifierDelayOff", 0 ):0.1; # CD 0043 deaktiviert, wird oben behandelt $delayAmp=0.01 if($delayAmp==0); if (!defined($hash->{helper}{AMPLIFIERDELAYOFF})) { - Log3( $hash, 5, 'SB_PLAYER_Amplifier($name): delaying amplifier on/off' ); - RemoveInternalTimer( "DelayAmplifier:$name"); - InternalTimer( gettimeofday() + $delayAmp, - "SB_PLAYER_tcb_DelayAmplifier", # CD 0014 Name geändert - "DelayAmplifier:$name", - 0 ); + # CD 0043 Timer nicht neu starten wenn Zustand sich nicht geändert hat + if ((!defined($hash->{helper}{AMPLIFIERACTIVETIMER})) || ($hash->{helper}{AMPLIFIERACTIVETIMER} ne ($actualState.$setvalue))) { + Log3( $hash, 5, "SB_PLAYER_Amplifier($name): delaying amplifier on/off by $delayAmp" ); + RemoveInternalTimer( "DelayAmplifier:$name"); + InternalTimer( gettimeofday() + $delayAmp, + "SB_PLAYER_tcb_DelayAmplifier", # CD 0014 Name geändert + "DelayAmplifier:$name", + 0 ); + $hash->{helper}{AMPLIFIERACTIVETIMER}=$actualState.$setvalue; # CD 0043 + } else { + Log3( $hash, 5, "SB_PLAYER_Amplifier($name): delay already active" ); + } return; } # CD 0012 end @@ -3614,6 +3786,7 @@ sub SB_PLAYER_Amplifier( $ ) { "state change" ); } delete($hash->{helper}{AMPLIFIERDELAYOFF}) if (defined($hash->{helper}{AMPLIFIERDELAYOFF})); + delete($hash->{helper}{AMPLIFIERACTIVETIMER}) if (defined($hash->{helper}{AMPLIFIERACTIVETIMER})); # CD 0043 return; } @@ -3960,6 +4133,7 @@ sub SB_PLAYER_ParsePlayerStatus( $$ ) { $hash->{helper}{elapsedTime}{VAL}=$2; $hash->{helper}{elapsedTime}{TS}=gettimeofday(); delete($hash->{helper}{saveLocked}) if (($hash->{helper}{ttsstate}==TTS_IDLE) && defined($hash->{helper}{saveLocked})); + readingsBulkUpdate( $hash, "currentTrackPosition", int($2+0.5) ); # CD 0047 next; } elsif( $cur =~ /^(playlist_tracks:)(.*)/ ) { readingsBulkUpdate( $hash, "playlistTracks", $2 ); @@ -4224,26 +4398,26 @@ sub SB_PLAYER_LoadPlayerStates($) =pod =begin html - +

SB_PLAYER

    Define
      - define <name> SB_PLAYER <player_mac_adress> [<ampl>] [<coverart>] + define <name> SB_PLAYER <player_mac_address> [ampl:<ampl>] [coverart:<coverart>]

      - This module allows you to control Squeezebox Media Players connected with a defined Logitech Media Server. An SB_SERVER device is needed to work.
      - Normally you don't need to define your SB_PLAYERS because autocreate will do that if enabled.

      + This module controls Squeezebox Media Players connected to a defined Logitech Media Server. A SB_SERVER device is required.
      + Usually SB_PLAYER devices are created automatically by autocreate.

        -
      • <player_mac_adress>: Mac adress of the player found in the LMS.
        • -

      +
    • <player_mac_address>: Mac address of player as seen by LMS.
      • +

    Optional

      -
    • <[ampl]>: You can define an FHEM Device to command when an on or off event is received. With the attribute - amplifier you can specify whether to command the selected FHEM Device on on|off or play|stop.
      • -
    • <[coverart]>: You can define an FHEM weblink. The player will update the weblink with the current coverart. - Useful for putting coverarts in the floorplan.
      • +
    • <[ampl]>: A FHEM device to switch on or off when relevant events are received. The attribute + amplifier specifies whether to switch this device upon reception of on/off or play/pause/stop events.
      • +
    • <[coverart]>: A FHEM weblink to be updated with the current coverart. + This may be used to show coverart in a floorplan.


@@ -4252,119 +4426,129 @@ sub SB_PLAYER_LoadPlayerStates($)
    set <name> <command> [<parameter>]

    - This module supports the following commands:
    SB_Player related commands:

      -
    • play - starts the playback (might only work if previously paused).
      • -
    • pause [<0|1>] - toggles between play and pause. With parameter 0 it unpauses and with 1 it pauses the player, it doesn't matter which state it had before
      • -
    • stop - stops the playback
      • -
    • next|channelUp - jumps to the next track
      • -
    • prev|channelDown - jumps to the previous track or the beginning of the current track.
      • -
    • mute - toggles between muted and unmuted
      • -
    • volume <n> - sets the volume to <n>. <n> must be a number between 0 and 100
      • +
    • play - start playback (might not work unless previously paused).
      • +
    • pause [<0|1>] - toggle between play and pause states. “pause 1” and “pause 0” respectively pause and resume play unconditionally.
      • +
    • stop - stop playback
      • +
    • next|channelUp - next track
      • +
    • prev|channelDown - previous track or the beginning of the current track.
      • +
    • mute - toggle mute.
      • +
    • volume <n> - set volume to <n>. <n> must be a number between 0 and 100
    • volumeStraight <n> - same as volume
    • volumeDown <n> - volume down
    • volumeUp <n> - volume up
      • -
    • on - sets the player on if possible. Otherwise it does play
      • -
    • off - sets the player off if possible. Otherwise it does stop
      • -
    • shuffle on|off|song|album - Enables/Disables shuffle mode
      • -
    • repeat one|all|off - Sets the repeat mode
      • -
    • sleep <n> - Sets the player off in <n> seconds and fade the player volume down
      • -
    • favorites <favorit> - Empties the current playlist and starts the selected playlist. Favorites are selectable through a dropdown list
      • -
    • talk|sayText <text> - Saves the current playlist, speaks the selected text with google TTS and resumes saved playlist
      • -
    • playlist track|album|artist|genre|year <x> - Empties the current playlist and starts the track, album or artist <x>
      • -
    • playlist genre:<genre> artist:<artist> album:<album> - Empties the current playlist and starts the track which will match the search. You can use * as wildcard for everything.
      • +
    • on - turn player on if possible. Issue play command otherwise.
      • +
    • off - turn player off if possible. Issue stop command otherwise.
      • +
    • shuffle on|off|song|album - Enable/Disable shuffle mode.
      • +
    • repeat one|all|off - Set repeat mode.
      • +
    • sleep <timespec> - Set player off after <timespec> has expired, fading player volume down. <timespec>'s format is hh:mm:ss.
      • +
    • favorites <favorite> - Empty current playlist and start <favorite>. The frontend may make favorites selectable by a dropdown list.
      • +
    • talk|sayText <text> - Save the playlist, speak <text> using Google TTS and resume saved playlist.
      • +
    • playlist track|album|artist|genre|year <x> - Empty current playlist and play given argument.
      • +
    • playlist genre:<genre> artist:<artist> album:<album> - Empty current playlist and play all tracks matching the parameters. A * acts as a wildcard for everything.

      • Example:
      set myplayer playlist genre:* artist:Whigfield album:*

      -
    • playlist play <filename|playlistname> - Empties the current playlist and starts the track or playlist
      • -
    • playlist add <filename|playlistname> - Adds the specified file or playlist at the end of the current playlist
      • -
    • playlist insert <filename|playlistname> - Inserts the specified file or playlist after the current song - in the current playlist.
      • -
    • statusRequest - Update of all readings
      • -
    • sync <playerName[,playerName...]> [new|asSlave] - Syncs with other players for multiroom function. Other players are selectable - through a dropdown list. The shown player is the master. Options:
      • -
        -
      • new - creates a new group with the selected players instead of adding to existing group
        • -
      • asSlave - adds player as slave to a player/group
        • -

      +
    • playlist play <filename|playlistname> - Empty current playlist and start the track or playlist.
      • +
    • playlist add <filename|playlistname> - Add the specified file or playlist at the end of the current playlist.
      • +
    • playlist insert <filename|playlistname> - Insert specified file or playlist after the current track into + the current playlist.
      • +
    • statusRequest - Update all readings.
      • +
    • sync <playerName[,playerName...]> [new|asSlave] - Put playerName(s) into this player's multiroom group. Remove playerName(s) from their existing group(s) if necessary. Options:
      • +
        +
      • new - create a new group, removing this player from any group.
        • +
      • asSlave - add this player to a player or existing group
        • +

      Examples:
      - set playerA sync playerB    adds playerB to playerA's group
      - set playerA sync playerB,playerC,playerD    adds playerB, C and D to playerA's group
      - set playerA sync playerB new    creates a new group with playerA and B, playerA is master
      - set playerA sync playerB asSlave    adds playerA to playerB's group

      -
    • unsync - Unsyncs the player from multiroom group
      • -
    • playlists - Empties the current playlist and starts the selected playlist. Playlists are selectable through a dropdown list
      • -
    • cliraw <command> - Sends the <command> to the LMS CLI for selected player
      • -
    • save [name] - Saves the current player state
      • -
    • recall [name] [options] - Recalls a saved player state, options:
      • -
        -
      • del - delete saved state after restore
        • -
      • delonly - delete saved state without restoring
        • -
      • off - ignore saved power setting, turn player off after restore
        • -
      • on - ignore saved power setting, turn player on after restore
        • -
      • play - ignore saved play state, start playing after restore
        • -
      • stop - ignore saved play state, stop player after restore
        • -
      -
    • show <line1> <line2> <duration> - displays text on the player
      • -
        -
      • line1 - Text for first line
        • -
      • line2 - Text for second line
        • -
      • duration - Duration for apperance in seconds
        • + set playerA sync playerB    add playerB to playerA's group
        + set playerA sync playerB,playerC,playerD    add playerB, C and D to playerA's group
        + set playerA sync playerB new    create a new group with playerA and B
        + set playerA sync playerB asSlave    add playerA to playerB's group

        +
      • unsync - Remove this player from any multiroom group
        • +
      • playlists - Empty current playlist and start selected playlist.
        • +
      • cliraw <command> - Tell LMS to execute <command> using its command line interface.
        • +
      • save [name] - Save player state
        • +
      • recall [name] [options] - Recall a saved player state. Options:
        • +
          +
        • del - delete saved state after restore
          • +
        • delonly - delete saved state without restoring
          • +
        • off - ignore saved power setting, turn player off after restore
          • +
        • on - ignore saved power setting, turn player on after restore
          • +
        • play - ignore saved play state, start playing after restore
          • +
        • stop - ignore saved play state, stop playing after restore
          • +
        +
      • show <line1> <line2> <duration> - show text on player
        • +
          +
        • line1 - First line
          • +
        • line2 - Second line
          • +
        • duration - Duration of display in seconds
          • +
      -
    -
    Alarms
    + +
    Alarms
      - You can define up to 2 alarms. - set sbradio alarm1 set <weekday> <time> -
    • <weekday> - Number of weekday. The week starts with Sunday and is 0
      • -
    • <time> - Timeformat HH:MM[:SS]
      • - Example:
      - set sbradio alarm1 set 5 12:23:17
      -set sbradio alarm2 set 4 17:18:00       -
    • alarm<1|2> delete - Delete alarm
      • -
    • alarm<1|2> volume <n> - Set volume for alarm to <n>
      • -
    • alarm<1|2> <enable|disable> - Enable or disable alarm
      • -
    • allalarms <enable|disable> - Enable or disable all alarms
      • + Multiple alarms may be defined. +
    • allalarms add <weekdays> <alarm time> <playlist|URL> - Add a new alarm
      • +
      <weekdays> - Active days for this alarm. Format: [0..7|daily|all]
      + 0..6 for Sunday (0) through Saturday (6), 7 for every day
      + The first two letters of the english or german names may be used to specify days instead of a single digit. (Su/So, Mo, Tu/Di, We/Mi, Th/Do, Fr, Sa)
      + <alarm time> Alarm time specified as hh:mm[:ss]

      + Example:
      + set player allalarms add 1DiWe 06:30 AlarmPlaylist - Add a new alarm to sound playlist AlarmPlaylist every Monday through Wednesday at 06:30

      +
    • allalarms enable|disable - Set global enable/disable flag. Setting this to "disable" effectively turns off all alarms. Setting this to "enable" allows alarms to honor their individual flags.
      • +
    • allalarms delete - Delete all alarms.
      • +
    • allalarms statusRequest - Update status of all alarms.
      • +
    • alarmsSnooze <minutes> - Set duration of any snooze in minutes.
      • +
    • alarmsTimeout <minutes> - Set duration of alarms in minutes. Setting this to 0 will disable the automatic timeout.
      • +
    • alarmsDefaultVolume <vol> - Set default volume level (0-100) of alarms. This can be overridden by individual levels per alarm.
      • +
    • alarmsFadeIn on|off - Whether alarms should fade in on this player
      • +
    • alarmsEnabled on|off - Whether any alarm can sound on this player. Set to off to prevent any alarm from sounding; on to allow them to sound
      • +
      +
    • alarm<X> delete - Delete alarm <X>
      • +
    • alarm<X> volume <n> - Set volume for alarm <X> to <n>
      • +
    • alarm<X> enable|disable - Enable or disable alarm <X>
      • +
    • alarm<X> sound <playlist|URL> - Define playlist or URL to be sounded by alarm <X>
      • +
    • alarm<X> repeat 0|off|no|1|on|yes - Specify one-shot or repeating alarm
      • +
    • alarm<X> wdays <weekdays> - Specify active days for alarm <X>. Format: [0..7|daily|all]
      + 0..6 for Sunday (0) through Saturday (6), 7 for every day
      + The first two letters of the english or german names may be used to specify days instead of a single digit. (Su/So, Mo, Tu/Di, We/Mi, Th/Do, Fr, Sa)
      • +
    • alarm<X> time hh:mm[:ss] - Define alarm time
      • +

- -
- - Generated Readings
-
    -
  • READING - READING DESCRIPTIONS
    • /* CHECK TODO -


Attributes
  • IODev
    - The name of the SB_SERVER device to which this player is connected.

    • -
  • donotnotify
    - Disables all events from the device. Must be explicitly set to false to enable events.

    • + Name of the SB_SERVER device controlling this player. +
  • do_not_notify
  • volumeLimit
    - Sets the volume limit of the player between 0 and 100. 100 means the function is disabled.

    • + Upper limit for volume setting by FHEM.
  • amplifier
    - Defines how a configured amplifier will be controlled. If set to on, the amplifier will be turned on and off with the - player. If set to play the amplifier will be turned on on play and off on stop.

    • + Configure trigger for amplifier device. Possible values: +
      +
    • on: Switch on "on" and "off" events.
      • +
    • play: Switch on "play", "pause" and "stop" events.
      • +
    +
  • amplifierDelayOff
    - Sets the delay in seconds before turning the amplifier off after the player has stopped or been turned off.

    • + Delay in seconds before turning the amplifier off after the player has stopped or been turned off. A second comma separated delay optionally enables switching off the amplifier after receiving a pause event.
  • updateReadingsOnSet
    - If set to true most readings are immediately updated when a set command is executed without waiting for the reply from the server.

    • + If set to true, most readings are immediately updated when a set command is executed without waiting for a reply from the server.
  • statusRequestInterval
    - Defines the interval in seconds for the automatic status request. Default: 300

    • + Interval in seconds for automatic status requests. Default: 300
  • ttsDelay
    - Delay in seconds before starting text to speech playback. If two values, separated by comma, are given, the first is used if - the player is on, the second if the player is off.

    • + Delay in seconds before starting text to speech playback. A second comma separated delay may optionally be given to be used if the player is off.
  • ttsMP3FileDir
    - The directory which should be used as a default for text-embedded MP3-Files.

    • + Directory to be used by default for text-embedded MP3-Files.
  • ttsPrefix
    - Text prepended to every text to speech output

    • + Text prepended to every text to speech output
  • ttsVolume
    - Volume for text to speech, if not set the current volume will be used. If the attribute ttsoptions contains ignorevolumelimit - the defined volume limit will be ignoerd for text to speech

    • + Volume for text to speech. Defaults to current volume. If the attribute ttsoptions contains ignorevolumelimit + any volume limit will be ignored for text to speech
=end html