SONOS: Unterschied zwischen den Versionen

SONOS
Zweck / Funktion
	Sonos-System Anbindung an Fhem
Allgemein
Typ	Gerätemodul
Details
Dokumentation	EN / DE
Support (Forum)	Multimedia
Modulname	00_SONOS.pm und 21_SONOSPLAYER.pm
Ersteller	Reinerlein
	Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!

Version vom 31. Dezember 2014, 14:37 Uhr

Dieses Anwendungsbeispiel soll den Einstieg in die Steuerung der heimischen Zoneplayer der Firma Sonos erleichtern. Es werden die Verwendung und Einrichtung der dazugehörenden Module SONOS und SONOSPLAYER beschrieben, und einige Beispiele für eine mehr oder weniger sinnvolle Nutzung von Events und Steuerungsmöglichkeiten gegeben. Sollte etwas fehlen oder unklar sein, dann einfach eine kurze Nachricht an den Autor.

! Achtung !

Obwohl die Module in Fhem mitgeliefert werden, sind trotzdem die Vorbedingungen bzgl. der Perl-Installation einzuhalten, da das Modul sonst nicht lauffähig ist.

Kurzüberblick

Hier soll nur ein kurzer Überblick über die mittlerweile doch recht umfangreichen Möglichkeiten geboten werden:

Automatisches Erkennen aller ZonePlayer im lokalen Netzwerk. Dabei werden alle Player einer Paarung zusammengehörig benannt und gruppiert
Automatische Aktualisierung aller aktuellen (und wenn verfügbar: der nächsten) Titelinformationen innerhalb von FHEM
- Dabei wird für jede veränderte Information ein Event erzeugt, man kann also dediziert darauf reagieren
- Bei normalen Abspiellisten werden auch die Informationen zum nächsten Titel ermittelt und angezeigt
- Es können auch verschiedene Zusammenfassungen der bestehenden Informationen zusammengestellt werden
Anzeige des aktuellen (oder auch nächsten) Covers als Weblink
Steuern der ZonePlayer: Play, Pause, Nächster Titel, Vorheriger Titel, Lautstärke Lauter/Leiser (auch als Rampe), Stummschalten
Alle Player auf einen Befehl hin stoppen oder pausieren lassen
Einstellen und Abfragen der Abspielparameter Repeat, Shuffle, CrossfadeMode, Loudness, Bass und Treble
Festlegen einer minimalen und maximalen Lautstärke für jeden ZonePlayer (getrennt zwischen Normalbetrieb und Kopfhörernutzung)
Laden und Speichern von Playlisten (auch M3U-Dateien aus dem Filesystem)
Abspielen eines Sonos-Favoriten (z.B. Playlist, Spotify-Playlist, Titel, Radiosender, usw.)
Abspielen beliebiger Titel (auch von Freigaben, die nicht von Sonos indiziert wurden)
Abspielen beliebiger Radiostationen über deren HTTP-Link
Hinzufügen beliebiger Titel und Radiostationen zur aktuellen Abspielliste
Temporäres Abspielen von Dateien, mit nachfolgender Wiederherstellung des vorherigen Titels inkl. genauer Position im vorherigen Titel und der Lautstärke
Erzeugen und temporäres Abspielen von Sprachdurchsagen auf Basis von eingegebenen Texten
- Wird standardmäßig über die Google-Übersetzungsmaschine realisiert
- Kann auch über eine eigenständige, lokale Installation realisiert werden
Auslesen und Setzen/Starten der verfügbaren gespeicherten Playlisten, Radiofavoriten und Sonos-Favoriten
Erzeugung und Bearbeitung von Alarmen, sowie Event bei Veränderung der Alarme duch andere Controller
Setzen des Sleeptimer inkl. Fhem-Event bei Veränderung durch andere Controller und Ablauf des Timers
Setzen und Auslesen der Gruppierungskonfiguration, sowie einzelnes Hinzufügen und Entfernen von Gruppenmitgliedern
Bildung und Trennung von Stereopaaren
Erzeugen von Events nach festgelegten Tastensequenzen (am Player)
Umbenennen der Zonen und festlegen der Zonenicons
Standardanzeige eines Player als ReadingsGroup mit automatischem Titel- und Coverwechsel sowie einer RemoteControl zum Steuern
Anzeigemöglichkeit einer Vollbilddarstellung ähnlich dem Original-Controller

Kurze Anmerkungen zur Sonos-Landschaftsgestaltung

Es ist im allgemeinen besser, die Sonos-Landschaft mit allen Paarungen vor dem Einrichten des Moduls zu erzeugen. Dieses Modul benennt die Player nach den Zonennamen und der jeweiligen Funktion des Players innerhalb der Paarungs-Zone.

Das bedeutet aber auch, dass in diesem Augenblick möglichst keine Player gruppiert sein sollten (mehrere Zonen spielen dasselbe ab), da diese sonst komische Namen erhalten könnten (es geht hier ausschliesslich um die Fhem-interne Device-Benennung, natürlich bleiben die Zoneplayer selbst wie sie sind).
Insbesondere gilt das für temporäre Stereopaare. Diese nicht ständigen Paare sollten erst getrennt werden, bis das Modul alle Player erkannt hat.

Damit man nun eine einigermaßen passende Bezeichnung in Fhem erhält, sollte also die Gestaltung der Sonos-Player abgeschlossen sein. Natürlich funktioniert das System nach einer Fhem-Einrichtung und anschließender Sonos-Umbenennung immer noch, da intern alles mittels der eindeutigen Bezeichner gehandhabt wird, allerdings wird es u.U. etwas unübersichtlich bzgl. der Fhem-Device-Namen. Diese passen dann nicht mehr zu den Zonennamen (die entsprechenden Readings werden aber natürlich korrekt besetzt), was man aber natürlich auch nachträglich wieder anpassen kann.

Einbindung von Sonos in FHEM

Die Einbindung erfolgt über die beiden Module SONOS und SONOSPLAYER. Dabei ist Hauptsächlich das Modul SONOS einzurichten. Alle Zoneplayer werden automatisch erkannt, und dann entsprechend angelegt:

define <Devicename> SONOS <Hostname:Port> [[[Prüfintervall] WaitTime] DelayTime]

Beispiele für die Einbindung

define Sonos SONOS localhost:4711 30

Der Name dieses Devices ist automatisch das Namensprefix beim Anlegen der SonosPlayer. In diesem Fall werden alle erkannten Zoneplayer mit dem Prefix "Sonos_" anfangen. Natürlich kann man das nach dem Anlegen einfach umbenennen.
Als Prüfintervall wurde hier 30s angegeben. Wenn kein Intervall angegeben wird, dann werden 10s verwendet.

define Sonos SONOS localhost:4711 30 1

Hier wurde eine verkürzte Wartezeit für den Subprozess von einer Sekunde angegeben. Bei schnellen Systemen wird dadurch der gesamte Startmechanismus schneller verarbeitet.
Wenn nichts angegeben wird, dann wird 8s verwendet.

define Sonos SONOS localhost:4711 30 1 5

Hier wurde noch eine zusätzliche Verzögerung von 5s eingebaut, da manche Systeme bei einem Fhem-Restart oder ähnlichem die belegten Ports nicht schnell genug wieder freigibt.
Hier kann diese Verzögerung helfen, da erst nach Ablauf dieser Zeitspanne ein Verbindungsversuch zm SubProzess unternommen wird (und auch erst dann der Versuch einen eigenen Prozess zu Starten unternommen wird).
Wenn nichts angegeben wird, dann wird keine Verzögerung durchgeführt.

Automatische Zoneplayererkennung

Erkannte Zoneplayer werden als SONOSPLAYER-Device angelegt:

define Sonos_Wohnzimmer SONOSPLAYER RINCON_000E5828D0F401400_MR

Der Name des Device wird aus dem Namen des SONOS-Device und dem Namen der Zone gebildet. Dabei werden Leer- und Sonderzeichen in "_" umgewandelt.

Beim Anlegen werden automatisch einige Attribute mit angelegt, am Beispiel eines Wohnzimmer-Players:

attr Sonos_Wohnzimmer generateInfoSummarize1 <NormalAudio><Artist prefix="(" suffix=")"/>
		<Title prefix=" '" suffix="'" ifempty="[Keine Musikdatei]"/>
		<Album prefix=" vom Album '" suffix="'"/></NormalAudio> 
		<StreamAudio><Sender suffix=":"/><SenderCurrent prefix=" '" suffix="' -"/>
		<SenderInfo prefix=" "/></StreamAudio>
attr Sonos_Wohnzimmer generateInfoSummarize2 <TransportState/><InfoSummarize1 prefix=" => "/>
attr Sonos_Wohnzimmer generateInfoSummarize3 <Volume prefix="Lautstärke: "/>
		<Mute instead=" ~ Kein Ton" ifempty=" ~ Ton An" emptyval="0"/>
		 ~ Balance: <Balance ifempty="Mitte" emptyval="0"/>
		<HeadphoneConnected instead=" ~ Kopfhörer aktiv" 
			ifempty=" ~ Kein Kopfhörer" emptyval="0"/>
attr Sonos_Wohnzimmer icon icoSONOSPLAYER_icon-ZP90.png
attr Sonos_Wohnzimmer room Sonos
attr Sonos_Wohnzimmer stateVariable InfoSummarize2
attr Sonos_Wohnzimmer webCmd Play:Pause:Previous:Next:VolumeD:VolumeU:MuteT
attr Sonos_Wohnzimmer group Wohnzimmer

Dadurch ist dieses Device direkt in der FHEM-Oberfläche steuerbar. Auch hier gilt, dass man das natürlich anpassen kann. Das sollen nur vereinfachende Vorgaben sein. Das Attribut "room" wird wieder aus dem Namen des SONOS-Device gebildet. Das Attribut "group" wird aus dem Namen der Zone gebildet

Außerdem wird eine ReadingsGroup angelegt, mit der die Titel- und Coverinformation übersichtlich in der Raumübersicht dargestellt werden:

define Sonos_WohnzimmerRG ReadingsGroup Sonos_Wohnzimmer:\
	<{SONOS_getCoverTitleRG($DEVICE)}@infoSummarize2>
attr Sonos_WohnzimmerRG room Sonos
attr Sonos_WohnzimmerRG group Wohnzimmer
attr Sonos_WohnzimmerRG sortby 2
attr Sonos_WohnzimmerRG noheading 1
attr Sonos_WohnzimmerRG nonames 1

Damit gibt es durch Klick auf das Cover des aktuellen Titels auch die Vollbilddarstellung ähnlich dem Original-Controller.

Zu guter Letzt wird noch ein RemoteControl angelegt, um das Device direkt über die Oberfläche steuern zu können:

define Sonos_WohnzimmerRC remotecontrol
attr Sonos_WohnzimmerRC room hidden
attr Sonos_WohnzimmerRC group Sonos
attr Sonos_WohnzimmerRC rc_iconpath icons/remotecontrol
attr Sonos_WohnzimmerRC rc_iconprefix black_btn_
attr Sonos_WohnzimmerRC row00 Play:PLAY,Pause:PAUSE,Previous:REWIND,Next:FF,VolumeD:VOLDOWN\
	,VolumeU:VOLUP,MuteT:MUTE

define Sonos_WohnzimmerRC_Notify notify Sonos_WohnzimmerRC set Sonos_Wohnzimmer $EVENT

define Sonos_WohnzimmerRC_Weblink weblink htmlCode {fhem("get Sonos_WohnzimmerRC htmlcode", 1)}
attr Sonos_WohnzimmerRC_Weblink room Somos
attr Sonos_WohnzimmerRC_Weblink group Wohnzimmer
attr Sonos_WohnzimmerRC_Weblink sortby 3

Namensvergabe der automatischen Erkennung

Der automatische Erkennungsmechanismus vergibt Devicenamen auf Basis der Zonennamen und der Funktion eines Players innerhalb eines Stereopaares oder einer Surroundkonstellation. Dabei wird immer ein Player (der Master dieser Konstellationen) nur den Namen der Zone erhalten (ohne Anhängekürzel) und die anderen werden mit Kürzel versehen. Dadurch ist der Master der Zone automatisch dasjenige Playerdevice, welches gesteuert werden muss. Alle anderen Player leiten Steueranfragen automatisch an den Master weiter. Besteht eine Zone nur aus einem Player, so gibt es natürlich auch nur diesen einen als Master.

Als Anhängekürzel wird immer der Inhalt des Readings fieldType verwendet.

Bei der Funktion gibt es später dann zwei Fälle zu unterscheiden:

Stereopaare werden von Sonos intern als Gruppe behandelt. Das bedeutet, dass der zweite Player (der nicht-Master) immer PLAYING als Status anzeigt, und nur der Master den korrekten Wert. Stereopaare haben, wie normale Gruppen oder Einzelplayer auch, eine Verzögerung von 70ms zu einem Eingangssignal.
Surroundsysteme werden als Satelliten angebunden, und werden vom Modul nur mit intialized angegeben, da Sonos für diese nie eine Statusmeldung sendet. Diese Playersysteme haben eine verkürzte Verzögerung von 30ms zu einem Eingangssignal.

Dabei ist ein Eingangsignal so etwas wie ein Line-In- oder SPDIF-Eingang.

Beispiel für eine Zonenlandschaft

Folgende Landschaft mit Status könnte es geben:

Sonos_Schlafzimmer      (STOPPED => [Keine Musikdatei])
Sonos_Schlafzimmer_RF   (PLAYING =>  'Keine Titelinformation bei Gruppenwiedergabe')
Sonos_Kinderzimmer      (PAUSED_PLAYBACK =>  'Titelinformation')
Sonos_Gaestezimmer      (STOPPED => [Keine Musikdatei])
Sonos_Wohnzimmer        (STOPPED => [Keine Musikdatei])
Sonos_Wohnzimmer_LR     (initialized)
Sonos_Wohnzimmer_RR     (initialized)
Sonos_Wohnzimmer_SW     (initialized)

Dabei wäre Schlafzimmer ein Stereopaar, Kinder- und Gästezimmer jeweils ein einzelner Player und Wohnzimmer z.B. eine Playbar mit zwei Rear-Lautsprechern und Subwoofer. In keiner Zone läuft eine aktive Wiedergabe. Hier kann man schön die einzelnen Zustände und die erzeugten Namen erkennen.

Hardwarevoraussetzungen

Diese Liste sollte im Laufe der Zeit fortgeführt werden. Es soll die Hardware-/Softwarevoraussetzungen festhalten, um Probleme im Vorfeld erkennen zu können.

Funktionierende Kombinationen:

Windows, ActivePerl (zusätzliche Pakete sollten dort mit Hilfe des mitgelieferten, grafischen Paketmanagers installiert werden)
Raspberry Pi, Default-Perl

Problematische Kombinationen:

FritzBox: Anscheinend ist Perl dort ohne Thread-Möglichkeit kompiliert. Diese sind aber essentiell notwendig für dieses Modul.

Softwarevoraussetzungen

Für die Verwendung sind Perlmodule notwendig, die unter Umständen noch nachinstalliert werden müssen:

LWP::Simple
LWP::UserAgent
SOAP::Lite
HTTP::Request

Die Installation dieser Module geht in der Regel per CPAN. Das bedeutet das zum Beispiel mit

sudo cpan LWP::Simple

das Modul "LWP::Simple" installiert wird. Wenn man bereits als Benutzer root arbeitet, dann ist das sudo natürlich nicht nötig.

Sollte es bei der Installation mittels CPAN zu Problemen kommen, dann folgt hier eine Beschreibung der manuellen Installation.

Hinweis für Debian-Systeme

Bei Debian-basierten Systemen (also auch Raspbian für den Raspberry Pi usw.) kann auch mittels

sudo apt-get install <paketname>

installiert werden. Manchmal ist es etwas schwieriger, die Paketnamen zu ermitteln, aber Google ist da sehr hilfreich.

Hier mal die Liste für die oben genannten Pakete:

LWP::Simple-Paketname (inkl. LWP::UserAgent und HTTP::Request): libwww-perl
SOAP::Lite-Paketname: libsoap-lite-perl
XML::Parser::Lite-Paketname: libxml-parser-lite-perl

Manuelle Installation LWP::Simple

