Sonos2mqtt

Grundeinrichtung

Die Grundeinrichtung ist bereits im Artikel MQTT2-Module - Praxisbeispiele beschrieben. Hier soll es um die praktische Verwendung und Erweiterung gehen.

Für alle Erweiterungen wird versucht vorhandene Devices in FHEM zu verwenden.

Viele Dinge werden derzeit noch entwickelt und können frei gestaltet werden - der Vorteil von generischen FHEM Devices.

Tipps zur Verwendung

Die automatische Konfiguration setzt den alias entsprechend dem im Sonos vergeben Namen . Die langen MQTT2_RINCON_ Namen sind unhandlich und schlecht lesbar. Man kann Player mit einem devspec ansprechen, das simpelste ist:

set alias=Büro play

Oder alle Player

set model=sonos2mqtt_speaker leaveGroup

Konfiguration der Player

Mit dem Template sonos_bridge_comfort wird aus dem contrib Ordner eine Datei 99_sonos2mqttUtils.pm nachgeladen und aktiviert. Darin befindet sich der wesentliche Code, die sonos2mqtt Geräte selbst enthalten nur rudimentäre Aufrufe.

Selbstverständlich kann man diese Datei jederzeit selbst gestalten (FHEM Menu:Edit Files) aber man sollte beachten, dass eine erneute Anwendung des Templates die Datei überschreibt.

Man kann auch jederzeit diese Datei aus dem SVN neu laden:

{ Svn_GetFile("contrib/AttrTemplate/99_sonos2mqttUtils.pm", "FHEM/99_sonos2mqttUtils.pm", sub(){ CommandReload(undef, "99_sonos2mqttUtils") }) }

Hauptroutine ist sonos2mqtt die mit zwei Parametern aufgerufen wird. {sonos2mqtt($NAME,$EVENT)}

Die Optik des Players wird mit der Routine sonos2mqtt_devStateIcon bestimmt.

Man kann die Player mittels attr a:model=sonos2mqtt_speaker webCmd volume mit einem Slider in der Übersicht ausstatten.

Ändert man die Sonoslandschaft, kann man auch alles einreißen und neu erzeugen lassen. Zunächst alles löschen (für die FHEM Kommandozeile):

{fhem("delete a:model=sonos2mqtt_speaker;;delete FileLog_MQTT2_RINCON.*");;qx(rm ./log/MQTT2_RINCON_*);;return ""}

Danach muss man sonos2mqtt einfach neu starten: pm2 start ... bzw den docker container neu starten.

Befehle nachrüsten

Um Befehle in der setList / getList / readingList nachzurüsten gibt es die Routine sonos2mqtt_mod_list(devspec,attrName,line)

Vorhandene Zeilen werden ersetzt. Identifiziert wird nur der erste Teil bis zum ":". Beispiel für die Kommandozeile:

{sonos2mqtt_mod_list('a:model=sonos2mqtt_bridge','readingList','sonos/RINCON_([0-9A-Z]+)/Reply:.* Reply')}

Sprachausgabe

Man hat zwei Möglichkeiten, dies umzusetzen:

1. Text2Speech FHEM intern
2. Mit dem sonos text to speech Server https://svrooij.io/sonos2mqtt/

Text2Speech Variante einrichten

Zwei zusätzliche Geräte sind notwendig:

• Text2Speech im Servermodus, erzeugt mp3 Dateien im cache Verzeichnis und legt einen Link im Reading httpName ab.
• Ein HTTP Server stellt die Dateien im gleichen Verzeichnis bereit

Hinweis: Für die vollständige Funktion und Installation von Text2Speech ist die Commandref zu beachten! Für das unten im Beispiel verwendete Feature UseMP3Wrap muss das Tool mp3wrap installiert werden (z.B. apt install mp3wrap). Dies ist bei längeren Texten und bei der Verwendung von eingebetteten festen Sounds existenziell!

Für die Funktion ist wichtig, dass das Sonos System den Host im Link zur Datei richtig auflösen kann. Deshalb wird der Hostname und Port des Servers im Reading host des TTS Device als Name oder IP Adresse abgelegt! Dies kann entweder mit dem hier gezeigten Befehl oder vollständig manuell erfolgen. Für FHEM innerhalb Docker muss man die Adresse des Docker Host angeben.

