From 0dfa220ab103e43c068d513ec08be251fcd6044a Mon Sep 17 00:00:00 2001
From: Beta-User <>
Date: Mon, 27 Jun 2022 20:34:26 +0000
Subject: [PATCH] 96_Snapcast: Maintainer change + commandref
git-svn-id: https://svn.fhem.de/fhem/trunk@26176 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/FHEM/96_Snapcast.pm | 46 ++++++++++++++++++++++------------------
fhem/MAINTAINER.txt | 2 +-
2 files changed, 26 insertions(+), 22 deletions(-)
diff --git a/fhem/FHEM/96_Snapcast.pm b/fhem/FHEM/96_Snapcast.pm
index fc36cd572..7be67f539 100755
--- a/fhem/FHEM/96_Snapcast.pm
+++ b/fhem/FHEM/96_Snapcast.pm
@@ -706,11 +706,15 @@ sub Snapcast_isPmInstalled($$)
}
1;
+__END__
+
=pod
-=item summary control and monitor Snapcast Server
+=item summary control and monitor Snapcast Servers and Clients
+=item summary_DE steuert und überwacht Snapcast Servers und Clients
+
=begin html
-
+
Snapcast
Snapcast is a module to control a Snapcast Server. Snapcast is a little project to achieve multiroom audio and is a leightweight alternative to such solutions using Pulseaudio.
@@ -720,8 +724,8 @@ sub Snapcast_isPmInstalled($$)
other FHEM capabilities around it, e.g. Notifies, etc. The server module includes all readings of all snapcast clients, and it allows to control all functions of all snapcast clients.
Each virtual client module just gets the reading for the specific client. The client modules is encouraged and also makes it possible to do per-client Attribute settings, e.g. volume step size and volume constraints.
-
- Define
+
+ Define
define Snapcast [<ip> <port>]
@@ -737,8 +741,8 @@ sub Snapcast_isPmInstalled($$)
which is normally made out of the MAC address. Once the server module is initialized it will have all the client IDs in the readings, so you want to use those for the definition of the client modules
-
- Set
+
+ Set
For a Server module: set <name> <function> <client> <value>
@@ -746,48 +750,48 @@ sub Snapcast_isPmInstalled($$)
Options:
- - update
+ - update
Perform a full update of the Snapcast Status including streams and servers. Only needed if something is not working. Server module only
- - volume
+ - volume
Set the volume of a client. For this and all the following 4 options, give client as second parameter (only for the server module), either as name, IP , or MAC and the desired value as third parameter.
Client can be given as "all", in that case all clients are changed at once (only for server module)
- Volume can be given in 3 ways: Range betwee 0 and 100 to set volume directly. Increment or Decrement given between -100 and +100. Keywords up and down to increase or decrease with a predifined step size.
+ Volume can be given in 3 ways: Range between 0 and 100 to set volume directly. Increment or Decrement given between -100 and +100. Keywords up and down to increase or decrease with a predifined step size.
The step size can be defined in the attribute volumeStepSize
The step size can be defined smaller for the lower volume range, so that finetuning is possible in this area.
See the description of the attributes volumeStepSizeSmall and volumeStepThreshold
Setting a volume bigger than 0 also unmutes the client, if muted.
- - mute
+ - mute
Mute or unmute by giving "true" or "false" as value. If no argument given, toggle between muted and unmuted.
- - latency
+ - latency
Change the Latency Setting of the client
- - name
+ - name
Change the Name of the client
- - stream
+ - stream
Change the stream that the client is listening to. Snapcast uses one or more streams which can be unterstood as virtual audio channels. Each client/room can subscribe to one of them.
By using next as value, you can cycle through the avaialble streams
-
- Attributes
+
+ Attributes
All attributes can be set to the master module and the client modules. Using them for client modules enable the setting of different attribute values per client.
- - streamnext
+ - streamnext
Can be set to all or playing. If set to all, the next function cycles through all streams, if set to playing, the next function cycles only through streams in the playing state.
- - volumeStepSize
+ - volumeStepSize
Default: 5. Set this to define, how far the volume is changed when using up/down volume commands.
- - volumeStepThreshold
+ - volumeStepThreshold
Default: 7. When the volume is below this threshold, then the volumeStepSizeSmall setting is used for volume steps, rather than the normal volumeStepSize.
- - volumeStepSizeSmall
+ - volumeStepSizeSmall
Default: 1. This typically smaller step size is used when using "volume up" or "volume down" and the current volume is smaller than the threshold.
- - constraintDummy
+ - constraintDummy
Links the Snapcast module to a dummy. The value of the dummy is then used as a selector for different sets of volumeConstraints. See the description of the volumeConstraint command.
- - constraints
Defines a set of volume Constraints for each client and, optionally, based on the value of the dummy as defined with constraintDummy. This way there can be different volume profiles for e.g. weekdays or weekends. volumeConstraints mean, that the maximum volume of snapcast clients can be limited or even set to 0 during certain times, e.g. at night for the childrens room, etc.
+ - constraints
Defines a set of volume Constraints for each client and, optionally, based on the value of the dummy as defined with constraintDummy. This way there can be different volume profiles for e.g. weekdays or weekends. volumeConstraints mean, that the maximum volume of snapcast clients can be limited or even set to 0 during certain times, e.g. at night for the childrens room, etc.
the constraint argument is given in the folling format: |hh:mm vol hh:mm vol ... [|hh:mm vol ... etc. The chain off pairs defines a volume profile for 24 hours. It is equivalent to the temeratore setting of the homematic thermostates supported by FHEM.
Example: standard|08:00 0 18:00 100 22:00 30 24:00 0,weekend|10:00 0 20:00 100 24:00 30
In this example, there are two profiles defined. If the value of the associated dummy is "standard", then the standard profile is used. It mutes the client between midnight and 8 am, then allows full volume until 18:00, then limites the volume to 30 until 22:00 and then mutes the client for the rest of the day. The snapcast module does not increase the volume when a limited time is over, it only allows for increasing it manually again.
diff --git a/fhem/MAINTAINER.txt b/fhem/MAINTAINER.txt
index abde315b3..2f79b4bdb 100644
--- a/fhem/MAINTAINER.txt
+++ b/fhem/MAINTAINER.txt
@@ -479,7 +479,7 @@ FHEM/95/ShareMaster.pm pahenning Sonstiges
FHEM/95_YAAHM.pm pahenning Unterstützende Dienste
FHEM/96_allowed.pm rudolfkoenig Automatisierung
FHEM/96_SIP.pm Wzut,plin Sonstiges
-FHEM/96_Snapcast.pm rudolfkoenig/orphan Multimedia
+FHEM/96_Snapcast.pm Beta-User Multimedia
FHEM/97_PiXtendV2 PiXtend Sonstige Systeme https://forum.fhem.de/index.php/topic,116308.0.html
FHEM/97_TrashCal.pm Tobias Unterstützende Dienste
FHEM/98_alarmclock.pm FlorianZ Unterstützende Dienste