Wenn sich dieses Paket nicht einfach per CPAN-Anweisung installieren läßt, dann hilft folgende Anleitung weiter. Beim Abbruch der Installation mittels CPAN erscheint mittendrin ein Fehler, das die Datei nicht entpackt werden könne (couldn't untar). Da scheint es einen Fehler im Installationsskript zu geben.

Man kann das aber auch Manuell installieren:

Am Einfachsten ist ein Wechsel in den Kontext des Benutzers root: "sudo su -"
Erstellen eines Ordners, z.B. "mkdir lwpsimple"
Wechsel in diesen Ordner "cd lwpsimple"
Herunterladen der Datei von libwww-perl-6.04 oder direkter Link: libwww-perl-6.04.tar.gz: z.B. "wget http://search.cpan.org/CPAN/authors/id/G/GA/GAAS/libwww-perl-6.04.tar.gz"
Entpacken der Datei: "tar -xzvf libwww-perl-6.04.tar.gz"
Wechsel in das neu entstandene Verzeichnis: "cd libwww-perl-6.04"
Nun kann es nach dem Standardvorgehen weitergehen:
- "perl Makefile.PL"
- "make"
- "make install"

Manuelle Installation SOAP::Lite

Wenn sich dieses Paket nicht einfach per CPAN-Anweisung installieren läßt, dann hilft folgende Anleitung weiter. Beim Abbruch der Installation mittels CPAN erscheint mittendrin ein Fehler, das die Datei nicht entpackt werden könne (couldn't untar). Da scheint es einen Fehler im Installationsskript zu geben.

Man kann das aber auch Manuell installieren:

Am Einfachsten ist ein Wechsel in den Kontext des Benutzers root: "sudo su -"
Erstellen eines Ordners, z.B. "mkdir soaplite"
Wechsel in diesen Ordner "cd soaplite"
Herunterladen der Datei von CPAN-SOAP-Lite-0.715 oder direkter Link: SOAP-Lite-0.715.tar.gz: z.B. "wget http://mirror.informatik.uni-mannheim.de/pub/mirrors/CPAN/authors/id/M/MK/MKUTTER/SOAP-Lite-0.715.tar.gz"
Entpacken der Datei: "tar -xzvf SOAP-Lite-0.715.tar.gz"
Wechsel in das neu entstandene Verzeichnis: "cd SOAP-Lite-0.715"
Nun kann es nach der Anleitung weitergehen:
- "perl Makefile.PL"
- Dann kommt eine Nachfrage, was zusammengebaut werden soll. An dieser Stelle ist es jetzt wie eine normale CPAN Installation. Einfach mit <Enter> weitermachen lassen.
- "make"
- "make install"

Einrichtung von Samba für Sprachausgabemöglichkeit

Wenn die Sprachausgabe verwendet werden soll, muss ein lokaler Samba-Daemon (Server für Windowsfreigaben) laufen oder eine für FHEM beschreibbare (Windows-)Freigabe woanders existieren, da Sonos nur auf eine solche lesend zugreifen kann.

Diese Beschreibung soll anhand des Raspberry-Pi (und anderer Debian-Systeme) zeigen, wie man einen solchen lokalen Samba-Server schnell für diesen Zweck einrichten kann:

Lokales Verzeichnis für die Ablage der Tondateien erzeugen. z.B.:
```
sudo mkdir /mnt/SonosSpeak
```
Installation der notwendigen Pakete für Samba:
```
sudo apt-get install samba samba-common-bin
```
Starten des Editors zum Anpassen der Konfigurationsdatei:
```
sudo nano /etc/samba/smb.conf
```
Folgende Zeilen hinzufügen (Pfade müssen natürlich u.U. angepasst werden):

[SonosSpeak]
  comment = Audio-Files for SonosPlayer to Speak
  read only = false
  path = /mnt/SonosSpeak
  guest ok = yes

Falls der Zugriff nicht funktioniert, kann vielleicht folgendes helfen:
- Sicherstellen, dass in der Global-Sektion der Parameter Security auf Share steht (oder gar nicht erst definiert wurde):

[global]
  security = share

Samba-Server neustarten:
```
sudo /etc/init.d/samba restart
```

Damit wird eine Freigabe mit dem Namen SonosSpeak erzeugt, die von allen ohne Anmeldung gelesen und beschrieben werden kann.

Interner Aufbau

Um die Kommunikation mit dem UPnP-Netzwerk parallel zum normalen Betrieb von FHEM zu ermöglichen, werden Threads eingesetzt. Dadurch sind manche Hardwareplattformen leider überfordert und können u.U. nicht mit diesem Modul verwendet werden.
Das läßt sich aus technologischen Gründen auch nicht umgehen.

Dabei wird der SubThread verwendet um die Callback-Aufrufe, die erfolgen, wenn z.B. eine Statusänderung eines Players erfolgt, zu verarbeiten. Die Aktualisierung der Daten selbst wird dann über eine interne Queue "nach oben" zum Hauptthread übertragen, und dann mittels einer bestehenden TCP-Verbindung zur Verarbeitung in FHEM übertragen.
Dadurch wird gewährleistet, dass die Daten immer im Hauptthread (also dem "eigentlichen" FHEM-Thread) verfügbar sind.

Da dieser SubThread auch die Kommandoübergabe an den Player übernimmt, gibt es auch eine Kommando-Queue in die andere Richtung, die dann mittels eines Thread-Signals im SubThread-Kontext ausgeführt wird.

Dieser Aufbau sorgt natürlich dafür, dass man auf die üblichen Nebenläufigskeitsprobleme achten muss (in der Hauptsache sind das Dead-Locks, da man oftmals über drei Ecken aufeinander wartet, ohne das direkt zu sehen). Deswegen wird in allen Log-Ausgaben des Moduls ein Kürzel vorangestellt: "SONOS_", wobei der Unterstrich durch die Nummer des aktiven, loggenden, Threads ersetzt wird. Damit kann man sehr leicht feststellen, auf welcher "Ebene" diese Ausgabe erfolgt ist, und ob das alles so seine Richtigkeit hat.

Der Rest sind nur viele Zeilen, die XML-Strukturen (mittels regulärer Ausdrücke) parsen oder erzeugen, und die entsprechenden Informationen setzen oder abfragen.

Installation des Moduls selbst

Hier wird die Installation des eigentlichen Moduls beschrieben, sowie ein Changelog ausgegeben, damit man nachvollziehen kann, was am Modul so passiert ist. Dieser Changelog steht auch in der Datei 00_SONOS.pm.

Installation mittels FHEM-Updatemechanismus

Dieses Modul wird seit Dezember 2014 zusammen mit Fhem ausgeliefert. Es sind keine weiteren Schritte zur Installation des Moduls selbst notwendig.

Living on the bleeding edge

Da ich vor einem Releasetermin natürlich einiges entwickelt habe, und dies natürlich auch selber teste, habe ich dafür einen Development-Server eingerichtet. Dieser kann u.U. sinnvollerweise auch von anderen als Installationsquelle verwendet werden, da er aktuelle Fehlerbereinigungen oder neue Features und Konzepte enthält, die man gerne vorab sehen möchte.

Achtung: Diese Version muss nicht immer und zwangsläufig besser sein! ich gebe mir Mühe, bin aber auch nur ein Mensch :-)

Folgendes muss für die Installation eingegeben werden:

update thirdparty http://fhem.lmsoft.de/sonos_dev sonos

Achtung!: Seit dem 19.08.2014 wird ein neues Update-Modul (Thema) von Fhem verteilt. Der obige Befehl ist bei diesen Installationen zu ersetzen durch:

update all http://fhem.lmsoft.de/sonos/sonos_dev/controls_sonos.txt

Fehlersuche

Da das Modul noch in der Entwicklung steht, und natürlich sowieso immer wieder Probleme auftauchen können, hier ein paar Hinweise zur Fehlersuche: Das Modul besteht zunächst aus zwei Ebenen:

Eine Ebene, die innerhalb von Fhem selbst läuft
Eine Ebene, die als eigenständiger Prozess läuft (entweder durch Fhem selbst oder manuell angestartet)

Die Logausgaben der ersten Ebene landen direkt im Fhem-Log, die der zweiten Ebene können dort nicht reingeschrieben werden, und landen dementsprechend auf der Konsole (genauer: auf STDOUT). Wenn man also die Log-Ausgaben dieses Sub-Prozesses sehen möchte, muss man im Startskript den STDOUT entsprechend umlenken, oder einen manuellen Start ausführen: sudo perl fhem.pl fhem.cfg Dazu muss man natürlich vorher in das entsprechende Verzeichnis wechseln.

Die Menge der Logausgaben werden, wie in Fhem üblich, über das Attribut Verbose am Sonos-Device gesteuert (Bis auf wenige Zeilen beim Start des Sub-Prozesses, die nur mit dem globalen Verbose-Attribut gesteuert werden können, da noch keine Verbindung besteht).

Im Normalfall sollte Anhand der Ausgabe erkennbar sein, was das jeweilige Problem ist. Bei Unklarheiten am Besten im Forum suchen/posten.

Hinweise / Häufige Fehler / FAQ

Hier soll mal eine Liste mit häufigen Fehlern, Problemen und Hinweisen entstehen.

Allgemein läuft das Modul besser, wenn es im Benutzerkontext root läuft. Für diverse Funktionalitäten ist das sogar notwendig (z.B. Pingtype auf icmp konfiguriert).
Wenn man das Problem hat, dass Befehle an den falschen Player gesendet werden, sollte man das Reading ZoneGroupID prüfen. Bei ungruppierten Playern sollte es die eigene UDN enthalten, bei gruppierten Playern die UDN des Gruppenmaster.
Sollte das mal nicht der Fall sein, so kann es sein, dass im Sonos-System eine Falschinformation vorliegt. Da es jetzt nicht so einfach ist, die bei Sonos dazu zu bewegen, diesen Fehler zu beseitigen, gibt es u.U. eine Workaround-Möglichkeit mit dem Modul.
Wenn wir z.B. zwei Player haben: Sonos_Bad und Sonos_Kueche, und dort die Steuerung nicht korrekt funktioniert, dann einmal die folgenden Schritte versuchen (bei mehr oder anderen Playern natürlich analog dazu).
Dadurch werden die Gruppen gebildet, und nochmal explizit aufgelöst.
- set Sonos Groups [Sonos_Bad, Sonos_Kueche]
- set Sonos Groups [Sonos_Kueche, Sonos_Bad]
- set Sonos Groups [Sonos_Bad], [Sonos_Kueche]
Es ist empfehlenswert, dass erst das Sonos-Device definiert wird, und dann erst die entsprechenden Sonosplayer-Devices dazu. Sonst kann es u.U. zu einer Verdoppelung des SubProzesses kommen.
Manchmal bleiben 'Reste' beim Beenden von Fhem. Dann kann es sinnvoll sein, erst alle Perl-Prozesse zu beenden. Diese kann man mit
```
sudo ps -aux | grep perl
```
finden, und dann einzeln mittels
```
sudo kill ID
```
beenden (die ID steht in der ersten Spalte des Ergebnisses des vorherigen Befehls).

Einträge, die mittlerweile behoben wurden:

Fehler-Ausgaben beim Fhem-Start: Einige Readings dürfen bei einem Neustart von Fhem nicht bereits vorbelegt sein, da der entsprechende Zoneplayer mittlerweile andere Informationen haben könnte, bzw. einige Events sonst nicht erzeugt werden. Aus diesem Grund werden diese beim Start auch nicht geladen.
Folgende Meldung erscheint z.B.:Reading Sonos_Wohnzimmer->AlarmListVersion must not be used out of statefile.
Diese Meldungen kann man getrost ignorieren, da sie nicht auf einen Fehler hindeuten, sondern nur klarstellen, dass diese Readings eben nicht aus dem Statefile verwendet werden dürfen (was durch Ausgabe dieser Meldung auch nicht passiert).
- Das konnte mittlerweile durch ein Setzen eines "Lademarkers" verhindert werden. Dadurch wird das Laden des Readings nicht mehr unterbunden, sondern auf einen sicher ungültigen Wert gesetzt. Damit funktionieren die folgenden Readings-Update Aufrufe wieder.

Changelog

SVN-History:
- 31.12.2014
  - Das Bilden von Stereopaaren wird nun unterstützt. Dafür gibt es die Anweisungen 'CreateStereoPair' und 'SeparateStereoPair' an einem Playerdevice.
- 28.12.2014
  - Umlaute: Die Erkennung von Umlauten war wegen der Quelltextumstellung auf UTF8 fehlerhaft. Das betraf nur die Zonennamenumwandlung, wo z.B. aus 'Küche' ein 'Kueche' gemacht wird.
  - Sonos-Coverlieferung: Es waren noch ein paar Return-Anweisungen zuviel drin.
- 26.12.2014:
  - DeleteFn für Sonos wurde implementiert. Das Sonos-Device löscht erst alle SonosPlayer-Devices und beendet den selbst gestarteten SubProzess. Danach wird das Sonos-Device selber von Fhem abgeräumt.
  - DeleteFn für SonosPlayer wurde implementiert. Es werden erst alle automatisch erzeugten Devices (RemoteControl und ReadingsGroups) entfernt, sofern sie noch unter dem Originalnamen existieren.
  - ReportUnresponsiveDevice hat manchmal versucht, die Mitteilung an "sich selbst" zu senden, was naturgemäß nicht klappen kann.
2.6 (17.12.2014):
- Die Zeichenkodierung bei Datenübernahme vom Zoneplayer kann nun über das Attribut characterDecoding eingestellt werden
- Bei Gruppen-/LineIn-/SPDIF-Wiedergabe wird wieder die liefernde Zone angezeigt (als Albumname)
- SetCurrentPlaylist hatte einen Tippfehler, und konnte dementsprechend nicht ausgeführt werden
- Unter Ubuntu gibt es die SHA1-Library nicht mehr, sodass man dort eine andere einbinden muss (SHA)
- Wenn bei den Methoden zum heraussuchen der FHEM-Devices etwas nicht gefunden wurde, dann wird jetzt eine Fehlermeldung mit dem gesuchten Merkmal ausgegeben
- Es können jetzt IP-Adressen von der UPnP-Verarbeitung ausgeschlossen werden
- Es wird nun ein fester Mimetype 'jpg' für Google Music und Simfy festgelegt
- Beim Alarm-Reading-Setzen wurde etwas doppelt gesetzt, was u.U. zu Fehlern führen konnte
- Die Read-Function wurde robuster gegen Übertragungsprobleme gemacht
- Das Wiederherstellen des Playerzustands nach einem PlayURITemp sieht nun auch den PlayBar-Eingang vor
- Es wird nun anstatt der WebCmd-Auflistung ein RemoteControl beim Erstellen der Komponenten erzeugt
- Wenn sich doch noch ein UPnP-Device als Player ausgibt, dann wird dies nun etwas sicherer erkannt
- Der Eingang einer Playbar kann nun auf anderen Playern wiedergegeben werden (mittels des Fhem-Namens)
- Lesen wurde auf DevIo_SimpleRead umgestellt (stand auf DevIo_DoSimpleRead). Dadurch wird das Fehlerhandling vereinfacht.
- Man kann die Zeit für das Warten auf den Subprozess nun beim Define mit angeben. Standardmäßig wird 8 verwendet.
- Es wird nun in regelmäßigen Abständen (Intervall wie bei der Prüfung der Sonosplayer) geprüft, ob die Verbindung zum Subprozess noch funktioniert
- Die Readings, die beim Start nicht geladen werden dürfen, werden beim Start von Fhem nun initialisiert. Damit wird die Fehlermeldung in MOTD verhindert
- Der Zeitstempel in der Konsolenausgabe berücksichtigt nun auch die Global-Angabe, ob Millisekunden mit ausgegeben werden sollen
- Der Start wurde komplett überarbeitet. Nun sind die einzelnen Wartebereiche in Timer ausgelagert, sodass Fhem nicht mit warten blockiert wird.
- Die Wiederherstellung des alten Playerzustands nach einem PlayURITemp (und damit auch bei Speak) wird nun auch bei Dateien gemacht, die mit 0s Dauer ermittelt werden (da sie sehr kurz sind).
- Der Aufruf der Google Text2Speech-Engine wird nun bei mehr als 95 Zeichen in mehrere Aufrufe aufgeteilt. Damit sind nun auch lange Texte über Google möglich, allerdings geht die Textmelodie u.U. verloren.
- Man kann jetzt für die Speak-Erzeugung ein JPG- oder PNG-Bild angeben. Dies kann für jedes Speak-Programm getrennt erfolgen.
- Beim Speak-Aufruf werden Umlaute nun auch korrekt an den Text2Speech-Generator (z.B. Google) übergeben, und korrekt in den MP3-Tag geschrieben
- Spotify-Cover werden nun in größerer Auflösung (meist 640x640 Pixel) direkt von Spotify heruntergeladen, und enthalten dann nicht mehr das Spotify-Logo
- Es gibt zwei neue Readings 'AlbumArtURL' und 'nextAlbumArtURL', die die Originalpfade zum eigenen Download darstellen
- Es gibt nun zwei Prozeduren, die als Grundlage oder Beispiel für die Verwendung von ReadingsGroups dienen können: 'SONOS_getTitleRG' und 'SONOS_getCoverRG'
- Beim automatischen Erzeugen der Sonos-Devices werden nun ReadingsGroups mit mehr Informationen erzeugt. Dies kann (und soll) auch als Vorlage für eigene Ideen Verwendet werden
- Es gibt eine weitere ReadingsGroup-Vorlage (steht auch im Wiki), mit der Listen (Playlisten, Favoriten und Radios) dargestellt werden können
- Es gibt zwei neue Attribute "proxyCacheTime" und "proxyCacheDir", die einen Cache im Proxy aktivieren
- Es gibt drei neue Getter am Sonosplayer-Device: "FavouritesWithCover", "PlaylistsWithCover" und "RadiosWithCovers". Diese geben eine Datenstruktur zurück, die den Titel und das Cover des Elements enthält.
- Die Prozeduren für die Anzeige des aktuellen und nächsten Titels verwenden nun ausschließlich DIV-Container (anstatt Tabellen). Dadurch klappt die Anzeige auch in einem Dashboard.
- Die Standard-ReadingsGroup-Anzeige durch die Prozeduren sind nun Parametrisiert. Man kann die minimale Breite der Anzeige sowie den Abstand zwischen aktuellem und nächstem Titel in Pixel festlegen
- Manche Sender (z.B. Capital Radio Türkiye) haben verbotene Newlines in den Titelinformationen mitgesendet. Diese werden nun entfernt.
- Man kann das Cover nun anklicken (oder antippen), und erhält dann die Coverdarstellung in einer Vollbilddarstellung mit Abspielstatus und Titelinformationen
- Es gibt zwei neue Befehle 'StartPlaylist' und 'StartRadio', die die gleichen Parameter wie ihre Pendants mit 'Load' am Anfang haben, nur dass hier das Abspielen gleich gestartet wird.
- Es gibt jetzt ein Reading 'currentTrackPosition', welches bei jedem Transportstate-Wechsel (neuer Titel, Play/Pause/Stop usw.) gesetzt wird. Damit kann man die verbleibende Restzeit eines laufenden Titels ermitteln, bzw. den Pausezeitpunkt anzeigen.
- Beim Wiedergeben von TV oder sonstigen externen Quellen, wird jetzt nicht mehr das 'leere' Cover angezeigt, sondern ein TV-Cover bzw. ein Default-Input-Cover
- Aufnahme in das offizielle Release von Fhem
2.5 (07.03.2014):
- Verwendung und Speicherung der Benutzer-IDs für Spotify und Napster wurden stabiler gegenüber Sonderzeichen gemacht
- Spotify-URLs werden im Reading 'currentTrackURI' und 'nextTrackURI' lesbarer abgelegt
- Ein Fehler beim Öffnen von M3U-Playlistdateien wurde behoben (dafür Danke an John)
- Überholt: Für die Informationsanfragen an Fhem durch den SubProzess wird nun standardmäßig der Telnet-Port von Fhem verwendet. Wenn das fehlschlägt, wird auf den alten Mechanismus zurückgeschaltet
- Neu: Es werden keine Informationsanfragen mehr zwischen Fhem und dem SubProzess ausgetauscht. Notwendige Informationen müssen vorher übertragen werden. Das bedeutet, dass bei einer Attributänderung ein Neustart von Fhem erfolgen muss.
- Es wurde ein Standard-Layout für das RemoteControl-Hilfsmodul angelegt
- Der Verbose-Level des Sonos-Devices wird nun auch an den SubProzess weitergereicht (auch zur Laufzeit), und beim initialen Start des SubProzess-Threads mitgegeben.
- AlbumArt von Napster erhält nun den festen Mimetype 'jpg', da dieser nicht übertragen wird
- Es werden nun die durch Fhem definierten Standard-Attribute mit angeboten
- Es gab ein Problem mit der Befehlsverarbeitung, wenn das Verbose-Attribut an einem Sonos-Device gesetzt war.
- Es wird nun auf Änderungsevents für den Zonennamen und das Zonenicon reagiert, und die entsprechenden Readings aktualisiert
- Es gibt jetzt zwei neue Setter: 'Name' und 'Icon', mit dem der Name und das Icon der Zone eingestellt werden kann
- Es gibt jetzt einen Getter 'PossibleRoomIcons', welcher die möglichen Angaben für den neuen Setter 'Icon' liefert
- Das Reading 'ZoneGroupID' wird nun auf eine andere Weise ermittelt und gesetzt
- Es gib jetzt ein neues Reading 'AlarmRunning', welches auf '1' steht, wenn gerade eine Alarmabspielung aktiv ist
- Die Namens- und Aufgabenerkennung beim Ermitteln der Player wurde angepasst
- Der Aufruf von AddMember und RemoveMember wurde bzgl. des SonosDevice-Namen abgesichert, sodass hier kein Absturz mehr bei einer falschen Deviceangabe erfolgt
- Es gibt jetzt ein neues Reading 'AlarmRunningID', welches bei einer Alarmausführung die ID des aktiven Alarms enthält
- Das Senden von Aktualisierungen an Fhem wurde etwas sicherer gemacht, wenn Fhem auf der anderen Seite gerade nicht zuhören kann
- Die Readings 'AlarmList', 'AlarmListIDs' und 'AlarmListVersion' werden nicht mehr aus dem Statefile geladen, da dort Sonderzeichen wie '#' zum Abschneiden der restlichen Zeile führen
- Anpassung der UPnP-Klasse, damit das Device-Beschreibungsdokument nur noch einmal geladen wird (anstatt wie bisher zweimal)
- Anpassung im Bereich der Cover Aktualisierung über FhemWeb. Das geht jetzt mit viel weniger Aufwand durch.
- Es gibt jetzt einen Setter 'SnapshotGroupVolume', der das aktuelle Lautstärkenverhältnis der einzelnen Player einer Gruppe für die folgenden Aufrufe des Setter 'GroupVolume' festhält. Die Anweisungen 'PlayURI' und 'PlayURITemp' (sowie darauf aufbauende Aufrufe wie 'Speak') führen diese Anweisung selbsttätig beim Starten durch.
- Wenn beim Auffrischen der Subscriptions ein Fehler auftritt, der darauf schließen läßt, dass der Player weg ist, dann wird die entsprechende Referenz aufgeräumt
- Man kann als relative Angabe bei setVolume nun einen Prozentwert angeben, z.B. '+20%'. Damit wird die Lautstärke um den jeweiligen prozentualen Anteil erhöht oder abgesenkt.
- Es gibt jetzt ein Reading 'LineInConnected', welches eine '1' enthält, wenn der Line-In-Eingang angeschlossen wurde, sonst '0'.
2.4 (31.12.2013):
- Initiale Lautstärkenermittlung wurde nun abgesichert, falls die Anfrage beim Player fehlschlägt
- Verbesserte Gruppenerkennung für die Anzeige der Informationen wie Titel usw.
- Fallback (Log) für den Aufruf von Log3 geschaffen, damit auch alte FHEM-Versionen funktionieren
- Es wurde eine Korrektur im verwendetetn UPnP-Modul gemacht, die eine bessere Verarbeitung der eingehenden Datagramme gewährleistet (dafür Danke an Sacha)
- Es werden nun zusätzliche Readings (beginnend mit 'next') mit den Informationen über den nächsten Titel befüllt. Diese können natürlich auch für InfoSummarize verwendet werden
- Es kann nun ein Eintrag aus der Sonos-Favoritenliste gestartet werden (Playlist oder Direkteintrag)
- Das Benennen der Sonos-Fhem-Devices wird nun auf Namensdoppelungen hin überprüft, und der Name eindeutig gemacht. Dabei wird im Normalfall das neue Reading 'fieldType' an den Namen angehangen. Nur der Master einer solchen Paarung bekommt dann den Original-Raumnamen als Fhem-Devicenamen
- Es gibt ein neues Reading 'fieldType', mit dem man erkennen kann, an welcher Position in einer Paarung dieser Zoneplayer steht
- Diverse Probleme mit Gruppen und Paarungen beim neu Erkennen der Sonos-Landschaft wurden beseitigt
- Es gibt jetzt einen Getter 'EthernetPortStatus', der den Status des gewünschten Ethernet-Ports liefert
- Es gibt jetzt einen Setter 'Reboot', der einen Neustart des Zoneplayers durchführt
- Es gibt jetzt einen Setter 'Wifi', mit dem der Zustand des Wifi-Ports eines Zoneplayers gesetzt werden kann
- Wenn ein Player als "Disappeared" erkannt wird, wird dem Sonos-System dies mitgeteilt, sodass er aus allen Listen und Controllern verschwindet
- Kleinere Korrektur, die eine bessere Verarbeitung der Kommunikation zwischen Fhem und dem Subprozess bewirkt
2.3 (2.12.2013):
- Die Antwort von 'SetCurrentPlaylist' wurde korrigiert. Dort kam vorher 'SetToCurrentPlaylist' zurück.
- VolumeStep kann nun auch als Attribut definiert werden. Das fehlte in der zulässigen Liste noch.
- Speak kann nun auch für lokale Binary-Aufrufe konfiguriert werden.
- Speak kann nun einen Hash-Wert auf Basis des gegebenen Textes in den Dateinamen einarbeiten, und diese dann bei Gleichheit wiederverwenden (Caching)
- Sonos kann nun ein "set StopAll" oder "set PauseAll" ausführen, um alle Player/Gruppen auf einen Schlag zu stoppen/pausieren
- Beim Discover-Event wird nun genauer geprüft, ob sich überhaupt ein ZonePlayer gemeldet hat
- Die UserIDs für Napster und Spotify werden wieder korrekt ermittelt. Damit kann auch wieder ein Playlistenimport erfolgen.
- Loudness Einstell- und Abfragbar
- Bass Einstell- und Abfragbar
- Treble Einstell- und Abfragbar
- Volume kann nun auch als RampToVolume ausgeführt werden
2.2 (12.10.2013):
- Befehlswarteschlange wieder ausgebaut. Dadurch gibt es nur noch das Reading LastActionResult, und alles wird viel zügiger ausgeführt, da Fhem nicht auf die Ausführung warten muss.
- TempPlaying berücksichtigt nun auch die Wiedergabe von Line-In-Eingängen (also auch Speak)
- Veraltete, mittlerweile unbenutzte, Readings werden nun gelöscht
- SetLEDState wurde hinzugefügt
- Die IsAlive-Überprüfung kann mit 'none' abgeschaltet werden
- CurrentTempPlaying wird nicht mehr benötigt
2.1 (23.09.2013):
- Neuen Befehl 'CurrentPlaylist' eingeführt
2.0 (15.09.2013):
- Neue Konzeptbasis eingebaut
- Man kann Gruppen auf- und wieder abbauen
- Es gibt neue Lautstärke- und Mute-Einstellungen für Gruppen ingesamt
- Man kann Button-Events definieren
1.13 (27.05.2013):
- Neuer Abspielzustand 'TRANSITIONING' wird berücksichtigt
- Der Aufruf von 'GetDeviceDefHash' wird nun mit dem Parameter 'undef' anstatt ohne einen Parameter durchgeführt
1.12 (23.05.2013):
- TrackURI hinzugefügt
- LoadPlayList und SavePlayList können nun auch Dateinamen annehmen, um eine M3U-Datei zu erzeugen/als Abspielliste zu laden
- Alarme können ausgelesen, gesetzt und gelöscht werden
- SleepTimer kann gesetzt und ausgelesen werden
- Reading DailyIndexRefreshTime hinzugefügt
- Bei AddURIToQueue und PlayURI können jetzt auch (wie bei LoadPlayList) Spotify und Napster-Ressourcen angegeben werden
- Beim Erzeugen des Cover-Weblinks wird nun nur noch die Breite festgelegt, damit Nicht-Quadratische Cover auch korrekt dargestellt werden
- SONOS_Stringify gibt Strings nun in einfachen Anführungszeichen aus (und maskiert etwaig enthaltene im String selbst)
1.11 (10.03.2013):
- Ein Transport-Event-Subscribing wird nur dann gemacht, wenn es auch einen Transport-Service gibt. Die Bridge z.B. hat sowas nicht.
- Bei PlayURITemp wird nun der Mute-Zustand auf UnMute gesetzt, und anschließend wiederhergestellt
- Shuffle, Repeat und CrossfadeMode können nun gesetzt und abgefragt werden. Desweiteren wird der Status beim Transport-Event aktualisiert.
- Umlaute bei "generateInfoSmmarize3" durch "sichere" Schreibweise ersetzt (Lautstärke -> Lautstaerke)
1.10 (22.02.2013):
- IsAlive beendet nicht mehr den Thread, wenn der Player nicht mehr erreichbar ist, sondern löscht nur noch die Proxy-Referenzen
- FHEMWEB-Icons werden nur noch im Hauptthread aktualisiert
- Getter 'getBalance' und Setter 'setBalance' eingeführt.
- HeadphoneConnected inkl. minVolumeHeadphone und maxVolumeHeadphone eingeführt
- InfoSummarize um die Möglichkeit der Volume/Balance/HeadphoneConnected-Felder erweitert. Außerdem werden diese Info-Felder nun auch bei einem Volume-Event neu berechnet (und triggern bei Bedarf auch!)
- InfoSummarize-Features erweitert: 'instead' und 'emptyval' hinzugefügt
- IsAlive prüft nicht mehr bei jedem Durchgang bis zum Thread runter, ob die Subscriptions erneuert werden müssen
1.9 (16.02.2013):
- RTL.it Informationen werden nun schöner dargestellt (Da steht eine XML-Struktur im Titel)
- Wenn kein Cover vom Sonos geliefert werden kann, wird das FHEM-Logo als Standard verwendet (da dieses sowieso auf dem Rechner vorliegt)
- UPnP-Fehlermeldungen eingebaut, um bei einer Nichtausführung nähere Informationen erhalten zu können
1.8 (13.02.2013):
- Device-Removed wird nun sicher ausgeführt. Manchmal bekommt man wohl deviceRemoved-Events ohne ein vorheriges deviceAdded-Event. Dann gibt es die gesuchte Referenz nicht.
- Renew-Subscriptions wurden zu spät ausgeführt. Da war alles schon abgelaufen, und konnte nicht mehr verlängert werden.
- ZonePlayer-Icon wird nun immer beim Discover-Event heruntergeladen. Damit wird es auch wieder aktualisiert, wenn FHEM das Icon beim Update verwirft.
- MinVolume und MaxVolume eingeführt. Damit kann nun der Lautstärkeregelbereich der ZonePlayer festgelegt werden
- Umlaute beim Übertragen in das Reading State werden wieder korrekt übertragen. Das Problem waren die etwaigen doppelten Anführungsstriche. Diese werden nun maskiert.
- Sonos Docks werden nun auch erkannt. Dieses hat eine andere Device-Struktur, weswegen der Erkennungsprozess angepasst werden musste.
1.7 (04.02.2013):
- Umlaute werden bei Playernamen beim Anlegen des Devices korrekt umgewandelt, und nicht in Unterstriche
- Renew-Subscription eingebaut, damit ein Player nicht die Verbindung zum Modul verliert
- CurrentTempPlaying wird nun auch sauber beim Abbrechen des Restore-Vorgangs zurückgesetzt
- Die Discovermechanik umgebaut, damit dieser Thread nach einem Discover nicht neu erzeugt werden muss.
1.6 (30.01.2013):
- Speak hinzugefügt (siehe Doku im Wiki)
- Korrektur von PlayURITemp für Dateien, für die Sonos keine Abspiellänge zur Verfügung stellt
- Korrektur des Thread-Problems welches unter *Nix-Varianten auftrat (Windows war nicht betroffen)
1.5:
- PlayURI, PlayURITemp und AddURIToQueue hinzugefügt (siehe Doku im Wiki)
1.4 (28.01.2013):
- Exception-Handling bei der Befehlsausführung soll FHEM besser vor verschwundenen Playern schützen
- Variable $SONOS_ThisThreadEnded sichert die korrekte Beendigung des vorhandenen Threads, trotz Discover-Events in der Pipeline
- Einrückungen im Code korrigiert
1.3 (26.01.2013):
- StopHandling prüft nun auch, ob die Referenz noch existiert
1.2 (24.01.2013):
- Proxy-Objekte werden beim Disappearen des Player entfernt, und sorgen bei einem nachfolgenden Aufruf für eine saubere Fehlermeldung
- Probleme mit Anführungszeichen " in Liedtiteln und Artist-Angaben. Diese Zeichen werden nun ersetzt
- Weblink wurde mit fehlendem "/" am Anfang angelegt. Dadurch hat dieser nicht im Floorplan funktionert
- pingType wird nun auf Korrektheit geprüft.
- Play:3 haben keinen Audio-Eingang, deshalb funktioniert das Holen eines Proxy dafür auch nicht. Jetzt ist das Holen abgesichert.
1.1 (18.01.2013):
- Ping-Methode einstellbar über Attribut 'pingType'
1.0 (16.01.2013):
- Initial Release

Modul SONOS

Dieses Modul erledigt die eigentliche Kommunikationsarbeit zu den ZonePlayern mittles UPnP. Es startet (und läßt ihn dauerhaft laufen) einen Discovery Prozess, der alle ZonePlayer auffordert, sich zu melden, und reagiert auf entsprechende Signalisierungen. Es instantiiert einen Listener und meldet diesen bei allen ZonePlayern für Abspielaktualisierungen an.

Wenn ein Aufruf des Discovery-Prozesses erfolgt, wird geprüft, ob der Player bereits definiert wurde. Wenn nicht, wird eine Definition erzeugt, wenn ja, dann wird die Komponente mit den neu erhaltenen Informationen aktualisiert.

Wenn ein Aufruf der Abspielaktualisierung erfolgt, so wird die entsprechene Zoneplayer-Komponente in FHEM mit den neu erhaltenen Informationen aktualisiert, und entsprechende FHEM-Events generiert.

Wenn das Feature mit minVolume oder maxVolume verwendet wird, wird ein weiterer Listener beim entsprechenden Zoneplayer angemeldet. Mittels diesem werden Lautstärkenänderungen am Zoneplayer gemeldet umd können entsprechend umgehend korrigiert werden.
Als Nebeneffekt wird für jede Lautstärkenänderung auch ein Event in FHEM erzeugt (als Folge einer Aktualisierung des Readings Volume).

Readings von SONOS

UserId_Napster: Speichert die UserId für den Napster-Zugriff. Diese Information ist notwendig, wenn eine M3U-Datei mit Napster-Titeln importiert werden soll, und wird automatisch ermittelt, sobald man mit dem Original-Controller einen einzelnen Titel aus Napster in die aktuelle Abspielliste überträgt.
UserId_Spotify: Speichert die UserId für den Spotify-Zugriff. Diese Information ist notwendig, wenn eine M3U-Datei mit Spotify-Titeln importiert werden soll, und wird automatisch ermittelt, sobald man mit dem Original-Controller einen einzelnen Titel aus Spotify in die aktuelle Abspielliste überträgt.
ZoneGroupState: Die Konfigurationsinformationen zu der aktuellen Gruppenlandschaft der Zoneplayer. Der Befehl get SONOS Groups vereinfacht den Zugriff hierauf, indem es eine einfach les- und verarbeitbare Liste erzeugt.

Attribute von SONOS

Grundsätzliches
- characterDecoding: Hiermit kann die Zeichendekodierung eingestellt werden. Z.b. <UTF-8>. Standardmäßig wird <CP-1252> verwendet.
- pingType(none,tcp,udp,icmp,syn): Definiert die Art, wie der Alive-Check eines Zoneplayers erfolgen soll. Die Verfahren funktionieren unterschiedlich gut. Am Ressourcensparsamsten ist icmp, benötigt aber "root"-Rechte. An zweiter Stelle ist syn zu empfehlen. Die anderen Verfahren melden manchmal fehlerhafte not alives. Einfach probieren. Mittels none kann dieser Mechanismus auch deaktiviert werden.
Proxy-Einstellungen
- generateProxyAlbumArtURLs(0,1): Wenn aktiviert, werden alle Cover-Links als Proxy-Aufrufe an Fhem generiert. Dieser Proxy-Server wird vom Sonos-Modul bereitgestellt. In der Grundeinstellung erfolgt kein Caching der Cover, sondern nur eine Durchreichung der Cover von den Sonosplayern (Damit ist der Zugriff durch einen externen Proxyserver auf Fhem möglich).
- proxyCacheDir: Hiermit wird das Verzeichnis festgelegt, in dem die Cover zwischengespeichert werden. Wenn nicht festgelegt, so wird /tmp verwendet.
- proxyCacheTime: Mit einer Angabe ungleich 0 wird der Caching-Mechanismus des Sonos-Modul-Proxy-Servers aktiviert. Dabei werden Cover, die im Cache älter sind als diese Zeitangabe in Sekunden, neu vom Sonosplayer geladen, alle anderen direkt ausgeliefert, ohne den Player zu fragen.
Sprachoptionen
- targetSpeakDir: Das Verzeichnis, in dem dieses Modul die Sprachdateien von Speak (siehe Set-Befehle an den SONOSPLAYER) ablegen soll (also die Adresse für den Schreibzugriff). Es wird empfohlen, dass dieses Verzeichnis nicht von Sonos indiziert ist.
  z.B. Pfade unter *Nix: /home/www/Sonos oder unter Windows: C:\InetPub\Sonos
- targetSpeakURL: Die URL, unter der von außen (also aus Sicht des Zoneplayers) auf die abgelegte Sprachdatei zugegriffen werden kann (also die Adresse für den Lesezugriff).
  z.B. \\192.168.178.45\Sonos
  - Achtung!: Dabei muss darauf geachtet werden, dass als letztes Zeichen vor dem Zeilenumbruch kein Backslash steht (ist hier für den Pfad auch nicht notwendig). Dieser würde von Fhem als Maskierer für den folgenden Zeilenumbruch interpretiert werden, und die nächste Zeile wäre auch noch Bestandteil dieses Attributs (und damit des Pfades).
- targetSpeakFileTimestamp(0,1): Definiert, ob in dem Namen der Sprachausgabedatei ein Zeitstempel enthalten sein soll. Das sorgt dafür, dass alle Dateien beibehalten werden (da nicht mit demselben Namen überschrieben wird).
  Manchmal kann das auch Caching-Probleme beseitigen. In meinen Tests hat die Anzeige der in der Sprachdatei enthaltenen MP3-Tags nur mit dieser aktivierten Option sauber funktioniert, da der ZonePlayer bei mir die Tags gecached hält.
  Anderseits muss man sich dabei Gedanken über eine Aufräumstrategie machen, da die alten Dateien immer vorhanden bleiben.
- targetSpeakFileHashCache(0,1): Definiert, ob in dem Namen der Sprachausgabedatei ein Hash-Wert enthalten sein soll. Das sorgt dafür, dass die Dateien bei gleichem Text wiederverwendet werden und nicht neu generiert werden.
  - Für diese Funktionalität wird das Perl-Modul Digest::SHA1 für die Berechnung des Hash-Werts benötigt. Am einfachsten kann es bei Bedarf per CPAN installiert werden: sudo cpan install Digest::SHA1.
- Speak1: Hiermit kann ein Systemaufruf definiert werden, der zu Erzeugung einer Sprachausgabe verwendet werden kann. Sobald dieses Attribut definiert wurde, ist ein entsprechender Setter am Sonosplayer verfügbar.
  Das Format ist:
  <Ausgabedateiendung>:<Befehlszeile>
  - Es dürfen folgende Platzhalter verwendet werden:
    %language%: Wird durch die eingegebene Sprache ersetzt
    %filename%: Wird durch den kompletten Dateinamen (inkl. Dateiendung) ersetzt.
    %text%: Wird durch den zu übersetzenden Text ersetzt.
- Speak2: Siehe Speak1
- Speak3: Siehe Speak1
- Speak4: Siehe Speak1
- SpeakCover: Hiermit kann ein JPG- oder PNG-Bild als Cover für die Google-Sprachdurchsagen definiert werden.
- Speak1Cover: Analog zu SpeakCover für Speak1.
- Speak2Cover: Analog zu SpeakCover für Speak2.
- Speak3Cover: Analog zu SpeakCover für Speak3.
- Speak4Cover: Analog zu SpeakCover für Speak4.

Get-Befehle an SONOS

Gruppenbefehle
- Groups: Liefert die aktuelle Gruppierungskonfiguration der Sonos-Systemlandschaft zurück. Das Format ist eine Komma-getrennte Liste von Listen mit Devicenamen, also z.B. [Sonos_Kueche], [Sonos_Wohnzimmer, Sonos_Schlafzimmer]. In diesem Beispiel sind also zwei Gruppen definiert, von denen die erste aus einem Player und die zweite aus Zwei Playern besteht. Dabei ist die Reihenfolge innerhalb der Unterlisten wichtig, da der erste Eintrag der sogenannte Gruppenkoordinator ist (in diesem Fall also Sonos_Wohnzimmer), von dem die aktuelle Abspielliste und der aktuelle Titel auf die anderen Gruppenmitglieder übernommen wird.

Set-Befehle an SONOS

Steuerbefehle
- PauseAll: Pausiert die Wiedergabe in allen Zonen.
- StopAll: Stoppt die Wiedergabe in allen Zonen.
Gruppenbefehle
- Groups <Gruppendefinition>: Setzt die aktuelle Gruppierungskonfiguration der Sonos-Systemlandschaft. Das Format ist jenes, welches auch von dem Get-Befehl Groups geliefert wird.

Modul SONOSPLAYER

Dieses Modul dient im großen und ganzen als Platzhalter für FHEM, damit der Anwender FHEM-Konform informiert werden, bzw. steuern kann.

Hier werden die Informationen, die vom SONOS-Modul erkannt werden, abgelegt, und die Aktualisierungs-Events erzeugt.

Readings von SONOSPLAYER

Folgende Informationen werden im SONOSPLAYER als Reading abgelegt:

Systemzustand
- AlarmList: Enthält die textuelle Repräsentation des Hashs mit den aktuell für diesen Player gültigen Alarminformationen. Diese Information wird automatisch aktualisiert, wenn das Attribut getAlarms auf 1 gesetzt wurde, ansonsten steht sie nicht zur Verfügung (und es kann kein Alarm angelegt, verändert und gelöscht werden). Das Format des Hashs entspricht dem, das zum Setzen oder Anpassen eines Alarms notwendig ist.
  Folgene Schlüssel sind dort zulässig/notwendig:
  - Enabled(0,1): Gibt an, ob der Alarm aktiviert ist.
  - Volume(0..100): Die Lautstärke, mit der der Alarm wiedergegeben werden soll.
  - StartTime(Timstamp): Die Uhrzeit, zu der der Alarm starten soll.
  - Duration(Timstamp): Die Dauer, die der Alarm laufen soll.
  - Repeat(0,1): Gibt an, ob die Wiedergabe wiederholt werden soll.
  - Shuffle(0,1): Gibt an, ob die Wiedergabe zufällig erfolgen soll.
  - RoomUUID: Die ID der Zone, in der der Alarm wiedergegeben werden soll. Dieser Wert muss nie mit angegeben werden, da er automatisch befüllt wird (Diese Information ist durch das verwendete Fhem-Zoneplayer-Device klar).
  - ProgramURI: Die abzuspielende URI.
  - ProgramMetaData: Die Metadaten zu der abzuspielenden URI.
  - Recurrence_Once(0,1): Gibt an, dass der Alarm nur einmal laufen soll. Wenn hier eine 1 angegeben wurde, dann werden die anderen Recurrence-Angaben ignoriert.
  - Recurrence_Monday(0,1): Gibt an, dass der Alarm jeden Montag laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - Recurrence_Tuesday(0,1): Gibt an, dass der Alarm jeden Dienstag laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - Recurrence_Wednesday(0,1): Gibt an, dass der Alarm jeden Mittwoch laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - Recurrence_Thursday(0,1): Gibt an, dass der Alarm jeden Donnerstag laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - Recurrence_Friday(0,1): Gibt an, dass der Alarm jeden Freitag laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - Recurrence_Saturday(0,1): Gibt an, dass der Alarm jeden Samstag laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - Recurrence_Sunday(0,1): Gibt an, dass der Alarm jeden Sonntag laufen soll. Kann mit den anderen Tagesangaben kombiniert werden.
  - IncludeLinkedZones(0,1): Gibt an, ob die aktuell verlinkten Zonen diesen Alarm ebenfall abspielen sollen.
  - Beispiel-Hash: { Enabled => 1, Volume => 12, StartTime => '16:00:00', Duration => '00:15:00', Repeat => 0, Shuffle => 0, ProgramURI => 'x-rincon-buzzer:0', ProgramMetaData => ' ', Recurrence_Once => 0, Recurrence_Monday => 1, Recurrence_Tuesday => 1, Recurrence_Wednesday => 1, Recurrence_Thursday => 1, Recurrence_Friday => 1, Recurrence_Saturday => 0, Recurrence_Sunday => 0, IncludeLinkedZones => 0 }
- AlarmListIDs: Enthält die Hash-Schlüssel der Alarme als kommaseparierte Liste. Dieses Reading gibt es Hauptsächlich zur Vereinfachung des Zugriffs auf das Reading AlarmList. Damit hat man direkt die Anzahl und Primärschlüssel im Zugriff.
- AlarmListVersion: Dieses Reading enthält die Information über die aktuelle Version der gespeicherten Alarm-Informationen. Diese Information wird Hauptsächlich intern benötigt, um beurteilen zu können, ob die Alarminformationen neu geladen werden müssen.
- DailyIndexRefreshTime: Enthält die aktuell gültige DailyIndexRefreshTime, zu der der Medienindex neu aufgebaut werden soll.
  Diese Information wird automatisch aktualisiert, wenn sie bei einem Player verändert wird, wenn das Attribut getAlarms des Player auf 1 gesetzt wurde.
- fieldType: In einer Paarung wird jedem Player vom Sonos-System ein eindeutiger FieldType zugewiesen. Dieser wird von diesem Modul für die Eindeutigkeit des Device-Namen verwendet. Bei einer Stereopaarung z.B. hat ein Player den Type 'LF' (für Left-Front), 'RF' (für Right-Front) oder SW (für Subwoofer); bei Surround-Komfigurationen aber auch RR (für Right-Rear) oder LR (für Left-Rear).
- HeadphoneConnected: Enthält, wenn eines der beiden Attribute minVolume oder maxVolume (oder auch minVolumeHeadphone und maxVolumeHeadphone) gesetzt wurde, den Zustand, ob ein Kopfhörer verwendet wird, oder nicht.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung dieses Zustands auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
- LastActionResult: Enthält den Namen und das Ergebnis der letzten Aktion auf dem Player. Da die Aktionen asyncron übertragen werden, kann nur hier kontrolliert werden, ob das gewünschte Ergebnis erreicht wurde.
- LineInConnected: Gibt an, ob der Line-In-Eingang angeschlossen ist, oder nicht. Wird bei Änderung am Player automatisch aktualisiert, und erzeugt damit auch ein Event.
- location: URL zum Informationsdokument des ZonePlayers
- playerType: Typbezeichnung des ZonePlayer. z.B. "ZP90"
- presence: Erreichbarkeit des Players. Kann "appeared" oder "disappeared" sein
- roomName: Originalname des ZonePlayers. Kann Leer- oder Sonderzeichen enthalten
- saveRoomName: Sicherer Name des Zoneplayer. Sonderzeichen wurden in Unterstriche umgewandelt. Das Device wird beim Anlegen mit diesem Namen angelegt
- serialNum: Seriennummer des ZonePlayers. Entspricht weitestgehend der MAC-Adresse. z.B. "00-0E-58-28-D0-F4:2"
- softwareRevision: Version der installierten Software. z.B. "3.8.4"
- ZoneGroupID: Die ID des Gruppenkoordinators plus eine laufende Nummer. Sollte die Gruppe nur aus einem Mitglied bestehen, so ist es die eigene ID (=UDN).
- ZoneGroupName: Der Name der aktuellen Gruppe
- ZonePlayerUUIDsInGroup: Eine Liste der in der aktuellen Gruppe befindlichen Zoneplayer.
Abspielzustand
- AlarmRunning: Dieses Reading enthält 1, wenn gerade ein Alarm abgespielt wird, sonst 0
- AlarmRunningID: Dieses Reading enthält die ID des verursachenden Alarms, wenn gerade ein Alarm abgespielt wird, sonst ist es leer.
- Balance: Enthält im Normalfall die am Player eingestellte Balance zum Zeitpunkt der Erkennung. Wenn eines der beiden Attribute minVolume oder maxVolume gesetzt wurde, wird diese Balance bei jeder Änderung am Player mit aktualisiert.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung der Balance auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
- Bass: Enthält im Normalfall den am Player eingestellten Basslevel zum Zeitpunkt der Erkennung. Wenn eines der beiden Attribute minVolume oder maxVolume gesetzt wurde, wird dieser Basslevel bei jeder Änderung am Player mit aktualisiert.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung des Basslevels auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
- CrossfadeMode: Enthält den aktuellen Zustand von CrossfadeMode. Wird durch Event des Players aktualisiert (zusammen mit der Titelinformation).
- Loudness: Enthält, wenn eines der beiden Attribute minVolume oder maxVolume gesetzt wurde, den aktuellen Zustand des Loudness.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung des Loudness-Zustands auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
- Mute: Enthält, wenn eines der beiden Attribute minVolume oder maxVolume gesetzt wurde, den aktuellen Zustand des Mute.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung des Mute-Zustands auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
- numberOfTracks: Anzahl der momentan in der Abspielliste befindlichen Titel
- Repeat: Enthält den aktuellen Zustand von Repeat. Wird durch Event des Players aktualisiert (zusammen mit der Titelinformation).
- Shuffle: Enthält den aktuellen Zustand von Shuffle. Wird durch Event des Players aktualisiert (zusammen mit der Titelinformation).
- SleepTimer: Enthält die Restzeit des Sleeptimers. Diese Information wird vom Player beim Setzen und Ablaufen gemeldet, und erzeugt somit ein Event zu Beginn und Ende des Timers. Während der Timer läuft, wird hier nichts aktualisiert. Man muss also, falls benötigt, selber die verbleibende Restzeit mittels des Readings-Timestamps und diesem Wert ermitteln.
  Diese Information wird automatisch aktualisiert, wenn sie bei einem Player verändert wird.
  Beim Ablaufen des Timers wird vom Player eine Aktualisierung auf den Wert off gesendet. Darauf kann in einem Notify-Event geprüft werden.
- SleepTimerVersion: Dieses Reading enthält die Information über die aktuelle Version der gespeicherten SleepTimer-Informationen. Diese Information wird Hauptsächlich intern benötigt, um beurteilen zu können, ob das Reading SleepTimer neu geladen werden muss.
- transportState: Aktueller Abspielstatus. Kann "ERROR", "STOPPED", "PLAYING" oder "PAUSED_PLAYBACK" sein. Wobei ERROR heißt, dass es keine Verbindung zum Player gibt
- Treble: Enthält im Normalfall den am Player eingestellten Treblelevel zum Zeitpunkt der Erkennung. Wenn eines der beiden Attribute minVolume oder maxVolume gesetzt wurde, wird dieser Treblelevel bei jeder Änderung am Player mit aktualisiert.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung des Treblelevels auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
- Volume: Enthält im Normalfall die am Player eingestellte Laustärke zum Zeitpunkt der Erkennung. Wenn eines der beiden Attribute minVolume oder maxVolume gesetzt wurde, wird diese Lautstärke bei jeder Änderung am Player mit aktualisiert.
  Wenn zusätzlich noch das Attribut generateVolumeEvent gesetzt ist, erzeugt jede Änderung der Lautstärke auch ein FHEM-Event. Standardmäßig ist dies aus Zeitgründen deaktiviert, da FHEM-Events an jeden(!) notify innerhalb FHEM gemeldet werden. Dies kann u.U. zu Verzögerungen bei dem ZonePlayer führen.
Infos zum aktuellen Titel
- currentTitle: Titelbezeichnung des aktuellen Titels
- currentArtist: Interpret des aktuellen Titels
- currentAlbum: Albumname des aktuellen Titel
- currentAlbumArtist: Interpret des Albums. Kann z.B. auch "(compilations)" sein.
- currentOriginalTrackNumber: Nummer des aktuellen Titels bezogen auf das Album
- currentTrack: Nummer des aktuellen Titels in der Abspielliste
- currentTrackURI: Dateipfad des aktuellen Titels in der Abspielliste. Gültige Formate siehe PlayURI.
- currentTrackDuration: Länge des aktuellen Titels im Format H:MM:SS
- currentTrackPosition: Position innerhalb des aktuellen Titels im Format H:MM:SS. Wird zum Zeitpunkt einer Änderung des Abspielstatus (Play, Pause, Stop, Nächster Titel, usw.) aktualisiert.
- currentSender: Senderbezeichnung, wenn es ein Radiostream ist
- currentSenderCurrent: Zusatzinformationen zur Radiosendung, meist der Programmtitel wie 'Pop&Weck'
- currentSenderInfo: Zusatzinformationen zur Radiosendung, meist der Titel des aktuellen Liedes
- currentAlbumArtURI: Relativer Verzeichnis-Pfad im lokalen FHEM (physisch). Beginnt momentan mit "www"
- currentAlbumArtURL: Kompletter Pfad für den eigenen Download der Coverdatei des aktuellen Titels oder für die Angabe in einer HTML-IMG-Source.
Infos zum nächsten Titel
- nextTitle: Titelbezeichnung des nächsten Titels
- nextArtist: Interpret des nächsten Titels
- nextAlbum: Albumname des nächsten Titel
- nextAlbumArtist: Interpret des Albums des nächsten Titels. Kann z.B. auch "(compilations)" sein.
- nextOriginalTrackNumber: Nummer des nächsten Titels bezogen auf das Album
- nextAlbumArtURI: Relativer Verzeichnis-Pfad im lokalen FHEM (physisch). Beginnt momentan mit "www"
- nextAlbumArtURL: Kompletter Pfad für den eigenen Download der Coverdatei des nächsten Titels oder für die Angabe in einer HTML-IMG-Source.
- nextTrackURI: Dateipfad des nächsten Titels in der Abspielliste. Gültige Formate siehe PlayURI.
- nextTrackDuration: Länge des nächsten Titels im Format H:MM:SS
Generierte Informationen
- infoSummarize1: Frei zusammenstellbare Informationszeile. Zum Format siehe [InfoSummarize]
- infoSummarize2: Frei zusammenstellbare Informationszeile. Zum Format siehe [InfoSummarize]
- infoSummarize3: Frei zusammenstellbare Informationszeile. Zum Format siehe [InfoSummarize]
- infoSummarize4: Frei zusammenstellbare Informationszeile. Zum Format siehe [InfoSummarize]
- currentStreamAudio: Boolean. 1 wenn gerade ein Radiostream läuft, sonst 0. Momentan faktisch Negation zu <currentNormalAudio>
- currentNormalAudio: Boolean. 1 wenn gerade ein normaler Titel läuft, sonst 0. Momentan faktisch Negation zu <currentStreamAudio>

Attribute von SONOSPLAYER

Grundsätzliches
- disable(0,1): Deaktiviert die Verarbeitung von Events dieses Devices
- generateSomethingChangedEvent(0,1): Bestimmt, ob ein Event mit dem Namen 'SomethingChanged' generiert werden soll, wenn überhaupt ein Event generiert wurde. Das ist nützlich, wenn man auf eine beliebige Änderung des Player reagieren möchte.
- generateVolumeEvent(0,1): Aktiviert die Generierung eines Events bei Lautstärkeänderungen, wenn mindestens eines der Attribute minVolume, maxVolume, minVolumeHeadphone oder maxVolumeHeadphone definiert ist. Standardmäßig ist dies deaktiviert (=0), um die Zeitverzögerung so gering wie möglich zu halten.
- generateVolumeSlider(0,1): Aktiviert einen Slider für die Lautstärkeneinstellung auf der Detailansicht. Standardmäßig ist dieser aktiviert (=1).
- getAlarms(0,1): Meldet sich bei Playern für die Aktualisierung von Alarm-Informationen an. Diese werden bei Änderung direkt aktualisiert, und erzeugen dementsprechend ein Fhem-Event. Gleichzeitig wird hiermit die DailyIndexRefreshTime mit aktualisiert.
- VolumeStep: Definiert die Schrittweite für den Aufruf von VolumeU und VolumeD.
Informationen generieren
- generateInfoSummarize1: Generiert das Reading 'InfoSummarize1' mit dem angegebenen Format.
- generateInfoSummarize2: Generiert das Reading 'InfoSummarize2' mit dem angegebenen Format.
- generateInfoSummarize3: Generiert das Reading 'InfoSummarize3' mit dem angegebenen Format.
- generateInfoSummarize4: Generiert das Reading 'InfoSummarize4' mit dem angegebenen Format.
- stateVariable(TransportState,NumberOfTracks,Track,TrackDuration,Title,Artist,Album,

OriginalTrackNumber,AlbumArtist,Sender,SenderCurrent,SenderInfo,StreamAudio,NormalAudio, AlbumArtURI,nextTrackDuration,nextTrackURI,nextAlbumArtURI,nextTitle,nextArtist, nextAlbum,nextAlbumArtist,nextOriginalTrackNumber,Volume,Mute,Shuffle,Repeat,CrossfadeMode, Balance,HeadphoneConnected,SleepTimer,Presence,RoomName,SaveRoomName,PlayerType,Location, SoftwareRevision,SerialNum,InfoSummarize1,InfoSummarize2,InfoSummarize3,InfoSummarize4): Legt fest, welcher Variablenwert in den State geschrieben werden soll.

Steueroptionen
- maxVolume(0..100): Legt die obere Grenze für die einstellbare Lautstärke dieses ZonePlayers fest. Diese kann auch mit keinem Controller überschritten werden, da diese überwacht wird.
  - Wenn eine untere oder obere Grenze festgelegt wurde, so wird das Reading Volume am entsprechenden SonosPlayer bei jeder Änderung am Player aktualisiert.
    Möchte man also immer die aktuelle Lautstärke kennen, aber keine Enschränkung machen, dann sollte der Wert von minVolume auf 0 oder maxVolume auf 100 gesetzt werden. Desweiteren werden gleichzeitig auch Änderungen an der Balance aktualisiert, da diese mit übertragen werden.
  - Achtung!: Wenn eine untere oder obere Grenze festgelegt wird, werden für Lautstärkenänderungen auch Events erzeugt. Es ist unbedingt darauf zu achten, dass etwaige Notify-Definitionen zügig bearbeitet werden, da sonst das Sonos-System träge werden könnte.
- minVolume(0..100): Legt die untere Grenze für die einstellbare Lautstärke dieses ZonePlayers fest. Diese kann auch mit keinem Controller unterschritten werden, da diese überwacht wird.
  - Wenn eine untere oder obere Grenze festgelegt wurde, so wird das Reading Volume am entsprechenden SonosPlayer bei jeder Änderung am Player aktualisiert.
    Möchte man also immer die aktuelle Lautstärke kennen, aber keine Enschränkung machen, dann sollte der Wert von minVolume auf 0 oder maxVolume auf 100 gesetzt werden. Desweiteren werden gleichzeitig auch Änderungen an der Balance aktualisiert, da diese mit übertragen werden.
  - Achtung!: Wenn eine untere oder obere Grenze festgelegt wird, werden für Lautstärkenänderungen auch Events erzeugt. Es ist unbedingt darauf zu achten, dass etwaige Notify-Definitionen zügig bearbeitet werden, da sonst das Sonos-System träge werden könnte.
- maxVolumeHeadphone(0..100): Legt die obere Grenze für die einstellbare Lautstärke dieses ZonePlayers im Kopfhörerbetrieb fest.
  - Hinweis!: Es gelten die gleichen Bedingungen und Hinweise wie bei maxVolume.
- minVolumeHeadphone(0..100): Legt die untere Grenze für die einstellbare Lautstärke dieses ZonePlayers im Kopfhörerbetrieb fest.
  - Hinweis!: Es gelten die gleichen Bedingungen und Hinweise wie bei minVolume.
- buttonEvents <Time:Pattern>[ <Time:Pattern> ...]: Definiert, dass bei einer bestimten Tastenfolge am Player ein Event erzeugt werden soll. Die Definition der Events erfolgt als Tupel: Der erste Teil vor dem Doppelpunkt ist die Zeit in Sekunden, die berücksichtigt werden soll, der zweite Teil hinter dem Doppelpunkt definiert die Abfolge der Buttons, die für dieses Event notwendig sind.
  - Folgende Button-Kürzel sind zulässig:
    - M: Der Mute-Button (Achtung: Der Mute-Button am SonosPlayer ist seit Firmware 4.2 ein Play/Pause/Next-Button, der kein Mute-Event mehr erzeugt, meine Beschwerde an Sonos, dass es nicht benutzerfreundlich ist, einen Mute-Symbolisierten Button mit Play/Pause zu belegen, wurde im großen und ganzen ignoriert)
    - H: Die Headphone-Buchse
    - U: Up-Button (Lautstärke Hoch)
    - D: Down-Button (Lautstärke Runter)
  - Das Event, das geworfen wird, heißt ButtonEvent, der Wert ist die definierte Tastenfolge
    Z.B.: 2:MM
    Hier wird definiert, dass ein Event erzeugt werden soll, wenn innerhalb von 2 Sekunden zweimal die Mute-Taste gedrückt wurde. Das damit erzeugte Event hat dann den Namen ButtonEvent, und den Wert MM.

Get-Befehle an den SONOSPLAYER

Hinweis!: Es wurden ein paar Get-Möglichkeiten entfernt. Diese Befehle (wie z.B. Volume) können mittlerweile direkt geliefert werden, und müssen nicht angefordert werden. Übrig geblieben sind nur noch solche Anweisungen, die Informationen beschaffen, die nicht automatisch geliefert werden (können).

Grundsätzliches
- Alarm <ID>: Ausnahmefall. Diese Get-Anweisung liefert direkt ein Hash zurück, in welchem die Informationen des Alarms mit der gegebenen ID enthalten sind. Es ist die Kurzform für eval(ReadingsVal(<Devicename>, 'Alarmlist', ()))->{<ID>};, damit sich nicht jeder ausdenken muss, wie er jetzt am einfachsten an die Alarm-Informationen rankommen kann.
- EthernetPortStatus <PortNumber>: Liefert den Ethernet-Portstatus des gegebenen Ports ('0' oder '1'). Kann 'Active' oder 'Inactive' liefern.
- PossibleRoomIcons: Liefert eine Liste aller möglichen RoomIcon-Bezeichnungen zurück.
Listen
- Favourites: Liefert eine Liste mit den Namen aller gespeicherten Sonos-Favoriten. Das Format der Liste ist eine Komma-Separierte Liste, bei der die Namen in doppelten Anführungsstrichen stehen. z.B. "Liste 1","Eintrag 2","Test"
- FavouritesWithCovers: Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller gespeicherten Sonos-Favoriten. Z.B.: {'FV:2/22' => {'Cover' => 'urlzumcover', 'Title' => '1. Favorit'}}. Dieser String kann einfach mit eval in eine Perl-Datenstruktur umgewandelt werden.
- Playlists: Liefert eine Liste aller gespeicherten Playlists. Diese Anfrage liefert bei allen Zoneplayern die gleiche Liste zurück. Das Format ist eine Komma-Separierte Liste, bei der die Einträge in doppelten Anführungszeichen stehen z.B. "Liste 1","Liste 2","Test"
- PlaylistsWithCovers: Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller gespeicherten Sonos-Playlisten. Z.B.: {'SQ:14' => {'Cover' => 'urlzumcover', 'Title' => '1. Playlist'}}. Dieser String kann einfach mit eval in eine Perl-Datenstruktur umgewandelt werden.
- Radios: Liefert eine Liste aller gespeicherten Radiosender (Favoriten). Diese Anfrage liefert bei allen Zoneplayern die gleiche Liste zurück. Das Format ist eine Komma-Separierte Liste, bei der die Einträge in doppelten Anführungszeichen stehen z.B. "Sender 1","Sender 2","Test"
- RadiosWithCovers: Liefert die Stringrepräsentation eines Hash mit den Namen und Covern aller gespeicherten Sonos-Radiofavoriten. Z.B.: {'R:0/0/2' => {'Cover' => 'urlzumcover', 'Title' => '1. Radiosender'}}. Dieser String kann einfach mit eval in eine Perl-Datenstruktur umgewandelt werden.
Informationen zum aktuellen Titel
- CurrentTrackPosition: Liefert die aktuelle Zeitposition im Lied

Set-Befehle an den SONOSPLAYER

Hinweis!: Alle Set-Befehle liefern kein direktes Ergebnis zurück. Sollte ein Ergebnis generiert werden (meistens eine Statusmeldung, bzw. was genau getan wurde), so landet dies nach der Ausführung in dem Reading LastActionResult.

Grundsätzliche Einstellungen
- Alarm <Create|Update|Delete> <ID> <Datenhash>: Diese Anweisung wird für die Bearbeitung der Alarme verwendet:
  - Create: Erzeugt einen neuen Alarm-Eintrag mit den übergebenen Hash-Daten. Der Rückgabewert ist die ID des neuen Alarms.
  - Update: Aktualisiert den Alarm mit der übergebenen ID und den angegebenen Hash-Daten.
  - Delete: Löscht den Alarm-Eintrag mit der übergebenen ID.
  - Datenhash: Das Format ist ein Perl-Hash und wird mittels der eval-Funktion interpretiert. Eine Beschreibung befindet sich bei der Dokumentation des Readings AlarmList oder den folgenden Beispielen.
  - Beispiele:
    - set Sonos_Wohnzimmer Alarm Create 0 { Enabled => 1, Volume => 35, StartTime => '00:00:00', Duration => '00:15:00', Repeat => 0, Shuffle => 0, ProgramURI => 'x-rincon-buzzer:0', ProgramMetaData => ' ', Recurrence_Once => 0, Recurrence_Monday => 1, Recurrence_Tuesday => 1, Recurrence_Wednesday => 1, Recurrence_Thursday => 1, Recurrence_Friday => 1, Recurrence_Saturday => 0, Recurrence_Sunday => 0, IncludeLinkedZones => 0 }: Erzeugt einen neuen Alarm mit den angegebenen Informationen. Die neue ID wird als Ergebnis zurückgegeben.
    - set Sonos_Wohnzimmer Alarm Update 17 { Shuffle => 1 }: Aktualisiert den Alarm mit der ID 17, und passt dort Shuffle auf Aktiv an.
    - set Sonos_Wohnzimmer Alarm Delete 17: Löscht den Alarm mit der ID 17.
- DailyIndexRefreshTime: Legt die aktuell gültige DailyIndexRefreshTime fest, zu der der Medienindex neu aufgebaut werden soll. Der Wert muss ein kompletter Zeitstempel sein (HH:MM:SS).
- Icon: Legt das Icon für die Zone fest.
- Name: Legt den Namen der Zone fest.
- Reboot: Führt für den Zoneplayer einen Neustart durch.
- Wifi <State>: Setzt den WiFi-Zustand des Players. Kann 'off', 'persist-off' oder 'on' sein.
Abspiel-Steuerbefehle
- CurrentTrackPosition <TimePosition>: Setzt die aktuelle Zeitposition im Lied
- Pause: Pausiert die Wiedergabe
- Previous: Springt zum Anfang des vorhergehenden Liedes. Das ist ein anderes Verhalten als mit einem Controller. Der Controller springt zunächst an den Anfang des aktuellen Liedes, und erst beim erneuten Drücken an den Anfang des vorhergehenden Liedes.
- Play: Startet die Wiedergabe
- PlayURI <SongURI> [Volume]: Spielt die angegebene MP3-Datei mit der optional verwendbaren Lautstärke ab. Die Datei muss vom SonosPlayer aus direkt erreichbar (und natürlich auch lesbar) sein, braucht aber nicht indiziert worden zu sein.
  Folgende Formate werden momentan akzeptiert:
  - Sonos-Devicenamen: z.B. Sonos_Wohnzimmer. Der Devicename muss natürlich bereits definiert worden sein. Es wird der AV-Eingang des gewählten Zoneplayer-Device als Wiedergabestrom gewählt.
    - Besonderheit bei Sonos Playbar-Komponenten:
      Wenn als Quelle eine Playbar ausgewählt wird, so wird erst die Playbar selbst auf den SPDIF-Eingang umgestellt, und anschließend eine Gruppe mit dem gewünschten Player gebildet.
      Wenn diese Anweisung an die Playbar selbst gegeben wird, dann wird nur der SPDIF-Eingang als Quelle aktiviert.
  - UNC-Pfade: z.B. \\Server\Freigabe\Dateiname.mp3. Erkennungsmerkmal ist der Doppelte Backslash am Anfang. Darstellung aller üblichen Informationen inkl. Cover u.ä.
  - Web-Streams: z.B. http://www.energyradio.de/hot. Erkennungsmerkmal ist die Angabe von http:// am Anfang. Es werden keine Cover aber Streaminformationen dargestellt.
  - Sonstige URI-Typen: z.B. x-sonos-spotify:spotify:track:0jkLC0noG4A4i9lob2gSc3?sid=9&flags=0. Darstellung aller üblichen Informationen. Die verfügbaren Formate können durch Sonos erweitert/verändert werden.
    Hinweis: Das Format der URI, das hier angegeben werden kann, ist stets identisch zum Reading currentTrackURI, das bedeutet, dass die URI, die man dort sieht, hier direkt wieder angegeben werden kann.
    Es gibt lediglich die oben benannte Vereinfachung für MP3-Dateien und Radio-URLs (aber auch dafür könnte man das offizielle Format angeben).
- PlayURITemp <SongURI> [Volume]: Spielt die angegebene MP3-Datei mit der optional verwendbaren Lautstärke als temporäre Datei ab. Nachdem die Datei abgespielt wurde, werden die vorhergehenden Abspielparameter (Lautstärke, Titel, Position usw.) wiederhergestellt. Im Normalfall geht es also direkt dort weiter, wo die Unterbrechung stattgefunden hat. Die Datei muss vom SonosPlayer aus direkt erreichbar (und natürlich auch lesbar) sein, braucht aber nicht indiziert worden zu sein. Für eine ordnungsgemäße Wiederherstellung ist es notwendig, dass dies eine Datei und kein Stream ist, da die Abspiellänge vorher bekannt sein muss.
  - Für Streams (genauer: Für Dateien, deren Abspiellänge nicht ermittelt werden kann) ist dieser Aufruf identisch zu PlayURI, es wird im Anschluß nichts wiederhergestellt.
  - Zulässige Formate stehen unter PlayURI.
  - Achtung!: Zum Ermitteln der Liedlänge wird u.U. eine zusätzliche Library verwendet (Wenn die Info nicht vom SonosPlayer bereitgestellt wird): MP3::Info. Diese Library muss zusätzlich in das FHEM-Lib-Verzeichnis kopiert werden.
  - Achtung!: Wenn bereits eine temporäre Ausgabe erfolgt, so wird die Aufforderung mit einer entsprechenden Meldung verworfen. Es kann nur eine geben :-)