defmod SonosTTS Text2Speech none
attr SonosTTS TTS_UseMP3Wrap 1
attr SonosTTS TTS_Language Deutsch
attr SonosTTS userReadings httpName:lastFilename.* {'http://'.ReadingsVal($name,'host','set host:port first').'/fhem/'.ReadingsVal($name,'lastFilename','')}
attr SonosTTS TTS_CacheFileDir cache
setreading SonosTTS host {(qx(hostname -s|tr -d '\n').':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host {((split(' ', qx(hostname -I)))[0].':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host <hostname>:<port>

defmod SonosSpeakWeb HTTPSRV cache cache SonosSpeakWeb

Der Sprachausgabe Befehl im Player Device läuft in 3 Schritten:

1. mit dem TTS Gerät wird die mp3 Datei erzeugt,
2. mit dem sleep wird auf die Fertigstellung gewartet,
3. die Datei wird mit set Player notify volume uri abgespielt.

Durch den "sonos2mqtt notify" Befehl wird die laufende Umgebung wiederhergestellt.

• Wird der Sprachbefehl an den Gruppenmaster gesendet wird die mp3 Datei in der gesamten Gruppe gespielt.
• Wird der Sprachbefehl an ein Mitglied einer Gruppe gesendet (nicht den Master) wird die Gruppe aufgetrennt und später wieder hergestellt.

Es sind zwei Befehle zur Sprachausgabe eingebaut:

sayText Befehl

Dieser Befehl orientiert sich an den FHEM DevelopmentGuidelines und sammelt "gleichzeitig" eintreffende Sprachnachrichten, damit nichts verloren geht. Informationen im Forum dazu in diesem Beitrag.

Die Lautstärke wird separat in SonosTTS gesetzt: setreading SonosTTS vol 15, ebenso die Sprache (einmalig bei der Einrichtung oder bei Bedarf zwischendurch) attr SonosTTS TTS_Language Deutsch

Hinweis: Der Befehl set SonosTTS volume xx hat im Servermodus des Devices keine Wirkung!

Speak Befehl

Dieser Befehl ist ähnlich wie der in der FHEM-Sonos Umgebung:

set Player speak <volume> text

Verwendet man diesen Syntax (mit Sprache und Stimme am Anfang), wird automatisch der speak Befehl an die sonos-tts abgesetzt. Die sonos-tts muss man separat installieren/integrieren!

set EG.KU.Sonos speak de-DE Vicki 25 Test

Will man keine laufenden Sendung unterbrechen sondern einfach eine Ansage machen und danach etwas starten, kann man so vorgehen:

set SonosTTS tts Hier steht die Ansage;sleep SonosTTS:playing:.0 ; set alias=PlayerAlias playUri [SonosTTS:httpName]

Volume Befehl

Der Befehl akzeptiert einen zweiten Wert als Startwert d.h. set volume 25 10 setzt sofort auf 10 und startet dann fading auf 25. Ein zweiter Wert -1 erzeugt ein fading vom aktuellen Wert auf den angegebenen.

Spiele feste Sounds

Generell kann man feste mp3 Dateien (Klingeltöne, Klänge usw.) auch im cache Verzeichnis ablegen und direkt mit dem Link starten.

Es gibt zahlreiche Soundquellen im Internet, ist der gewünschte Sound dabei, kann man ihn innerhalb FHEM herunterladen und an Ort und Stelle platzieren. (Beispiel ohne und mit Umbennung)

"wget -qP ./cache https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
"wget -qO ./cache/KlingelTon.mp3 https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"

Vergewissern ob der gewünschte Sound auch da ist: {qx(ls -lha ./cache)}

Mit set magic kann man dabei einfach Teile aus anderen Readings holen.

set alias=Büro notify 25 {('http://[SonosTTS:host]/fhem/cache/KlingelTon.mp3')}

Man kann auch den setter im Gerät erweitern {sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList',q(playSound:textField ....))} :

playSound:textField {my $tts="SonosTTS";my ($cmd,$vol,$file)=split(' ', $EVENT,3);$file=($file=~m/.*\.mp3$/)?"$file":"$file.mp3";fhem("set $NAME notify $vol http://[$tts:host]/fhem/[a:$tts:TTS_CacheFileDir]/$file")}

Damit sind dann dieser Syntax möglich:

set alias=Büro playSound 40 KlingelTon.mp3

oder ohne Dateiendung (wird auf .mp3 gesetzt)

set alias=Büro playSound 40 KlingelTon

SonosBridge

Die SonsoBridge enthält bereits ein paar zentrale Funktionen und Readings, z.B. wird beim Laden der Favoritenliste ein Reading favlist und grouplist erzeugt, welches zur Erweiterung der Player mit Auswahllisten dienen kann.

Player mit Favoritenliste und Gruppenliste ausstatten

Wenn nicht schon geschehen muss man jetzt die Favoriten zum ersten Mal einlesen:

get SonosBridge Favorites

Nachdem die SonosBridge "aufgerüstet" ist, kann man allen Playern die Favoritenliste zum Auswählen eintragen. Beide Zeile sind für die FHEM Kommandozeile und verwenden die Routine aus der 99_sonos2mqttUtils.

{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','joinGroup:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'grouplist','').q( {sonos2mqtt($NAME,$EVENT)}))}
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','playFav:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'favlist','').q( {sonos2mqtt($NAME,$EVENT)}))}

