-
Notifications
You must be signed in to change notification settings - Fork 4
/
98_OpenMultiroom.pm
executable file
·563 lines (520 loc) · 25.8 KB
/
98_OpenMultiroom.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
package main;
use strict;
use warnings;
use Data::Dumper;
my %OpenMultiroom_sets = (
"0" =>1,
"1" =>1,
"2" =>1,
"3" =>1,
"4" =>1,
"5" =>1,
"6" =>1,
"7" =>1,
"8" =>1,
"9" =>1,
"mute" =>2,
"volume" =>2,
"volup" =>2,
"voldown" =>2,
"forward" =>3,
"rewind" =>3,
"next" =>3,
"previous" =>3,
"play" =>3,
"pause" =>3,
"toggle" =>3,
"stop" =>3,
"random" =>3,
"single" =>3,
"repeat" =>3,
"statesave" =>3,
"stateload" =>3,
"channelUp" =>3,
"channelDown" =>3,
"trackinfo" =>3,
"offtimer" =>2,
"stream" =>2,
"copystate" =>2,
"control" =>2,
"streamreset" =>2
);
sub OpenMultiroom_Initialize($) {
my ($hash) = @_;
$hash->{DefFn} = 'OpenMultiroom_Define';
$hash->{UndefFn} = 'OpenMultiroom_Undef';
$hash->{NotifyFn} = 'OpenMultiroom_Notify';
$hash->{SetFn} = 'OpenMultiroom_Set';
$hash->{AttrFn} = 'OpenMultiroom_Attr';
$hash->{NotifyOrderPrefix} = "80-";
$hash->{AttrList} =
"mrSystem:SNAPCAST soundSystem:MPD mr soundMapping ttsMapping defaultTts defaultStream defaultSound playlistPattern stateSaveDir seekStep seekDirect:percent,seconds seekStepSmall seekStepThreshold digitTimeout"
. $readingFnAttributes;
}
sub OpenMultiroom_Define($$) {
my ($hash, $def) = @_;
my @a = split('[ \t]+', $def);
my $name= $hash->{name} = $a[0];
readingsSingleUpdate($hash,"state","defined",1);
RemoveInternalTimer($hash);
$hash->{NOTIFYDEV}="undefined";
$attr{$name}{mrSystem} = 'SNAPCAST' unless (exists($attr{$name}{mrSystem}));
$attr{$name}{soundSystem} = 'MPD' unless (exists($attr{$name}{soundSystem}));
$attr{$name}{seekStep} = '7' unless (exists($attr{$name}{seekStep}));
$attr{$name}{seekDirect} = 'percent' unless (exists($attr{$name}{seekDirect}));
$attr{$name}{seekStepSmall} = '2' unless (exists($attr{$name}{seekStepSmall}));
$attr{$name}{seekStepThreshold} = '8' unless (exists($attr{$name}{seekStepThreshold}));
Log3 $name,3,"MAC DEFINED";
return undef;
}
sub OpenMultiroom_Attr($$){
my ($cmd, $name, $attr, $value) = @_;
my $hash = $defs{$name};
Log3 $name,3,"MAC Attr set: $attr, $value";
if ($cmd eq "set"){
if($attr eq "mr"){
$hash->{NOTIFYDEV}=$value;
$hash->{NOTIFYDEV} .= ",".$hash->{SOUND} if defined($hash->{SOUND}) and $hash->{SOUND} ne "";
OpenMultiroom_getReadings($hash,$value);
}
if($attr eq "soundMapping"){
$hash->{soundMapping}=$value;
OpenMultiroom_setNotifyDef($hash);
}
}
my $out=Dumper($hash);
Log3 $name,3,$out;
return undef;
}
sub OpenMultiroom_setNotifyDef($){
my ($hash) = @_;
my $name = $hash->{NAME};
my $oldsound=$hash->{SOUND};
if (!$init_done){
InternalTimer(gettimeofday()+5,"OpenMultiroom_setNotifyDef", $hash, 0);
return "init not done";
}
$hash->{NOTIFYDEV}=AttrVal($name,"mr","undefined");
my @soundMapping = split(",",$hash->{soundMapping});
delete ($hash->{SOUND});
foreach my $map (@soundMapping){
my @mapping = split(":",$map);
$hash->{SOUND} = $mapping[1] if(ReadingsVal($name,"stream","") eq $mapping[0]);
}
OpenMultiroom_getReadings($hash,$hash->{SOUND}) if $hash->{SOUND} ne $oldsound;
$hash->{NOTIFYDEV} .= ",".$hash->{SOUND} if defined($hash->{SOUND}) and $hash->{SOUND} ne "";
}
sub OpenMultiroom_Undef($$) {
my ($hash, $arg) = @_;
RemoveInternalTimer($hash);
return undef;
}
sub OpenMultiroom_Notify($$){
my ($hash, $dev_hash) = @_;
my $ownName = $hash->{NAME}; # own name / hash
my $devName = $dev_hash->{NAME}; # own name / hash
my $devType = $dev_hash->{TYPE}; # own name / hash
my $updateFlag=0;
return "" if(IsDisabled($ownName)); # Return without any further action if the module is disabled
my $devName = $dev_hash->{NAME}; # Device that created the events
my $events = deviceEvents($dev_hash,1);
return if( !$events );
readingsBeginUpdate($hash);
foreach my $event (@{$events}) {
$event = "" if(!defined($event));
my ($name,$value) = split( ": ", $event );
if($devType =~/MPD/i){
$name=~s/volume/sound_volume/;
$name=~s/state/sound_state/;
}
if($devType =~/Snapcast/i){
$name=~s/state/mr_state/;
$name=~s/name/mr_name/;
$updateFlag = 1 if($name eq "stream");
}
readingsBulkUpdateIfChanged($hash,$name,$value );
Log3 $ownName,3,"MAC got reading from $devName: $devType: $name|$value";
# processing $event with further code
}
readingsEndUpdate($hash,1);
Log3 $ownName,3,"MAC Notify_done";
OpenMultiroom_setNotifyDef($hash) if $updateFlag == 1;
return undef;
}
sub OpenMultiroom_Set($@) {
my ($hash, @param) = @_;
return '"set Snapcast" needs at least one argument' if (int(@param) < 2);
my $name = shift @param;
my $cmd = shift @param;
my $val = shift @param;
my $mrname=AttrVal($name,"mr","undefined");
my $soundname= defined($hash->{SOUND}) ? $hash->{SOUND} : '' ;
if (not defined($defs{$soundname})){
OpenMultiroom_setNotifyDef($hash) if not defined($defs{$soundname});
$soundname= defined($hash->{SOUND}) ? $hash->{SOUND} : '' ;
}
my $mrhash=$defs{$mrname};
my $soundhash= defined ($defs{$soundname}) ? $defs{$soundname} : '';
my $soundtyp=AttrVal($name,"soundSystem","");
my $soundModuleHash=$modules{$soundtyp};
my @ttsmap = split(/,/,AttrVal($name,"ttsMapping",""));
my $ttsname="";
foreach my $map(@ttsmap){
my ($stream,$tts) = split(/\:/,$map);
$ttsname=$tts if $stream eq ReadingsVal($name,"stream","");
}
readingsBeginUpdate($hash);readingsBulkUpdateIfChanged($hash,"tts",$ttsname);readingsEndUpdate($hash,1);
if(!defined($OpenMultiroom_sets{$cmd})) {
my @cList = keys %OpenMultiroom_sets;
return "Unknown argument $cmd, choose one of " . join(" ", @cList);
}
# clear:noArg clear_readings:noArg mpdCMD next:noArg outputenabled0:0,1 pause:noArg play playfile playlist previous:noArg random:noArg repeat:noArg reset:noArg single:noArg stop:noArg toggle:noArg updateDb:noArg volume:slider,0,1,100 volumeDown:noArg volumeUp:noArg
return OpenMultiroom_Error($hash,"no sound backend connected or soundsystem not defined, check soundMapping and soundSystem attributes",1)
if $OpenMultiroom_sets{$cmd}>2 && (not defined ($soundhash) || $soundhash eq '' || not defined ($soundModuleHash) || $soundModuleHash eq '');
return OpenMultiroom_Error($hash,"no multiroom backend connected, check mr attribute",1) if $OpenMultiroom_sets{$cmd}>1 && (!defined ($mrhash) || $mrhash eq '');
if($cmd=~/^\d$/){ # is the command 1 digit?
# function called when a client presses a number on the remote. sets a timeout and waits for the next number in case of multi digit numbers.
# numbers are always entered by a client in preperation of a function like next, next playlist etc.
RemoveInternalTimer($hash, "OpenMultiroom_clearDigitBuffer");
my $last = $hash->{lastdigittime}; # when was last digit received?
my $now = time();
my $timeout = AttrVal($name,"digitTimeout",10);
$hash->{lastdigittime} = $now; # reset time for last digit
if($now-$last < $timeout){
$hash->{digitBuffer} = $hash->{digitBuffer} * 10 + $cmd;
}else{
$hash->{digitBuffer} = $cmd;
}
OpenMultiroom_TTS($hash,$hash->{digitBuffer} );
InternalTimer(gettimeofday()+ AttrVal($name,"digitTimeout",10),"OpenMultiroom_clearDigitBuffer", $hash, 0);
return undef;
}
if($cmd eq "play"){
my $number = OpenMultiroom_getDigits($hash);
if($number >0){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd,$number);
}else{
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
}
return undef
}
if($cmd eq "pause"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "toggle"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "stop"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "next" || $cmd eq "previous"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "forward" || $cmd eq "rewind"){
my ($elapsed,$total) = split (":",ReadingsVal($name,"time",""));
$total=int($total);
return undef unless defined($total) && $total>0;
my $percent = $elapsed / $total;
my $number = OpenMultiroom_getDigits($hash);
if($number >0){
$percent=0.01*$number;
}else{
my $step = 0.01*(0.01*AttrVal($name,"seekStepThreshold",0) > $percent ? AttrVal($name,"seekStepSmall",3) : AttrVal($name,"seekStep",7));
$percent +=$step if $cmd eq "forward";
$percent -=$step if $cmd eq "rewind";
}
$percent = 0 if $percent<0;
$percent = 0.99 if $percent > 0.99;
my $newint=int($percent*$total);
my $new=$percent*$total;
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,"seekcur",int($percent*$total));
return undef;
}
if($cmd eq "random"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "single"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "repeat"){
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,$cmd);
return undef;
}
if($cmd eq "channelUp" || $cmd eq "channelDown"){ # next playlist or specific playlist if number was entered before
# get lists based on regexp. Seperate those playlists that have a 2 or 3 digit number in them.
my $filter=AttrVal($name,"playlistPattern",".*");
my @allPlaylists=split(":",ReadingsVal($name,"playlistcollection",""));
my @filteredPlaylists= grep { /$filter/ } @allPlaylists;
return "no playlists found" if(@filteredPlaylists == 0);
my @filteredPlaylistsWithNumbers = grep { /\d{2,3}/ } @filteredPlaylists;
my @filteredPlaylistsWithoutNumbers = grep { !/\d{2,3}/ } @filteredPlaylists;
# delete existing playlist array and crate a reference to an empty array to pupulate it afterwards
delete $hash->{PLARRAY};
$hash->{PLARRAY}=[];
# iterate the items with a number first, to try to put the to the slot according to their number.
foreach my $item (@filteredPlaylistsWithNumbers){
# for each one push it to the according position. pushPlArray will ensure no slot is used twice and increase accordingly
$item=~/(\d{2,3})/;
OpenMultiroom_pushPlArray($hash,$item,$1);
}
# do the same for the other items and push them into the array
foreach my $item (@filteredPlaylistsWithoutNumbers){
OpenMultiroom_pushPlArray($hash,$item);
}
# next 3 lines, build an array of pl numbers, get the number of the current one and its index in the index array. This could probably be done better.
my $mpdplaylist = defined ($soundhash->{'.playlist'}) ? $soundhash->{'.playlist'} : '';
my (@indexes) = grep { defined(${$hash->{PLARRAY}}[$_]) } (0 .. @{$hash->{PLARRAY}});
my ($current) = grep { ${$hash->{PLARRAY}}[$_] eq $mpdplaylist } (0 .. @{$hash->{PLARRAY}});
my ($currentindex) = grep { defined($current) && defined($indexes[$_]) && $indexes[$_] eq $current } (0 .. @indexes-1);
my $number = OpenMultiroom_getDigits($hash);
if($number>0 && $number < @indexes){
$currentindex = $number;
}else{
# for next or prev, just increase the number or decrease the number based on $cmd, call getPlName(number)
if($cmd eq 'channelUp'){
$currentindex = not(defined($currentindex)) || $currentindex == @indexes-1 ? 0 : $currentindex+1;
}
if($cmd eq 'channelDown'){
$currentindex = not(defined($currentindex)) || $currentindex == 0 ? @indexes-1 : $currentindex-1;
}
}
# load the playlist
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,"playlist",${$hash->{PLARRAY}}[$indexes[$currentindex]]);
Log3 $name,3,"MAC2: CallFn $soundname, SetFn, ".$defs{$soundname}.", $soundname, playlist, ".${$hash->{PLARRAY}}[$indexes[$currentindex]];
readingsSingleUpdate($hash,"playlistnumber",$indexes[$currentindex],1);
OpenMultiroom_TTS($hash,$indexes[$currentindex]);
CallFn($soundname,"SetFn",$defs{$soundname},$soundname,"play");
return undef;
}
if($cmd eq "volume"){
my $number = OpenMultiroom_getDigits($hash);
if($number>0){
$val=$number;
$val=100 if $val>100;
}
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"volume",$val);
return undef;
}
if($cmd eq "volup"){
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"volume","up");
return undef;
}
if($cmd eq "voldown"){
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"volume","down");
return undef;
}
if($cmd eq "mute"){
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"mute",$val);
return undef;
}
if($cmd eq "stream"){
my $targetStream="next";
if(defined($val)){
$targetStream = $val;
}
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"stream",$targetStream);
return undef;
}
if($cmd eq "copystate"){
return OpenMultiroom_Error($hash,"$cmd not yet implemented",2) ;
my $defaultstream = AttrVal($name,"defaultStream","");
return undef if $defaultstream eq "";
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"stream",$defaultstream);
return undef;
}
if($cmd eq "control"){
return OpenMultiroom_Error($hash,"$cmd not yet implemented",2) ;
my $defaultstream = AttrVal($name,"defaultStream","");
return undef if $defaultstream eq "";
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"stream",$defaultstream);
return undef;
}
if($cmd eq "streamreset"){
return OpenMultiroom_Error($hash,"$cmd not yet implemented",2) ;
my $defaultstream = AttrVal($name,"defaultStream","");
return undef if $defaultstream eq "";
CallFn($mrname,"SetFn",$defs{$mrname},$mrname,"stream",$defaultstream);
return undef;
}
return OpenMultiroom_Error($hash,"$cmd not yet implemented",2) ;
}
sub OpenMultiroom_pushPlArray(@){
my ($hash,$item,$number) = @_;
my $name = $hash->{NAME};
$number=1 unless defined($number);
while (defined(${$hash->{PLARRAY}}[$number])){
$number++;
}
${$hash->{PLARRAY}}[$number]=$item;
$hash->{CURRENTPL} = $number if(ReadingsVal($name,"playlistname","") eq $item);
return $number;
}
sub OpenMultiroom_Error($$$){ # hier noch TTS feedback einbauen je nach errorlevel
my ($hash,$msg,$level) = @_;
return $msg;
}
sub OpenMultiroom_getReadings($$){
my ($hash, $module) = @_;
my $name = $hash->{NAME};
if (!$init_done){
InternalTimer(gettimeofday()+10,"OpenMultiroom_getReadings", $hash, $module);
return "init not done";
}
return undef unless defined($defs{$module});
my $modhash=$defs{$module};
my $readings=$modhash->{READINGS};
my $modname=$modhash->{NAME};
my $devType=$modhash->{TYPE};
my $updateFlag=0;
Log3 $name,3,"MAC getting readings from $modname";
readingsBeginUpdate($hash);
while ( my ($key, $value) = each %{$readings} ){
if($devType =~/MPD/i){
$key=~s/volume/sound_volume/;
$key=~s/state/sound_state/;
}
if($devType =~/Snapcast/i){
$key=~s/state/mr_state/;
$key=~s/name/mr_name/;
$updateFlag = 1 if($key eq "stream");
}
readingsBulkUpdateIfChanged($hash,$key,$value->{VAL} );
Log3 $name,3,"MAC getReading got reading $key from $modname, ".$value->{VAL};
}
readingsEndUpdate($hash,1);
OpenMultiroom_setNotifyDef($hash) if $updateFlag == 1;
if(ReadingsVal($name,"stream","") eq "" && $module eq AttrVal($name,"mr","")){
InternalTimer(gettimeofday()+10,"OpenMultiroom_getReadings", $hash, $module);
}
return undef;
}
sub OpenMultiroom_clearDigitBuffer($){
my $hash = shift;
my $name = $hash->{NAME};
$hash->{digitBuffer}=0;
OpenMultiroom_TTS($hash,":NACK1:");
return undef;
}
sub OpenMultiroom_getDigits($){
my $hash = shift;
my $name = $hash->{NAME};
my $buf = $hash->{digitBuffer};
RemoveInternalTimer($hash, "OpenMultiroom_clearDigitBuffer");
$hash->{digitBuffer}=0;
return $buf;
}
sub OpenMultiroom_TTS($$){
my $hash = shift;
my $value = shift;
my $name = $hash->{NAME};
my $ttsname = ReadingsVal($name,"tts","");
return undef unless defined $defs{$ttsname};
CallFn($ttsname,"SetFn",$defs{$ttsname},$ttsname,"tts",$value);
}
=pod
=item summary integrate MPD and Snapcast into a Multiroom/
=begin html
<a name="OpenMultiroom"></a>
<h3>OpenMultiroom</h3>
<ul>
<i>OpenMultiroom</i> is a module that integrates the functions of an audio player module and a multiroom module into one module, giving one interface with one set of readings and set-commands. Currently it supports the <a href="#MPD">MPD module</a> as sound backend and the <a href="#Snapcast">Snapcast module</a> as multiroom backend. Optionally a <a href="#Text2Speech">Text2Speech module</a> can be attached on top to enable audio-feedback on userinteraction, which makes most sense if used in a headless environment. OpenMultiroom is specificallz optimized to be used just with a remote control without a display, but its interface also allows to be used with common frontends such as TabletUI or SmartVISU. A comprehensive introcuction into how to use and configure this module and the associated modules and software services is given in the <a href="http://www.fhemwiki.de/wiki/OpenMultiroom">Wiki</a> (german only).
<a name="OpenMultiroomDefine"></a>
<b>Define</b>
<ul>
<code>define <name> OpenMultiroom</code>
<br><br>
There are no other arguments during define. The configuration is done only with attributes.
</ul>
<br>
<a name="OpenMultiroomSet"></a>
<b>Set</b><br>
<ul>
The OpenMultiroom module mirrors many set functions from the connected sound backened and multiroom backend. Some sets are modified, some are added.
<code>set <name> <function> <value></code>
<br><br>
Options:
<ul>
<li><i>0...9</i><br>
Any single digit. This is useful to connect the digits on a IR or radio remote to this module. The module has a memory of digits "pressed". Whenever more digits are pressed within the timeout(Attribute <i>digitTimeout</i>) the digits are chained together to a number, similar to changing a channel on a TV with numbers on a remote. If afterwards one of the functions that can be controled with numbers is used, the number will be used as argument to it, e.g. for skipping to a track with a specific number. If the timeout occurs before that, the number memory is set to 0 and optionally a configurable NACK-Sound is played. (configured in associated TTS-Module)</li>
<li><i>play</i><br>
play is forwarded to the sound backend. If a number is entered before, it will skip to the track with that number.</li>
<li><i>pause</i><br>
pause just pauses the sound backend</li>
<li><i>toggle</i><br>
toggles between play and pause in the sound backend</li>
<li><i>stop</i><br>
stops the sound backend</li>
<li><i>next / previous</i><br>
Skips to the next or previous track in the sound backend</li>
<li><i>forward / rewind</i><br>
jump forward or backward in the current track as far as defined in the Attributes <i>seekStep</i>, <i>seekStepSmall</i> and <i>seekStepThreshold</i>, default 7%<br>
If a number is entered before, skips to the given position either in seconds or in percent, depending on Attribute <i>seekDirect</i><</li>
<li><i>random, single, repeat</i><br>
Those commands are just forwarded to the sound backend and change its behavior accordingly.</li>
<li><i>channelUp / channelDown / channel (number)</i><br>
loads the next or previous playlist in the sound backend. To determine what is the next or previous playlist the module uses the attribute <i>playlistPattern</i> which is applied as regular expression filter to the list of playlists available. On top of that the module sorts the playlist in a way, that those playlists that have a number in its name are available on exactly that position in the list. This way a playlist can be named with a certain number and is then later available through this module by entering that number with the digits of a remote and then using the channel or channelUp command. If there is more than one playlist with the same number in its name, it will be sorted into the list at the next free number slot</li>
<li><i>volume [number]</i><br>
sets the volume of the multiroom backend, either by giving volume as a parameter, or by entering a number with digits before using this command.</li>
<li><i>volup / voldown</i><br>
uses the volup or voldown command of the multiroom backend to change the volume in configurable steps</li>
<li><i>mute [true|false]</i><br>
mutes or unmutes the multiroom backend using the true or false option. Without option given, toggles the mute status</li>
<li><i>stream [streamname]</i><br>
changes the stream to which the module is listening to in the multiroom backend. Without argument, it just switches to the next stream, or with argument, to the stream with the given name. A change of stream also leads to a situation, where the module is connected to a different instance of the sound backend and therefore all readings of the sound backend will be updated with those from the new sound backend. The new sound backend is determined based on the attribute <i>soundMapping</i>. This also means, that the module is always in control of the sound backend instance that it is listening to.</li>
</ul>
</ul>
<br><br>
<a name="OpenMultiroomattr"></a>
<b>Attributes</b>
<ul>
The following attributes change the behavior of the module. Without the attributes <i>mr</i> and <i>soundMapping</i>, the module cannot be used in a meaningful way.
<li>mrSystem (Default: Snapcast)<br>
The type of the multiroom backend module. Currently only Snapcast is supported.
</li>
<li>soundSystem (Default: MPD)<br>
The type of the sound backend module. Currently only MPD is supported.
</li>
<li>mr<br>
The name of the multiroom backend definition. For Snapcast, this must be the name of a snapcast module in client mode.
</li>
<li>soundMapping<br>
The mapping of the multiroom streams to the sound players. For Snapcast and MPD it defines, which MPD modules are playing on which snapcast streams. Check the WIKI for a comprehensive example.
<pre>attr <name> soundMapping stream1:mpd.room1,stream2:mpd.stream2</pre>
</li>
<li>ttsMapping<br>
If Text2Speech is used, this maps the defined Text2Speech modules to the associated Multiroom-System-Streams.
<pre>attr <name> ttsMapping stream1:tts.room1,stream2:tts.stream2</pre>
</li>
<li>defaultTts<br>
defines what is the default tts module to use. Requires a name of a Text2Speech module.
</li>
<li>defaultStream<br>
Name of the default stream of this module. This is used for a reset function (not yet implemented)
</li>
<li>defaultSound<br>
Name of the default sound backend of this module. This is used for a reset function (not yet implemented)
</li>
<li>playlistPattern<br>
Regular expression to filter the playlists used by the channel, channelUp and channelDown commands.
</li>
<li>seekStep (Default: 7)<br>
set this to define how far the forward and rewind commands jump in the current track. Defaults to 7 if not set
</li>
<li>seekStepSmall (Default: 2)<br>
set this on top of seekStep to define a smaller step size, if the current playing position is below seekStepThreshold percent. This is useful to skip intro music, e.g. in radio plays or audiobooks.
</li>
<li>seekStepThreshold (Default: 8)<br>
used to define when seekStep or seekStepSmall is applied. Defaults to 0. If set e.g. to 10, then during the first 10% of a track, forward and rewind are using the seekStepSmall value.
</li>
<li>digitTimeout<br>
Time within digits can be entered and chained to a multi-digit number before the digit memory is set to 0 again.
</li>
</ul>
</ul>
=end html