- Next: Springt zum Anfang des nächsten Liedes
- Speak <Volume> <Language> <Text>: Wandelt den angegebenen Text mittels Google in gesprochenen Text um und spielt diesen mittels PlayURITemp ab. An dieser Stelle ist zu berücksichtigen, dass der Text-Parameter auch Leerzeichen enthalten darf (und damit nach FHEM-Regeln eigentlich mehrere Parameter sind). Deswegen steht die Lautstärke vorne als nicht optionaler Parameter.
  - Hinweis: In dem generierten MP3 wird ein ID3-Tag eingetragen, in dem die Umlaute wohl leider nicht sauber ankommen. Deswegen ist im Sonos-Controller die Anzeige dieser Umlaute bei den Sprachdurchsagen auch nicht korrekt.
  - Achtung!: Für die korrekte Funktionsweise müssen die Attribute targetSpeakDir und targetSpeakURL am Sonos-Device konfiguriert sein (siehe Attribute von SONOS).
  - Mögliche Sprachparameter können bei Google herausgefunden werden. Diese sind z.B. de, en, es, fr, it...
  - Achtung!: Die Textlänge ist durch Google begrenzt. Wenn die Größe überschritten wird, erhält man eine Fehlermeldung im Log: "404 Not found". Leider erhielt ich in meinen Tests unterschiedliche Ergebnisse bzgl. der verwendbaren Länge (ca. 100 Zeichen). Einfach probieren.
  - Achtung!: Wenn bereits eine temporäre Ausgabe erfolgt, so wird die Aufforderung mit einer entsprechenden Meldung verworfen. Es kann nur eine geben :-)
