git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.sonos.internal.handler;
  14
  15 import static org.openhab.binding.sonos.internal.SonosBindingConstants.*;
  16
  17 import java.io.IOException;
  18 import java.net.MalformedURLException;
  19 import java.net.URL;
  20 import java.text.ParseException;
  21 import java.text.SimpleDateFormat;
  22 import java.util.ArrayList;
  23 import java.util.Arrays;
  24 import java.util.Calendar;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.Date;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.TimeZone;
  32 import java.util.concurrent.ScheduledFuture;
  33 import java.util.concurrent.TimeUnit;
  34
  35 import org.eclipse.jdt.annotation.NonNullByDefault;
  36 import org.eclipse.jdt.annotation.Nullable;
  37 import org.openhab.binding.sonos.internal.SonosAlarm;
  38 import org.openhab.binding.sonos.internal.SonosBindingConstants;
  39 import org.openhab.binding.sonos.internal.SonosEntry;
  40 import org.openhab.binding.sonos.internal.SonosMetaData;
  41 import org.openhab.binding.sonos.internal.SonosMusicService;
  42 import org.openhab.binding.sonos.internal.SonosResourceMetaData;
  43 import org.openhab.binding.sonos.internal.SonosStateDescriptionOptionProvider;
  44 import org.openhab.binding.sonos.internal.SonosXMLParser;
  45 import org.openhab.binding.sonos.internal.SonosZoneGroup;
  46 import org.openhab.binding.sonos.internal.SonosZonePlayerState;
  47 import org.openhab.binding.sonos.internal.config.ZonePlayerConfiguration;
  48 import org.openhab.core.io.net.http.HttpUtil;
  49 import org.openhab.core.io.transport.upnp.UpnpIOParticipant;
  50 import org.openhab.core.io.transport.upnp.UpnpIOService;
  51 import org.openhab.core.library.types.DecimalType;
  52 import org.openhab.core.library.types.IncreaseDecreaseType;
  53 import org.openhab.core.library.types.NextPreviousType;
  54 import org.openhab.core.library.types.OnOffType;
  55 import org.openhab.core.library.types.OpenClosedType;
  56 import org.openhab.core.library.types.PercentType;
  57 import org.openhab.core.library.types.PlayPauseType;
  58 import org.openhab.core.library.types.RawType;
  59 import org.openhab.core.library.types.StringType;
  60 import org.openhab.core.library.types.UpDownType;
  61 import org.openhab.core.thing.ChannelUID;
  62 import org.openhab.core.thing.Thing;
  63 import org.openhab.core.thing.ThingRegistry;
  64 import org.openhab.core.thing.ThingStatus;
  65 import org.openhab.core.thing.ThingStatusDetail;
  66 import org.openhab.core.thing.ThingTypeUID;
  67 import org.openhab.core.thing.ThingUID;
  68 import org.openhab.core.thing.binding.BaseThingHandler;
  69 import org.openhab.core.thing.binding.ThingHandler;
  70 import org.openhab.core.types.Command;
  71 import org.openhab.core.types.RefreshType;
  72 import org.openhab.core.types.State;
  73 import org.openhab.core.types.StateOption;
  74 import org.openhab.core.types.UnDefType;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77
  78 /**
  79  * The {@link ZonePlayerHandler} is responsible for handling commands, which are
  80  * sent to one of the channels.
  81  *
  82  * @author Karel Goderis - Initial contribution
  83  */
  84 @NonNullByDefault
  85 public class ZonePlayerHandler extends BaseThingHandler implements UpnpIOParticipant {
  86
  87     private static final String ANALOG_LINE_IN_URI = "x-rincon-stream:";
  88     private static final String OPTICAL_LINE_IN_URI = "x-sonos-htastream:";
  89     private static final String VIRTUAL_LINE_IN_URI = "x-sonos-vli:";
  90     private static final String QUEUE_URI = "x-rincon-queue:";
  91     private static final String GROUP_URI = "x-rincon:";
  92     private static final String STREAM_URI = "x-sonosapi-stream:";
  93     private static final String RADIO_URI = "x-sonosapi-radio:";
  94     private static final String RADIO_MP3_URI = "x-rincon-mp3radio:";
  95     private static final String RADIOAPP_URI = "x-sonosapi-hls:radioapp_";
  96     private static final String OPML_TUNE = "://opml.radiotime.com/Tune.ashx";
  97     private static final String FILE_URI = "x-file-cifs:";
  98     private static final String SPDIF = ":spdif";
  99     private static final String TUNEIN_URI = "x-sonosapi-stream:s%s?sid=%s&flags=32";
 100
 101     private static final String STATE_PLAYING = "PLAYING";
 102     private static final String STATE_PAUSED_PLAYBACK = "PAUSED_PLAYBACK";
 103     private static final String STATE_STOPPED = "STOPPED";
 104     private static final String STATE_TRANSITIONING = "TRANSITIONING";
 105
 106     private static final String LINEINCONNECTED = "LineInConnected";
 107     private static final String TOSLINEINCONNECTED = "TOSLinkConnected";
 108
 109     private static final String SERVICE_DEVICE_PROPERTIES = "DeviceProperties";
 110     private static final String SERVICE_AV_TRANSPORT = "AVTransport";
 111     private static final String SERVICE_RENDERING_CONTROL = "RenderingControl";
 112     private static final String SERVICE_ZONE_GROUP_TOPOLOGY = "ZoneGroupTopology";
 113     private static final String SERVICE_GROUP_MANAGEMENT = "GroupManagement";
 114     private static final String SERVICE_AUDIO_IN = "AudioIn";
 115     private static final String SERVICE_HT_CONTROL = "HTControl";
 116     private static final String SERVICE_CONTENT_DIRECTORY = "ContentDirectory";
 117     private static final String SERVICE_ALARM_CLOCK = "AlarmClock";
 118
 119     private static final Collection<String> SERVICE_SUBSCRIPTIONS = Arrays.asList(SERVICE_DEVICE_PROPERTIES,
 120             SERVICE_AV_TRANSPORT, SERVICE_ZONE_GROUP_TOPOLOGY, SERVICE_GROUP_MANAGEMENT, SERVICE_RENDERING_CONTROL,
 121             SERVICE_AUDIO_IN, SERVICE_HT_CONTROL, SERVICE_CONTENT_DIRECTORY);
 122     protected static final int SUBSCRIPTION_DURATION = 1800;
 123
 124     private static final String ACTION_GET_ZONE_ATTRIBUTES = "GetZoneAttributes";
 125     private static final String ACTION_GET_ZONE_INFO = "GetZoneInfo";
 126     private static final String ACTION_GET_LED_STATE = "GetLEDState";
 127     private static final String ACTION_SET_LED_STATE = "SetLEDState";
 128
 129     private static final String ACTION_GET_POSITION_INFO = "GetPositionInfo";
 130     private static final String ACTION_SET_AV_TRANSPORT_URI = "SetAVTransportURI";
 131     private static final String ACTION_SEEK = "Seek";
 132     private static final String ACTION_PLAY = "Play";
 133     private static final String ACTION_STOP = "Stop";
 134     private static final String ACTION_PAUSE = "Pause";
 135     private static final String ACTION_PREVIOUS = "Previous";
 136     private static final String ACTION_NEXT = "Next";
 137     private static final String ACTION_ADD_URI_TO_QUEUE = "AddURIToQueue";
 138     private static final String ACTION_REMOVE_TRACK_RANGE_FROM_QUEUE = "RemoveTrackRangeFromQueue";
 139     private static final String ACTION_REMOVE_ALL_TRACKS_FROM_QUEUE = "RemoveAllTracksFromQueue";
 140     private static final String ACTION_SAVE_QUEUE = "SaveQueue";
 141     private static final String ACTION_SET_PLAY_MODE = "SetPlayMode";
 142     private static final String ACTION_BECOME_COORDINATOR_OF_STANDALONE_GROUP = "BecomeCoordinatorOfStandaloneGroup";
 143     private static final String ACTION_GET_RUNNING_ALARM_PROPERTIES = "GetRunningAlarmProperties";
 144     private static final String ACTION_SNOOZE_ALARM = "SnoozeAlarm";
 145     private static final String ACTION_GET_REMAINING_SLEEP_TIMER_DURATION = "GetRemainingSleepTimerDuration";
 146     private static final String ACTION_CONFIGURE_SLEEP_TIMER = "ConfigureSleepTimer";
 147
 148     private static final String ACTION_SET_VOLUME = "SetVolume";
 149     private static final String ACTION_SET_MUTE = "SetMute";
 150     private static final String ACTION_SET_BASS = "SetBass";
 151     private static final String ACTION_SET_TREBLE = "SetTreble";
 152     private static final String ACTION_SET_LOUDNESS = "SetLoudness";
 153     private static final String ACTION_SET_EQ = "SetEQ";
 154
 155     private static final int TUNEIN_DEFAULT_SERVICE_TYPE = 65031;
 156
 157     private static final int MIN_BASS = -10;
 158     private static final int MAX_BASS = 10;
 159     private static final int MIN_TREBLE = -10;
 160     private static final int MAX_TREBLE = 10;
 161     private static final int MIN_SUBWOOFER_GAIN = -15;
 162     private static final int MAX_SUBWOOFER_GAIN = 15;
 163     private static final int MIN_SURROUND_LEVEL = -15;
 164     private static final int MAX_SURROUND_LEVEL = 15;
 165     private static final int MIN_HEIGHT_LEVEL = -10;
 166     private static final int MAX_HEIGHT_LEVEL = 10;
 167
 168     private static final int HTTP_TIMEOUT = 5000;
 169
 170     private final Logger logger = LoggerFactory.getLogger(ZonePlayerHandler.class);
 171
 172     private final ThingRegistry localThingRegistry;
 173     private final UpnpIOService service;
 174     private final @Nullable String opmlUrl;
 175     private final SonosStateDescriptionOptionProvider stateDescriptionProvider;
 176
 177     private ZonePlayerConfiguration configuration = new ZonePlayerConfiguration();
 178
 179     /**
 180      * Intrinsic lock used to synchronize the execution of notification sounds
 181      */
 182     private final Object notificationLock = new Object();
 183     private final Object upnpLock = new Object();
 184     private final Object stateLock = new Object();
 185     private final Object jobLock = new Object();
 186
 187     private final Map<String, String> stateMap = Collections.synchronizedMap(new HashMap<>());
 188
 189     private @Nullable ScheduledFuture<?> pollingJob;
 190     private @Nullable SonosZonePlayerState savedState;
 191
 192     private Map<String, Boolean> subscriptionState = new HashMap<>();
 193
 194     /**
 195      * Thing handler instance of the coordinator speaker used for control delegation
 196      */
 197     private @Nullable ZonePlayerHandler coordinatorHandler;
 198
 199     private @Nullable List<SonosMusicService> musicServices;
 200
 201     private enum LineInType {
 202         ANALOG,
 203         DIGITAL,
 204         ANY
 205     }
 206
 207     public ZonePlayerHandler(ThingRegistry thingRegistry, Thing thing, UpnpIOService upnpIOService,
 208             @Nullable String opmlUrl, SonosStateDescriptionOptionProvider stateDescriptionProvider) {
 209         super(thing);
 210         this.localThingRegistry = thingRegistry;
 211         this.opmlUrl = opmlUrl;
 212         logger.debug("Creating a ZonePlayerHandler for thing '{}'", getThing().getUID());
 213         this.service = upnpIOService;
 214         this.stateDescriptionProvider = stateDescriptionProvider;
 215     }
 216
 217     @Override
 218     public void dispose() {
 219         logger.debug("Handler disposed for thing {}", getThing().getUID());
 220
 221         ScheduledFuture<?> job = this.pollingJob;
 222         if (job != null) {
 223             job.cancel(true);
 224         }
 225         this.pollingJob = null;
 226
 227         removeSubscription();
 228         service.unregisterParticipant(this);
 229     }
 230
 231     @Override
 232     public void initialize() {
 233         logger.debug("initializing handler for thing {}", getThing().getUID());
 234
 235         if (migrateThingType()) {
 236             // we change the type, so we might need a different handler -> let's finish
 237             return;
 238         }
 239
 240         configuration = getConfigAs(ZonePlayerConfiguration.class);
 241         String udn = configuration.udn;
 242         if (udn != null && !udn.isEmpty()) {
 243             service.registerParticipant(this);
 244             pollingJob = scheduler.scheduleWithFixedDelay(this::poll, 0, configuration.refresh, TimeUnit.SECONDS);
 245         } else {
 246             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
 247                     "@text/offline.conf-error-missing-udn");
 248             logger.debug("Cannot initalize the zoneplayer. UDN not set.");
 249         }
 250     }
 251
 252     private void poll() {
 253         synchronized (jobLock) {
 254             if (pollingJob == null) {
 255                 return;
 256             }
 257             try {
 258                 logger.debug("Polling job");
 259
 260                 // First check if the Sonos zone is set in the UPnP service registry
 261                 // If not, set the thing state to OFFLINE and wait for the next poll
 262                 if (!isUpnpDeviceRegistered()) {
 263                     logger.debug("UPnP device {} not yet registered", getUDN());
 264                     updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
 265                             "@text/offline.upnp-device-not-registered [\"" + getUDN() + "\"]");
 266                     synchronized (upnpLock) {
 267                         subscriptionState = new HashMap<>();
 268                     }
 269                     return;
 270                 }
 271
 272                 // Check if the Sonos zone can be joined
 273                 // If not, set the thing state to OFFLINE and do nothing else
 274                 updatePlayerState();
 275                 if (getThing().getStatus() != ThingStatus.ONLINE) {
 276                     return;
 277                 }
 278
 279                 addSubscription();
 280
 281                 if (isLinked(ZONENAME)) {
 282                     updateCurrentZoneName();
 283                 }
 284                 if (isLinked(LED)) {
 285                     updateLed();
 286                 }
 287                 // Action GetRemainingSleepTimerDuration is failing for a group slave member (error code 500)
 288                 if (isLinked(SLEEPTIMER) && isCoordinator()) {
 289                     updateSleepTimerDuration();
 290                 }
 291             } catch (Exception e) {
 292                 logger.debug("Exception during poll: {}", e.getMessage(), e);
 293             }
 294         }
 295     }
 296
 297     @Override
 298     public void handleCommand(ChannelUID channelUID, Command command) {
 299         if (command == RefreshType.REFRESH) {
 300             updateChannel(channelUID.getId());
 301         } else {
 302             switch (channelUID.getId()) {
 303                 case LED:
 304                     setLed(command);
 305                     break;
 306                 case MUTE:
 307                     setMute(command);
 308                     break;
 309                 case NOTIFICATIONSOUND:
 310                     scheduleNotificationSound(command);
 311                     break;
 312                 case STOP:
 313                     stopPlaying(command);
 314                     break;
 315                 case VOLUME:
 316                     setVolumeForGroup(command);
 317                     break;
 318                 case BASS:
 319                     setBass(command);
 320                     break;
 321                 case TREBLE:
 322                     setTreble(command);
 323                     break;
 324                 case LOUDNESS:
 325                     setLoudness(command);
 326                     break;
 327                 case SUBWOOFER:
 328                     setSubwoofer(command);
 329                     break;
 330                 case SUBWOOFERGAIN:
 331                     setSubwooferGain(command);
 332                     break;
 333                 case SURROUND:
 334                     setSurround(command);
 335                     break;
 336                 case SURROUNDMUSICMODE:
 337                     setSurroundMusicMode(command);
 338                     break;
 339                 case SURROUNDMUSICLEVEL:
 340                     setSurroundMusicLevel(command);
 341                     break;
 342                 case SURROUNDTVLEVEL:
 343                     setSurroundTvLevel(command);
 344                     break;
 345                 case HEIGHTLEVEL:
 346                     setHeightLevel(command);
 347                     break;
 348                 case ADD:
 349                     addMember(command);
 350                     break;
 351                 case REMOVE:
 352                     removeMember(command);
 353                     break;
 354                 case STANDALONE:
 355                     becomeStandAlonePlayer();
 356                     break;
 357                 case PUBLICADDRESS:
 358                     publicAddress(LineInType.ANY);
 359                     break;
 360                 case PUBLICANALOGADDRESS:
 361                     publicAddress(LineInType.ANALOG);
 362                     break;
 363                 case PUBLICDIGITALADDRESS:
 364                     publicAddress(LineInType.DIGITAL);
 365                     break;
 366                 case RADIO:
 367                     playRadio(command);
 368                     break;
 369                 case TUNEINSTATIONID:
 370                     playTuneinStation(command);
 371                     break;
 372                 case FAVORITE:
 373                     playFavorite(command);
 374                     break;
 375                 case ALARM:
 376                     setAlarm(command);
 377                     break;
 378                 case SNOOZE:
 379                     snoozeAlarm(command);
 380                     break;
 381                 case SAVEALL:
 382                     saveAllPlayerState();
 383                     break;
 384                 case RESTOREALL:
 385                     restoreAllPlayerState();
 386                     break;
 387                 case SAVE:
 388                     saveState();
 389                     break;
 390                 case RESTORE:
 391                     restoreState();
 392                     break;
 393                 case PLAYLIST:
 394                     playPlayList(command);
 395                     break;
 396                 case CLEARQUEUE:
 397                     clearQueue();
 398                     break;
 399                 case PLAYQUEUE:
 400                     playQueue();
 401                     break;
 402                 case PLAYTRACK:
 403                     playTrack(command);
 404                     break;
 405                 case PLAYURI:
 406                     playURI(command);
 407                     break;
 408                 case PLAYLINEIN:
 409                     playLineIn(command);
 410                     break;
 411                 case CONTROL:
 412                     try {
 413                         if (command instanceof PlayPauseType) {
 414                             if (command == PlayPauseType.PLAY) {
 415                                 getCoordinatorHandler().play();
 416                             } else if (command == PlayPauseType.PAUSE) {
 417                                 getCoordinatorHandler().pause();
 418                             }
 419                         }
 420                         if (command instanceof NextPreviousType) {
 421                             if (command == NextPreviousType.NEXT) {
 422                                 getCoordinatorHandler().next();
 423                             } else if (command == NextPreviousType.PREVIOUS) {
 424                                 getCoordinatorHandler().previous();
 425                             }
 426                         }
 427                         // Rewind and Fast Forward are currently not implemented by the binding
 428                     } catch (IllegalStateException e) {
 429                         logger.debug("Cannot handle control command ({})", e.getMessage());
 430                     }
 431                     break;
 432                 case SLEEPTIMER:
 433                     setSleepTimer(command);
 434                     break;
 435                 case SHUFFLE:
 436                     setShuffle(command);
 437                     break;
 438                 case REPEAT:
 439                     setRepeat(command);
 440                     break;
 441                 case NIGHTMODE:
 442                     setNightMode(command);
 443                     break;
 444                 case SPEECHENHANCEMENT:
 445                     setSpeechEnhancement(command);
 446                     break;
 447                 default:
 448                     break;
 449             }
 450         }
 451     }
 452
 453     private void restoreAllPlayerState() {
 454         for (Thing aThing : localThingRegistry.getAll()) {
 455             if (SonosBindingConstants.SUPPORTED_THING_TYPES_UIDS.contains(aThing.getThingTypeUID())) {
 456                 ZonePlayerHandler handler = (ZonePlayerHandler) aThing.getHandler();
 457                 if (handler != null) {
 458                     handler.restoreState();
 459                 }
 460             }
 461         }
 462     }
 463
 464     private void saveAllPlayerState() {
 465         for (Thing aThing : localThingRegistry.getAll()) {
 466             if (SonosBindingConstants.SUPPORTED_THING_TYPES_UIDS.contains(aThing.getThingTypeUID())) {
 467                 ZonePlayerHandler handler = (ZonePlayerHandler) aThing.getHandler();
 468                 if (handler != null) {
 469                     handler.saveState();
 470                 }
 471             }
 472         }
 473     }
 474
 475     @Override
 476     public void onValueReceived(@Nullable String variable, @Nullable String value, @Nullable String service) {
 477         if (variable == null || value == null || service == null) {
 478             return;
 479         }
 480
 481         if (getThing().getStatus() == ThingStatus.ONLINE) {
 482             logger.trace("Received pair '{}':'{}' (service '{}') for thing '{}'",
 483                     new Object[] { variable, value, service, this.getThing().getUID() });
 484
 485             String oldValue = this.stateMap.get(variable);
 486             if (shouldIgnoreVariableUpdate(variable, value, oldValue)) {
 487                 return;
 488             }
 489
 490             this.stateMap.put(variable, value);
 491
 492             // pre-process some variables, eg XML processing
 493             if (SERVICE_AV_TRANSPORT.equals(service) && "LastChange".equals(variable)) {
 494                 Map<String, String> parsedValues = SonosXMLParser.getAVTransportFromXML(value);
 495                 parsedValues.forEach((variable1, value1) -> {
 496                     // Update the transport state after the update of the media information
 497                     // to not break the notification mechanism
 498                     if (!"TransportState".equals(variable1)) {
 499                         onValueReceived(variable1, value1, service);
 500                     }
 501                     // Translate AVTransportURI/AVTransportURIMetaData to CurrentURI/CurrentURIMetaData
 502                     // for a compatibility with the result of the action GetMediaInfo
 503                     if ("AVTransportURI".equals(variable1)) {
 504                         onValueReceived("CurrentURI", value1, service);
 505                     } else if ("AVTransportURIMetaData".equals(variable1)) {
 506                         onValueReceived("CurrentURIMetaData", value1, service);
 507                     }
 508                 });
 509                 updateMediaInformation();
 510                 if (parsedValues.get("TransportState") != null) {
 511                     onValueReceived("TransportState", parsedValues.get("TransportState"), service);
 512                 }
 513             }
 514
 515             if (SERVICE_RENDERING_CONTROL.equals(service) && "LastChange".equals(variable)) {
 516                 Map<String, String> parsedValues = SonosXMLParser.getRenderingControlFromXML(value);
 517                 parsedValues.forEach((variable1, value1) -> {
 518                     onValueReceived(variable1, value1, service);
 519                 });
 520             }
 521
 522             List<StateOption> options = new ArrayList<>();
 523
 524             // update the appropriate channel
 525             switch (variable) {
 526                 case "TransportState":
 527                     updateChannel(STATE);
 528                     updateChannel(CONTROL);
 529                     updateChannel(STOP);
 530                     dispatchOnAllGroupMembers(variable, value, service);
 531                     break;
 532                 case "CurrentPlayMode":
 533                     updateChannel(SHUFFLE);
 534                     updateChannel(REPEAT);
 535                     dispatchOnAllGroupMembers(variable, value, service);
 536                     break;
 537                 case "CurrentLEDState":
 538                     updateChannel(LED);
 539                     break;
 540                 case "ZoneName":
 541                     updateState(ZONENAME, new StringType(value));
 542                     break;
 543                 case "CurrentZoneName":
 544                     updateChannel(ZONENAME);
 545                     break;
 546                 case "ZoneGroupState":
 547                     updateChannel(COORDINATOR);
 548                     // Update coordinator after a change is made to the grouping of Sonos players
 549                     updateGroupCoordinator();
 550                     updateMediaInformation();
 551                     // Update state and control channels for the group members with the coordinator values
 552                     String transportState = getTransportState();
 553                     if (transportState != null) {
 554                         dispatchOnAllGroupMembers("TransportState", transportState, SERVICE_AV_TRANSPORT);
 555                     }
 556                     // Update shuffle and repeat channels for the group members with the coordinator values
 557                     String playMode = getPlayMode();
 558                     if (playMode != null) {
 559                         dispatchOnAllGroupMembers("CurrentPlayMode", playMode, SERVICE_AV_TRANSPORT);
 560                     }
 561                     break;
 562                 case "LocalGroupUUID":
 563                     updateChannel(ZONEGROUPID);
 564                     break;
 565                 case "GroupCoordinatorIsLocal":
 566                     updateChannel(LOCALCOORDINATOR);
 567                     break;
 568                 case "VolumeMaster":
 569                     updateChannel(VOLUME);
 570                     break;
 571                 case "MuteMaster":
 572                     updateChannel(MUTE);
 573                     break;
 574                 case "Bass":
 575                     updateChannel(BASS);
 576                     break;
 577                 case "Treble":
 578                     updateChannel(TREBLE);
 579                     break;
 580                 case "LoudnessMaster":
 581                     updateChannel(LOUDNESS);
 582                     break;
 583                 case "OutputFixed":
 584                     updateChannel(BASS);
 585                     updateChannel(TREBLE);
 586                     updateChannel(LOUDNESS);
 587                     break;
 588                 case "SubEnabled":
 589                     updateChannel(SUBWOOFER);
 590                     break;
 591                 case "SubGain":
 592                     updateChannel(SUBWOOFERGAIN);
 593                     break;
 594                 case "SurroundEnabled":
 595                     updateChannel(SURROUND);
 596                     break;
 597                 case "SurroundMode":
 598                     updateChannel(SURROUNDMUSICMODE);
 599                     break;
 600                 case "SurroundLevel":
 601                     updateChannel(SURROUNDTVLEVEL);
 602                     break;
 603                 case "HTAudioIn":
 604                     updateChannel(CODEC);
 605                     break;
 606                 case "MusicSurroundLevel":
 607                     updateChannel(SURROUNDMUSICLEVEL);
 608                     break;
 609                 case "HeightChannelLevel":
 610                     updateChannel(HEIGHTLEVEL);
 611                     break;
 612                 case "NightMode":
 613                     updateChannel(NIGHTMODE);
 614                     break;
 615                 case "DialogLevel":
 616                     updateChannel(SPEECHENHANCEMENT);
 617                     break;
 618                 case LINEINCONNECTED:
 619                     if (SonosBindingConstants.WITH_LINEIN_THING_TYPES_UIDS.contains(getThing().getThingTypeUID())) {
 620                         updateChannel(LINEIN);
 621                     }
 622                     if (SonosBindingConstants.WITH_ANALOG_LINEIN_THING_TYPES_UIDS
 623                             .contains(getThing().getThingTypeUID())) {
 624                         updateChannel(ANALOGLINEIN);
 625                     }
 626                     break;
 627                 case TOSLINEINCONNECTED:
 628                     if (SonosBindingConstants.WITH_LINEIN_THING_TYPES_UIDS.contains(getThing().getThingTypeUID())) {
 629                         updateChannel(LINEIN);
 630                     }
 631                     if (SonosBindingConstants.WITH_DIGITAL_LINEIN_THING_TYPES_UIDS
 632                             .contains(getThing().getThingTypeUID())) {
 633                         updateChannel(DIGITALLINEIN);
 634                     }
 635                     break;
 636                 case "AlarmRunning":
 637                     updateChannel(ALARMRUNNING);
 638                     updateRunningAlarmProperties();
 639                     break;
 640                 case "RunningAlarmProperties":
 641                     updateChannel(ALARMPROPERTIES);
 642                     break;
 643                 case "CurrentURIFormatted":
 644                     updateChannel(CURRENTTRACK);
 645                     break;
 646                 case "CurrentTitle":
 647                     updateChannel(CURRENTTITLE);
 648                     break;
 649                 case "CurrentArtist":
 650                     updateChannel(CURRENTARTIST);
 651                     break;
 652                 case "CurrentAlbum":
 653                     updateChannel(CURRENTALBUM);
 654                     break;
 655                 case "CurrentURI":
 656                     updateChannel(CURRENTTRANSPORTURI);
 657                     break;
 658                 case "CurrentTrackURI":
 659                     updateChannel(CURRENTTRACKURI);
 660                     break;
 661                 case "CurrentAlbumArtURI":
 662                     updateChannel(CURRENTALBUMARTURL);
 663                     break;
 664                 case "CurrentSleepTimerGeneration":
 665                     if ("0".equals(value)) {
 666                         updateState(SLEEPTIMER, new DecimalType(0));
 667                     }
 668                     break;
 669                 case "SleepTimerGeneration":
 670                     if ("0".equals(value)) {
 671                         updateState(SLEEPTIMER, new DecimalType(0));
 672                     } else {
 673                         updateSleepTimerDuration();
 674                     }
 675                     break;
 676                 case "RemainingSleepTimerDuration":
 677                     updateState(SLEEPTIMER, new DecimalType(sleepStrTimeToSeconds(value)));
 678                     break;
 679                 case "CurrentTuneInStationId":
 680                     updateChannel(TUNEINSTATIONID);
 681                     break;
 682                 case "SavedQueuesUpdateID": // service ContentDirectoy
 683                     for (SonosEntry entry : getPlayLists()) {
 684                         options.add(new StateOption(entry.getTitle(), entry.getTitle()));
 685                     }
 686                     stateDescriptionProvider.setStateOptions(new ChannelUID(getThing().getUID(), PLAYLIST), options);
 687                     break;
 688                 case "FavoritesUpdateID": // service ContentDirectoy
 689                     for (SonosEntry entry : getFavorites()) {
 690                         options.add(new StateOption(entry.getTitle(), entry.getTitle()));
 691                     }
 692                     stateDescriptionProvider.setStateOptions(new ChannelUID(getThing().getUID(), FAVORITE), options);
 693                     break;
 694                 // For favorite radios, we should have checked the state variable named RadioFavoritesUpdateID
 695                 // Due to a bug in the data type definition of this state variable, it is not set.
 696                 // As a workaround, we check the state variable named ContainerUpdateIDs.
 697                 case "ContainerUpdateIDs": // service ContentDirectoy
 698                     if (value.startsWith("R:0,") || stateDescriptionProvider
 699                             .getStateOptions(new ChannelUID(getThing().getUID(), RADIO)) == null) {
 700                         for (SonosEntry entry : getFavoriteRadios()) {
 701                             options.add(new StateOption(entry.getTitle(), entry.getTitle()));
 702                         }
 703                         stateDescriptionProvider.setStateOptions(new ChannelUID(getThing().getUID(), RADIO), options);
 704                     }
 705                     break;
 706                 case "MoreInfo":
 707                     updateChannel(BATTERYCHARGING);
 708                     updateChannel(BATTERYLEVEL);
 709                     break;
 710                 case "MicEnabled":
 711                     updateChannel(MICROPHONE);
 712                     break;
 713                 default:
 714                     break;
 715             }
 716         }
 717     }
 718
 719     private void dispatchOnAllGroupMembers(String variable, String value, String service) {
 720         if (isCoordinator()) {
 721             for (String member : getOtherZoneGroupMembers()) {
 722                 try {
 723                     ZonePlayerHandler memberHandler = getHandlerByName(member);
 724                     if (ThingStatus.ONLINE.equals(memberHandler.getThing().getStatus())) {
 725                         memberHandler.onValueReceived(variable, value, service);
 726                     }
 727                 } catch (IllegalStateException e) {
 728                     logger.debug("Cannot update channel for group member ({})", e.getMessage());
 729                 }
 730             }
 731         }
 732     }
 733
 734     private @Nullable String getAlbumArtUrl() {
 735         String url = null;
 736         String albumArtURI = stateMap.get("CurrentAlbumArtURI");
 737         if (albumArtURI != null) {
 738             if (albumArtURI.startsWith("http")) {
 739                 url = albumArtURI;
 740             } else if (albumArtURI.startsWith("/")) {
 741                 try {
 742                     URL serviceDescrUrl = service.getDescriptorURL(this);
 743                     if (serviceDescrUrl != null) {
 744                         url = new URL(serviceDescrUrl.getProtocol(), serviceDescrUrl.getHost(),
 745                                 serviceDescrUrl.getPort(), albumArtURI).toExternalForm();
 746                     }
 747                 } catch (MalformedURLException e) {
 748                     logger.debug("Failed to build a valid album art URL from {}: {}", albumArtURI, e.getMessage());
 749                 }
 750             }
 751         }
 752         return url;
 753     }
 754
 755     protected void updateChannel(String channelId) {
 756         if (!isLinked(channelId)) {
 757             return;
 758         }
 759
 760         String url;
 761
 762         State newState = UnDefType.UNDEF;
 763         String value;
 764         switch (channelId) {
 765             case STATE:
 766                 value = getTransportState();
 767                 if (value != null) {
 768                     // Ignoring state TRANSITIONING
 769                     newState = STATE_TRANSITIONING.equals(value) ? null : new StringType(value);
 770                 }
 771                 break;
 772             case CONTROL:
 773                 value = getTransportState();
 774                 if (STATE_PLAYING.equals(value)) {
 775                     newState = PlayPauseType.PLAY;
 776                 } else if (STATE_STOPPED.equals(value)) {
 777                     newState = PlayPauseType.PAUSE;
 778                 } else if (STATE_PAUSED_PLAYBACK.equals(value)) {
 779                     newState = PlayPauseType.PAUSE;
 780                 } else if (STATE_TRANSITIONING.equals(value)) {
 781                     // Ignoring state TRANSITIONING
 782                     newState = null;
 783                 }
 784                 break;
 785             case STOP:
 786                 value = getTransportState();
 787                 if (value != null) {
 788                     newState = STATE_TRANSITIONING.equals(value) ? null : OnOffType.from(STATE_STOPPED.equals(value));
 789                 }
 790                 break;
 791             case SHUFFLE:
 792                 if (getPlayMode() != null) {
 793                     newState = OnOffType.from(isShuffleActive());
 794                 }
 795                 break;
 796             case REPEAT:
 797                 if (getPlayMode() != null) {
 798                     newState = new StringType(getRepeatMode());
 799                 }
 800                 break;
 801             case LED:
 802                 value = getLed();
 803                 if (value != null) {
 804                     newState = OnOffType.from(value);
 805                 }
 806                 break;
 807             case ZONENAME:
 808                 value = getCurrentZoneName();
 809                 if (value != null) {
 810                     newState = new StringType(value);
 811                 }
 812                 break;
 813             case ZONEGROUPID:
 814                 value = getZoneGroupID();
 815                 if (value != null) {
 816                     newState = new StringType(value);
 817                 }
 818                 break;
 819             case COORDINATOR:
 820                 newState = new StringType(getCoordinator());
 821                 break;
 822             case LOCALCOORDINATOR:
 823                 if (getGroupCoordinatorIsLocal() != null) {
 824                     newState = OnOffType.from(isGroupCoordinator());
 825                 }
 826                 break;
 827             case VOLUME:
 828                 value = getVolume();
 829                 if (value != null) {
 830                     newState = new PercentType(value);
 831                 }
 832                 break;
 833             case BASS:
 834                 value = getBass();
 835                 if (value != null && !isOutputLevelFixed()) {
 836                     newState = new DecimalType(value);
 837                 }
 838                 break;
 839             case TREBLE:
 840                 value = getTreble();
 841                 if (value != null && !isOutputLevelFixed()) {
 842                     newState = new DecimalType(value);
 843                 }
 844                 break;
 845             case LOUDNESS:
 846                 value = getLoudness();
 847                 if (value != null && !isOutputLevelFixed()) {
 848                     newState = OnOffType.from(value);
 849                 }
 850                 break;
 851             case MUTE:
 852                 value = getMute();
 853                 if (value != null) {
 854                     newState = OnOffType.from(value);
 855                 }
 856                 break;
 857             case SUBWOOFER:
 858                 value = getSubwooferEnabled();
 859                 if (value != null) {
 860                     newState = OnOffType.from(value);
 861                 }
 862                 break;
 863             case SUBWOOFERGAIN:
 864                 value = getSubwooferGain();
 865                 if (value != null) {
 866                     newState = new DecimalType(value);
 867                 }
 868                 break;
 869             case SURROUND:
 870                 value = getSurroundEnabled();
 871                 if (value != null) {
 872                     newState = OnOffType.from(value);
 873                 }
 874                 break;
 875             case SURROUNDMUSICMODE:
 876                 value = getSurroundMusicMode();
 877                 if (value != null) {
 878                     newState = new StringType(value);
 879                 }
 880                 break;
 881             case SURROUNDMUSICLEVEL:
 882                 value = getSurroundMusicLevel();
 883                 if (value != null) {
 884                     newState = new DecimalType(value);
 885                 }
 886                 break;
 887             case SURROUNDTVLEVEL:
 888                 value = getSurroundTvLevel();
 889                 if (value != null) {
 890                     newState = new DecimalType(value);
 891                 }
 892                 break;
 893             case CODEC:
 894                 value = getCodec();
 895                 if (value != null) {
 896                     newState = new StringType(value);
 897                 }
 898                 break;
 899             case HEIGHTLEVEL:
 900                 value = getHeightLevel();
 901                 if (value != null) {
 902                     newState = new DecimalType(value);
 903                 }
 904                 break;
 905             case NIGHTMODE:
 906                 value = getNightMode();
 907                 if (value != null) {
 908                     newState = OnOffType.from(value);
 909                 }
 910                 break;
 911             case SPEECHENHANCEMENT:
 912                 value = getDialogLevel();
 913                 if (value != null) {
 914                     newState = OnOffType.from(value);
 915                 }
 916                 break;
 917             case LINEIN:
 918                 if (getAnalogLineInConnected() != null) {
 919                     newState = OnOffType.from(isAnalogLineInConnected());
 920                 } else if (getOpticalLineInConnected() != null) {
 921                     newState = OnOffType.from(isOpticalLineInConnected());
 922                 }
 923                 break;
 924             case ANALOGLINEIN:
 925                 if (getAnalogLineInConnected() != null) {
 926                     newState = OnOffType.from(isAnalogLineInConnected());
 927                 }
 928                 break;
 929             case DIGITALLINEIN:
 930                 if (getOpticalLineInConnected() != null) {
 931                     newState = OnOffType.from(isOpticalLineInConnected());
 932                 }
 933                 break;
 934             case ALARMRUNNING:
 935                 if (getAlarmRunning() != null) {
 936                     newState = OnOffType.from(isAlarmRunning());
 937                 }
 938                 break;
 939             case ALARMPROPERTIES:
 940                 value = getRunningAlarmProperties();
 941                 if (value != null) {
 942                     newState = new StringType(value);
 943                 }
 944                 break;
 945             case CURRENTTRACK:
 946                 value = stateMap.get("CurrentURIFormatted");
 947                 if (value != null) {
 948                     newState = new StringType(value);
 949                 }
 950                 break;
 951             case CURRENTTITLE:
 952                 value = getCurrentTitle();
 953                 if (value != null) {
 954                     newState = new StringType(value);
 955                 }
 956                 break;
 957             case CURRENTARTIST:
 958                 value = getCurrentArtist();
 959                 if (value != null) {
 960                     newState = new StringType(value);
 961                 }
 962                 break;
 963             case CURRENTALBUM:
 964                 value = getCurrentAlbum();
 965                 if (value != null) {
 966                     newState = new StringType(value);
 967                 }
 968                 break;
 969             case CURRENTALBUMART:
 970                 newState = null;
 971                 updateAlbumArtChannel(false);
 972                 break;
 973             case CURRENTALBUMARTURL:
 974                 url = getAlbumArtUrl();
 975                 if (url != null) {
 976                     newState = new StringType(url);
 977                 }
 978                 break;
 979             case CURRENTTRANSPORTURI:
 980                 value = getCurrentURI();
 981                 if (value != null) {
 982                     newState = new StringType(value);
 983                 }
 984                 break;
 985             case CURRENTTRACKURI:
 986                 value = stateMap.get("CurrentTrackURI");
 987                 if (value != null) {
 988                     newState = new StringType(value);
 989                 }
 990                 break;
 991             case TUNEINSTATIONID:
 992                 value = stateMap.get("CurrentTuneInStationId");
 993                 if (value != null) {
 994                     newState = new StringType(value);
 995                 }
 996                 break;
 997             case BATTERYCHARGING:
 998                 value = extractInfoFromMoreInfo("BattChg");
 999                 if (value != null) {
1000                     newState = OnOffType.from("CHARGING".equalsIgnoreCase(value));
1001                 }
1002                 break;
1003             case BATTERYLEVEL:
1004                 value = extractInfoFromMoreInfo("BattPct");
1005                 if (value != null) {
1006                     newState = new DecimalType(value);
1007                 }
1008                 break;
1009             case MICROPHONE:
1010                 value = getMicEnabled();
1011                 if (value != null) {
1012                     newState = OnOffType.from(value);
1013                 }
1014                 break;
1015             default:
1016                 newState = null;
1017                 break;
1018         }
1019         if (newState != null) {
1020             updateState(channelId, newState);
1021         }
1022     }
1023
1024     private void updateAlbumArtChannel(boolean allGroup) {
1025         String url = getAlbumArtUrl();
1026         if (url != null) {
1027             // We download the cover art in a different thread to not delay the other operations
1028             scheduler.submit(() -> {
1029                 RawType image = HttpUtil.downloadImage(url, true, 500000);
1030                 updateChannel(CURRENTALBUMART, image != null ? image : UnDefType.UNDEF, allGroup);
1031             });
1032         } else {
1033             updateChannel(CURRENTALBUMART, UnDefType.UNDEF, allGroup);
1034         }
1035     }
1036
1037     private void updateChannel(String channeldD, State state, boolean allGroup) {
1038         if (allGroup) {
1039             for (String member : getZoneGroupMembers()) {
1040                 try {
1041                     ZonePlayerHandler memberHandler = getHandlerByName(member);
1042                     if (ThingStatus.ONLINE.equals(memberHandler.getThing().getStatus())
1043                             && memberHandler.isLinked(channeldD)) {
1044                         memberHandler.updateState(channeldD, state);
1045                     }
1046                 } catch (IllegalStateException e) {
1047                     logger.debug("Cannot update channel for group member ({})", e.getMessage());
1048                 }
1049             }
1050         } else if (ThingStatus.ONLINE.equals(getThing().getStatus()) && isLinked(channeldD)) {
1051             updateState(channeldD, state);
1052         }
1053     }
1054
1055     /**
1056      * CurrentURI will not change, but will trigger change of CurrentURIFormated
1057      * CurrentTrackMetaData will not change, but will trigger change of Title, Artist, Album
1058      */
1059     private boolean shouldIgnoreVariableUpdate(String variable, String value, @Nullable String oldValue) {
1060         return !hasValueChanged(value, oldValue) && !isQueueEvent(variable);
1061     }
1062
1063     private boolean hasValueChanged(@Nullable String value, @Nullable String oldValue) {
1064         return oldValue != null ? !oldValue.equals(value) : value != null;
1065     }
1066
1067     /**
1068      * Similar to the AVTransport eventing, the Queue events its state variables
1069      * as sub values within a synthesized LastChange state variable.
1070      */
1071     private boolean isQueueEvent(String variable) {
1072         return "LastChange".equals(variable);
1073     }
1074
1075     private void updateGroupCoordinator() {
1076         try {
1077             coordinatorHandler = getHandlerByName(getCoordinator());
1078         } catch (IllegalStateException e) {
1079             logger.debug("Cannot update the group coordinator ({})", e.getMessage());
1080             coordinatorHandler = null;
1081         }
1082     }
1083
1084     private boolean isUpnpDeviceRegistered() {
1085         return service.isRegistered(this);
1086     }
1087
1088     private void addSubscription() {
1089         synchronized (upnpLock) {
1090             // Set up GENA Subscriptions
1091             if (service.isRegistered(this)) {
1092                 for (String subscription : SERVICE_SUBSCRIPTIONS) {
1093                     Boolean state = subscriptionState.get(subscription);
1094                     if (state == null || !state) {
1095                         logger.debug("{}: Subscribing to service {}...", getUDN(), subscription);
1096                         service.addSubscription(this, subscription, SUBSCRIPTION_DURATION);
1097                         subscriptionState.put(subscription, true);
1098                     }
1099                 }
1100             }
1101         }
1102     }
1103
1104     private void removeSubscription() {
1105         synchronized (upnpLock) {
1106             // Set up GENA Subscriptions
1107             if (service.isRegistered(this)) {
1108                 for (String subscription : SERVICE_SUBSCRIPTIONS) {
1109                     Boolean state = subscriptionState.get(subscription);
1110                     if (state != null && state) {
1111                         logger.debug("{}: Unsubscribing from service {}...", getUDN(), subscription);
1112                         service.removeSubscription(this, subscription);
1113                     }
1114                 }
1115             }
1116             subscriptionState = new HashMap<>();
1117         }
1118     }
1119
1120     @Override
1121     public void onServiceSubscribed(@Nullable String service, boolean succeeded) {
1122         if (service == null) {
1123             return;
1124         }
1125         synchronized (upnpLock) {
1126             logger.debug("{}: Subscription to service {} {}", getUDN(), service, succeeded ? "succeeded" : "failed");
1127             subscriptionState.put(service, succeeded);
1128         }
1129     }
1130
1131     private Map<String, String> executeAction(String serviceId, String actionId, @Nullable Map<String, String> inputs) {
1132         Map<String, String> result = service.invokeAction(this, serviceId, actionId, inputs);
1133         result.forEach((variable, value) -> {
1134             this.onValueReceived(variable, value, serviceId);
1135         });
1136         return result;
1137     }
1138
1139     private void updatePlayerState() {
1140         if (!updateZoneInfo()) {
1141             if (!ThingStatus.OFFLINE.equals(getThing().getStatus())) {
1142                 logger.debug("Sonos player {} is not available in local network", getUDN());
1143                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
1144                         "@text/offline.not-available-on-network [\"" + getUDN() + "\"]");
1145                 synchronized (upnpLock) {
1146                     subscriptionState = new HashMap<>();
1147                 }
1148             }
1149         } else if (!ThingStatus.ONLINE.equals(getThing().getStatus())) {
1150             logger.debug("Sonos player {} has been found in local network", getUDN());
1151             updateStatus(ThingStatus.ONLINE);
1152         }
1153     }
1154
1155     protected void updateCurrentZoneName() {
1156         executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_GET_ZONE_ATTRIBUTES, null);
1157     }
1158
1159     protected void updateLed() {
1160         executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_GET_LED_STATE, null);
1161     }
1162
1163     protected void updateTime() {
1164         executeAction(SERVICE_ALARM_CLOCK, "GetTimeNow", null);
1165     }
1166
1167     protected void updatePosition() {
1168         executeAction(SERVICE_AV_TRANSPORT, ACTION_GET_POSITION_INFO, null);
1169     }
1170
1171     protected void updateRunningAlarmProperties() {
1172         Map<String, String> result = service.invokeAction(this, SERVICE_AV_TRANSPORT,
1173                 ACTION_GET_RUNNING_ALARM_PROPERTIES, null);
1174
1175         String alarmID = result.get("AlarmID");
1176         String loggedStartTime = result.get("LoggedStartTime");
1177         String newStringValue = null;
1178         if (alarmID != null && loggedStartTime != null) {
1179             newStringValue = alarmID + " - " + loggedStartTime;
1180         } else {
1181             newStringValue = "No running alarm";
1182         }
1183         result.put("RunningAlarmProperties", newStringValue);
1184
1185         result.forEach((variable, value) -> {
1186             this.onValueReceived(variable, value, SERVICE_AV_TRANSPORT);
1187         });
1188     }
1189
1190     protected boolean updateZoneInfo() {
1191         Map<String, String> result = executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_GET_ZONE_INFO, null);
1192
1193         Map<String, String> properties = editProperties();
1194         String value = stateMap.get("HardwareVersion");
1195         if (value != null && !value.isEmpty()) {
1196             properties.put(Thing.PROPERTY_HARDWARE_VERSION, value);
1197         }
1198         value = stateMap.get("DisplaySoftwareVersion");
1199         if (value != null && !value.isEmpty()) {
1200             properties.put(Thing.PROPERTY_FIRMWARE_VERSION, value);
1201         }
1202         value = stateMap.get("SerialNumber");
1203         if (value != null && !value.isEmpty()) {
1204             properties.put(Thing.PROPERTY_SERIAL_NUMBER, value);
1205         }
1206         value = stateMap.get("MACAddress");
1207         if (value != null && !value.isEmpty()) {
1208             properties.put(MAC_ADDRESS, value);
1209         }
1210         value = stateMap.get("IPAddress");
1211         if (value != null && !value.isEmpty()) {
1212             properties.put(IP_ADDRESS, value);
1213         }
1214         updateProperties(properties);
1215
1216         return !result.isEmpty();
1217     }
1218
1219     public String getCoordinator() {
1220         for (SonosZoneGroup zg : getZoneGroups()) {
1221             if (zg.getMembers().contains(getUDN())) {
1222                 return zg.getCoordinator();
1223             }
1224         }
1225         return getUDN();
1226     }
1227
1228     public boolean isCoordinator() {
1229         return getUDN().equals(getCoordinator());
1230     }
1231
1232     protected void updateMediaInformation() {
1233         String currentURI = getCurrentURI();
1234         SonosMetaData currentTrack = getTrackMetadata();
1235         SonosMetaData currentUriMetaData = getCurrentURIMetadata();
1236
1237         String stationID = null;
1238         SonosMediaInformation mediaInfo = new SonosMediaInformation();
1239
1240         // if currentURI == null, we do nothing
1241         if (currentURI != null) {
1242             if (currentURI.isEmpty()) {
1243                 // Reset data
1244                 mediaInfo = new SonosMediaInformation(true);
1245             }
1246
1247             // if (currentURI.contains(GROUP_URI)) we do nothing, because
1248             // The Sonos is a slave member of a group
1249             // The media information will be updated by the coordinator
1250             // Notification of group change occurs later, so we just check the URI
1251
1252             else if (isPlayingStream(currentURI) || isPlayingRadioStartedByAmazonEcho(currentURI)) {
1253                 // Radio stream (tune-in)
1254                 stationID = extractStationId(currentURI);
1255                 mediaInfo = SonosMediaInformation.parseTuneInMediaInfo(getOpmlData(stationID),
1256                         currentUriMetaData != null ? currentUriMetaData.getTitle() : null, currentTrack);
1257             }
1258
1259             else if (isPlayingRadioApp(currentURI)) {
1260                 mediaInfo = SonosMediaInformation.parseRadioAppMediaInfo(
1261                         currentUriMetaData != null ? currentUriMetaData.getTitle() : null, currentTrack);
1262             }
1263
1264             else if (isPlayingLineIn(currentURI)) {
1265                 mediaInfo = SonosMediaInformation.parseTrackTitle(currentTrack);
1266             }
1267
1268             else if (isPlayingRadio(currentURI)
1269                     || (!currentURI.contains("x-rincon-mp3") && !currentURI.contains("x-sonosapi"))) {
1270                 mediaInfo = SonosMediaInformation.parseTrack(currentTrack);
1271             }
1272         }
1273
1274         String albumArtURI = (currentTrack != null && !currentTrack.getAlbumArtUri().isEmpty())
1275                 ? currentTrack.getAlbumArtUri()
1276                 : "";
1277
1278         ZonePlayerHandler handlerForImageUpdate = null;
1279         for (String member : getZoneGroupMembers()) {
1280             try {
1281                 ZonePlayerHandler memberHandler = getHandlerByName(member);
1282                 if (ThingStatus.ONLINE.equals(memberHandler.getThing().getStatus())) {
1283                     if (memberHandler.isLinked(CURRENTALBUMART)
1284                             && hasValueChanged(albumArtURI, memberHandler.stateMap.get("CurrentAlbumArtURI"))) {
1285                         handlerForImageUpdate = memberHandler;
1286                     }
1287                     memberHandler.onValueReceived("CurrentTuneInStationId", (stationID != null) ? stationID : "",
1288                             SERVICE_AV_TRANSPORT);
1289                     if (mediaInfo.needsUpdate()) {
1290                         String artist = mediaInfo.getArtist();
1291                         String album = mediaInfo.getAlbum();
1292                         String title = mediaInfo.getTitle();
1293                         String combinedInfo = mediaInfo.getCombinedInfo();
1294                         memberHandler.onValueReceived("CurrentArtist", (artist != null) ? artist : "",
1295                                 SERVICE_AV_TRANSPORT);
1296                         memberHandler.onValueReceived("CurrentAlbum", (album != null) ? album : "",
1297                                 SERVICE_AV_TRANSPORT);
1298                         memberHandler.onValueReceived("CurrentTitle", (title != null) ? title : "",
1299                                 SERVICE_AV_TRANSPORT);
1300                         memberHandler.onValueReceived("CurrentURIFormatted", (combinedInfo != null) ? combinedInfo : "",
1301                                 SERVICE_AV_TRANSPORT);
1302                         memberHandler.onValueReceived("CurrentAlbumArtURI", albumArtURI, SERVICE_AV_TRANSPORT);
1303                     }
1304                 }
1305             } catch (IllegalStateException e) {
1306                 logger.debug("Cannot update media data for group member ({})", e.getMessage());
1307             }
1308         }
1309         if (mediaInfo.needsUpdate() && handlerForImageUpdate != null) {
1310             handlerForImageUpdate.updateAlbumArtChannel(true);
1311         }
1312     }
1313
1314     private @Nullable String getOpmlData(@Nullable String stationId) {
1315         String url = opmlUrl;
1316         if (url != null && stationId != null && !stationId.isEmpty()) {
1317             String mac = getMACAddress();
1318             if (mac != null && !mac.isEmpty()) {
1319                 url = url.replace("%id", stationId);
1320                 url = url.replace("%serial", mac);
1321                 String response = null;
1322                 try {
1323                     response = HttpUtil.executeUrl("GET", url, HTTP_TIMEOUT);
1324                 } catch (IOException e) {
1325                     logger.debug("OPML request failed ({})", url, e);
1326                 }
1327                 logger.trace("OPML response = {}", response);
1328                 return response;
1329             }
1330         }
1331         return null;
1332     }
1333
1334     private @Nullable String extractStationId(String uri) {
1335         String stationID = null;
1336         if (isPlayingStream(uri)) {
1337             stationID = substringBetween(uri, ":s", "?sid");
1338         } else if (isPlayingRadioStartedByAmazonEcho(uri)) {
1339             stationID = substringBetween(uri, "sid=s", "&");
1340         }
1341         return stationID;
1342     }
1343
1344     private @Nullable String substringBetween(String str, String open, String close) {
1345         String result = null;
1346         int idx1 = str.indexOf(open);
1347         if (idx1 >= 0) {
1348             idx1 += open.length();
1349             int idx2 = str.indexOf(close, idx1);
1350             if (idx2 >= 0) {
1351                 result = str.substring(idx1, idx2);
1352             }
1353         }
1354         return result;
1355     }
1356
1357     public @Nullable String getGroupCoordinatorIsLocal() {
1358         return stateMap.get("GroupCoordinatorIsLocal");
1359     }
1360
1361     public boolean isGroupCoordinator() {
1362         return "true".equals(getGroupCoordinatorIsLocal());
1363     }
1364
1365     @Override
1366     public String getUDN() {
1367         String udn = configuration.udn;
1368         return udn != null && !udn.isEmpty() ? udn : "undefined";
1369     }
1370
1371     public @Nullable String getCurrentURI() {
1372         return stateMap.get("CurrentURI");
1373     }
1374
1375     public @Nullable String getCurrentURIMetadataAsString() {
1376         return stateMap.get("CurrentURIMetaData");
1377     }
1378
1379     public @Nullable SonosMetaData getCurrentURIMetadata() {
1380         String metaData = getCurrentURIMetadataAsString();
1381         return metaData != null && !metaData.isEmpty() ? SonosXMLParser.getMetaDataFromXML(metaData) : null;
1382     }
1383
1384     public @Nullable SonosMetaData getTrackMetadata() {
1385         String metaData = stateMap.get("CurrentTrackMetaData");
1386         return metaData != null && !metaData.isEmpty() ? SonosXMLParser.getMetaDataFromXML(metaData) : null;
1387     }
1388
1389     public @Nullable SonosMetaData getEnqueuedTransportURIMetaData() {
1390         String metaData = stateMap.get("EnqueuedTransportURIMetaData");
1391         return metaData != null && !metaData.isEmpty() ? SonosXMLParser.getMetaDataFromXML(metaData) : null;
1392     }
1393
1394     public @Nullable String getMACAddress() {
1395         String mac = stateMap.get("MACAddress");
1396         if (mac == null || mac.isEmpty()) {
1397             updateZoneInfo();
1398         }
1399         return stateMap.get("MACAddress");
1400     }
1401
1402     public @Nullable String getRefreshedPosition() {
1403         updatePosition();
1404         return stateMap.get("RelTime");
1405     }
1406
1407     public long getRefreshedCurrenTrackNr() {
1408         updatePosition();
1409         String value = stateMap.get("Track");
1410         if (value != null) {
1411             return Long.valueOf(value);
1412         } else {
1413             return -1;
1414         }
1415     }
1416
1417     public @Nullable String getVolume() {
1418         return stateMap.get("VolumeMaster");
1419     }
1420
1421     public boolean isOutputLevelFixed() {
1422         return "1".equals(stateMap.get("OutputFixed"));
1423     }
1424
1425     public @Nullable String getBass() {
1426         return stateMap.get("Bass");
1427     }
1428
1429     public @Nullable String getTreble() {
1430         return stateMap.get("Treble");
1431     }
1432
1433     public @Nullable String getLoudness() {
1434         return stateMap.get("LoudnessMaster");
1435     }
1436
1437     public @Nullable String getSurroundEnabled() {
1438         return stateMap.get("SurroundEnabled");
1439     }
1440
1441     public @Nullable String getSurroundMusicMode() {
1442         return stateMap.get("SurroundMode");
1443     }
1444
1445     public @Nullable String getSurroundTvLevel() {
1446         return stateMap.get("SurroundLevel");
1447     }
1448
1449     public @Nullable String getSurroundMusicLevel() {
1450         return stateMap.get("MusicSurroundLevel");
1451     }
1452
1453     public @Nullable String getCodec() {
1454         String codec = stateMap.get("HTAudioIn");
1455         if (codec != null) {
1456             switch (codec) {
1457                 case "0":
1458                 case "21":
1459                     codec = "noSignal";
1460                     break;
1461                 case "22":
1462                 case "33554454":
1463                     codec = "silence";
1464                     break;
1465                 case "32":
1466                     codec = "DTS";
1467                     break;
1468                 case "59":
1469                 case "61":
1470                 case "63":
1471                     codec = "dolbyAtmos";
1472                     break;
1473                 case "33554434":
1474                     codec = "DD20";
1475                     break;
1476                 case "33554494":
1477                     codec = "PCM20";
1478                     break;
1479                 case "84934713":
1480                     codec = "DD51";
1481                     break;
1482                 case "84934714":
1483                     codec = "DDPlus51";
1484                     break;
1485                 case "84934718":
1486                     codec = "PCM51";
1487                     break;
1488                 case "84934721":
1489                     codec = "DTS51";
1490                     break;
1491                 default:
1492                     codec = "Unknown - " + codec;
1493             }
1494         }
1495         return codec;
1496     }
1497
1498     public @Nullable String getSubwooferEnabled() {
1499         return stateMap.get("SubEnabled");
1500     }
1501
1502     public @Nullable String getSubwooferGain() {
1503         return stateMap.get("SubGain");
1504     }
1505
1506     public @Nullable String getHeightLevel() {
1507         return stateMap.get("HeightChannelLevel");
1508     }
1509
1510     public @Nullable String getTransportState() {
1511         return stateMap.get("TransportState");
1512     }
1513
1514     public @Nullable String getCurrentTitle() {
1515         return stateMap.get("CurrentTitle");
1516     }
1517
1518     public @Nullable String getCurrentArtist() {
1519         return stateMap.get("CurrentArtist");
1520     }
1521
1522     public @Nullable String getCurrentAlbum() {
1523         return stateMap.get("CurrentAlbum");
1524     }
1525
1526     public List<SonosEntry> getArtists(String filter) {
1527         return getEntries("A:", filter);
1528     }
1529
1530     public List<SonosEntry> getArtists() {
1531         return getEntries("A:", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1532     }
1533
1534     public List<SonosEntry> getAlbums(String filter) {
1535         return getEntries("A:ALBUM", filter);
1536     }
1537
1538     public List<SonosEntry> getAlbums() {
1539         return getEntries("A:ALBUM", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1540     }
1541
1542     public List<SonosEntry> getTracks(String filter) {
1543         return getEntries("A:TRACKS", filter);
1544     }
1545
1546     public List<SonosEntry> getTracks() {
1547         return getEntries("A:TRACKS", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1548     }
1549
1550     public List<SonosEntry> getQueue(String filter) {
1551         return getEntries("Q:0", filter);
1552     }
1553
1554     public List<SonosEntry> getQueue() {
1555         return getEntries("Q:0", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1556     }
1557
1558     public long getQueueSize() {
1559         return getNbEntries("Q:0");
1560     }
1561
1562     public List<SonosEntry> getPlayLists(String filter) {
1563         return getEntries("SQ:", filter);
1564     }
1565
1566     public List<SonosEntry> getPlayLists() {
1567         return getEntries("SQ:", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1568     }
1569
1570     public List<SonosEntry> getFavoriteRadios(String filter) {
1571         return getEntries("R:0/0", filter);
1572     }
1573
1574     public List<SonosEntry> getFavoriteRadios() {
1575         return getEntries("R:0/0", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1576     }
1577
1578     /**
1579      * Searches for entries in the 'favorites' list on a sonos account
1580      *
1581      * @return
1582      */
1583     public List<SonosEntry> getFavorites() {
1584         return getEntries("FV:2", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1585     }
1586
1587     protected List<SonosEntry> getEntries(String type, String filter) {
1588         long startAt = 0;
1589
1590         Map<String, String> inputs = new HashMap<>();
1591         inputs.put("ObjectID", type);
1592         inputs.put("BrowseFlag", "BrowseDirectChildren");
1593         inputs.put("Filter", filter);
1594         inputs.put("StartingIndex", Long.toString(startAt));
1595         inputs.put("RequestedCount", Integer.toString(200));
1596         inputs.put("SortCriteria", "");
1597
1598         Map<String, String> result = service.invokeAction(this, SERVICE_CONTENT_DIRECTORY, "Browse", inputs);
1599
1600         String initialResult = result.get("Result");
1601         if (initialResult == null) {
1602             return Collections.emptyList();
1603         }
1604
1605         long totalMatches = getResultEntry(result, "TotalMatches", type, filter);
1606         long initialNumberReturned = getResultEntry(result, "NumberReturned", type, filter);
1607
1608         List<SonosEntry> resultList = SonosXMLParser.getEntriesFromString(initialResult);
1609         startAt = startAt + initialNumberReturned;
1610
1611         while (startAt < totalMatches) {
1612             inputs.put("StartingIndex", Long.toString(startAt));
1613             result = service.invokeAction(this, SERVICE_CONTENT_DIRECTORY, "Browse", inputs);
1614
1615             // Execute this action synchronously
1616             String nextResult = result.get("Result");
1617             if (nextResult == null) {
1618                 break;
1619             }
1620
1621             long numberReturned = getResultEntry(result, "NumberReturned", type, filter);
1622
1623             resultList.addAll(SonosXMLParser.getEntriesFromString(nextResult));
1624
1625             startAt = startAt + numberReturned;
1626         }
1627
1628         return resultList;
1629     }
1630
1631     protected long getNbEntries(String type) {
1632         Map<String, String> inputs = new HashMap<>();
1633         inputs.put("ObjectID", type);
1634         inputs.put("BrowseFlag", "BrowseDirectChildren");
1635         inputs.put("Filter", "dc:title");
1636         inputs.put("StartingIndex", "0");
1637         inputs.put("RequestedCount", "1");
1638         inputs.put("SortCriteria", "");
1639
1640         Map<String, String> result = service.invokeAction(this, SERVICE_CONTENT_DIRECTORY, "Browse", inputs);
1641
1642         return getResultEntry(result, "TotalMatches", type, "dc:title");
1643     }
1644
1645     /**
1646      * Handles value searching in a SONOS result map (called by {@link #getEntries(String, String)})
1647      *
1648      * @param resultInput - the map to be examined for the requestedKey
1649      * @param requestedKey - the key to be sought in the resultInput map
1650      * @param entriesType - the 'type' argument of {@link #getEntries(String, String)} method used for logging
1651      * @param entriesFilter - the 'filter' argument of {@link #getEntries(String, String)} method used for logging
1652      *
1653      * @return 0 as long or the value corresponding to the requiredKey if found
1654      */
1655     private Long getResultEntry(Map<String, String> resultInput, String requestedKey, String entriesType,
1656             String entriesFilter) {
1657         long result = 0;
1658
1659         if (resultInput.isEmpty()) {
1660             return result;
1661         }
1662
1663         try {
1664             String resultString = resultInput.get(requestedKey);
1665             if (resultString == null) {
1666                 throw new NumberFormatException("Requested key is null.");
1667             }
1668             result = Long.valueOf(resultString);
1669         } catch (NumberFormatException ex) {
1670             logger.debug("Could not fetch {} result for type: {} and filter: {}. Using default value '0': {}",
1671                     requestedKey, entriesType, entriesFilter, ex.getMessage(), ex);
1672         }
1673
1674         return result;
1675     }
1676
1677     /**
1678      * Save the state (track, position etc) of the Sonos Zone player.
1679      *
1680      * @return true if no error occurred.
1681      */
1682     protected void saveState() {
1683         synchronized (stateLock) {
1684             savedState = new SonosZonePlayerState();
1685             String currentURI = getCurrentURI();
1686
1687             savedState.transportState = getTransportState();
1688             savedState.volume = getVolume();
1689
1690             if (currentURI != null) {
1691                 if (isPlayingStreamOrRadio(currentURI)) {
1692                     // we are streaming music, like tune-in radio or Google Play Music radio
1693                     SonosMetaData track = getTrackMetadata();
1694                     SonosMetaData current = getCurrentURIMetadata();
1695                     if (track != null && current != null) {
1696                         savedState.entry = new SonosEntry("", current.getTitle(), "", "", track.getAlbumArtUri(), "",
1697                                 current.getUpnpClass(), currentURI);
1698                     }
1699                 } else if (currentURI.contains(GROUP_URI)) {
1700                     // we are a slave to some coordinator
1701                     savedState.entry = new SonosEntry("", "", "", "", "", "", "", currentURI);
1702                 } else if (isPlayingLineIn(currentURI)) {
1703                     // we are streaming from the Line In connection
1704                     savedState.entry = new SonosEntry("", "", "", "", "", "", "", currentURI);
1705                 } else if (isPlayingQueue(currentURI)) {
1706                     // we are playing something that sits in the queue
1707                     SonosMetaData queued = getEnqueuedTransportURIMetaData();
1708                     if (queued != null) {
1709                         savedState.track = getRefreshedCurrenTrackNr();
1710
1711                         if (queued.getUpnpClass().contains("object.container.playlistContainer")) {
1712                             // we are playing a real 'saved' playlist
1713                             List<SonosEntry> playLists = getPlayLists();
1714                             for (SonosEntry someList : playLists) {
1715                                 if (someList.getTitle().equals(queued.getTitle())) {
1716                                     savedState.entry = new SonosEntry(someList.getId(), someList.getTitle(),
1717                                             someList.getParentId(), "", "", "", someList.getUpnpClass(),
1718                                             someList.getRes());
1719                                     break;
1720                                 }
1721                             }
1722                         } else if (queued.getUpnpClass().contains("object.container")) {
1723                             // we are playing some other sort of
1724                             // 'container' - we will save that to a
1725                             // playlist for our convenience
1726                             logger.debug("Save State for a container of type {}", queued.getUpnpClass());
1727
1728                             // save the playlist
1729                             String existingList = "";
1730                             List<SonosEntry> playLists = getPlayLists();
1731                             for (SonosEntry someList : playLists) {
1732                                 if (someList.getTitle().equals(TITLE_PREFIX + getUDN())) {
1733                                     existingList = someList.getId();
1734                                     break;
1735                                 }
1736                             }
1737
1738                             saveQueue(TITLE_PREFIX + getUDN(), existingList);
1739
1740                             // get all the playlists and a ref to our
1741                             // saved list
1742                             playLists = getPlayLists();
1743                             for (SonosEntry someList : playLists) {
1744                                 if (someList.getTitle().equals(TITLE_PREFIX + getUDN())) {
1745                                     savedState.entry = new SonosEntry(someList.getId(), someList.getTitle(),
1746                                             someList.getParentId(), "", "", "", someList.getUpnpClass(),
1747                                             someList.getRes());
1748                                     break;
1749                                 }
1750                             }
1751                         }
1752                     } else {
1753                         savedState.entry = new SonosEntry("", "", "", "", "", "", "", QUEUE_URI + getUDN() + "#0");
1754                     }
1755                 }
1756
1757                 savedState.relTime = getRefreshedPosition();
1758             } else {
1759                 savedState.entry = null;
1760             }
1761         }
1762     }
1763
1764     /**
1765      * Restore the state (track, position etc) of the Sonos Zone player.
1766      *
1767      * @return true if no error occurred.
1768      */
1769     protected void restoreState() {
1770         synchronized (stateLock) {
1771             SonosZonePlayerState state = savedState;
1772             if (state != null) {
1773                 // put settings back
1774                 String volume = state.volume;
1775                 if (volume != null) {
1776                     setVolume(DecimalType.valueOf(volume));
1777                 }
1778
1779                 if (isCoordinator()) {
1780                     SonosEntry entry = state.entry;
1781                     if (entry != null) {
1782                         // check if we have a playlist to deal with
1783                         if (entry.getUpnpClass().contains("object.container.playlistContainer")) {
1784                             addURIToQueue(entry.getRes(), SonosXMLParser.compileMetadataString(entry), 0, true);
1785                             entry = new SonosEntry("", "", "", "", "", "", "", QUEUE_URI + getUDN() + "#0");
1786                             setCurrentURI(entry);
1787                             setPositionTrack(state.track);
1788                         } else {
1789                             setCurrentURI(entry);
1790                             setPosition(state.relTime);
1791                         }
1792                     }
1793
1794                     String transportState = state.transportState;
1795                     if (STATE_PLAYING.equals(transportState)) {
1796                         play();
1797                     } else if (STATE_STOPPED.equals(transportState)) {
1798                         stop();
1799                     } else if (STATE_PAUSED_PLAYBACK.equals(transportState)) {
1800                         pause();
1801                     }
1802                 }
1803             }
1804         }
1805     }
1806
1807     public void saveQueue(String name, String queueID) {
1808         executeAction(SERVICE_AV_TRANSPORT, ACTION_SAVE_QUEUE, Map.of("Title", name, "ObjectID", queueID));
1809     }
1810
1811     public void setVolume(Command command) {
1812         if (command instanceof OnOffType || command instanceof IncreaseDecreaseType || command instanceof DecimalType
1813                 || command instanceof PercentType) {
1814             String newValue = null;
1815             String currentVolume = getVolume();
1816             if (command == IncreaseDecreaseType.INCREASE && currentVolume != null) {
1817                 int i = Integer.valueOf(currentVolume);
1818                 newValue = String.valueOf(Math.min(100, i + 1));
1819             } else if (command == IncreaseDecreaseType.DECREASE && currentVolume != null) {
1820                 int i = Integer.valueOf(currentVolume);
1821                 newValue = String.valueOf(Math.max(0, i - 1));
1822             } else if (command == OnOffType.ON) {
1823                 newValue = "100";
1824             } else if (command == OnOffType.OFF) {
1825                 newValue = "0";
1826             } else if (command instanceof DecimalType decimalCommand) {
1827                 newValue = String.valueOf(decimalCommand.intValue());
1828             } else {
1829                 return;
1830             }
1831             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_VOLUME,
1832                     Map.of("Channel", "Master", "DesiredVolume", newValue));
1833         }
1834     }
1835
1836     /**
1837      * Set the VOLUME command specific to the current grouping according to the Sonos behaviour.
1838      * AdHoc groups handles the volume specifically for each player.
1839      * Bonded groups delegate the volume to the coordinator which applies the same level to all group members.
1840      */
1841     public void setVolumeForGroup(Command command) {
1842         if (isAdHocGroup() || isStandalonePlayer()) {
1843             setVolume(command);
1844         } else {
1845             try {
1846                 getCoordinatorHandler().setVolume(command);
1847             } catch (IllegalStateException e) {
1848                 logger.debug("Cannot set group volume ({})", e.getMessage());
1849             }
1850         }
1851     }
1852
1853     public void setBass(Command command) {
1854         if (!isOutputLevelFixed()) {
1855             String newValue = getNewNumericValue(command, getBass(), MIN_BASS, MAX_BASS);
1856             if (newValue != null) {
1857                 executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_BASS,
1858                         Map.of("InstanceID", "0", "DesiredBass", newValue));
1859             }
1860         }
1861     }
1862
1863     public void setTreble(Command command) {
1864         if (!isOutputLevelFixed()) {
1865             String newValue = getNewNumericValue(command, getTreble(), MIN_TREBLE, MAX_TREBLE);
1866             if (newValue != null) {
1867                 executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_TREBLE,
1868                         Map.of("InstanceID", "0", "DesiredTreble", newValue));
1869             }
1870         }
1871     }
1872
1873     private @Nullable String getNewNumericValue(Command command, @Nullable String currentValue, int minValue,
1874             int maxValue) {
1875         String newValue = null;
1876         if (command instanceof IncreaseDecreaseType || command instanceof DecimalType) {
1877             if (command == IncreaseDecreaseType.INCREASE && currentValue != null) {
1878                 int i = Integer.valueOf(currentValue);
1879                 newValue = String.valueOf(Math.min(maxValue, i + 1));
1880             } else if (command == IncreaseDecreaseType.DECREASE && currentValue != null) {
1881                 int i = Integer.valueOf(currentValue);
1882                 newValue = String.valueOf(Math.max(minValue, i - 1));
1883             } else if (command instanceof DecimalType decimalCommand) {
1884                 newValue = String.valueOf(decimalCommand.intValue());
1885             }
1886         }
1887         return newValue;
1888     }
1889
1890     public void setLoudness(Command command) {
1891         if (!isOutputLevelFixed() && (command instanceof OnOffType || command instanceof OpenClosedType
1892                 || command instanceof UpDownType)) {
1893             String value = (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
1894                     || command.equals(OpenClosedType.OPEN)) ? "True" : "False";
1895             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_LOUDNESS,
1896                     Map.of("InstanceID", "0", "Channel", "Master", "DesiredLoudness", value));
1897         }
1898     }
1899
1900     /**
1901      * Checks if the player receiving the command is part of a group that
1902      * consists of randomly added players or contains bonded players
1903      *
1904      * @return boolean
1905      */
1906     private boolean isAdHocGroup() {
1907         SonosZoneGroup currentZoneGroup = getCurrentZoneGroup();
1908         if (currentZoneGroup != null) {
1909             List<String> zoneGroupMemberNames = currentZoneGroup.getMemberZoneNames();
1910
1911             for (String zoneName : zoneGroupMemberNames) {
1912                 if (!zoneName.equals(zoneGroupMemberNames.get(0))) {
1913                     // At least one "ZoneName" differs so we have an AdHoc group
1914                     return true;
1915                 }
1916             }
1917         }
1918         return false;
1919     }
1920
1921     /**
1922      * Checks if the player receiving the command is a standalone player
1923      *
1924      * @return boolean
1925      */
1926     private boolean isStandalonePlayer() {
1927         SonosZoneGroup zoneGroup = getCurrentZoneGroup();
1928         return zoneGroup == null || zoneGroup.getMembers().size() == 1;
1929     }
1930
1931     private Collection<SonosZoneGroup> getZoneGroups() {
1932         String zoneGroupState = stateMap.get("ZoneGroupState");
1933         return zoneGroupState == null ? Collections.emptyList() : SonosXMLParser.getZoneGroupFromXML(zoneGroupState);
1934     }
1935
1936     /**
1937      * Returns the current zone group
1938      * (of which the player receiving the command is part)
1939      *
1940      * @return {@link SonosZoneGroup}
1941      */
1942     private @Nullable SonosZoneGroup getCurrentZoneGroup() {
1943         for (SonosZoneGroup zoneGroup : getZoneGroups()) {
1944             if (zoneGroup.getMembers().contains(getUDN())) {
1945                 return zoneGroup;
1946             }
1947         }
1948         logger.debug("Could not fetch Sonos group state information");
1949         return null;
1950     }
1951
1952     /**
1953      * Sets the volume level for a notification sound
1954      *
1955      * @param notificationSoundVolume
1956      */
1957     public void setNotificationSoundVolume(@Nullable PercentType notificationSoundVolume) {
1958         if (notificationSoundVolume != null) {
1959             setVolumeForGroup(notificationSoundVolume);
1960         }
1961     }
1962
1963     /**
1964      * Gets the volume level for a notification sound
1965      */
1966     public @Nullable PercentType getNotificationSoundVolume() {
1967         Integer notificationSoundVolume = getConfigAs(ZonePlayerConfiguration.class).notificationVolume;
1968         if (notificationSoundVolume == null) {
1969             // if no value is set we use the current volume instead
1970             String volume = getVolume();
1971             return volume != null ? new PercentType(volume) : null;
1972         }
1973         return new PercentType(notificationSoundVolume);
1974     }
1975
1976     public void addURIToQueue(String URI, String meta, long desiredFirstTrack, boolean enqueueAsNext) {
1977         Map<String, String> inputs = new HashMap<>();
1978
1979         try {
1980             inputs.put("InstanceID", "0");
1981             inputs.put("EnqueuedURI", URI);
1982             inputs.put("EnqueuedURIMetaData", meta);
1983             inputs.put("DesiredFirstTrackNumberEnqueued", Long.toString(desiredFirstTrack));
1984             inputs.put("EnqueueAsNext", Boolean.toString(enqueueAsNext));
1985         } catch (NumberFormatException ex) {
1986             logger.debug("Action Invalid Value Format Exception {}", ex.getMessage());
1987         }
1988
1989         executeAction(SERVICE_AV_TRANSPORT, ACTION_ADD_URI_TO_QUEUE, inputs);
1990     }
1991
1992     public void setCurrentURI(SonosEntry newEntry) {
1993         setCurrentURI(newEntry.getRes(), SonosXMLParser.compileMetadataString(newEntry));
1994     }
1995
1996     public void setCurrentURI(@Nullable String URI, @Nullable String URIMetaData) {
1997         if (URI != null && URIMetaData != null) {
1998             logger.debug("setCurrentURI URI {} URIMetaData {}", URI, URIMetaData);
1999             executeAction(SERVICE_AV_TRANSPORT, ACTION_SET_AV_TRANSPORT_URI,
2000                     Map.of("InstanceID", "0", "CurrentURI", URI, "CurrentURIMetaData", URIMetaData));
2001         }
2002     }
2003
2004     public void setPosition(@Nullable String relTime) {
2005         seek("REL_TIME", relTime);
2006     }
2007
2008     public void setPositionTrack(long tracknr) {
2009         seek("TRACK_NR", Long.toString(tracknr));
2010     }
2011
2012     public void setPositionTrack(String tracknr) {
2013         seek("TRACK_NR", tracknr);
2014     }
2015
2016     protected void seek(String unit, @Nullable String target) {
2017         if (target != null) {
2018             executeAction(SERVICE_AV_TRANSPORT, ACTION_SEEK, Map.of("InstanceID", "0", "Unit", unit, "Target", target));
2019         }
2020     }
2021
2022     public void play() {
2023         executeAction(SERVICE_AV_TRANSPORT, ACTION_PLAY, Map.of("Speed", "1"));
2024     }
2025
2026     public void stop() {
2027         executeAction(SERVICE_AV_TRANSPORT, ACTION_STOP, null);
2028     }
2029
2030     public void pause() {
2031         executeAction(SERVICE_AV_TRANSPORT, ACTION_PAUSE, null);
2032     }
2033
2034     public void setShuffle(Command command) {
2035         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2036             try {
2037                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2038
2039                 if (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2040                         || command.equals(OpenClosedType.OPEN)) {
2041                     switch (coordinator.getRepeatMode()) {
2042                         case "ALL":
2043                             coordinator.updatePlayMode("SHUFFLE");
2044                             break;
2045                         case "ONE":
2046                             coordinator.updatePlayMode("SHUFFLE_REPEAT_ONE");
2047                             break;
2048                         case "OFF":
2049                             coordinator.updatePlayMode("SHUFFLE_NOREPEAT");
2050                             break;
2051                     }
2052                 } else if (command.equals(OnOffType.OFF) || command.equals(UpDownType.DOWN)
2053                         || command.equals(OpenClosedType.CLOSED)) {
2054                     switch (coordinator.getRepeatMode()) {
2055                         case "ALL":
2056                             coordinator.updatePlayMode("REPEAT_ALL");
2057                             break;
2058                         case "ONE":
2059                             coordinator.updatePlayMode("REPEAT_ONE");
2060                             break;
2061                         case "OFF":
2062                             coordinator.updatePlayMode("NORMAL");
2063                             break;
2064                     }
2065                 }
2066             } catch (IllegalStateException e) {
2067                 logger.debug("Cannot handle shuffle command ({})", e.getMessage());
2068             }
2069         }
2070     }
2071
2072     public void setRepeat(Command command) {
2073         if (command instanceof StringType) {
2074             try {
2075                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2076
2077                 switch (command.toString()) {
2078                     case "ALL":
2079                         coordinator.updatePlayMode(coordinator.isShuffleActive() ? "SHUFFLE" : "REPEAT_ALL");
2080                         break;
2081                     case "ONE":
2082                         coordinator.updatePlayMode(coordinator.isShuffleActive() ? "SHUFFLE_REPEAT_ONE" : "REPEAT_ONE");
2083                         break;
2084                     case "OFF":
2085                         coordinator.updatePlayMode(coordinator.isShuffleActive() ? "SHUFFLE_NOREPEAT" : "NORMAL");
2086                         break;
2087                     default:
2088                         logger.debug("{}: unexpected repeat command; accepted values are ALL, ONE and OFF",
2089                                 command.toString());
2090                         break;
2091                 }
2092             } catch (IllegalStateException e) {
2093                 logger.debug("Cannot handle repeat command ({})", e.getMessage());
2094             }
2095         }
2096     }
2097
2098     public void setSubwoofer(Command command) {
2099         setEqualizerBooleanSetting(command, "SubEnable");
2100     }
2101
2102     public void setSubwooferGain(Command command) {
2103         setEqualizerNumericSetting(command, "SubGain", getSubwooferGain(), MIN_SUBWOOFER_GAIN, MAX_SUBWOOFER_GAIN);
2104     }
2105
2106     public void setSurround(Command command) {
2107         setEqualizerBooleanSetting(command, "SurroundEnable");
2108     }
2109
2110     public void setSurroundMusicMode(Command command) {
2111         if (command instanceof StringType) {
2112             setEQ("SurroundMode", command.toString());
2113         }
2114     }
2115
2116     public void setSurroundMusicLevel(Command command) {
2117         setEqualizerNumericSetting(command, "MusicSurroundLevel", getSurroundMusicLevel(), MIN_SURROUND_LEVEL,
2118                 MAX_SURROUND_LEVEL);
2119     }
2120
2121     public void setSurroundTvLevel(Command command) {
2122         setEqualizerNumericSetting(command, "SurroundLevel", getSurroundTvLevel(), MIN_SURROUND_LEVEL,
2123                 MAX_SURROUND_LEVEL);
2124     }
2125
2126     public void setHeightLevel(Command command) {
2127         setEqualizerNumericSetting(command, "HeightChannelLevel", getHeightLevel(), MIN_HEIGHT_LEVEL, MAX_HEIGHT_LEVEL);
2128     }
2129
2130     public void setNightMode(Command command) {
2131         setEqualizerBooleanSetting(command, "NightMode");
2132     }
2133
2134     public void setSpeechEnhancement(Command command) {
2135         setEqualizerBooleanSetting(command, "DialogLevel");
2136     }
2137
2138     private void setEqualizerBooleanSetting(Command command, String eqType) {
2139         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2140             setEQ(eqType, (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2141                     || command.equals(OpenClosedType.OPEN)) ? "1" : "0");
2142         }
2143     }
2144
2145     private void setEqualizerNumericSetting(Command command, String eqType, @Nullable String currentValue, int minValue,
2146             int maxValue) {
2147         String newValue = getNewNumericValue(command, currentValue, minValue, maxValue);
2148         if (newValue != null) {
2149             setEQ(eqType, newValue);
2150         }
2151     }
2152
2153     private void setEQ(String eqType, String value) {
2154         try {
2155             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_EQ,
2156                     Map.of("InstanceID", "0", "EQType", eqType, "DesiredValue", value));
2157         } catch (IllegalStateException e) {
2158             logger.debug("Cannot handle {} command ({})", eqType, e.getMessage());
2159         }
2160     }
2161
2162     public @Nullable String getNightMode() {
2163         return stateMap.get("NightMode");
2164     }
2165
2166     public @Nullable String getDialogLevel() {
2167         return stateMap.get("DialogLevel");
2168     }
2169
2170     public @Nullable String getPlayMode() {
2171         return stateMap.get("CurrentPlayMode");
2172     }
2173
2174     public Boolean isShuffleActive() {
2175         String playMode = getPlayMode();
2176         return (playMode != null && playMode.startsWith("SHUFFLE"));
2177     }
2178
2179     public String getRepeatMode() {
2180         String mode = "OFF";
2181         String playMode = getPlayMode();
2182         if (playMode != null) {
2183             switch (playMode) {
2184                 case "REPEAT_ALL":
2185                 case "SHUFFLE":
2186                     mode = "ALL";
2187                     break;
2188                 case "REPEAT_ONE":
2189                 case "SHUFFLE_REPEAT_ONE":
2190                     mode = "ONE";
2191                     break;
2192                 case "NORMAL":
2193                 case "SHUFFLE_NOREPEAT":
2194                 default:
2195                     mode = "OFF";
2196                     break;
2197             }
2198         }
2199         return mode;
2200     }
2201
2202     public @Nullable String getMicEnabled() {
2203         return stateMap.get("MicEnabled");
2204     }
2205
2206     protected void updatePlayMode(String playMode) {
2207         executeAction(SERVICE_AV_TRANSPORT, ACTION_SET_PLAY_MODE, Map.of("InstanceID", "0", "NewPlayMode", playMode));
2208     }
2209
2210     /**
2211      * Clear all scheduled music from the current queue.
2212      *
2213      */
2214     public void removeAllTracksFromQueue() {
2215         executeAction(SERVICE_AV_TRANSPORT, ACTION_REMOVE_ALL_TRACKS_FROM_QUEUE, Map.of("InstanceID", "0"));
2216     }
2217
2218     /**
2219      * Play music from the line-in of the given Player referenced by the given UDN or name
2220      *
2221      * @param udn or name
2222      */
2223     public void playLineIn(Command command) {
2224         if (command instanceof StringType) {
2225             try {
2226                 LineInType lineInType = LineInType.ANY;
2227                 String remotePlayerName = command.toString();
2228                 if (remotePlayerName.toUpperCase().startsWith("ANALOG,")) {
2229                     lineInType = LineInType.ANALOG;
2230                     remotePlayerName = remotePlayerName.substring(7);
2231                 } else if (remotePlayerName.toUpperCase().startsWith("DIGITAL,")) {
2232                     lineInType = LineInType.DIGITAL;
2233                     remotePlayerName = remotePlayerName.substring(8);
2234                 }
2235                 ZonePlayerHandler coordinatorHandler = getCoordinatorHandler();
2236                 ZonePlayerHandler remoteHandler = getHandlerByName(remotePlayerName);
2237
2238                 // check if player has a line-in connected
2239                 if ((lineInType != LineInType.DIGITAL && remoteHandler.isAnalogLineInConnected())
2240                         || (lineInType != LineInType.ANALOG && remoteHandler.isOpticalLineInConnected())) {
2241                     // stop whatever is currently playing
2242                     coordinatorHandler.stop();
2243
2244                     // set the URI
2245                     if (lineInType != LineInType.DIGITAL && remoteHandler.isAnalogLineInConnected()) {
2246                         coordinatorHandler.setCurrentURI(ANALOG_LINE_IN_URI + remoteHandler.getUDN(), "");
2247                     } else {
2248                         coordinatorHandler.setCurrentURI(OPTICAL_LINE_IN_URI + remoteHandler.getUDN() + SPDIF, "");
2249                     }
2250
2251                     // take the system off mute
2252                     coordinatorHandler.setMute(OnOffType.OFF);
2253
2254                     // start jammin'
2255                     coordinatorHandler.play();
2256                 } else {
2257                     logger.debug("Line-in of {} is not connected", remoteHandler.getUDN());
2258                 }
2259             } catch (IllegalStateException e) {
2260                 logger.debug("Cannot play line-in ({})", e.getMessage());
2261             }
2262         }
2263     }
2264
2265     private ZonePlayerHandler getCoordinatorHandler() throws IllegalStateException {
2266         ZonePlayerHandler handler = coordinatorHandler;
2267         if (handler != null) {
2268             return handler;
2269         }
2270         try {
2271             handler = getHandlerByName(getCoordinator());
2272             coordinatorHandler = handler;
2273             return handler;
2274         } catch (IllegalStateException e) {
2275             throw new IllegalStateException("Missing group coordinator " + getCoordinator());
2276         }
2277     }
2278
2279     /**
2280      * Returns a list of all zone group members this particular player is member of
2281      * Or empty list if the players is not assigned to any group
2282      *
2283      * @return a list of Strings containing the UDNs of other group members
2284      */
2285     protected List<String> getZoneGroupMembers() {
2286         List<String> result = new ArrayList<>();
2287
2288         Collection<SonosZoneGroup> zoneGroups = getZoneGroups();
2289         if (!zoneGroups.isEmpty()) {
2290             for (SonosZoneGroup zg : zoneGroups) {
2291                 if (zg.getMembers().contains(getUDN())) {
2292                     result.addAll(zg.getMembers());
2293                     break;
2294                 }
2295             }
2296         } else {
2297             // If the group topology was not yet received, return at least the current Sonos zone
2298             result.add(getUDN());
2299         }
2300         return result;
2301     }
2302
2303     /**
2304      * Returns a list of other zone group members this particular player is member of
2305      * Or empty list if the players is not assigned to any group
2306      *
2307      * @return a list of Strings containing the UDNs of other group members
2308      */
2309     protected List<String> getOtherZoneGroupMembers() {
2310         List<String> zoneGroupMembers = getZoneGroupMembers();
2311         zoneGroupMembers.remove(getUDN());
2312         return zoneGroupMembers;
2313     }
2314
2315     protected ZonePlayerHandler getHandlerByName(String remotePlayerName) throws IllegalStateException {
2316         for (ThingTypeUID supportedThingType : SonosBindingConstants.SUPPORTED_THING_TYPES_UIDS) {
2317             Thing thing = localThingRegistry.get(new ThingUID(supportedThingType, remotePlayerName));
2318             if (thing != null) {
2319                 ThingHandler handler = thing.getHandler();
2320                 if (handler instanceof ZonePlayerHandler zonePlayerHandler) {
2321                     return zonePlayerHandler;
2322                 }
2323             }
2324         }
2325         for (Thing aThing : localThingRegistry.getAll()) {
2326             if (SonosBindingConstants.SUPPORTED_THING_TYPES_UIDS.contains(aThing.getThingTypeUID())
2327                     && aThing.getConfiguration().get(ZonePlayerConfiguration.UDN).equals(remotePlayerName)) {
2328                 ThingHandler handler = aThing.getHandler();
2329                 if (handler instanceof ZonePlayerHandler zonePlayerHandler) {
2330                     return zonePlayerHandler;
2331                 }
2332             }
2333         }
2334         throw new IllegalStateException("Could not find handler for " + remotePlayerName);
2335     }
2336
2337     public void setMute(Command command) {
2338         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2339             String value = (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2340                     || command.equals(OpenClosedType.OPEN)) ? "True" : "False";
2341             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_MUTE,
2342                     Map.of("Channel", "Master", "DesiredMute", value));
2343         }
2344     }
2345
2346     public List<SonosAlarm> getCurrentAlarmList() {
2347         Map<String, String> result = executeAction(SERVICE_ALARM_CLOCK, "ListAlarms", null);
2348         String alarmList = result.get("CurrentAlarmList");
2349         return alarmList == null ? Collections.emptyList() : SonosXMLParser.getAlarmsFromStringResult(alarmList);
2350     }
2351
2352     public void updateAlarm(SonosAlarm alarm) {
2353         Map<String, String> inputs = new HashMap<>();
2354
2355         try {
2356             inputs.put("ID", Integer.toString(alarm.getId()));
2357             inputs.put("StartLocalTime", alarm.getStartTime());
2358             inputs.put("Duration", alarm.getDuration());
2359             inputs.put("Recurrence", alarm.getRecurrence());
2360             inputs.put("RoomUUID", alarm.getRoomUUID());
2361             inputs.put("ProgramURI", alarm.getProgramURI());
2362             inputs.put("ProgramMetaData", alarm.getProgramMetaData());
2363             inputs.put("PlayMode", alarm.getPlayMode());
2364             inputs.put("Volume", Integer.toString(alarm.getVolume()));
2365             if (alarm.getIncludeLinkedZones()) {
2366                 inputs.put("IncludeLinkedZones", "1");
2367             } else {
2368                 inputs.put("IncludeLinkedZones", "0");
2369             }
2370
2371             if (alarm.getEnabled()) {
2372                 inputs.put("Enabled", "1");
2373             } else {
2374                 inputs.put("Enabled", "0");
2375             }
2376         } catch (NumberFormatException ex) {
2377             logger.debug("Action Invalid Value Format Exception {}", ex.getMessage());
2378         }
2379
2380         executeAction(SERVICE_ALARM_CLOCK, "UpdateAlarm", inputs);
2381     }
2382
2383     public void setAlarm(Command command) {
2384         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2385             if (command.equals(OnOffType.ON) || command.equals(UpDownType.UP) || command.equals(OpenClosedType.OPEN)) {
2386                 setAlarm(true);
2387             } else if (command.equals(OnOffType.OFF) || command.equals(UpDownType.DOWN)
2388                     || command.equals(OpenClosedType.CLOSED)) {
2389                 setAlarm(false);
2390             }
2391         }
2392     }
2393
2394     public void setAlarm(boolean alarmSwitch) {
2395         List<SonosAlarm> sonosAlarms = getCurrentAlarmList();
2396
2397         // find the nearest alarm - take the current time from the Sonos system,
2398         // not the system where we are running
2399         SimpleDateFormat fmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
2400         fmt.setTimeZone(TimeZone.getTimeZone("GMT"));
2401
2402         String currentLocalTime = getTime();
2403         Date currentDateTime = null;
2404         try {
2405             currentDateTime = fmt.parse(currentLocalTime);
2406         } catch (ParseException e) {
2407             logger.debug("An exception occurred while formatting a date", e);
2408         }
2409
2410         if (currentDateTime != null) {
2411             Calendar currentDateTimeCalendar = Calendar.getInstance();
2412             currentDateTimeCalendar.setTimeZone(TimeZone.getTimeZone("GMT"));
2413             currentDateTimeCalendar.setTime(currentDateTime);
2414             currentDateTimeCalendar.add(Calendar.DAY_OF_YEAR, 10);
2415             long shortestDuration = currentDateTimeCalendar.getTimeInMillis() - currentDateTime.getTime();
2416
2417             SonosAlarm firstAlarm = null;
2418
2419             for (SonosAlarm anAlarm : sonosAlarms) {
2420                 SimpleDateFormat durationFormat = new SimpleDateFormat("HH:mm:ss");
2421                 durationFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
2422                 Date durationDate;
2423                 try {
2424                     durationDate = durationFormat.parse(anAlarm.getDuration());
2425                 } catch (ParseException e) {
2426                     logger.debug("An exception occurred while parsing a date : '{}'", e.getMessage());
2427                     continue;
2428                 }
2429
2430                 long duration = durationDate.getTime();
2431
2432                 if (duration < shortestDuration && anAlarm.getRoomUUID().equals(getUDN())) {
2433                     shortestDuration = duration;
2434                     firstAlarm = anAlarm;
2435                 }
2436             }
2437
2438             // Set the Alarm
2439             if (firstAlarm != null) {
2440                 if (alarmSwitch) {
2441                     firstAlarm.setEnabled(true);
2442                 } else {
2443                     firstAlarm.setEnabled(false);
2444                 }
2445
2446                 updateAlarm(firstAlarm);
2447             }
2448         }
2449     }
2450
2451     public @Nullable String getTime() {
2452         updateTime();
2453         return stateMap.get("CurrentLocalTime");
2454     }
2455
2456     public @Nullable String getAlarmRunning() {
2457         return stateMap.get("AlarmRunning");
2458     }
2459
2460     public boolean isAlarmRunning() {
2461         return "1".equals(getAlarmRunning());
2462     }
2463
2464     public void snoozeAlarm(Command command) {
2465         if (isAlarmRunning() && command instanceof DecimalType decimalCommand) {
2466             int minutes = decimalCommand.intValue();
2467
2468             Map<String, String> inputs = new HashMap<>();
2469
2470             Calendar snoozePeriod = Calendar.getInstance();
2471             snoozePeriod.setTimeZone(TimeZone.getTimeZone("GMT"));
2472             snoozePeriod.setTimeInMillis(0);
2473             snoozePeriod.add(Calendar.MINUTE, minutes);
2474             SimpleDateFormat pFormatter = new SimpleDateFormat("HH:mm:ss");
2475             pFormatter.setTimeZone(TimeZone.getTimeZone("GMT"));
2476
2477             try {
2478                 inputs.put("Duration", pFormatter.format(snoozePeriod.getTime()));
2479             } catch (NumberFormatException ex) {
2480                 logger.debug("Action Invalid Value Format Exception {}", ex.getMessage());
2481             }
2482
2483             executeAction(SERVICE_AV_TRANSPORT, ACTION_SNOOZE_ALARM, inputs);
2484         } else {
2485             logger.debug("There is no alarm running on {}", getUDN());
2486         }
2487     }
2488
2489     public @Nullable String getAnalogLineInConnected() {
2490         return stateMap.get(LINEINCONNECTED);
2491     }
2492
2493     public boolean isAnalogLineInConnected() {
2494         return "true".equals(getAnalogLineInConnected());
2495     }
2496
2497     public @Nullable String getOpticalLineInConnected() {
2498         return stateMap.get(TOSLINEINCONNECTED);
2499     }
2500
2501     public boolean isOpticalLineInConnected() {
2502         return "true".equals(getOpticalLineInConnected());
2503     }
2504
2505     public void becomeStandAlonePlayer() {
2506         executeAction(SERVICE_AV_TRANSPORT, ACTION_BECOME_COORDINATOR_OF_STANDALONE_GROUP, null);
2507     }
2508
2509     public void addMember(Command command) {
2510         if (command instanceof StringType) {
2511             SonosEntry entry = new SonosEntry("", "", "", "", "", "", "", GROUP_URI + getUDN());
2512             try {
2513                 getHandlerByName(command.toString()).setCurrentURI(entry);
2514             } catch (IllegalStateException e) {
2515                 logger.debug("Cannot add group member ({})", e.getMessage());
2516             }
2517         }
2518     }
2519
2520     @SuppressWarnings("PMD.CompareObjectsWithEquals")
2521     public boolean publicAddress(LineInType lineInType) {
2522         // check if sourcePlayer has a line-in connected
2523         if ((lineInType != LineInType.DIGITAL && isAnalogLineInConnected())
2524                 || (lineInType != LineInType.ANALOG && isOpticalLineInConnected())) {
2525             // first remove this player from its own group if any
2526             becomeStandAlonePlayer();
2527
2528             // add all other players to this new group
2529             for (SonosZoneGroup group : getZoneGroups()) {
2530                 for (String player : group.getMembers()) {
2531                     try {
2532                         ZonePlayerHandler somePlayer = getHandlerByName(player);
2533                         if (somePlayer != this) {
2534                             somePlayer.becomeStandAlonePlayer();
2535                             somePlayer.stop();
2536                             addMember(StringType.valueOf(somePlayer.getUDN()));
2537                         }
2538                     } catch (IllegalStateException e) {
2539                         logger.debug("Cannot add to group ({})", e.getMessage());
2540                     }
2541                 }
2542             }
2543
2544             try {
2545                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2546                 // set the URI of the group to the line-in
2547                 SonosEntry entry = new SonosEntry("", "", "", "", "", "", "", ANALOG_LINE_IN_URI + getUDN());
2548                 if (lineInType != LineInType.ANALOG && isOpticalLineInConnected()) {
2549                     entry = new SonosEntry("", "", "", "", "", "", "", OPTICAL_LINE_IN_URI + getUDN() + SPDIF);
2550                 }
2551                 coordinator.setCurrentURI(entry);
2552                 coordinator.play();
2553
2554                 return true;
2555             } catch (IllegalStateException e) {
2556                 logger.debug("Cannot handle command ({})", e.getMessage());
2557                 return false;
2558             }
2559         } else {
2560             logger.debug("Line-in of {} is not connected", getUDN());
2561             return false;
2562         }
2563     }
2564
2565     /**
2566      * Play a given url to music in one of the music libraries.
2567      *
2568      * @param url
2569      *            in the format of //host/folder/filename.mp3
2570      */
2571     public void playURI(Command command) {
2572         if (command instanceof StringType) {
2573             try {
2574                 String url = command.toString();
2575
2576                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2577
2578                 // stop whatever is currently playing
2579                 coordinator.stop();
2580                 coordinator.waitForNotTransportState(STATE_PLAYING);
2581
2582                 // clear any tracks which are pending in the queue
2583                 coordinator.removeAllTracksFromQueue();
2584
2585                 // add the new track we want to play to the queue
2586                 // The url will be prefixed with x-file-cifs if it is NOT a http URL
2587                 if (!url.startsWith("x-") && (!url.startsWith("http"))) {
2588                     // default to file based url
2589                     url = FILE_URI + url;
2590                 }
2591                 coordinator.addURIToQueue(url, "", 0, true);
2592
2593                 // set the current playlist to our new queue
2594                 coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
2595
2596                 // take the system off mute
2597                 coordinator.setMute(OnOffType.OFF);
2598
2599                 // start jammin'
2600                 coordinator.play();
2601             } catch (IllegalStateException e) {
2602                 logger.debug("Cannot play URI ({})", e.getMessage());
2603             } catch (InterruptedException e) {
2604                 logger.debug("Play URI interrupted ({})", e.getMessage());
2605                 Thread.currentThread().interrupt();
2606             }
2607         }
2608     }
2609
2610     private void scheduleNotificationSound(final Command command) {
2611         scheduler.submit(() -> {
2612             synchronized (notificationLock) {
2613                 playNotificationSoundURI(command);
2614             }
2615         });
2616     }
2617
2618     /**
2619      * Play a given notification sound
2620      *
2621      * @param url in the format of //host/folder/filename.mp3
2622      */
2623     public void playNotificationSoundURI(Command notificationURL) {
2624         if (notificationURL instanceof StringType) {
2625             try {
2626                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2627
2628                 String currentURI = coordinator.getCurrentURI();
2629                 logger.debug("playNotificationSoundURI: currentURI {} metadata {}", currentURI,
2630                         coordinator.getCurrentURIMetadataAsString());
2631
2632                 if (isPlayingStreamOrRadio(currentURI)) {
2633                     handleNotifForRadioStream(currentURI, notificationURL, coordinator);
2634                 } else if (isPlayingLineIn(currentURI)) {
2635                     handleNotifForLineIn(currentURI, notificationURL, coordinator);
2636                 } else if (isPlayingVirtualLineIn(currentURI)) {
2637                     handleNotifForVirtualLineIn(currentURI, notificationURL, coordinator);
2638                 } else if (isPlayingQueue(currentURI)) {
2639                     handleNotifForSharedQueue(currentURI, notificationURL, coordinator);
2640                 } else if (isPlaylistEmpty(coordinator)) {
2641                     handleNotifForEmptyQueue(notificationURL, coordinator);
2642                 } else {
2643                     logger.debug("Notification feature not yet implemented while the current media is being played");
2644                 }
2645                 synchronized (notificationLock) {
2646                     notificationLock.notify();
2647                 }
2648             } catch (IllegalStateException e) {
2649                 logger.debug("Cannot play notification sound ({})", e.getMessage());
2650             } catch (InterruptedException e) {
2651                 logger.debug("Play notification sound interrupted ({})", e.getMessage());
2652                 Thread.currentThread().interrupt();
2653             }
2654         }
2655     }
2656
2657     private boolean isPlaylistEmpty(ZonePlayerHandler coordinator) {
2658         return coordinator.getQueueSize() == 0;
2659     }
2660
2661     private boolean isPlayingQueue(@Nullable String currentURI) {
2662         return currentURI != null && currentURI.contains(QUEUE_URI);
2663     }
2664
2665     private boolean isPlayingStream(@Nullable String currentURI) {
2666         return currentURI != null && currentURI.contains(STREAM_URI);
2667     }
2668
2669     private boolean isPlayingRadio(@Nullable String currentURI) {
2670         // Google Play Music radio or Apple Music radio
2671         return currentURI != null && currentURI.contains(RADIO_URI);
2672     }
2673
2674     private boolean isPlayingRadioApp(@Nullable String currentURI) {
2675         // RadioApp music service
2676         return currentURI != null && currentURI.contains(RADIOAPP_URI);
2677     }
2678
2679     private boolean isPlayingRadioStartedByAmazonEcho(@Nullable String currentURI) {
2680         return currentURI != null && currentURI.contains(RADIO_MP3_URI) && currentURI.contains(OPML_TUNE);
2681     }
2682
2683     private boolean isPlayingStreamOrRadio(@Nullable String currentURI) {
2684         return isPlayingStream(currentURI) || isPlayingRadioStartedByAmazonEcho(currentURI)
2685                 || isPlayingRadio(currentURI) || isPlayingRadioApp(currentURI);
2686     }
2687
2688     private boolean isPlayingLineIn(@Nullable String currentURI) {
2689         return currentURI != null && (isPlayingAnalogLineIn(currentURI) || isPlayingOpticalLineIn(currentURI));
2690     }
2691
2692     private boolean isPlayingAnalogLineIn(@Nullable String currentURI) {
2693         return currentURI != null && currentURI.contains(ANALOG_LINE_IN_URI);
2694     }
2695
2696     private boolean isPlayingOpticalLineIn(@Nullable String currentURI) {
2697         return currentURI != null && currentURI.startsWith(OPTICAL_LINE_IN_URI) && currentURI.endsWith(SPDIF);
2698     }
2699
2700     private boolean isPlayingVirtualLineIn(@Nullable String currentURI) {
2701         return currentURI != null && currentURI.startsWith(VIRTUAL_LINE_IN_URI);
2702     }
2703
2704     /**
2705      * Does a chain of predefined actions when a Notification sound is played by
2706      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2707      * radio streaming is currently loaded
2708      *
2709      * @param currentStreamURI - the currently loaded stream's URI
2710      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2711      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2712      * @throws InterruptedException
2713      */
2714     private void handleNotifForRadioStream(@Nullable String currentStreamURI, Command notificationURL,
2715             ZonePlayerHandler coordinator) throws InterruptedException {
2716         String nextAction = coordinator.getTransportState();
2717         SonosMetaData track = coordinator.getTrackMetadata();
2718         SonosMetaData currentUriMetaData = coordinator.getCurrentURIMetadata();
2719
2720         handleNotificationSound(notificationURL, coordinator);
2721         if (currentStreamURI != null && track != null && currentUriMetaData != null) {
2722             coordinator.setCurrentURI(new SonosEntry("", currentUriMetaData.getTitle(), "", "", track.getAlbumArtUri(),
2723                     "", currentUriMetaData.getUpnpClass(), currentStreamURI));
2724             restoreLastTransportState(coordinator, nextAction);
2725         }
2726     }
2727
2728     /**
2729      * Does a chain of predefined actions when a Notification sound is played by
2730      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2731      * line in is currently loaded
2732      *
2733      * @param currentLineInURI - the currently loaded line-in URI
2734      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2735      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2736      * @throws InterruptedException
2737      */
2738     private void handleNotifForLineIn(@Nullable String currentLineInURI, Command notificationURL,
2739             ZonePlayerHandler coordinator) throws InterruptedException {
2740         logger.debug("Handling notification while sound from line-in was being played");
2741         String nextAction = coordinator.getTransportState();
2742
2743         handleNotificationSound(notificationURL, coordinator);
2744         if (currentLineInURI != null) {
2745             logger.debug("Restoring sound from line-in using URI {}", currentLineInURI);
2746             coordinator.setCurrentURI(currentLineInURI, "");
2747             restoreLastTransportState(coordinator, nextAction);
2748         }
2749     }
2750
2751     /**
2752      * Does a chain of predefined actions when a Notification sound is played by
2753      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2754      * virtual line in is currently loaded
2755      *
2756      * @param currentVirtualLineInURI - the currently loaded virtual line-in URI
2757      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2758      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2759      * @throws InterruptedException
2760      */
2761     private void handleNotifForVirtualLineIn(@Nullable String currentVirtualLineInURI, Command notificationURL,
2762             ZonePlayerHandler coordinator) throws InterruptedException {
2763         logger.debug("Handling notification while sound from virtual line-in was being played");
2764         String nextAction = coordinator.getTransportState();
2765         String currentUriMetaData = coordinator.getCurrentURIMetadataAsString();
2766
2767         handleNotificationSound(notificationURL, coordinator);
2768         if (currentVirtualLineInURI != null && currentUriMetaData != null) {
2769             logger.debug("Restoring sound from virtual line-in using URI {} and metadata {}", currentVirtualLineInURI,
2770                     currentUriMetaData);
2771             coordinator.setCurrentURI(currentVirtualLineInURI, currentUriMetaData);
2772             restoreLastTransportState(coordinator, nextAction);
2773         }
2774     }
2775
2776     /**
2777      * Does a chain of predefined actions when a Notification sound is played by
2778      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2779      * shared queue is currently loaded
2780      *
2781      * @param currentQueueURI - the currently loaded queue URI
2782      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2783      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2784      * @throws InterruptedException
2785      */
2786     private void handleNotifForSharedQueue(@Nullable String currentQueueURI, Command notificationURL,
2787             ZonePlayerHandler coordinator) throws InterruptedException {
2788         String nextAction = coordinator.getTransportState();
2789         String trackPosition = coordinator.getRefreshedPosition();
2790         long currentTrackNumber = coordinator.getRefreshedCurrenTrackNr();
2791         logger.debug(
2792                 "Handling notification while playing queue: currentQueueURI {} trackPosition {} currentTrackNumber {}",
2793                 currentQueueURI, trackPosition, currentTrackNumber);
2794
2795         handleNotificationSound(notificationURL, coordinator);
2796         String queueUri = QUEUE_URI + coordinator.getUDN() + "#0";
2797         if (queueUri.equals(currentQueueURI)) {
2798             coordinator.setPositionTrack(currentTrackNumber);
2799             coordinator.setPosition(trackPosition);
2800             restoreLastTransportState(coordinator, nextAction);
2801         }
2802     }
2803
2804     /**
2805      * Handle the execution of the notification sound by sequentially executing the required steps.
2806      *
2807      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2808      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2809      * @throws InterruptedException
2810      */
2811     private void handleNotificationSound(Command notificationURL, ZonePlayerHandler coordinator)
2812             throws InterruptedException {
2813         boolean sourceStoppable = !isPlayingOpticalLineIn(coordinator.getCurrentURI());
2814         String originalVolume = (isAdHocGroup() || isStandalonePlayer()) ? getVolume() : coordinator.getVolume();
2815         if (sourceStoppable) {
2816             coordinator.stop();
2817             coordinator.waitForNotTransportState(STATE_PLAYING);
2818             applyNotificationSoundVolume();
2819         }
2820         long notificationPosition = coordinator.getQueueSize() + 1;
2821         coordinator.addURIToQueue(notificationURL.toString(), "", notificationPosition, false);
2822         coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
2823         coordinator.setPositionTrack(notificationPosition);
2824         if (!sourceStoppable) {
2825             coordinator.stop();
2826             coordinator.waitForNotTransportState(STATE_PLAYING);
2827             applyNotificationSoundVolume();
2828         }
2829         coordinator.play();
2830         coordinator.waitForFinishedNotification();
2831         if (originalVolume != null) {
2832             setVolumeForGroup(DecimalType.valueOf(originalVolume));
2833         }
2834         coordinator.removeRangeOfTracksFromQueue(new StringType(Long.toString(notificationPosition) + ",1"));
2835     }
2836
2837     private void restoreLastTransportState(ZonePlayerHandler coordinator, @Nullable String nextAction)
2838             throws InterruptedException {
2839         if (nextAction != null) {
2840             switch (nextAction) {
2841                 case STATE_PLAYING:
2842                     coordinator.play();
2843                     coordinator.waitForTransportState(STATE_PLAYING);
2844                     break;
2845                 case STATE_PAUSED_PLAYBACK:
2846                     coordinator.pause();
2847                     break;
2848             }
2849         }
2850     }
2851
2852     /**
2853      * Does a chain of predefined actions when a Notification sound is played by
2854      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2855      * empty queue is currently loaded
2856      *
2857      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2858      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2859      * @throws InterruptedException
2860      */
2861     private void handleNotifForEmptyQueue(Command notificationURL, ZonePlayerHandler coordinator)
2862             throws InterruptedException {
2863         String originalVolume = coordinator.getVolume();
2864         coordinator.applyNotificationSoundVolume();
2865         coordinator.playURI(notificationURL);
2866         coordinator.waitForFinishedNotification();
2867         coordinator.removeAllTracksFromQueue();
2868         if (originalVolume != null) {
2869             coordinator.setVolume(DecimalType.valueOf(originalVolume));
2870         }
2871     }
2872
2873     /**
2874      * Applies the notification sound volume level to the group (if not null)
2875      *
2876      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2877      */
2878     private void applyNotificationSoundVolume() {
2879         setNotificationSoundVolume(getNotificationSoundVolume());
2880     }
2881
2882     private void waitForFinishedNotification() throws InterruptedException {
2883         waitForTransportState(STATE_PLAYING);
2884
2885         // check Sonos state events to determine the end of the notification sound
2886         String notificationTitle = getCurrentTitle();
2887         long playstart = System.currentTimeMillis();
2888         while (System.currentTimeMillis() - playstart < (long) configuration.notificationTimeout * 1000) {
2889             Thread.sleep(50);
2890             String currentTitle = getCurrentTitle();
2891             if ((notificationTitle == null && currentTitle != null)
2892                     || (notificationTitle != null && !notificationTitle.equals(currentTitle))
2893                     || !STATE_PLAYING.equals(getTransportState())) {
2894                 break;
2895             }
2896         }
2897     }
2898
2899     private void waitForTransportState(String state) throws InterruptedException {
2900         if (getTransportState() != null) {
2901             long start = System.currentTimeMillis();
2902             while (!state.equals(getTransportState())) {
2903                 Thread.sleep(50);
2904                 if (System.currentTimeMillis() - start > (long) configuration.notificationTimeout * 1000) {
2905                     break;
2906                 }
2907             }
2908         }
2909     }
2910
2911     private void waitForNotTransportState(String state) throws InterruptedException {
2912         if (getTransportState() != null) {
2913             long start = System.currentTimeMillis();
2914             while (state.equals(getTransportState())) {
2915                 Thread.sleep(50);
2916                 if (System.currentTimeMillis() - start > (long) configuration.notificationTimeout * 1000) {
2917                     break;
2918                 }
2919             }
2920         }
2921     }
2922
2923     /**
2924      * Removes a range of tracks from the queue.
2925      * (<x,y> will remove y songs started by the song number x)
2926      *
2927      * @param command - must be in the format <startIndex, numberOfSongs>
2928      */
2929     public void removeRangeOfTracksFromQueue(Command command) {
2930         if (command instanceof StringType) {
2931             String[] rangeInputSplit = command.toString().split(",");
2932             // If range input is incorrect, remove the first song by default
2933             String startIndex = rangeInputSplit[0] != null ? rangeInputSplit[0] : "1";
2934             String numberOfTracks = rangeInputSplit[1] != null ? rangeInputSplit[1] : "1";
2935             executeAction(SERVICE_AV_TRANSPORT, ACTION_REMOVE_TRACK_RANGE_FROM_QUEUE,
2936                     Map.of("InstanceID", "0", "StartingIndex", startIndex, "NumberOfTracks", numberOfTracks));
2937         }
2938     }
2939
2940     public void clearQueue() {
2941         try {
2942             ZonePlayerHandler coordinator = getCoordinatorHandler();
2943
2944             coordinator.removeAllTracksFromQueue();
2945         } catch (IllegalStateException e) {
2946             logger.debug("Cannot clear queue ({})", e.getMessage());
2947         }
2948     }
2949
2950     public void playQueue() {
2951         try {
2952             ZonePlayerHandler coordinator = getCoordinatorHandler();
2953
2954             // set the current playlist to our new queue
2955             coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
2956
2957             // take the system off mute
2958             coordinator.setMute(OnOffType.OFF);
2959
2960             // start jammin'
2961             coordinator.play();
2962         } catch (IllegalStateException e) {
2963             logger.debug("Cannot play queue ({})", e.getMessage());
2964         }
2965     }
2966
2967     public void setLed(Command command) {
2968         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2969             String value = (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2970                     || command.equals(OpenClosedType.OPEN)) ? "On" : "Off";
2971             executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_SET_LED_STATE, Map.of("DesiredLEDState", value));
2972             executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_GET_LED_STATE, null);
2973         }
2974     }
2975
2976     public void removeMember(Command command) {
2977         if (command instanceof StringType) {
2978             try {
2979                 ZonePlayerHandler oldmemberHandler = getHandlerByName(command.toString());
2980
2981                 oldmemberHandler.becomeStandAlonePlayer();
2982                 SonosEntry entry = new SonosEntry("", "", "", "", "", "", "",
2983                         QUEUE_URI + oldmemberHandler.getUDN() + "#0");
2984                 oldmemberHandler.setCurrentURI(entry);
2985             } catch (IllegalStateException e) {
2986                 logger.debug("Cannot remove group member ({})", e.getMessage());
2987             }
2988         }
2989     }
2990
2991     public void previous() {
2992         executeAction(SERVICE_AV_TRANSPORT, ACTION_PREVIOUS, null);
2993     }
2994
2995     public void next() {
2996         executeAction(SERVICE_AV_TRANSPORT, ACTION_NEXT, null);
2997     }
2998
2999     public void stopPlaying(Command command) {
3000         if (command instanceof OnOffType) {
3001             try {
3002                 getCoordinatorHandler().stop();
3003             } catch (IllegalStateException e) {
3004                 logger.debug("Cannot handle stop command ({})", e.getMessage(), e);
3005             }
3006         }
3007     }
3008
3009     public void playRadio(Command command) {
3010         if (command instanceof StringType) {
3011             String station = command.toString();
3012             List<SonosEntry> stations = getFavoriteRadios();
3013
3014             SonosEntry theEntry = null;
3015             // search for the appropriate radio based on its name (title)
3016             for (SonosEntry someStation : stations) {
3017                 if (someStation.getTitle().equals(station)) {
3018                     theEntry = someStation;
3019                     break;
3020                 }
3021             }
3022
3023             // set the URI of the group coordinator
3024             if (theEntry != null) {
3025                 try {
3026                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3027                     coordinator.setCurrentURI(theEntry);
3028                     coordinator.play();
3029                 } catch (IllegalStateException e) {
3030                     logger.debug("Cannot play radio ({})", e.getMessage());
3031                 }
3032             } else {
3033                 logger.debug("Radio station '{}' not found", station);
3034             }
3035         }
3036     }
3037
3038     public void playTuneinStation(Command command) {
3039         if (command instanceof StringType) {
3040             String stationId = command.toString();
3041             List<SonosMusicService> allServices = getAvailableMusicServices();
3042
3043             SonosMusicService tuneinService = null;
3044             // search for the TuneIn music service based on its name
3045             if (allServices != null) {
3046                 for (SonosMusicService service : allServices) {
3047                     if ("TuneIn".equals(service.getName())) {
3048                         tuneinService = service;
3049                         break;
3050                     }
3051                 }
3052             }
3053
3054             // set the URI of the group coordinator
3055             if (tuneinService != null) {
3056                 try {
3057                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3058                     SonosEntry entry = new SonosEntry("", "TuneIn station", "", "", "", "",
3059                             "object.item.audioItem.audioBroadcast",
3060                             String.format(TUNEIN_URI, stationId, tuneinService.getId()));
3061                     Integer tuneinServiceType = tuneinService.getType();
3062                     int serviceTypeNum = tuneinServiceType == null ? TUNEIN_DEFAULT_SERVICE_TYPE : tuneinServiceType;
3063                     entry.setDesc("SA_RINCON" + Integer.toString(serviceTypeNum) + "_");
3064                     coordinator.setCurrentURI(entry);
3065                     coordinator.play();
3066                 } catch (IllegalStateException e) {
3067                     logger.debug("Cannot play TuneIn station {} ({})", stationId, e.getMessage());
3068                 }
3069             } else {
3070                 logger.debug("TuneIn service not found");
3071             }
3072         }
3073     }
3074
3075     private @Nullable List<SonosMusicService> getAvailableMusicServices() {
3076         if (musicServices == null) {
3077             Map<String, String> result = service.invokeAction(this, "MusicServices", "ListAvailableServices", null);
3078
3079             String serviceList = result.get("AvailableServiceDescriptorList");
3080             if (serviceList != null) {
3081                 List<SonosMusicService> services = SonosXMLParser.getMusicServicesFromXML(serviceList);
3082                 musicServices = services;
3083
3084                 String[] servicesTypes = new String[0];
3085                 String serviceTypeList = result.get("AvailableServiceTypeList");
3086                 if (serviceTypeList != null) {
3087                     // It is a comma separated list of service types (integers) in the same order as the services
3088                     // declaration in "AvailableServiceDescriptorList" except that there is no service type for the
3089                     // TuneIn service
3090                     servicesTypes = serviceTypeList.split(",");
3091                 }
3092
3093                 int idx = 0;
3094                 for (SonosMusicService service : services) {
3095                     if (!"TuneIn".equals(service.getName())) {
3096                         // Add the service type integer value from "AvailableServiceTypeList" to each service
3097                         // except TuneIn
3098                         if (idx < servicesTypes.length) {
3099                             try {
3100                                 Integer serviceType = Integer.parseInt(servicesTypes[idx]);
3101                                 service.setType(serviceType);
3102                             } catch (NumberFormatException e) {
3103                             }
3104                             idx++;
3105                         }
3106                     } else {
3107                         service.setType(TUNEIN_DEFAULT_SERVICE_TYPE);
3108                     }
3109                     logger.debug("Service name {} => id {} type {}", service.getName(), service.getId(),
3110                             service.getType());
3111                 }
3112             }
3113         }
3114         return musicServices;
3115     }
3116
3117     /**
3118      * This will attempt to match the station string with an entry in the
3119      * favorites list, this supports both single entries and playlists
3120      *
3121      * @param favorite to match
3122      * @return true if a match was found and played.
3123      */
3124     public void playFavorite(Command command) {
3125         if (command instanceof StringType) {
3126             String favorite = command.toString();
3127             List<SonosEntry> favorites = getFavorites();
3128
3129             SonosEntry theEntry = null;
3130             // search for the appropriate favorite based on its name (title)
3131             for (SonosEntry entry : favorites) {
3132                 if (entry.getTitle().equals(favorite)) {
3133                     theEntry = entry;
3134                     break;
3135                 }
3136             }
3137
3138             // set the URI of the group coordinator
3139             if (theEntry != null) {
3140                 try {
3141                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3142
3143                     /**
3144                      * If this is a playlist we need to treat it as such
3145                      */
3146                     SonosResourceMetaData resourceMetaData = theEntry.getResourceMetaData();
3147                     if (resourceMetaData != null && resourceMetaData.getUpnpClass().startsWith("object.container")) {
3148                         coordinator.removeAllTracksFromQueue();
3149                         coordinator.addURIToQueue(theEntry);
3150                         coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
3151                         String firstTrackNumberEnqueued = stateMap.get("FirstTrackNumberEnqueued");
3152                         coordinator.seek("TRACK_NR", firstTrackNumberEnqueued);
3153                     } else {
3154                         coordinator.setCurrentURI(theEntry);
3155                     }
3156                     coordinator.play();
3157                 } catch (IllegalStateException e) {
3158                     logger.debug("Cannot paly favorite ({})", e.getMessage());
3159                 }
3160             } else {
3161                 logger.debug("Favorite '{}' not found", favorite);
3162             }
3163         }
3164     }
3165
3166     public void playTrack(Command command) {
3167         if (command instanceof DecimalType decimalCommand) {
3168             try {
3169                 ZonePlayerHandler coordinator = getCoordinatorHandler();
3170
3171                 String trackNumber = String.valueOf(decimalCommand.intValue());
3172
3173                 coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
3174
3175                 // seek the track - warning, we do not check if the tracknumber falls in the boundary of the queue
3176                 coordinator.setPositionTrack(trackNumber);
3177
3178                 // take the system off mute
3179                 coordinator.setMute(OnOffType.OFF);
3180
3181                 // start jammin'
3182                 coordinator.play();
3183             } catch (IllegalStateException e) {
3184                 logger.debug("Cannot play track ({})", e.getMessage());
3185             }
3186         }
3187     }
3188
3189     public void playPlayList(Command command) {
3190         if (command instanceof StringType) {
3191             String playlist = command.toString();
3192             List<SonosEntry> playlists = getPlayLists();
3193
3194             SonosEntry theEntry = null;
3195             // search for the appropriate play list based on its name (title)
3196             for (SonosEntry somePlaylist : playlists) {
3197                 if (somePlaylist.getTitle().equals(playlist)) {
3198                     theEntry = somePlaylist;
3199                     break;
3200                 }
3201             }
3202
3203             // set the URI of the group coordinator
3204             if (theEntry != null) {
3205                 try {
3206                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3207
3208                     coordinator.addURIToQueue(theEntry);
3209
3210                     coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
3211
3212                     String firstTrackNumberEnqueued = stateMap.get("FirstTrackNumberEnqueued");
3213                     coordinator.seek("TRACK_NR", firstTrackNumberEnqueued);
3214
3215                     coordinator.play();
3216                 } catch (IllegalStateException e) {
3217                     logger.debug("Cannot play playlist ({})", e.getMessage());
3218                 }
3219             } else {
3220                 logger.debug("Playlist '{}' not found", playlist);
3221             }
3222         }
3223     }
3224
3225     public void addURIToQueue(SonosEntry newEntry) {
3226         addURIToQueue(newEntry.getRes(), SonosXMLParser.compileMetadataString(newEntry), 1, true);
3227     }
3228
3229     public @Nullable String getZoneName() {
3230         return stateMap.get("ZoneName");
3231     }
3232
3233     public @Nullable String getZoneGroupID() {
3234         return stateMap.get("LocalGroupUUID");
3235     }
3236
3237     public @Nullable String getRunningAlarmProperties() {
3238         return stateMap.get("RunningAlarmProperties");
3239     }
3240
3241     public @Nullable String getRefreshedRunningAlarmProperties() {
3242         updateRunningAlarmProperties();
3243         return getRunningAlarmProperties();
3244     }
3245
3246     public @Nullable String getMute() {
3247         return stateMap.get("MuteMaster");
3248     }
3249
3250     public @Nullable String getLed() {
3251         return stateMap.get("CurrentLEDState");
3252     }
3253
3254     public @Nullable String getCurrentZoneName() {
3255         return stateMap.get("CurrentZoneName");
3256     }
3257
3258     public @Nullable String getRefreshedCurrentZoneName() {
3259         updateCurrentZoneName();
3260         return getCurrentZoneName();
3261     }
3262
3263     @Override
3264     public void onStatusChanged(boolean status) {
3265         if (status) {
3266             logger.info("UPnP device {} is present (thing {})", getUDN(), getThing().getUID());
3267             if (getThing().getStatus() != ThingStatus.ONLINE) {
3268                 updateStatus(ThingStatus.ONLINE);
3269                 scheduler.execute(this::poll);
3270             }
3271         } else {
3272             logger.info("UPnP device {} is absent (thing {})", getUDN(), getThing().getUID());
3273             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR);
3274         }
3275     }
3276
3277     private @Nullable String getModelNameFromDescriptor() {
3278         URL descriptor = service.getDescriptorURL(this);
3279         if (descriptor != null) {
3280             String sonosModelDescription = SonosXMLParser.parseModelDescription(descriptor);
3281             return sonosModelDescription == null ? null
3282                     : SonosXMLParser.buildThingTypeIdFromModelName(sonosModelDescription);
3283         } else {
3284             return null;
3285         }
3286     }
3287
3288     private boolean migrateThingType() {
3289         if (getThing().getThingTypeUID().equals(ZONEPLAYER_THING_TYPE_UID)) {
3290             String modelName = getModelNameFromDescriptor();
3291             if (modelName != null && isSupportedModel(modelName)) {
3292                 updateSonosThingType(modelName);
3293                 return true;
3294             }
3295         }
3296         return false;
3297     }
3298
3299     private boolean isSupportedModel(String modelName) {
3300         for (ThingTypeUID thingTypeUID : SUPPORTED_KNOWN_THING_TYPES_UIDS) {
3301             if (thingTypeUID.getId().equalsIgnoreCase(modelName)) {
3302                 return true;
3303             }
3304         }
3305         return false;
3306     }
3307
3308     private void updateSonosThingType(String newThingTypeID) {
3309         changeThingType(new ThingTypeUID(SonosBindingConstants.BINDING_ID, newThingTypeID), getConfig());
3310     }
3311
3312     /*
3313      * Set the sleeptimer duration
3314      * Use String command of format "HH:MM:SS" to set the timer to the desired duration
3315      * Use empty String "" to switch the sleep timer off
3316      */
3317     public void setSleepTimer(Command command) {
3318         if (command instanceof DecimalType decimalCommand) {
3319             this.service.invokeAction(this, SERVICE_AV_TRANSPORT, ACTION_CONFIGURE_SLEEP_TIMER, Map.of("InstanceID",
3320                     "0", "NewSleepTimerDuration", sleepSecondsToTimeStr(decimalCommand.longValue())));
3321         }
3322     }
3323
3324     protected void updateSleepTimerDuration() {
3325         executeAction(SERVICE_AV_TRANSPORT, ACTION_GET_REMAINING_SLEEP_TIMER_DURATION, null);
3326     }
3327
3328     private String sleepSecondsToTimeStr(long sleepSeconds) {
3329         if (sleepSeconds == 0) {
3330             return "";
3331         } else if (sleepSeconds < 68400) {
3332             long remainingSeconds = sleepSeconds;
3333             long hours = TimeUnit.SECONDS.toHours(remainingSeconds);
3334             remainingSeconds -= TimeUnit.HOURS.toSeconds(hours);
3335             long minutes = TimeUnit.SECONDS.toMinutes(remainingSeconds);
3336             remainingSeconds -= TimeUnit.MINUTES.toSeconds(minutes);
3337             long seconds = TimeUnit.SECONDS.toSeconds(remainingSeconds);
3338             return String.format("%02d:%02d:%02d", hours, minutes, seconds);
3339         } else {
3340             logger.debug("Sonos SleepTimer: Invalid sleep time set. sleep time must be >=0 and < 68400s (24h)");
3341             return "ERR";
3342         }
3343     }
3344
3345     private long sleepStrTimeToSeconds(String sleepTime) {
3346         String[] units = sleepTime.split(":");
3347         int hours = Integer.parseInt(units[0]);
3348         int minutes = Integer.parseInt(units[1]);
3349         int seconds = Integer.parseInt(units[2]);
3350         return 3600 * hours + 60 * minutes + seconds;
3351     }
3352
3353     private @Nullable String extractInfoFromMoreInfo(String searchedInfo) {
3354         String value = stateMap.get("MoreInfo");
3355         if (value != null) {
3356             String[] fields = value.split(",");
3357             for (int i = 0; i < fields.length; i++) {
3358                 String[] pair = fields[i].trim().split(":");
3359                 if (pair.length == 2 && searchedInfo.equalsIgnoreCase(pair[0].trim())) {
3360                     return pair[1].trim();
3361                 }
3362             }
3363         }
3364         return null;
3365     }
3366 }