Man kann den playFav Befehl auch im set Befehl mit einem Teil des Favoriten Namen verwenden. Enthält die Favoritenliste z.B. Radio Leipzig würde der auch mit diesem Befehl angesteuert werden:

set alias=Bad playFav leipzig

Listen der Favoriten Radios und Playlist erstellen

Im Sonos System kann man an (mindestens) drei Stellen Favoriten hinterlegen: Sonos-Favoriten, Sonos-Playlisten, TuneIn: Meine Radiosender

Diese drei Listen kann man einlesen und für die einfache Suche und Auswahl verwenden. Der play Befehl akzeptiert dazu zwei weitere Parameter und sucht in den entsprechenden Listen.

Diese play Befehle starten nicht sofort, sondern erst nach einem folgenden set ... play. Damit kann man etwas vorbereiten und gezielt starten.

set alias=Büro play Favorite Deutschlandfunk

set alias=Büro play Radio HitRadio

set alias=Büro play Playlist Meine Hits

Die Sonos-Favoriten-, TuneIn: Meine Radiosender- und Sonos-Playlisten dazu vom Sonos System einmalig (bzw. bei Veränderungen) einlesen:

get SonosBridge Reply Playlists;sleep SonosBridge:Reply.*;setreading SonosBridge Playlists [SonosBridge:Reply]
get SonosBridge Reply Favorites;sleep SonosBridge:Reply.*;setreading SonosBridge Favorites [SonosBridge:Reply]
get SonosBridge Reply Radios;sleep SonosBridge:Reply.*;setreading SonosBridge Radios [SonosBridge:Reply]

Beispiel für ein Guten Morgen Radio:

set alias=BadWanne,alias=Kueche joinGroup Bad;
set alias=BadWanne,alias=Bad volume 13 6;
set alias=Bad play Favorite Deutschlandfunk.Kultur.RP;
set alias=Kueche volume 18 8;
sleep 0.2;set alias=Bad play

Radioliste durchtasten

Will man eine Liste von bestimmten Radiostationen mit einem Taster "durchtasten" kann man das wie folgt tun:

Das oben erwähnte 99_sonos2mqttUtils.pm (ab 6.1.2023) schreibt die Radios aus dem Reading Favoriten in das userReading favlist im SonosBridge Device und aktualisiert das auch.

Der Befehl zum weiterschalten

Jedes Mal wenn dieser Befehl ausgeführt wird, wird der nächste "Radio-Favorit" (aus dem userReading favlist des SonosBridge Devices) gestartet.

Erfolgt die Ausgabe eines Radiosender, wird bei einem set sonos2mqtt_speaker next auf den nächsten Sender in dieser Liste geschaltet und der transportState beibehalten.

Name der Radiostation vor dem Umschalten ansagen

Will man vor dem Radiostart noch die Ansage des Senders haben, geht das zwar auch mit dem speak Befehl, die direkte Ausgabe ohne Restore der Umgebung (sonos2mqtt notify) ist aber effektiver.

Damit das funktioniert müssen wir die Events einschränken:

attr model=sonos2mqtt_speaker event-on-change-reading .*
{my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',''));;my $play = (devspec2array('alias=Büro'))[0];;my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r;;sleep $tts:playing:.0;;set $play playUri [$tts:httpName];;sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED;;set $play playFav $r")}

Kurze Erklärung zum Code

• ermittelt den nächsten Radiosender in der Liste: my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',''))
• ermitteln des Namens des sonos2mqtt_speaker Devices anhand des alias Attributes: my $play = (devspec2array('alias=Büro'))[0]
• erzeugt die Ansage "Es folgt SenderXY": my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r
• wenn die mp3 Datei fertig erzeugt ist: sleep $tts:playing:.0, wird sie mit dem Befehl playUri an den oben ermittelten sonos2mqtt_speaker gesendet: set $play playUri [$tts:httpName]
• es wird eine Eventfolge abgewartet -> play / PLAYING / STOPPED: sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED
• danach wird der Radiosender gestartet: set $play playFav $r

Der Code ist so einfach und relativ "steif" für die Kommandozeile. Man kann das auch in einen Setter packen (set sonos2mqtt_speaker toggleRadio). Dazu den Text unten in das Attribut setList des sonos2mqtt_speaker Devices hinzufügen:

toggleRadio:noArg {my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];my $r=Each($dev,ReadingsVal($dev,'favlist',''));my $tts="SonosTTS";fhem("set $tts tts Es folgt $r;sleep $tts:playing:.0;set $NAME playUri [$tts:httpName];sleep $NAME:play;sleep $NAME:PLAYING;sleep $NAME:STOPPED;set $NAME playFav $r")}

Dokumentationen und weitere Entwicklungen

ToDo

Erweiterung um Alarmhandling siehe Forum