- StartFavourite <FavouriteName> [NoStart]: Startet den angegebenen Favoriten. Der Name bezeichnet einen Eintrag in der Sonos-Favoritenliste. Der Parameter sollte/kann URL-Encoded werden um auch Spezialzeichen zu ermöglichen.
  - Wenn das Wort 'NoStart' als zweiter Parameter angegeben wurde, dann wird der Favorit geladen und fertig vorbereitet, aber nicht explizit gestartet.
  - Folgende Unterscheidungen werden auf Basis des Typs des Sonos-Favoriten gemacht:
    - Bei einem Playlist-Typ (z.B. Sonos-Playlist, Spotify-Playlist, usw.) wird die aktuelle Abspielliste geleert, mit dem neuen Inhalt befüllt und die Wiedergabe gestartet
    - Bei einem Einzel-Eintrag (Direkter Titel, Radiosender, Spotify-Titel, usw) wird die aktuelle Abspielliste nicht angetastet, sondern der aktuelle Abspieleintrag entsprechend angepasst und gestartet
- StartPlaylist <Playlistname> [ListeVorherLeeren]: Lädt die benannte Playlist und startet sofort die Wiedergabe.
  Zu den Parametern und Bemerkungen bitte unter LoadPlaylist nachsehen.
- StartRadio <Radiostationname>: Lädt den benannten Radiosender, genauer gesagt, den benannten Radiofavoriten und startet sofort die Wiedergabe. Dabei wird die bestehende Abspielliste beibehalten, aber deaktiviert. Der Parameter kann/muss URL-Encoded sein, um auch Leer- und Sonderzeichen angeben zu können.
- Stop: Stoppt die Wiedergabe
- Track <TrackNumber>: Stellt das Lied an der Position TrackNumber in der Abspielliste als aktuelles Lied ein. Dabei kann als Tracknummer der Wert Random angegeben werden. Dann wird eine zufällige Tracknummer ausgewählt (diese Ermittlung erfolgt nach Setzen der aktuellen Abspielliste, und erfolgt somit korrekt auf die gesamte zur Verfügung stehende Liste).
Einstellungen zum Abspielen
- Balance: Setzt die Balance auf den angegebenen Wert. Der Wert kann zwischen -100 (voll links) und 100 (voll rechts) liegen. Gibt die wirklich eingestellte Balance als Ergebnis zurück.
- Bass: Setzt den Bass-Level auf den angegebenen Wert. Der Wert kann zwischen -10 und 10 liegen.
- CrossfadeMode: Legt den Zustand des Crossfade-Mode fest. Liefert den aktuell gültigen Crossfade-Mode.
- LEDState: Legt den Zustand der LED fest. Liefert den aktuell gültigen Zustand zurück.
- Loudness: Aktiviert oder deaktiviert das Loudness (Bassanhebung bei geringen Lautstärken). Kann 0 oder 1 sein.
- Mute <State>: Setzt den Mute-Zustand auf den angegebenen Wert. Der Wert kann on oder off sein. Liefert als Ergebnis den neuen Zustand.
- MuteT: Schaltet den Mute-Zustand um. Liefert als Ergebnis den neuen Zustand.
- Repeat: Legt den Zustand des Repeat-Zustands fest. Liefert den aktuell gültigen Repeat-Zustand.
- Shuffle: Legt den Zustand des Shuffle-Zustands fest. Liefert den aktuell gültigen Shuffle-Zustand.
- SleepTimer: Legt den aktuellen SleepTimer fest. Der Wert muss ein kompletter Zeitstempel sein (HH:MM:SS). Zum Deaktivieren darf der Zeitstempel nur Nullen enthalten oder das Wort 'off'.
- Treble: Setzt den Höhen-Level auf den angegebenen Wert. Der Wert kann zwischen -10 und 10 liegen.
- Volume <VolumeLevel> [RampType]: Setzt die Lautstärke auf den angegebenen Wert. Der kann eine relative Angabe mittels + oder - sein. Dann wird um die entsprechende Höhe erhöht oder verringert. Wird eine relative Lautstärke angegeben, so kann diese mit einem folgenden Prozentzeichen als anteilige Änderung ausgeführt werden (z.B. +20%). Liefert als Ergebnis die neue Lautstärke.
  Als optionaler Parameter ist ein Ramptype zulässig. Mögliche Werte sind 1 (SLEEP_TIMER_RAMP_TYPE), 2 (AUTOPLAY_RAMP_TYPE) und 3 (ALARM_RAMP_TYPE). Die Werte entsprechen verschiedenen Mustern bei der Geschwindigkeit nach oben oder unten.
- VolumeD: Verringert die Lautstärke um [VolumeStep]-Einheiten (Standardmäßig 10).
- VolumeRestore: Stellt die mittels VolumeSave gespeicherte Lautstärke wieder her.
- VolumeSave <VolumeLevel>: Setzt die Lautstärke auf den angegebenen Wert. Der kann eine relative Angabe mittels + oder - sein. Dann wird um die entsprechende Höhe erhöht oder verringert. Liefert als Ergebnis die neue Lautstärke. Zusätzlich wird die alte Lautstärke in einem Reading abgelegt, um sie wiederherstellen zu können.
- VolumeU: Erhöht die Lautstärke um [VolumeStep]-Einheiten (Standardmäßig 10).
Steuerung der aktuellen Abspielliste
- AddURIToQueue <SongURI>: Fügt die angegebene Datei in die aktuelle Abspielliste an die Stelle hinter dem aktuellen Titel hinzu. Ändert nichts am aktuell abgespielten Titel.
  Zulässige Formate stehen unter PlayURI.
  - Achtung!: Es kann auch ein Radio-Stream hinzugefügt werden. Dieser wird auch normal abgespielt, wenn er dran ist. Dabei ist zu beachten, dass dieser Titel nie enden wird, und die Titel- und Interpretinformationen nicht dargestellt werden. Auch nicht die sonst üblichen Streaminformationen. Diese werden nur angezeigt, wenn der Stream mittels PlayURI direkt (ohne Verwendung der Queue) abgespielt wird.
- CurrentPlaylist: Setzt den Abspielmodus auf die aktuelle Abspielliste, startet aber keine Wiedergabe (z.B. nach dem Hören eines Radiostreams, wo die aktuelle Abspielliste zwar noch existiert, aber gerade "nicht verwendet" wird)
- EmptyPlaylist: Löscht die aktuelle Abspielliste
- LoadPlaylist <Playlistname> [ListeVorherLeeren]: Lädt die benannte Playliste in die aktuelle Abspielliste. Der Parameter kann/muss URL-Encoded sein, um auch Leer- und Sonderzeichen angeben zu können. Wenn der Parameter ListeVorherLeeren mit 1 angegeben wurde, wird die aktuelle Abspielliste vor dem Import geleert. Standardmäßig wird hier eine 1 angenommen.
  - Hinweis: Es kann auch ein Dateiname angegeben werden, um eine übliche M3U-Datei aus dem Filesystem zu laden. Dieser muss mit "file:" eingeleitet werden. Beispiel: "file:c:/Test.m3u".
    Innerhalb der Datei selbst werden bislang folgende Sonderformate unterstützt:
    - Spotify: Titel aus Spotify werden mit dem Kürzel x-sonos-spotify: begonnen.
    - Napster/Rhapsody: Titel aus Napster/Rhapsody werden mit dem Kürzel npsdy: begonnen.
    - Hinweise: Die Benutzernamen für diese Importe, die zum Zeitpunkt des Import bekannt sein müssen, müssen zuvor dem System bekannt gemacht werden. Ansonsten erscheint eine entsprechende Fehlermeldung.
      So kann der Benutzername für eines der Systeme bekannt gemacht werden:
      - Aktuelle Abspielliste eines Players leeren
      - Einen beliebigen Titel aus dem gewünschten Anbieter in die aktuelle Abspielliste einfügen. Dabei ist zu beachten, dass man das direkt aus der Auswahl des Anbietes heraus macht (also nicht über eine Playliste, Favoriten o.ä. Direktzugriffe)
      - Nun gibt es ein neues Reading am zentralen Sonos-Device, welches den Benutzernamen enthält. Um diesen Dauerhaft bereitzustellen, muss der Zustand mittels save gespeichert werden.
- LoadRadio <Radiostationname>: Lädt den benannten Radiosender, genauer gesagt, den benannten Radiofavoriten. Dabei wird die bestehende Abspielliste beibehalten, aber deaktiviert. Der Parameter kann/muss URL-Encoded sein, um auch Leer- und Sonderzeichen angeben zu können.
- SavePlaylist <Playlistname>: Speichert die aktuelle Abspielliste unter dem angegebenen Namen als Playliste ab. Dabei wird eine etwaig bestehende Liste gleichen Namens überschrieben. Der Parameter kann/muss URL-Encoded sein, um auch Leer- und Sonderzeichen angeben zu können.
  - Hinweis: Es kann auch ein Dateiname angegeben werden, um eine übliche M3U-Datei im Filesystem zu erzeugen. Dieser muss mit "file:" eingeleitet werden. Beispiel: "file:c:/Test.m3u".
    Nähere Informationen zum möglichen Inhalt der Datei siehe unter LoadPlayList.
Gruppenbefehle
- AddMember <Devicename>: Fügt dem Device das übergebene Device als Gruppenmitglied hinzu. Die Wiedergabe des aktuellen Devices bleibt erhalten, und wird auf das angegebene Device mit übertragen.
- CreateStereoPair <rightPlayerDevicename>: Fügt dem Device das übergebene Device als rechtes Stereopaar-Element hinzu. Die Wiedergabe des aktuellen Devices bleibt erhalten (als linker Lautsprecher), und wird auf das angegebene Device mit übertragen (als rechter Lautsprecher).
- GroupMute <State>: Setzt den Mute-Zustand für die komplette Gruppe in einem Schritt. Der Wert kann on oder off sein.
- GroupVolume <VolumeLevel>: Setzt die Gruppenlautstärke. Das dafür verwendete Lautstärkenverhältnis muss zuvor einmal mittels der Anweisung SnapshotGroupVolume festgelegt worden sein.
  - Hinweis: Wenn man GroupVolume aufruft, ohne vorher SnapshotGroupVolume aufgerufen zu haben, wird nur die Lautstärke des Players verändert wird, für den man den Aufruf durchführt.
- RemoveMember <Devicename>: Entfernt dem Device das übergebene Device, sodass die beiden keine Gruppe mehr bilden. Die Wiedergabe des aktuellen Devices läuft normal weiter. Das abgetrennte Device stoppt seine Wiedergabe, und hat keine aktuelle Abspielliste mehr (seit Sonos Version 4.2 hat der Player wieder die Playliste von vorher aktiv).
- SeparateStereoPair: Trennt das Stereopaar wieder auf.
- SnapshotGroupVolume: Legt das Lautstärkeverhältnis der aktuellen Player der Gruppe für folgende GroupVolume-Aufrufe fest. Dieses festgelegte Verhältnis wird bis zum nächsten Aufruf von SnapshotGroupVolume beibehalten.
  - Hinweis: Das einzelne Verstellen von Zoneplayer-Laustärken mittels Volume wird nicht im bereits gespeicherten Lautstärkenverhältnis aktualisiert/widergespiegelt. Hat man also nachträglich die Lautstärke eines einzelnen Players geändert (auch über den Controller), so muss SnapshotGroupVolume erneut aufgerufen werden, damit das Verhältnis bei einer weiteren Gruppenlautstärkenänderung wieder erhalten bleibt (ansonsten wird das alte Verhältnis vor der Lautstärkeänderung wiederhergestellt).
  - Hinweis: Dieser Aufruf muss vor einem eventuellen Aufruf von GroupVolume erfolgen, da sonst nur die Lautstärke des Players verändert wird, für den man den Aufruf durchführt.
  - Beispiel für eine Gruppe mit stark verschiedenen Lautstärken:
    - Aufruf von SnapshotGroupVolume => Aktuelles Lautstärkeverhältnis wird gespeichert
    - Aufruf von GroupVolume 2 => Gruppe wird sehr leise gestellt, dabei sieht das relative Lautstärkeverhältnis fast gleich aus, da sich die Abstände immer weiter annähern
    - Aufruf von GroupVolume 35 => Gruppe wird laut gestellt, dabei kommt wieder das vorhergehende Lautstärkeverhältnis zum tragen

Definition der InfoSummarize

infoSummarizeX := <NormalAudio>:sumElem:</NormalAudio> <StreamAudio>:sumElem:</StreamAudio>|
	:sumElem:
sumElem := <:variable:[ prefix=":text:"][ suffix=":text:"][ instead=":text:"]
	[ ifempty=":text:"][ emptyval=":text:"]/>
variable := TransportState|NumberOfTracks|Track|TrackDuration|Title|Artist|Album|
	OriginalTrackNumber|AlbumArtist|Sender|SenderCurrent|SenderInfo|StreamAudio|NormalAudio|
	AlbumArtURI|nextTrackDuration|nextTrackURI|nextAlbumArtURI|nextTitle|nextArtist|
	nextAlbum|nextAlbumArtist|nextOriginalTrackNumber|Volume|Mute|Shuffle|Repeat|
	CrossfadeMode|Balance|HeadphoneConnected|SleepTimer|Presence|RoomName|SaveRoomName|
	PlayerType|Location|SoftwareRevision|SerialNum|InfoSummarize1|InfoSummarize2|
	InfoSummarize3|InfoSummarize4
text := [Beliebiger Text ohne doppelte Anführungszeichen]

Die Unterscheidung zwischen <NormalAudio> und <StreamAudio> liegt bei der anliegenden Musikquelle. Gestreamte Audioquellen habe nur einen kleineren Set an Informationen vorliegen, während bei einer "normalen" Musikquelle z.B. eine Unterscheidung zwischen Artist und Title gemacht wird, und im Gegenzug z.B. kein Sendername existiert.
Man kann diese Unterscheidung auch weglassen, und direkt die Variablenausgaben hinschreiben. Dann gilt der Code für beide Musikquellenarten gleichermaßen (u.U. sind dann einige Felder nicht sinnvoll bzw. gar nicht gefüllt).

Die Tag-Erweiterungen prefix und suffix werden jeweils vor bzw. hinter den Feldwert in die Ausgabe gesetzt, wenn es einen Feldwert zum Ausgeben gibt.
Die Erweiterung instead wird anstatt des Feldwerts ausgegeben, wenn normalerweise der Feldwert ausgegeben werden würde (abhängig davon, ob der Feldwert als empty angesehen wird, oder nicht).
Die Erweiterung ifempty wird eingesetzt, wenn es gerade keinen Feldinhalt gibt. In diesem Fall werden natürlich auch keine Pre- und Suffixe sowie Instead-Angaben ausgegeben.
Die Erweiterung emptyval legt fest, was neben einem undefinierten Feldwert noch als leer gelten soll. Dies ist interessant, wenn man z.B. den Zahlwert 0 als leer festlegen möchte.
Beim Definieren dieser Erweiterungen ist zu beachten, dass keine doppelten Anführungszeichen angegeben werden. Diese zerstören die weitere, interne Verarbeitung durch FHEM (Irgendwas ist immer :-) Desweiteren können Verweise auf andere InfoSummarize-Felder nur in aufsteigender Reihenfolge erfolgen. Es sind also keine Vorwärtsreferenzen oder Rekursionen möglich.

Fehlende Kommandos

Sollte eine Steuerungsmöglichkeit oder Information fehlen, oder anderes gewünscht sein, dann einfach eine Nachricht ins Forum. Meistens läßt sich da was machen :-)

Ideenpipeline

Folgende Ideen sind bereits in der gedanklichen Pipeline. Aber alles Schritt für Schritt und der Reihe nach:

Momentan Leer

Erledigte Ideen:

Zwischendurchsage: Eine Datei abspielen, und danach wieder an der alten Stelle mit der alten Lautstärke weiterspielen (In Version 1.5 hinzugekommen)
Beliebige MP3s in die Queue legen oder abspielen: Entgegen dem Controllergefühl kann man sehr wohl völlig frei abspielbare Dateien in der Queue haben. Es kann nur sein, das man kein Cover oder ähnliches angezeigt bekommt (noch zu testen). (In Version 1.5 hinzugekommen, Cover funktionieren wie immer)
Beliebige Radiostationen abspielen: Hier gilt das gleich wie für die MP3s. (In Version 1.5 hinzugekommen, Cover und Streaminformationen funktionieren beim Direktabspielen, aus der Queue heraus wird nur der Stream abgespielt)
Lautstärkegrenzen festlegen: Damit soll festgelegt werden können, in welchen Grenzen die Lautstärke überhaupt verändert werden kann. Das soll in der entsprechenden Zone natürlich auch für die normalen Sonos-Controller gelten. Dabei werden explizit keine Readings im FHEM aktualisiert, da eine Lautstärkeänderung sonst von der Verarbeitungsgeschwindigkeit von FHEM (inkl. seiner Notifies) abhängig wäre. (In Version 1.8 hinzugekommen)
Zonentopologie verwenden/anpassen: Es soll eine Speichermöglichkeit für die aktuelle Topologie geschaffen werden, und auch eine neue Topologie gesetzt werden können. Ich stelle mir da eine Art von "Szenen" vor die man nach Bedarf setzen und dann natürlich auch steuern kann. Diese Szenen sollen den Gruppierungszustand aller verfügbaren ZonePlayer repräsentieren (können), also wer mit wem in einer Gruppe ist, und wer der jeweilige Koordinator ist (nur dieser kann die Steuerung entgegennehmen, und für die gesamte Gruppe ausführen). (In Version 2.0 hinzugekommen)
Button-Events: Es soll eine Möglichkeit zum direkten Reagieren auf Tastenevents am Player existieren. Man soll verschiedene Tastensequenzen festlegen können, die dann Fhem-Events erzeugen, auf die man reagieren kann. (In Version 2.0 hinzugekommen)

Beispiele

Hier können mit der Zeit ein paar Beispiele eingestellt werden, um die Möglichkeiten zu verdeutlichen.

Beispiel zum Loggen aller Aktionen auf allen Playern

define FileLog_Sonos_Actions FileLog /path/to/log/Sonos_Actions-%Y-%m.log \
		Sonos_.*:.*LastActionResult.*

Hiermit wird jede Aktion, die, durch Fhem verursacht, an die Player gesendet wurde, mitgeschrieben. Sehr praktisch für Fehlersuche, bzw. die Kontrolle darüber, was eigentlich von Fhem aus so auf den Playern gesteuert wird.

Beispiel zum automatischen Abspielen einer Liste nach dem Einschalten eines Players

define Sonos_Wohnzimmer_Appeared_Notify notify Sonos_Wohnzimmer:presence:.appeared { \
	fhem "set Sonos_Wohnzimmer LoadPlaylist R.%%20Spielliste" ;; \
	fhem "set Sonos_Wohnzimmer Volume 15" ;; \
	fhem "set Sonos_Wohnzimmer Track random" ;; \
	fhem "set Sonos_Wohnzimmer Play" \
}

Hier wird auf das Event presence: appeared reagiert und eine Playlist geladen (hier mit Leerzeichen im Namen, darum mittels "%20" HTML-kodiert, was wiederum wegen FHEM-Notify auf "%%20" kodiert werden muss). Anschließend wird die Lautstärke gesetzt, ein Titel ausgewählt (zufällig) und das Abspielen gestartet.

Beispiel für eine Verstärkerschaltung auf Basis des Player-Zustands

define Sonos_Wohnzimmer_GoPlaying_Notify notify Sonos_Wohnzimmer:transportState.*PLAYING { \
			fhem "delete wohnzimmer_Sonos_Ton_Off_Timer" ;; \
			if (Value('wohnzimmer_Sonos_Ton') ne 'on') { \
				fhem "set wohnzimmer_Sonos_Ton on" \
			} \
		}
define Sonos_Wohnzimmer_GoNotPlaying_Notify notify \
		Sonos_Wohnzimmer:transportState.*(STOPPED|PAUSED_PLAYBACK) { \
			fhem "delete wohnzimmer_Sonos_Ton_Off_Timer";; \
			fhem "define wohnzimmer_Sonos_Ton_Off_Timer at +00:05:00 \
				set wohnzimmer_Sonos_Ton off" \
		}

Hier wird beim Wechsel des transportState auf "PLAYING" der Verstärker angeschaltet, und beim Wechsel auf "STOPPED" oder "PAUSED_PLAYBACK" ein Timer zum Ausschalten des Verstärkers in 5 Minuten definiert.
Der Timer ist notwendig, da beim Wechsel zwischen einem "normalen" Titel und einem Radiostream ein kurzer Zwischenwechsel auf "STOPPED" erfolgt, und ich nicht den Verstärker innerhalb von ein paar Sekunden aus- und wieder einschalten will.

Beispiel für das Loggen des gerade abgespielten Titels

define FileLog_Sonos_Wohnzimmer FileLog /etc/fhem/log/Sonos_Wohnzimmer-%Y-%m.log \
		Sonos_Wohnzimmer:infoSummarize2:.{2,}
attr FileLog_Sonos_Wohnzimmer room Sonos

Hier wird bei jedem Wechsel des Titels oder des Abspielzustands ein Eintrag ins Log geschrieben. Damit kann man, auch bei einem Radiosender, verfolgen, welche Titel zu welcher Zeit so über den Player gelaufen sind :-)

Beispiel für eine Stummschaltung bei einem Anruf

define fritzBox_anrufstartring_notify notify fritzBox:.*ring set Sonos_Wohnzimmer VolumeSave 15
define fritzBox_anrufstartcall_notify notify fritzBox:.*call set Sonos_Wohnzimmer VolumeSave +0
define fritzBox_anrufende_notify notify fritzBox:.*disconnect set Sonos_Wohnzimmer VolumeRestore

Der Trigger auf 'call' existiert nur, damit ausgehende Telefonate beim Beenden nicht die Lautstärke verändern. Das passiert, weil das Disconnected-Event auch nach ausgehenden Anrufen kommt.
Das Beispiel kann man natürlich noch beliebig erweitern, vielleicht etwas mit Anrufererkennung usw.

Beispiel für eine Anrufsignalisierung per MP3 bei einem Anruf

define fritzBox_anrufstartringsong_notify notify fritzBox:.*ring set Sonos_Wohnzimmer \
		PlayURITemp \\Server\Audio\RingRingRing.mp3 30

Hier wird bei Anruf die angegebene MP3-Datei temporär mit der Lautstärke 30 eingeblendet. Wenn die Datei abgespielt wurde, wird der vorherige Zustand im Player wiederhergestellt, und es geht weiter, wo unterbrochen wurde.

Beispiel für beide Varianten beim Telefonanruf gleichzeitig

define fritzBox_anrufstartring_notify notify fritzBox:.*ring set Sonos_Wohnzimmer VolumeSave 15 \
		;; set Sonos_Wohnzimmer PlayURITemp \\Server\Audio\RingRingRing.mp3 30
define fritzBox_anrufstartcall_notify notify fritzBox:.*call set Sonos_Wohnzimmer VolumeSave +0
define fritzBox_anrufende_notify notify fritzBox:.*disconnect set Sonos_Wohnzimmer VolumeRestore

Dieses Beispiel soll nur die Kombinationsmöglichkeiten verdeutlichen, und hat mehr spielerischen Character.

Beispiel für eine Sprachdurchsage auf Basis eines Notify

define wohnzimmer_Tastenfeld_1_Notify notify wohnzimmer_Tastenfeld_1 set Sonos_Wohnzimmer Speak \
		45 de Hier dann die Textnachricht, wie sie auf dem Player ausgegeben werden soll.
define wohnzimmer_Tastenfeld_2_Notify notify wohnzimmer_Tastenfeld_2 set Sonos_Wohnzimmer Speak \
		+10 de Hier dann die Textnachricht, wie sie auf dem Player ausgegeben werden soll.
define wohnzimmer_Tastenfeld_3_Notify notify wohnzimmer_Tastenfeld_3 set Sonos_Wohnzimmer Speak \
		+0 en Hello, this is a short message.

1: Hier wird auf Basis eines Notify (hier ein FS20-Taster) eine Textnachricht auf Deutsch mit der Lautstärke 45 auf dem SonosPlayer ausgegeben.
2: Hier wird eine deutsche Textnachricht mit 10 Einheiten lauter als aktuell eingestellt ausgegeben.
3: Hier wird eine englische Textnachricht mit der gleichen Lautstärke wie aktuell eingestellt ausgegeben.

Beispiel für das Reagieren auf Tastenevents

Hier ein Beispiel, wie man die Tasten an einem Play5 (und natürlich auch an jedem anderen Player) zu einer einfachen, autarken Steuerung programmieren kann.

Grundlagen, die ich zur allgemeinen Vereinfachung in meiner 99_myUtils.pm habe:

# Wird benötigt, da ein reDefine nur einen Befehl aufrufen kann
sub pauseMuteOff($) {
  my ($devName) = @_;

  if (defined($main::defs{$devName})) {
    fhem("set $devName Pause");
    fhem("set $devName Mute Off");
  }
}

# Löscht ein Define, wenn es existiert. Damit kann man dynamische AT-Defines löschen, 
# ohne zu wissen, ob sie überhaupt existieren
sub deleteDefineIfExists($) {
  my ($devName) = @_;

  if (defined($main::defs{$devName})) {
    fhem("delete $devName");
  }
}

# Definiert ein define neu; Heisst, es wird, wenn es bereits existiert, gelöscht und neu angelegt
sub reDefine($$) {
  my ($devName, $define) = @_;

  deleteDefineIfExists($devName);
  fhem('define '.$devName.' '.$define);
}

Attribut am Sonosplayer-Device:

attr Sonos_Schlafzimmer buttonEvents 1:MM

Notify-Defines, die die Steuerung übernehmen:

define Sonos_Schlafzimmer_WantPlaying_Notify notify Sonos_Schlafzimmer:ButtonEvent:.MM \
	set Sonos_Schlafzimmer Play
define Sonos_Schlafzimmer_WantStopPlaying notify Sonos_Schlafzimmer:Mute.*1 \
	{ reDefine('Schlafzimmer_Sonos_Stop_Timer', 'at +00:00:30 \
		{ pauseMuteOff("Sonos_Schlafzimmer") }') }
define Sonos_Schlafzimmer_WantStopPlayingOff notify Sonos_Schlafzimmer:Mute.*0 \
	{ deleteDefineIfExists('Schlafzimmer_Sonos_Stop_Timer') }

Hier wird mittels des Attributs buttonEvents ein Event bei zweimaligen Drücken von Mute innerhalb von 1 Sekunde definiert. Anschließend wird auf dieses Event reagiert, indem der Player mit der Wiedergabe beginnen soll. Desweiteren wird auf das Ändern von Mute reagiert, indem beim Aktivieren von Mute (also einmal drücken) ein Timer gestartet wird, der nach 30 Sekunden die Wiedergabe anhält, und den Mute-Zustand wieder zurücksetzt. Das letzte notify existiert nur, damit man das Beenden der Wiedergabe innerhalb der 30 Sekunden noch verhindern kann.

Hier ist zu beachten, dass diese Events natürlich nicht unterscheiden können, ob das ganze am Player selbst oder über einen Controller geschaltet wurde. Von beiden Stellen aus kann diese Funktionalität verursacht werden.

Beispiel für einen Offline-Sprachsynthetisierer

Man kann mit den Attributen Speak1, Speak2, Speak3 und Speak4 am zentralen Sonos-Device Kommandozeilen definieren, die einen Text in eine Sounddatei umwandeln. Hier soll dies am Beispiel von espeak verdeutlicht werden.

wav:/usr/bin/espeak -v %language% -w %filename% "%text%"

Zuerst muss das Ausgabedateiformat definiert werden, damit die internen Funktionen entsprechend reagieren können. Anschließend wird die Befehlszeile mit den entsprechenden Platzhaltern angegeben. Hier muss beachtet werden, dass der Platzhalter %language% mit dem zweiten Parameter der Fhem-Befehlseingabe gefüllt wird. In diesem Beispiel muss man dort also german angeben (anstatt de bei Google), um eine deutsche Ausgabe zu erhalten.

Dieses Beispiel hat den kleinen Nachteil, dass die Ausgabe in einer WAV-Datei erfolgt, die keinerlei Tag-Informationen tragen kann. Um das zu ändern, kann man einen Konverter nachschalten:

mp3:/usr/bin/espeak -v %language% --stdout "%text%" | /usr/bin/avconv -i - %filename%

Damit wird die Ausgabe von espeak direkt in das MP3-Format umgewandelt, und intern mit den entsprechenden Tags versehen. Hier ist allerdings der Nachteil, dass es etwas länger dauert (auf meinem Raspberry Pi ca. 1-3 Sekunden).

Die in diesem Beispiel verwendeten Pakete können unter Debian mittels der Anweisungen

sudo apt-get install espeak
sudo apt-get install ffmpeg

installiert werden.

Beispiel zu InfoSummarize

Standard, wie er angelegt wird:

InfoSummarize1 = <NormalAudio><Artist prefix="(" suffix=")"/>\
	<Title prefix=" '" suffix="'" ifempty="[Keine Musikdatei]"/>\
	<Album prefix=" vom Album '" suffix="'"/></NormalAudio> \
	<StreamAudio><Sender suffix=":"/>\
	<SenderCurrent prefix=" '" suffix="' -"/>\
	<SenderInfo prefix=" "/></StreamAudio>
InfoSummarize2 = <TransportState/><InfoSummarize1 prefix=" => "/>
InfoSummarize3 = <Volume prefix="Lautstärke: "/>\
	<Mute instead=" ~ Kein Ton" ifempty=" ~ Ton An" emptyval="0"/>\
	 ~ Balance: <Balance ifempty="Mitte" emptyval="0"/>\
	<HeadphoneConnected instead=" ~ Kopfhörer aktiv" ifempty=" ~ Kein Kopfhörer" \
		emptyval="0"/>

Dabei ist zu beachten, dass man auf andere InfoSummarize-Felder verweisen darf, solange man diese nur in aufsteigender Reihenfolge verwendet. Rekursionen oder Vorwärtrsreferenzen werden nicht unterstützt.

Hier noch ein Beispiel, um die Informationen des nächsten Titels zusammenzufassen:

InfoSummarize4 = <NormalAudio>Nächster Titel: <nextArtist prefix="(" suffix=")"/>\
	<nextTitle prefix=" '" suffix="'" ifempty="[Keine Musikdatei]"/>\
	<nextAlbum prefix=" vom Album '" suffix="'"/></NormalAudio>\
	<StreamAudio>Kein nächster Titel ermittelbar</StreamAudio>

Beispiel für eine Cover-Anzeige des nächsten Titels

Mit diesem Beispiel wird gezeigt, wie man sich einen Weblink für die Anzeige des Covers des nächsten Titels erzeugen kann:

define NextAlbumArt_Wohnzimmer weblink image fhem/icons/SONOSPLAYER/Sonos_Wohnzimmer_NextAlbumArt
attr NextAlbumArt_Wohnzimmer group Wohnzimmer
attr NextAlbumArt_Wohnzimmer htmlattr width="200"
attr NextAlbumArt_Wohnzimmer room Sonos

Beispiel für das Übertragen eines Titels an einen anderen Player

Mein Sohn hat öfter den Wunsch, einen gerade im Wohnzimmer laufenden Titel auch in seine eigene Abspielliste zu bekommen. Der Weg am Sonos-Controller über eine gespeicherte Playliste ist dabei sehr umständlich. Ich habe ein 8-fach Sensorfeld an der Wohnzimmerwand, wo ich ein Feld dafür programmiert habe, das Reading currentTrackURI mittels der Set-Anweisung AddURIToQueue in die aktuelle Abspielliste meines Sohnes zu packen. Das ist natürlich nichts besonderes, aber vielleicht für den einen oder anderen auch eine nette Idee:

define wohnzimmer_Sensorfeld_Notify notify wohnzimmer_Sensorfeld { \
	fhem "set Sonos_Sohnemann AddURIToQueue ".\
		ReadingsVal("Sonos_Wohnzimmer", "currentTrackURI", "") \
}

Beispiel für eine eigene ReadingsGroup zur Darstellung der Cover- und Titelinformationen

Wenn man das Standarddesign der generierten ReadingsGroup überarbeiten möchte, muss man sich einfach eine eigene Prozedur in der 99_myUtils.pm anlegen, die dann in der ReadingsGroup verwendet werden kann.

Da die Original-Vorlage wegen des Vollbildmodus sehr umfangreich ist, gibt es hier nur eine abgespeckte Version, die nur die Anzeige selbst übernimmt. Wer gerne den Vollbildmodus anpassen möchte, kann sich die entsprechende Prozedur SONOS_getCoverTitleRG einfach aus dem Modulcode kopieren (umbenennen nicht vergessen).

Hier die Vorlage der drei Prozeduren:

sub getCoverTitleRG($;$$) {
	my ($device, $width, $space) = @_;
	$width = 500 if (!defined($width));
	
	return '<div style="float: left;">'.getCoverRG($device).\
		'</div><div style="margin-left: 150px; min-width: '.$width.\
		'px;>'.getTitleRG($device, $space).'</div>';
}

sub getCoverRG($;$) {
	my ($device) = @_;
	
	return '<img style="margin-right: 5px; border: 1px solid lightgray; \
		height: 175px" src="'.ReadingsVal($device, 'currentAlbumArtURL', '').'" />';
}

sub SONOS_getTitleRG($;$) {
	my ($device, $space) = @_;
	$space = 20 if (!defined($space));
	
	my $infoString = '';
	
	my $transportState = ReadingsVal($device, 'transportState', '');
	$transportState = 'Spiele' if ($transportState eq 'PLAYING');
	$transportState = 'Pausiere' if ($transportState eq 'PAUSED_PLAYBACK');
	$transportState = 'Stop bei' if ($transportState eq 'STOPPED');
  
	# Läuft Radio oder ein "normaler" Titel
	if (ReadingsVal($device, 'currentNormalAudio', 1) == 1) {
		$infoString = sprintf('<div style="margin-left: -150px;">%s Titel %s \
			von %s<br />Titel: <b>%s</b><br />Interpret: <b>%s</b><br />Album: \
			<b>%s</b><div style="height: %dpx;"></div>'.encode('UTF-8', \
			'Nächste Wiedergabe:').'</div><div style="float: left; margin-left: \
			0px;"><img style="margin: 0px; padding: 0px; margin-right: 5px; \
			border: 1px solid lightgray;" height="55"  border="0" src="%s" />\
			</div><div style="margin-left: 0px;">Titel: %s<br />Artist: %s<br />\
			Album: %s</div>',
				$transportState, 
				ReadingsVal($device, 'currentTrack', ''), 
				ReadingsVal($device, 'numberOfTracks', ''),
				ReadingsVal($device, 'currentTitle', ''),
				ReadingsVal($device, 'currentArtist', ''),
				ReadingsVal($device, 'currentAlbum', ''),
				$space,
				ReadingsVal($device, 'nextAlbumArtURL', ''),
				ReadingsVal($device, 'nextTitle', ''),
				ReadingsVal($device, 'nextArtist', ''),
				ReadingsVal($device, 'nextAlbum', ''));
	} else {
		$infoString = sprintf('<div style="margin-left: -150px;">%s Radiostream\
			<br />Sender: <b>%s</b><br />Info: <b>%s</b><br />'.encode('UTF-8', \
			'Läuft:').' <b>%s</b></div>',
				$transportState,
				ReadingsVal($device, 'currentSender', ''),
				ReadingsVal($device, 'currentSenderInfo', ''),
				ReadingsVal($device, 'currentSenderCurrent', ''));
	}
	
	return $infoString;
}

Diese kann man als Kopiervorlage für eigene Ideen verwenden. Die Backslashs vor den Zeilenumbrüchen sind hauptsächlich der Optik halber hier. Generell empfehle ich die so getrennten Befehle in eine Zeile zu schreiben...

Hier noch eine beispielhafte ReadingsGroup dazu:

define Sonos_WohnzimmerRG ReadingsGroup Sonos_Wohnzimmer:\
	<{getCoverTitleRG($DEVICE)}@infoSummarize1>

Beispiel für eine ReadingsGroup für die Darstellung von Listen (Favoriten, Playlisten und Radios)

Es gibt eine mitgelieferte Prozedur, die für diese Darstellung verwendet werden kann. Diese stellt die Listen einfach als zweispaltige Tabelle dar (links das Cover, rechts der Titel als ausführbarer Link). Für die Datenlieferung (z.B. die Favoriten in einem Reading) muss man sich noch ein entsprechendes userReading schaffen. Beim Generieren der Devices vom Autocreate-Mechanismus werden diese Elemente und Attribute bereits mit erzeugt. Es muss lediglich ein Automatismus zum Aktualisieren des entsprechenden Readings geschaffen werden, oder dieses einmal manuell ausgeführt werden.

Hier die Vorlage für das userReading:

attr Sonos_Wohnzimmer userReadings Favourites:LastActionResult.*?\
	GetFavouritesWithCovers.* { if (ReadingsVal("Sonos_Wohnzimmer", \
	"LastActionResult", "") =~ m/.*?: (.*)/) { return $1; } }, Radios:\
	LastActionResult.*?GetRadiosWithCovers.* { if (ReadingsVal("Sonos_Wohnzimmer", \
	"LastActionResult", "") =~ m/.*?: (.*)/) { return $1; } }, Playlists:\
	LastActionResult.*?GetPlaylistsWithCovers.* { if (ReadingsVal("Sonos_Wohnzimmer", \
	"LastActionResult", "") =~ m/.*?: (.*)/) { return $1; } }

Damit wird jeweils ein Reading für Favoriten, Playlisten und Radios angelegt, sobald im Reading LastActionResult dieses Ergebnis asynchron geliefert wurde.

Die Lieferung selbst kann man mit einem at-Statement zu bestimmten Zeitpunkten erzeugen/aktualisieren lassen:

define refreshFavouritesWohnzimmer at *06:00 get Sonos_Wohnzimmer FavouritesWithCovers

Das ganze muss natürlich für jede gewünschte Liste an jedem Player aktualisiert werden. Man kann also auch sowas schreiben:

define refreshFavouritesWohnzimmer at *06:00 get Sonos_.* FavouritesWithCovers

Möchte man eine andere Darstellung, so muss man sich eine eigene Prozedur in eine 99_myUtils.pm packen. Hier eine Kopiervorlage:

sub getListRG($$;$) {
	my ($device, $reading, $ul) = @_;
	$ul = 0 if (!defined($ul));
	
	my $resultString = '';
	
	# Manchmal ist es etwas komplizierter mit den Zeichensätzen...
	my %elems = %{eval(decode('CP1252', ReadingsVal($device, $reading, '{}')))};
	
	for my $key (keys %elems) {
		my $command;
		if ($reading eq 'Favourites') {
			$command = 'cmd.'.$device.uri_escape('=set '.$device.' \
				StartFavourite '.uri_escape($elems{$key}->{Title}));
		} elsif ($reading eq 'Playlists') {
			$command = 'cmd.'.$device.uri_escape('=set '.$device.' \
				StartPlaylist '.uri_escape($elems{$key}->{Title}));
		} elsif ($reading eq 'Radios') {
			$command = 'cmd.'.$device.uri_escape('=set '.$device.' \
				StartRadio '.uri_escape($elems{$key}->{Title}));
		}
		$command = "FW_cmd('/fhem?XHR=1&$command')";
		
		if ($ul) {
			$resultString .= '<li style="list-style-type: none; display: inline;">\
				<a onclick="'.$command.'"><img style="border: solid 1px lightgray; \
				margin: 3px;" width="70" src="'.$elems{$key}->{Cover}.'" /></a></li>';
		} else {
			$resultString .= '<tr><td><img width="70" src="'.$elems{$key}->{Cover}.\
				'" /></td><td><a onclick="'.$command.'">'.$elems{$key}->{Title}."</a>\
				</td></tr>\n";
		}
	}
	
	if ($ul) {
		return '<ul style="margin-left: 0px; padding-left: 0px; list-style-type: none; \
			display: inline;">'.$resultString.'</ul>';
	} else {
		return '<table>'.$resultString.'</table>';
	}
}

Diese Prozedur hat einen optionalen Parameter ($ul). Mit diesem kann man angeben, ob eine Tabelle mit vertikaler Darstellung ($ul=0) oder eine Unordered-List mit horizontaler Darstellung ($ul=1) erzeugt wird. Die Variante mit den ListItems ist auch für eine Darstellung in einem Dashboard geeignet. Da bei der horizontalen Darstellung kein Platz für Namen ist, eignet sich diese Darstellung nur für Listen, deren Icon für jeden Eintrag unterschiedlich ist (Playlisten kann man hier also nicht mehr unterscheiden :-).

Die eigentliche ReadingsGroup verwendet dann diese Prozedur:

define Sonos_WohnzimmerFavouriteListRG ReadingsGroup Sonos_Wohnzimmer:\
	<{getListRG($DEVICE,"Favourites")}@Favourites>

oder für die Variante mit den List-Elementen: define Sonos_WohnzimmerFavouriteListRG ReadingsGroup Sonos_Wohnzimmer:\ <{getListRG($DEVICE,"Favourites",1)}@Favourites>

Damit kann man sich dynamische Listen auf Basis der Informationen im Sonosplayer für die Darstellung erzeugen lassen.

Die Backslashs vor den Zeilenumbrüchen sind hauptsächlich der Optik halber hier. Generell empfehle ich die so getrennten Befehle in eine Zeile zu schreiben...

Beispiel für die Anzeige der Gruppenkonstellation in einer ReadingsGroup

Mit der folgende Prozedur (in die 99_myUtils.pm schreiben) und der ReadingsGroup läßt sich auf einfache Weise die Gruppenkonstellation stets aktuell darstellen.

Die Prozedur, die die Zerlegung des Strings und in diesem Fall die Aufbereitung als UL (Unordered-List) übernimmt:

sub getGroupsRG() {
	my $groups = CommandGet(undef, SONOS_getDeviceDefHash(undef)->{NAME}.\
		' Groups');
	
	my $result = '';
	my $i = 0;
	while ($groups =~ m/\[(.*?)\]/ig) {
		my @member = split(/, /, $1);
		@member = map FW_makeImage('icoSONOSPLAYER_icon-'.ReadingsVal($_, \
			'playerType', '').'.png', '', '').ReadingsVal($_, 'roomName', $_), \
			@member;
		
		$result .= '<li>'.++$i.'. Gruppe:<ul style="list-style-type: none; \
			padding-left: 0px;"><li>'.join('</li><li>', @member).'</li></ul></li>';
	}
	return '<ul>'.$result.'</ul>';
}

Und hier die entsprechende ReadingsGrouo dazu:

define SonosRG ReadingsGroup Sonos:<{getGroupsRG()}@ZoneGroupState>

Damit wird eine einfache Darstellung der Gruppenkonstellation durchgeführt, die man sich natürlich selber nach Belieben anpassen kann/soll.

Die Backslashs vor den Zeilenumbrüchen sind hauptsächlich der Optik halber hier. Generell empfehle ich die so getrennten Befehle in eine Zeile zu schreiben...

@@ Zeile 44: / Zeile 44: @@
 *Setzen des Sleeptimer inkl. Fhem-Event bei Veränderung durch andere Controller und Ablauf des Timers
 *Setzen und Auslesen der Gruppierungskonfiguration, sowie einzelnes Hinzufügen und Entfernen von Gruppenmitgliedern
+*Bildung und Trennung von Stereopaaren
 *Erzeugen von Events nach festgelegten Tastensequenzen (am Player)
 *Umbenennen der Zonen und festlegen der Zonenicons
@@ Zeile 54: / Zeile 55: @@
 Dieses Modul benennt die Player nach den Zonennamen und der jeweiligen Funktion des Players innerhalb der Paarungs-Zone.
-Das bedeutet aber auch, dass in diesem Augenblick möglichst keine Player gruppiert sein sollten (mehrere Zonen spielen dasselbe ab), da diese sonst komische Namen erhalten könnten (es geht hier ausschliesslich um die Fhem-interne Device-Benennung, natürlich bleiben die Zoneplayer selbst wie sie sind).
+Das bedeutet aber auch, dass in diesem Augenblick möglichst keine Player gruppiert sein sollten (mehrere Zonen spielen dasselbe ab), da diese sonst komische Namen erhalten könnten (es geht hier ausschliesslich um die Fhem-interne Device-Benennung, natürlich bleiben die Zoneplayer selbst wie sie sind).<br />Insbesondere gilt das für temporäre Stereopaare. Diese nicht ständigen Paare sollten erst getrennt werden, bis das Modul alle Player erkannt hat.
 Damit man nun eine einigermaßen passende Bezeichnung in Fhem erhält, sollte also die Gestaltung der Sonos-Player abgeschlossen sein. Natürlich funktioniert das System nach einer Fhem-Einrichtung und anschließender Sonos-Umbenennung immer noch, da intern alles mittels der eindeutigen Bezeichner gehandhabt wird, allerdings wird es u.U. etwas unübersichtlich bzgl. der Fhem-Device-Namen. Diese passen dann nicht mehr zu den Zonennamen (die entsprechenden Readings werden aber natürlich korrekt besetzt), was man aber natürlich auch nachträglich wieder anpassen kann.
@@ Zeile 341: / Zeile 342: @@
 ===  Changelog ===
 *SVN-History:
+**31.12.2014
+***Das Bilden von Stereopaaren wird nun unterstützt. Dafür gibt es die Anweisungen 'CreateStereoPair' und 'SeparateStereoPair' an einem Playerdevice.
 **28.12.2014
 ***Umlaute: Die Erkennung von Umlauten war wegen der Quelltextumstellung auf UTF8 fehlerhaft. Das betraf nur die Zonennamenumwandlung, wo z.B. aus 'Küche' ein 'Kueche' gemacht wird.
@@ Zeile 814: / Zeile 817: @@
 *Gruppenbefehle
 **<code>AddMember <Devicename></code>: Fügt dem Device das übergebene Device als Gruppenmitglied hinzu. Die Wiedergabe des aktuellen Devices bleibt erhalten, und wird auf das angegebene Device mit übertragen.
+**<code>CreateStereoPair <rightPlayerDevicename></code>: Fügt dem Device das übergebene Device als rechtes Stereopaar-Element hinzu. Die Wiedergabe des aktuellen Devices bleibt erhalten (als linker Lautsprecher), und wird auf das angegebene Device mit übertragen (als rechter Lautsprecher).
 **<code>GroupMute <State></code>: Setzt den Mute-Zustand für die komplette Gruppe in einem Schritt. Der Wert kann on oder off sein.
 **<code>GroupVolume <VolumeLevel></code>: Setzt die Gruppenlautstärke. Das dafür verwendete Lautstärkenverhältnis muss zuvor einmal mittels der Anweisung '''SnapshotGroupVolume''' festgelegt worden sein.
 ***''Hinweis'': Wenn man '''GroupVolume''' aufruft, ohne vorher '''SnapshotGroupVolume''' aufgerufen zu haben, wird nur die Lautstärke des Players verändert wird, für den man den Aufruf durchführt.
 **<code>RemoveMember <Devicename></code>: Entfernt dem Device das übergebene Device, sodass die beiden keine Gruppe mehr bilden. Die Wiedergabe des aktuellen Devices läuft normal weiter. Das abgetrennte Device stoppt seine Wiedergabe, und hat keine aktuelle Abspielliste mehr (seit Sonos Version 4.2 hat der Player wieder die Playliste von vorher aktiv).
+**<code>SeparateStereoPair</code>: Trennt das Stereopaar wieder auf.
 **<code>SnapshotGroupVolume</code>: Legt das Lautstärkeverhältnis der aktuellen Player der Gruppe für folgende '''GroupVolume'''-Aufrufe fest. Dieses festgelegte Verhältnis wird bis zum nächsten Aufruf von '''SnapshotGroupVolume''' beibehalten.
 ***''Hinweis'': Das einzelne Verstellen von Zoneplayer-Laustärken mittels '''Volume''' wird nicht im bereits gespeicherten Lautstärkenverhältnis aktualisiert/widergespiegelt. Hat man also nachträglich die Lautstärke eines einzelnen Players geändert (auch über den Controller), so muss '''SnapshotGroupVolume''' erneut aufgerufen werden, damit das Verhältnis bei einer weiteren Gruppenlautstärkenänderung wieder erhalten bleibt (ansonsten wird das alte Verhältnis vor der Lautstärkeänderung wiederhergestellt).