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

   1 /**
   2  * Copyright (c) 2010-2024 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 = "Atmos";
1472                     break;
1473                 case "33554434":
1474                 case "33554488":
1475                     codec = "DD20";
1476                     break;
1477                 case "33554490":
1478                     codec = "DDPlus20";
1479                     break;
1480                 case "33554494":
1481                     codec = "PCM20";
1482                     break;
1483                 case "84934713":
1484                     codec = "DD51";
1485                     break;
1486                 case "84934714":
1487                     codec = "DDPlus51";
1488                     break;
1489                 case "84934716":
1490                     codec = "TrueHD51";
1491                     break;
1492                 case "84934718":
1493                     codec = "PCM51";
1494                     break;
1495                 case "84934721":
1496                     codec = "DTS51";
1497                     break;
1498                 default:
1499                     codec = "Unknown - " + codec;
1500             }
1501         }
1502         return codec;
1503     }
1504
1505     public @Nullable String getSubwooferEnabled() {
1506         return stateMap.get("SubEnabled");
1507     }
1508
1509     public @Nullable String getSubwooferGain() {
1510         return stateMap.get("SubGain");
1511     }
1512
1513     public @Nullable String getHeightLevel() {
1514         return stateMap.get("HeightChannelLevel");
1515     }
1516
1517     public @Nullable String getTransportState() {
1518         return stateMap.get("TransportState");
1519     }
1520
1521     public @Nullable String getCurrentTitle() {
1522         return stateMap.get("CurrentTitle");
1523     }
1524
1525     public @Nullable String getCurrentArtist() {
1526         return stateMap.get("CurrentArtist");
1527     }
1528
1529     public @Nullable String getCurrentAlbum() {
1530         return stateMap.get("CurrentAlbum");
1531     }
1532
1533     public List<SonosEntry> getArtists(String filter) {
1534         return getEntries("A:", filter);
1535     }
1536
1537     public List<SonosEntry> getArtists() {
1538         return getEntries("A:", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1539     }
1540
1541     public List<SonosEntry> getAlbums(String filter) {
1542         return getEntries("A:ALBUM", filter);
1543     }
1544
1545     public List<SonosEntry> getAlbums() {
1546         return getEntries("A:ALBUM", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1547     }
1548
1549     public List<SonosEntry> getTracks(String filter) {
1550         return getEntries("A:TRACKS", filter);
1551     }
1552
1553     public List<SonosEntry> getTracks() {
1554         return getEntries("A:TRACKS", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1555     }
1556
1557     public List<SonosEntry> getQueue(String filter) {
1558         return getEntries("Q:0", filter);
1559     }
1560
1561     public List<SonosEntry> getQueue() {
1562         return getEntries("Q:0", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1563     }
1564
1565     public long getQueueSize() {
1566         return getNbEntries("Q:0");
1567     }
1568
1569     public List<SonosEntry> getPlayLists(String filter) {
1570         return getEntries("SQ:", filter);
1571     }
1572
1573     public List<SonosEntry> getPlayLists() {
1574         return getEntries("SQ:", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1575     }
1576
1577     public List<SonosEntry> getFavoriteRadios(String filter) {
1578         return getEntries("R:0/0", filter);
1579     }
1580
1581     public List<SonosEntry> getFavoriteRadios() {
1582         return getEntries("R:0/0", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1583     }
1584
1585     /**
1586      * Searches for entries in the 'favorites' list on a sonos account
1587      *
1588      * @return
1589      */
1590     public List<SonosEntry> getFavorites() {
1591         return getEntries("FV:2", "dc:title,res,dc:creator,upnp:artist,upnp:album");
1592     }
1593
1594     protected List<SonosEntry> getEntries(String type, String filter) {
1595         long startAt = 0;
1596
1597         Map<String, String> inputs = new HashMap<>();
1598         inputs.put("ObjectID", type);
1599         inputs.put("BrowseFlag", "BrowseDirectChildren");
1600         inputs.put("Filter", filter);
1601         inputs.put("StartingIndex", Long.toString(startAt));
1602         inputs.put("RequestedCount", Integer.toString(200));
1603         inputs.put("SortCriteria", "");
1604
1605         Map<String, String> result = service.invokeAction(this, SERVICE_CONTENT_DIRECTORY, "Browse", inputs);
1606
1607         String initialResult = result.get("Result");
1608         if (initialResult == null) {
1609             return Collections.emptyList();
1610         }
1611
1612         long totalMatches = getResultEntry(result, "TotalMatches", type, filter);
1613         long initialNumberReturned = getResultEntry(result, "NumberReturned", type, filter);
1614
1615         List<SonosEntry> resultList = SonosXMLParser.getEntriesFromString(initialResult);
1616         startAt = startAt + initialNumberReturned;
1617
1618         while (startAt < totalMatches) {
1619             inputs.put("StartingIndex", Long.toString(startAt));
1620             result = service.invokeAction(this, SERVICE_CONTENT_DIRECTORY, "Browse", inputs);
1621
1622             // Execute this action synchronously
1623             String nextResult = result.get("Result");
1624             if (nextResult == null) {
1625                 break;
1626             }
1627
1628             long numberReturned = getResultEntry(result, "NumberReturned", type, filter);
1629
1630             resultList.addAll(SonosXMLParser.getEntriesFromString(nextResult));
1631
1632             startAt = startAt + numberReturned;
1633         }
1634
1635         return resultList;
1636     }
1637
1638     protected long getNbEntries(String type) {
1639         Map<String, String> inputs = new HashMap<>();
1640         inputs.put("ObjectID", type);
1641         inputs.put("BrowseFlag", "BrowseDirectChildren");
1642         inputs.put("Filter", "dc:title");
1643         inputs.put("StartingIndex", "0");
1644         inputs.put("RequestedCount", "1");
1645         inputs.put("SortCriteria", "");
1646
1647         Map<String, String> result = service.invokeAction(this, SERVICE_CONTENT_DIRECTORY, "Browse", inputs);
1648
1649         return getResultEntry(result, "TotalMatches", type, "dc:title");
1650     }
1651
1652     /**
1653      * Handles value searching in a SONOS result map (called by {@link #getEntries(String, String)})
1654      *
1655      * @param resultInput - the map to be examined for the requestedKey
1656      * @param requestedKey - the key to be sought in the resultInput map
1657      * @param entriesType - the 'type' argument of {@link #getEntries(String, String)} method used for logging
1658      * @param entriesFilter - the 'filter' argument of {@link #getEntries(String, String)} method used for logging
1659      *
1660      * @return 0 as long or the value corresponding to the requiredKey if found
1661      */
1662     private Long getResultEntry(Map<String, String> resultInput, String requestedKey, String entriesType,
1663             String entriesFilter) {
1664         long result = 0;
1665
1666         if (resultInput.isEmpty()) {
1667             return result;
1668         }
1669
1670         try {
1671             String resultString = resultInput.get(requestedKey);
1672             if (resultString == null) {
1673                 throw new NumberFormatException("Requested key is null.");
1674             }
1675             result = Long.valueOf(resultString);
1676         } catch (NumberFormatException ex) {
1677             logger.debug("Could not fetch {} result for type: {} and filter: {}. Using default value '0': {}",
1678                     requestedKey, entriesType, entriesFilter, ex.getMessage(), ex);
1679         }
1680
1681         return result;
1682     }
1683
1684     /**
1685      * Save the state (track, position etc) of the Sonos Zone player.
1686      */
1687     protected void saveState() {
1688         synchronized (stateLock) {
1689             savedState = new SonosZonePlayerState();
1690             String currentURI = getCurrentURI();
1691
1692             savedState.transportState = getTransportState();
1693             savedState.volume = getVolume();
1694
1695             if (currentURI != null) {
1696                 if (isPlayingStreamOrRadio(currentURI)) {
1697                     // we are streaming music, like tune-in radio or Google Play Music radio
1698                     SonosMetaData track = getTrackMetadata();
1699                     SonosMetaData current = getCurrentURIMetadata();
1700                     if (track != null && current != null) {
1701                         savedState.entry = new SonosEntry("", current.getTitle(), "", "", track.getAlbumArtUri(), "",
1702                                 current.getUpnpClass(), currentURI);
1703                     }
1704                 } else if (currentURI.contains(GROUP_URI)) {
1705                     // we are a slave to some coordinator
1706                     savedState.entry = new SonosEntry("", "", "", "", "", "", "", currentURI);
1707                 } else if (isPlayingLineIn(currentURI)) {
1708                     // we are streaming from the Line In connection
1709                     savedState.entry = new SonosEntry("", "", "", "", "", "", "", currentURI);
1710                 } else if (isPlayingQueue(currentURI)) {
1711                     // we are playing something that sits in the queue
1712                     SonosMetaData queued = getEnqueuedTransportURIMetaData();
1713                     if (queued != null) {
1714                         savedState.track = getRefreshedCurrenTrackNr();
1715
1716                         if (queued.getUpnpClass().contains("object.container.playlistContainer")) {
1717                             // we are playing a real 'saved' playlist
1718                             List<SonosEntry> playLists = getPlayLists();
1719                             for (SonosEntry someList : playLists) {
1720                                 if (someList.getTitle().equals(queued.getTitle())) {
1721                                     savedState.entry = new SonosEntry(someList.getId(), someList.getTitle(),
1722                                             someList.getParentId(), "", "", "", someList.getUpnpClass(),
1723                                             someList.getRes());
1724                                     break;
1725                                 }
1726                             }
1727                         } else if (queued.getUpnpClass().contains("object.container")) {
1728                             // we are playing some other sort of
1729                             // 'container' - we will save that to a
1730                             // playlist for our convenience
1731                             logger.debug("Save State for a container of type {}", queued.getUpnpClass());
1732
1733                             // save the playlist
1734                             String existingList = "";
1735                             List<SonosEntry> playLists = getPlayLists();
1736                             for (SonosEntry someList : playLists) {
1737                                 if (someList.getTitle().equals(TITLE_PREFIX + getUDN())) {
1738                                     existingList = someList.getId();
1739                                     break;
1740                                 }
1741                             }
1742
1743                             saveQueue(TITLE_PREFIX + getUDN(), existingList);
1744
1745                             // get all the playlists and a ref to our
1746                             // saved list
1747                             playLists = getPlayLists();
1748                             for (SonosEntry someList : playLists) {
1749                                 if (someList.getTitle().equals(TITLE_PREFIX + getUDN())) {
1750                                     savedState.entry = new SonosEntry(someList.getId(), someList.getTitle(),
1751                                             someList.getParentId(), "", "", "", someList.getUpnpClass(),
1752                                             someList.getRes());
1753                                     break;
1754                                 }
1755                             }
1756                         }
1757                     } else {
1758                         savedState.entry = new SonosEntry("", "", "", "", "", "", "", QUEUE_URI + getUDN() + "#0");
1759                     }
1760                 }
1761
1762                 savedState.relTime = getRefreshedPosition();
1763             } else {
1764                 savedState.entry = null;
1765             }
1766         }
1767     }
1768
1769     /**
1770      * Restore the state (track, position etc) of the Sonos Zone player.
1771      */
1772     protected void restoreState() {
1773         synchronized (stateLock) {
1774             SonosZonePlayerState state = savedState;
1775             if (state != null) {
1776                 // put settings back
1777                 String volume = state.volume;
1778                 if (volume != null) {
1779                     setVolume(DecimalType.valueOf(volume));
1780                 }
1781
1782                 if (isCoordinator()) {
1783                     SonosEntry entry = state.entry;
1784                     if (entry != null) {
1785                         // check if we have a playlist to deal with
1786                         if (entry.getUpnpClass().contains("object.container.playlistContainer")) {
1787                             addURIToQueue(entry.getRes(), SonosXMLParser.compileMetadataString(entry), 0, true);
1788                             entry = new SonosEntry("", "", "", "", "", "", "", QUEUE_URI + getUDN() + "#0");
1789                             setCurrentURI(entry);
1790                             setPositionTrack(state.track);
1791                         } else {
1792                             setCurrentURI(entry);
1793                             setPosition(state.relTime);
1794                         }
1795                     }
1796
1797                     String transportState = state.transportState;
1798                     if (STATE_PLAYING.equals(transportState)) {
1799                         play();
1800                     } else if (STATE_STOPPED.equals(transportState)) {
1801                         stop();
1802                     } else if (STATE_PAUSED_PLAYBACK.equals(transportState)) {
1803                         pause();
1804                     }
1805                 }
1806             }
1807         }
1808     }
1809
1810     public void saveQueue(String name, String queueID) {
1811         executeAction(SERVICE_AV_TRANSPORT, ACTION_SAVE_QUEUE, Map.of("Title", name, "ObjectID", queueID));
1812     }
1813
1814     public void setVolume(Command command) {
1815         if (command instanceof OnOffType || command instanceof IncreaseDecreaseType || command instanceof DecimalType
1816                 || command instanceof PercentType) {
1817             String newValue = null;
1818             String currentVolume = getVolume();
1819             if (command == IncreaseDecreaseType.INCREASE && currentVolume != null) {
1820                 int i = Integer.valueOf(currentVolume);
1821                 newValue = String.valueOf(Math.min(100, i + 1));
1822             } else if (command == IncreaseDecreaseType.DECREASE && currentVolume != null) {
1823                 int i = Integer.valueOf(currentVolume);
1824                 newValue = String.valueOf(Math.max(0, i - 1));
1825             } else if (command == OnOffType.ON) {
1826                 newValue = "100";
1827             } else if (command == OnOffType.OFF) {
1828                 newValue = "0";
1829             } else if (command instanceof DecimalType decimalCommand) {
1830                 newValue = String.valueOf(decimalCommand.intValue());
1831             } else {
1832                 return;
1833             }
1834             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_VOLUME,
1835                     Map.of("Channel", "Master", "DesiredVolume", newValue));
1836         }
1837     }
1838
1839     /**
1840      * Set the VOLUME command specific to the current grouping according to the Sonos behaviour.
1841      * AdHoc groups handles the volume specifically for each player.
1842      * Bonded groups delegate the volume to the coordinator which applies the same level to all group members.
1843      */
1844     public void setVolumeForGroup(Command command) {
1845         if (isAdHocGroup() || isStandalonePlayer()) {
1846             setVolume(command);
1847         } else {
1848             try {
1849                 getCoordinatorHandler().setVolume(command);
1850             } catch (IllegalStateException e) {
1851                 logger.debug("Cannot set group volume ({})", e.getMessage());
1852             }
1853         }
1854     }
1855
1856     public void setBass(Command command) {
1857         if (!isOutputLevelFixed()) {
1858             String newValue = getNewNumericValue(command, getBass(), MIN_BASS, MAX_BASS);
1859             if (newValue != null) {
1860                 executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_BASS,
1861                         Map.of("InstanceID", "0", "DesiredBass", newValue));
1862             }
1863         }
1864     }
1865
1866     public void setTreble(Command command) {
1867         if (!isOutputLevelFixed()) {
1868             String newValue = getNewNumericValue(command, getTreble(), MIN_TREBLE, MAX_TREBLE);
1869             if (newValue != null) {
1870                 executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_TREBLE,
1871                         Map.of("InstanceID", "0", "DesiredTreble", newValue));
1872             }
1873         }
1874     }
1875
1876     private @Nullable String getNewNumericValue(Command command, @Nullable String currentValue, int minValue,
1877             int maxValue) {
1878         String newValue = null;
1879         if (command instanceof IncreaseDecreaseType || command instanceof DecimalType) {
1880             if (command == IncreaseDecreaseType.INCREASE && currentValue != null) {
1881                 int i = Integer.valueOf(currentValue);
1882                 newValue = String.valueOf(Math.min(maxValue, i + 1));
1883             } else if (command == IncreaseDecreaseType.DECREASE && currentValue != null) {
1884                 int i = Integer.valueOf(currentValue);
1885                 newValue = String.valueOf(Math.max(minValue, i - 1));
1886             } else if (command instanceof DecimalType decimalCommand) {
1887                 newValue = String.valueOf(decimalCommand.intValue());
1888             }
1889         }
1890         return newValue;
1891     }
1892
1893     public void setLoudness(Command command) {
1894         if (!isOutputLevelFixed() && (command instanceof OnOffType || command instanceof OpenClosedType
1895                 || command instanceof UpDownType)) {
1896             String value = (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
1897                     || command.equals(OpenClosedType.OPEN)) ? "True" : "False";
1898             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_LOUDNESS,
1899                     Map.of("InstanceID", "0", "Channel", "Master", "DesiredLoudness", value));
1900         }
1901     }
1902
1903     /**
1904      * Checks if the player receiving the command is part of a group that
1905      * consists of randomly added players or contains bonded players
1906      *
1907      * @return boolean
1908      */
1909     private boolean isAdHocGroup() {
1910         SonosZoneGroup currentZoneGroup = getCurrentZoneGroup();
1911         if (currentZoneGroup != null) {
1912             List<String> zoneGroupMemberNames = currentZoneGroup.getMemberZoneNames();
1913
1914             for (String zoneName : zoneGroupMemberNames) {
1915                 if (!zoneName.equals(zoneGroupMemberNames.get(0))) {
1916                     // At least one "ZoneName" differs so we have an AdHoc group
1917                     return true;
1918                 }
1919             }
1920         }
1921         return false;
1922     }
1923
1924     /**
1925      * Checks if the player receiving the command is a standalone player
1926      *
1927      * @return boolean
1928      */
1929     private boolean isStandalonePlayer() {
1930         SonosZoneGroup zoneGroup = getCurrentZoneGroup();
1931         return zoneGroup == null || zoneGroup.getMembers().size() == 1;
1932     }
1933
1934     private Collection<SonosZoneGroup> getZoneGroups() {
1935         String zoneGroupState = stateMap.get("ZoneGroupState");
1936         return zoneGroupState == null ? Collections.emptyList() : SonosXMLParser.getZoneGroupFromXML(zoneGroupState);
1937     }
1938
1939     /**
1940      * Returns the current zone group
1941      * (of which the player receiving the command is part)
1942      *
1943      * @return {@link SonosZoneGroup}
1944      */
1945     private @Nullable SonosZoneGroup getCurrentZoneGroup() {
1946         for (SonosZoneGroup zoneGroup : getZoneGroups()) {
1947             if (zoneGroup.getMembers().contains(getUDN())) {
1948                 return zoneGroup;
1949             }
1950         }
1951         logger.debug("Could not fetch Sonos group state information");
1952         return null;
1953     }
1954
1955     /**
1956      * Sets the volume level for a notification sound
1957      *
1958      * @param notificationSoundVolume
1959      */
1960     public void setNotificationSoundVolume(@Nullable PercentType notificationSoundVolume) {
1961         if (notificationSoundVolume != null) {
1962             setVolumeForGroup(notificationSoundVolume);
1963         }
1964     }
1965
1966     /**
1967      * Gets the volume level for a notification sound
1968      */
1969     public @Nullable PercentType getNotificationSoundVolume() {
1970         Integer notificationSoundVolume = getConfigAs(ZonePlayerConfiguration.class).notificationVolume;
1971         if (notificationSoundVolume == null) {
1972             // if no value is set we use the current volume instead
1973             String volume = getVolume();
1974             return volume != null ? new PercentType(volume) : null;
1975         }
1976         return new PercentType(notificationSoundVolume);
1977     }
1978
1979     public void addURIToQueue(String URI, String meta, long desiredFirstTrack, boolean enqueueAsNext) {
1980         Map<String, String> inputs = new HashMap<>();
1981
1982         try {
1983             inputs.put("InstanceID", "0");
1984             inputs.put("EnqueuedURI", URI);
1985             inputs.put("EnqueuedURIMetaData", meta);
1986             inputs.put("DesiredFirstTrackNumberEnqueued", Long.toString(desiredFirstTrack));
1987             inputs.put("EnqueueAsNext", Boolean.toString(enqueueAsNext));
1988         } catch (NumberFormatException ex) {
1989             logger.debug("Action Invalid Value Format Exception {}", ex.getMessage());
1990         }
1991
1992         executeAction(SERVICE_AV_TRANSPORT, ACTION_ADD_URI_TO_QUEUE, inputs);
1993     }
1994
1995     public void setCurrentURI(SonosEntry newEntry) {
1996         setCurrentURI(newEntry.getRes(), SonosXMLParser.compileMetadataString(newEntry));
1997     }
1998
1999     public void setCurrentURI(@Nullable String URI, @Nullable String URIMetaData) {
2000         if (URI != null && URIMetaData != null) {
2001             logger.debug("setCurrentURI URI {} URIMetaData {}", URI, URIMetaData);
2002             executeAction(SERVICE_AV_TRANSPORT, ACTION_SET_AV_TRANSPORT_URI,
2003                     Map.of("InstanceID", "0", "CurrentURI", URI, "CurrentURIMetaData", URIMetaData));
2004         }
2005     }
2006
2007     public void setPosition(@Nullable String relTime) {
2008         seek("REL_TIME", relTime);
2009     }
2010
2011     public void setPositionTrack(long tracknr) {
2012         seek("TRACK_NR", Long.toString(tracknr));
2013     }
2014
2015     public void setPositionTrack(String tracknr) {
2016         seek("TRACK_NR", tracknr);
2017     }
2018
2019     protected void seek(String unit, @Nullable String target) {
2020         if (target != null) {
2021             executeAction(SERVICE_AV_TRANSPORT, ACTION_SEEK, Map.of("InstanceID", "0", "Unit", unit, "Target", target));
2022         }
2023     }
2024
2025     public void play() {
2026         executeAction(SERVICE_AV_TRANSPORT, ACTION_PLAY, Map.of("Speed", "1"));
2027     }
2028
2029     public void stop() {
2030         executeAction(SERVICE_AV_TRANSPORT, ACTION_STOP, null);
2031     }
2032
2033     public void pause() {
2034         executeAction(SERVICE_AV_TRANSPORT, ACTION_PAUSE, null);
2035     }
2036
2037     public void setShuffle(Command command) {
2038         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2039             try {
2040                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2041
2042                 if (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2043                         || command.equals(OpenClosedType.OPEN)) {
2044                     switch (coordinator.getRepeatMode()) {
2045                         case "ALL":
2046                             coordinator.updatePlayMode("SHUFFLE");
2047                             break;
2048                         case "ONE":
2049                             coordinator.updatePlayMode("SHUFFLE_REPEAT_ONE");
2050                             break;
2051                         case "OFF":
2052                             coordinator.updatePlayMode("SHUFFLE_NOREPEAT");
2053                             break;
2054                     }
2055                 } else if (command.equals(OnOffType.OFF) || command.equals(UpDownType.DOWN)
2056                         || command.equals(OpenClosedType.CLOSED)) {
2057                     switch (coordinator.getRepeatMode()) {
2058                         case "ALL":
2059                             coordinator.updatePlayMode("REPEAT_ALL");
2060                             break;
2061                         case "ONE":
2062                             coordinator.updatePlayMode("REPEAT_ONE");
2063                             break;
2064                         case "OFF":
2065                             coordinator.updatePlayMode("NORMAL");
2066                             break;
2067                     }
2068                 }
2069             } catch (IllegalStateException e) {
2070                 logger.debug("Cannot handle shuffle command ({})", e.getMessage());
2071             }
2072         }
2073     }
2074
2075     public void setRepeat(Command command) {
2076         if (command instanceof StringType) {
2077             try {
2078                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2079
2080                 switch (command.toString()) {
2081                     case "ALL":
2082                         coordinator.updatePlayMode(coordinator.isShuffleActive() ? "SHUFFLE" : "REPEAT_ALL");
2083                         break;
2084                     case "ONE":
2085                         coordinator.updatePlayMode(coordinator.isShuffleActive() ? "SHUFFLE_REPEAT_ONE" : "REPEAT_ONE");
2086                         break;
2087                     case "OFF":
2088                         coordinator.updatePlayMode(coordinator.isShuffleActive() ? "SHUFFLE_NOREPEAT" : "NORMAL");
2089                         break;
2090                     default:
2091                         logger.debug("{}: unexpected repeat command; accepted values are ALL, ONE and OFF",
2092                                 command.toString());
2093                         break;
2094                 }
2095             } catch (IllegalStateException e) {
2096                 logger.debug("Cannot handle repeat command ({})", e.getMessage());
2097             }
2098         }
2099     }
2100
2101     public void setSubwoofer(Command command) {
2102         setEqualizerBooleanSetting(command, "SubEnable");
2103     }
2104
2105     public void setSubwooferGain(Command command) {
2106         setEqualizerNumericSetting(command, "SubGain", getSubwooferGain(), MIN_SUBWOOFER_GAIN, MAX_SUBWOOFER_GAIN);
2107     }
2108
2109     public void setSurround(Command command) {
2110         setEqualizerBooleanSetting(command, "SurroundEnable");
2111     }
2112
2113     public void setSurroundMusicMode(Command command) {
2114         if (command instanceof StringType) {
2115             setEQ("SurroundMode", command.toString());
2116         }
2117     }
2118
2119     public void setSurroundMusicLevel(Command command) {
2120         setEqualizerNumericSetting(command, "MusicSurroundLevel", getSurroundMusicLevel(), MIN_SURROUND_LEVEL,
2121                 MAX_SURROUND_LEVEL);
2122     }
2123
2124     public void setSurroundTvLevel(Command command) {
2125         setEqualizerNumericSetting(command, "SurroundLevel", getSurroundTvLevel(), MIN_SURROUND_LEVEL,
2126                 MAX_SURROUND_LEVEL);
2127     }
2128
2129     public void setHeightLevel(Command command) {
2130         setEqualizerNumericSetting(command, "HeightChannelLevel", getHeightLevel(), MIN_HEIGHT_LEVEL, MAX_HEIGHT_LEVEL);
2131     }
2132
2133     public void setNightMode(Command command) {
2134         setEqualizerBooleanSetting(command, "NightMode");
2135     }
2136
2137     public void setSpeechEnhancement(Command command) {
2138         setEqualizerBooleanSetting(command, "DialogLevel");
2139     }
2140
2141     private void setEqualizerBooleanSetting(Command command, String eqType) {
2142         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2143             setEQ(eqType, (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2144                     || command.equals(OpenClosedType.OPEN)) ? "1" : "0");
2145         }
2146     }
2147
2148     private void setEqualizerNumericSetting(Command command, String eqType, @Nullable String currentValue, int minValue,
2149             int maxValue) {
2150         String newValue = getNewNumericValue(command, currentValue, minValue, maxValue);
2151         if (newValue != null) {
2152             setEQ(eqType, newValue);
2153         }
2154     }
2155
2156     private void setEQ(String eqType, String value) {
2157         try {
2158             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_EQ,
2159                     Map.of("InstanceID", "0", "EQType", eqType, "DesiredValue", value));
2160         } catch (IllegalStateException e) {
2161             logger.debug("Cannot handle {} command ({})", eqType, e.getMessage());
2162         }
2163     }
2164
2165     public @Nullable String getNightMode() {
2166         return stateMap.get("NightMode");
2167     }
2168
2169     public @Nullable String getDialogLevel() {
2170         return stateMap.get("DialogLevel");
2171     }
2172
2173     public @Nullable String getPlayMode() {
2174         return stateMap.get("CurrentPlayMode");
2175     }
2176
2177     public Boolean isShuffleActive() {
2178         String playMode = getPlayMode();
2179         return (playMode != null && playMode.startsWith("SHUFFLE"));
2180     }
2181
2182     public String getRepeatMode() {
2183         String mode = "OFF";
2184         String playMode = getPlayMode();
2185         if (playMode != null) {
2186             switch (playMode) {
2187                 case "REPEAT_ALL":
2188                 case "SHUFFLE":
2189                     mode = "ALL";
2190                     break;
2191                 case "REPEAT_ONE":
2192                 case "SHUFFLE_REPEAT_ONE":
2193                     mode = "ONE";
2194                     break;
2195                 case "NORMAL":
2196                 case "SHUFFLE_NOREPEAT":
2197                 default:
2198                     mode = "OFF";
2199                     break;
2200             }
2201         }
2202         return mode;
2203     }
2204
2205     public @Nullable String getMicEnabled() {
2206         return stateMap.get("MicEnabled");
2207     }
2208
2209     protected void updatePlayMode(String playMode) {
2210         executeAction(SERVICE_AV_TRANSPORT, ACTION_SET_PLAY_MODE, Map.of("InstanceID", "0", "NewPlayMode", playMode));
2211     }
2212
2213     /**
2214      * Clear all scheduled music from the current queue.
2215      *
2216      */
2217     public void removeAllTracksFromQueue() {
2218         executeAction(SERVICE_AV_TRANSPORT, ACTION_REMOVE_ALL_TRACKS_FROM_QUEUE, Map.of("InstanceID", "0"));
2219     }
2220
2221     /**
2222      * Play music from the line-in of the given Player referenced by the given UDN or name
2223      *
2224      * @param command udn or name
2225      */
2226     public void playLineIn(Command command) {
2227         if (command instanceof StringType) {
2228             try {
2229                 LineInType lineInType = LineInType.ANY;
2230                 String remotePlayerName = command.toString();
2231                 if (remotePlayerName.toUpperCase().startsWith("ANALOG,")) {
2232                     lineInType = LineInType.ANALOG;
2233                     remotePlayerName = remotePlayerName.substring(7);
2234                 } else if (remotePlayerName.toUpperCase().startsWith("DIGITAL,")) {
2235                     lineInType = LineInType.DIGITAL;
2236                     remotePlayerName = remotePlayerName.substring(8);
2237                 }
2238                 ZonePlayerHandler coordinatorHandler = getCoordinatorHandler();
2239                 ZonePlayerHandler remoteHandler = getHandlerByName(remotePlayerName);
2240
2241                 // check if player has a line-in connected
2242                 if ((lineInType != LineInType.DIGITAL && remoteHandler.isAnalogLineInConnected())
2243                         || (lineInType != LineInType.ANALOG && remoteHandler.isOpticalLineInConnected())) {
2244                     // stop whatever is currently playing
2245                     coordinatorHandler.stop();
2246
2247                     // set the URI
2248                     if (lineInType != LineInType.DIGITAL && remoteHandler.isAnalogLineInConnected()) {
2249                         coordinatorHandler.setCurrentURI(ANALOG_LINE_IN_URI + remoteHandler.getUDN(), "");
2250                     } else {
2251                         coordinatorHandler.setCurrentURI(OPTICAL_LINE_IN_URI + remoteHandler.getUDN() + SPDIF, "");
2252                     }
2253
2254                     // take the system off mute
2255                     coordinatorHandler.setMute(OnOffType.OFF);
2256
2257                     // start jammin'
2258                     coordinatorHandler.play();
2259                 } else {
2260                     logger.debug("Line-in of {} is not connected", remoteHandler.getUDN());
2261                 }
2262             } catch (IllegalStateException e) {
2263                 logger.debug("Cannot play line-in ({})", e.getMessage());
2264             }
2265         }
2266     }
2267
2268     private ZonePlayerHandler getCoordinatorHandler() throws IllegalStateException {
2269         ZonePlayerHandler handler = coordinatorHandler;
2270         if (handler != null) {
2271             return handler;
2272         }
2273         try {
2274             handler = getHandlerByName(getCoordinator());
2275             coordinatorHandler = handler;
2276             return handler;
2277         } catch (IllegalStateException e) {
2278             throw new IllegalStateException("Missing group coordinator " + getCoordinator());
2279         }
2280     }
2281
2282     /**
2283      * Returns a list of all zone group members this particular player is member of
2284      * Or empty list if the players is not assigned to any group
2285      *
2286      * @return a list of Strings containing the UDNs of other group members
2287      */
2288     protected List<String> getZoneGroupMembers() {
2289         List<String> result = new ArrayList<>();
2290
2291         Collection<SonosZoneGroup> zoneGroups = getZoneGroups();
2292         if (!zoneGroups.isEmpty()) {
2293             for (SonosZoneGroup zg : zoneGroups) {
2294                 if (zg.getMembers().contains(getUDN())) {
2295                     result.addAll(zg.getMembers());
2296                     break;
2297                 }
2298             }
2299         } else {
2300             // If the group topology was not yet received, return at least the current Sonos zone
2301             result.add(getUDN());
2302         }
2303         return result;
2304     }
2305
2306     /**
2307      * Returns a list of other zone group members this particular player is member of
2308      * Or empty list if the players is not assigned to any group
2309      *
2310      * @return a list of Strings containing the UDNs of other group members
2311      */
2312     protected List<String> getOtherZoneGroupMembers() {
2313         List<String> zoneGroupMembers = getZoneGroupMembers();
2314         zoneGroupMembers.remove(getUDN());
2315         return zoneGroupMembers;
2316     }
2317
2318     protected ZonePlayerHandler getHandlerByName(String remotePlayerName) throws IllegalStateException {
2319         for (ThingTypeUID supportedThingType : SonosBindingConstants.SUPPORTED_THING_TYPES_UIDS) {
2320             Thing thing = localThingRegistry.get(new ThingUID(supportedThingType, remotePlayerName));
2321             if (thing != null) {
2322                 ThingHandler handler = thing.getHandler();
2323                 if (handler instanceof ZonePlayerHandler zonePlayerHandler) {
2324                     return zonePlayerHandler;
2325                 }
2326             }
2327         }
2328         for (Thing aThing : localThingRegistry.getAll()) {
2329             if (SonosBindingConstants.SUPPORTED_THING_TYPES_UIDS.contains(aThing.getThingTypeUID())
2330                     && aThing.getConfiguration().get(ZonePlayerConfiguration.UDN).equals(remotePlayerName)) {
2331                 ThingHandler handler = aThing.getHandler();
2332                 if (handler instanceof ZonePlayerHandler zonePlayerHandler) {
2333                     return zonePlayerHandler;
2334                 }
2335             }
2336         }
2337         throw new IllegalStateException("Could not find handler for " + remotePlayerName);
2338     }
2339
2340     public void setMute(Command command) {
2341         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2342             String value = (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2343                     || command.equals(OpenClosedType.OPEN)) ? "True" : "False";
2344             executeAction(SERVICE_RENDERING_CONTROL, ACTION_SET_MUTE,
2345                     Map.of("Channel", "Master", "DesiredMute", value));
2346         }
2347     }
2348
2349     public List<SonosAlarm> getCurrentAlarmList() {
2350         Map<String, String> result = executeAction(SERVICE_ALARM_CLOCK, "ListAlarms", null);
2351         String alarmList = result.get("CurrentAlarmList");
2352         return alarmList == null ? Collections.emptyList() : SonosXMLParser.getAlarmsFromStringResult(alarmList);
2353     }
2354
2355     public void updateAlarm(SonosAlarm alarm) {
2356         Map<String, String> inputs = new HashMap<>();
2357
2358         try {
2359             inputs.put("ID", Integer.toString(alarm.getId()));
2360             inputs.put("StartLocalTime", alarm.getStartTime());
2361             inputs.put("Duration", alarm.getDuration());
2362             inputs.put("Recurrence", alarm.getRecurrence());
2363             inputs.put("RoomUUID", alarm.getRoomUUID());
2364             inputs.put("ProgramURI", alarm.getProgramURI());
2365             inputs.put("ProgramMetaData", alarm.getProgramMetaData());
2366             inputs.put("PlayMode", alarm.getPlayMode());
2367             inputs.put("Volume", Integer.toString(alarm.getVolume()));
2368             if (alarm.getIncludeLinkedZones()) {
2369                 inputs.put("IncludeLinkedZones", "1");
2370             } else {
2371                 inputs.put("IncludeLinkedZones", "0");
2372             }
2373
2374             if (alarm.getEnabled()) {
2375                 inputs.put("Enabled", "1");
2376             } else {
2377                 inputs.put("Enabled", "0");
2378             }
2379         } catch (NumberFormatException ex) {
2380             logger.debug("Action Invalid Value Format Exception {}", ex.getMessage());
2381         }
2382
2383         executeAction(SERVICE_ALARM_CLOCK, "UpdateAlarm", inputs);
2384     }
2385
2386     public void setAlarm(Command command) {
2387         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2388             if (command.equals(OnOffType.ON) || command.equals(UpDownType.UP) || command.equals(OpenClosedType.OPEN)) {
2389                 setAlarm(true);
2390             } else if (command.equals(OnOffType.OFF) || command.equals(UpDownType.DOWN)
2391                     || command.equals(OpenClosedType.CLOSED)) {
2392                 setAlarm(false);
2393             }
2394         }
2395     }
2396
2397     public void setAlarm(boolean alarmSwitch) {
2398         List<SonosAlarm> sonosAlarms = getCurrentAlarmList();
2399
2400         // find the nearest alarm - take the current time from the Sonos system,
2401         // not the system where we are running
2402         SimpleDateFormat fmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
2403         fmt.setTimeZone(TimeZone.getTimeZone("GMT"));
2404
2405         String currentLocalTime = getTime();
2406         Date currentDateTime = null;
2407         try {
2408             currentDateTime = fmt.parse(currentLocalTime);
2409         } catch (ParseException e) {
2410             logger.debug("An exception occurred while formatting a date", e);
2411         }
2412
2413         if (currentDateTime != null) {
2414             Calendar currentDateTimeCalendar = Calendar.getInstance();
2415             currentDateTimeCalendar.setTimeZone(TimeZone.getTimeZone("GMT"));
2416             currentDateTimeCalendar.setTime(currentDateTime);
2417             currentDateTimeCalendar.add(Calendar.DAY_OF_YEAR, 10);
2418             long shortestDuration = currentDateTimeCalendar.getTimeInMillis() - currentDateTime.getTime();
2419
2420             SonosAlarm firstAlarm = null;
2421
2422             for (SonosAlarm anAlarm : sonosAlarms) {
2423                 SimpleDateFormat durationFormat = new SimpleDateFormat("HH:mm:ss");
2424                 durationFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
2425                 Date durationDate;
2426                 try {
2427                     durationDate = durationFormat.parse(anAlarm.getDuration());
2428                 } catch (ParseException e) {
2429                     logger.debug("An exception occurred while parsing a date : '{}'", e.getMessage());
2430                     continue;
2431                 }
2432
2433                 long duration = durationDate.getTime();
2434
2435                 if (duration < shortestDuration && anAlarm.getRoomUUID().equals(getUDN())) {
2436                     shortestDuration = duration;
2437                     firstAlarm = anAlarm;
2438                 }
2439             }
2440
2441             // Set the Alarm
2442             if (firstAlarm != null) {
2443                 if (alarmSwitch) {
2444                     firstAlarm.setEnabled(true);
2445                 } else {
2446                     firstAlarm.setEnabled(false);
2447                 }
2448
2449                 updateAlarm(firstAlarm);
2450             }
2451         }
2452     }
2453
2454     public @Nullable String getTime() {
2455         updateTime();
2456         return stateMap.get("CurrentLocalTime");
2457     }
2458
2459     public @Nullable String getAlarmRunning() {
2460         return stateMap.get("AlarmRunning");
2461     }
2462
2463     public boolean isAlarmRunning() {
2464         return "1".equals(getAlarmRunning());
2465     }
2466
2467     public void snoozeAlarm(Command command) {
2468         if (isAlarmRunning() && command instanceof DecimalType decimalCommand) {
2469             int minutes = decimalCommand.intValue();
2470
2471             Map<String, String> inputs = new HashMap<>();
2472
2473             Calendar snoozePeriod = Calendar.getInstance();
2474             snoozePeriod.setTimeZone(TimeZone.getTimeZone("GMT"));
2475             snoozePeriod.setTimeInMillis(0);
2476             snoozePeriod.add(Calendar.MINUTE, minutes);
2477             SimpleDateFormat pFormatter = new SimpleDateFormat("HH:mm:ss");
2478             pFormatter.setTimeZone(TimeZone.getTimeZone("GMT"));
2479
2480             try {
2481                 inputs.put("Duration", pFormatter.format(snoozePeriod.getTime()));
2482             } catch (NumberFormatException ex) {
2483                 logger.debug("Action Invalid Value Format Exception {}", ex.getMessage());
2484             }
2485
2486             executeAction(SERVICE_AV_TRANSPORT, ACTION_SNOOZE_ALARM, inputs);
2487         } else {
2488             logger.debug("There is no alarm running on {}", getUDN());
2489         }
2490     }
2491
2492     public @Nullable String getAnalogLineInConnected() {
2493         return stateMap.get(LINEINCONNECTED);
2494     }
2495
2496     public boolean isAnalogLineInConnected() {
2497         return "true".equals(getAnalogLineInConnected());
2498     }
2499
2500     public @Nullable String getOpticalLineInConnected() {
2501         return stateMap.get(TOSLINEINCONNECTED);
2502     }
2503
2504     public boolean isOpticalLineInConnected() {
2505         return "true".equals(getOpticalLineInConnected());
2506     }
2507
2508     public void becomeStandAlonePlayer() {
2509         executeAction(SERVICE_AV_TRANSPORT, ACTION_BECOME_COORDINATOR_OF_STANDALONE_GROUP, null);
2510     }
2511
2512     public void addMember(Command command) {
2513         if (command instanceof StringType) {
2514             SonosEntry entry = new SonosEntry("", "", "", "", "", "", "", GROUP_URI + getUDN());
2515             try {
2516                 getHandlerByName(command.toString()).setCurrentURI(entry);
2517             } catch (IllegalStateException e) {
2518                 logger.debug("Cannot add group member ({})", e.getMessage());
2519             }
2520         }
2521     }
2522
2523     @SuppressWarnings("PMD.CompareObjectsWithEquals")
2524     public boolean publicAddress(LineInType lineInType) {
2525         // check if sourcePlayer has a line-in connected
2526         if ((lineInType != LineInType.DIGITAL && isAnalogLineInConnected())
2527                 || (lineInType != LineInType.ANALOG && isOpticalLineInConnected())) {
2528             // first remove this player from its own group if any
2529             becomeStandAlonePlayer();
2530
2531             // add all other players to this new group
2532             for (SonosZoneGroup group : getZoneGroups()) {
2533                 for (String player : group.getMembers()) {
2534                     try {
2535                         ZonePlayerHandler somePlayer = getHandlerByName(player);
2536                         if (somePlayer != this) {
2537                             somePlayer.becomeStandAlonePlayer();
2538                             somePlayer.stop();
2539                             addMember(StringType.valueOf(somePlayer.getUDN()));
2540                         }
2541                     } catch (IllegalStateException e) {
2542                         logger.debug("Cannot add to group ({})", e.getMessage());
2543                     }
2544                 }
2545             }
2546
2547             try {
2548                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2549                 // set the URI of the group to the line-in
2550                 SonosEntry entry = new SonosEntry("", "", "", "", "", "", "", ANALOG_LINE_IN_URI + getUDN());
2551                 if (lineInType != LineInType.ANALOG && isOpticalLineInConnected()) {
2552                     entry = new SonosEntry("", "", "", "", "", "", "", OPTICAL_LINE_IN_URI + getUDN() + SPDIF);
2553                 }
2554                 coordinator.setCurrentURI(entry);
2555                 coordinator.play();
2556
2557                 return true;
2558             } catch (IllegalStateException e) {
2559                 logger.debug("Cannot handle command ({})", e.getMessage());
2560                 return false;
2561             }
2562         } else {
2563             logger.debug("Line-in of {} is not connected", getUDN());
2564             return false;
2565         }
2566     }
2567
2568     /**
2569      * Play a given url to music in one of the music libraries.
2570      *
2571      * @param command
2572      *            in the format of //host/folder/filename.mp3
2573      */
2574     public void playURI(Command command) {
2575         if (command instanceof StringType) {
2576             try {
2577                 String url = command.toString();
2578
2579                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2580
2581                 // stop whatever is currently playing
2582                 coordinator.stop();
2583                 coordinator.waitForNotTransportState(STATE_PLAYING);
2584
2585                 // clear any tracks which are pending in the queue
2586                 coordinator.removeAllTracksFromQueue();
2587
2588                 // add the new track we want to play to the queue
2589                 // The url will be prefixed with x-file-cifs if it is NOT a http URL
2590                 if (!url.startsWith("x-") && (!url.startsWith("http"))) {
2591                     // default to file based url
2592                     url = FILE_URI + url;
2593                 }
2594                 coordinator.addURIToQueue(url, "", 0, true);
2595
2596                 // set the current playlist to our new queue
2597                 coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
2598
2599                 // take the system off mute
2600                 coordinator.setMute(OnOffType.OFF);
2601
2602                 // start jammin'
2603                 coordinator.play();
2604             } catch (IllegalStateException e) {
2605                 logger.debug("Cannot play URI ({})", e.getMessage());
2606             } catch (InterruptedException e) {
2607                 logger.debug("Play URI interrupted ({})", e.getMessage());
2608                 Thread.currentThread().interrupt();
2609             }
2610         }
2611     }
2612
2613     private void scheduleNotificationSound(final Command command) {
2614         scheduler.submit(() -> {
2615             synchronized (notificationLock) {
2616                 playNotificationSoundURI(command);
2617             }
2618         });
2619     }
2620
2621     /**
2622      * Play a given notification sound
2623      *
2624      * @param notificationURL in the format of //host/folder/filename.mp3
2625      */
2626     public void playNotificationSoundURI(Command notificationURL) {
2627         if (notificationURL instanceof StringType) {
2628             try {
2629                 ZonePlayerHandler coordinator = getCoordinatorHandler();
2630
2631                 String currentURI = coordinator.getCurrentURI();
2632                 logger.debug("playNotificationSoundURI: currentURI {} metadata {}", currentURI,
2633                         coordinator.getCurrentURIMetadataAsString());
2634
2635                 if (isPlayingStreamOrRadio(currentURI)) {
2636                     handleNotifForRadioStream(currentURI, notificationURL, coordinator);
2637                 } else if (isPlayingLineIn(currentURI)) {
2638                     handleNotifForLineIn(currentURI, notificationURL, coordinator);
2639                 } else if (isPlayingVirtualLineIn(currentURI)) {
2640                     handleNotifForVirtualLineIn(currentURI, notificationURL, coordinator);
2641                 } else if (isPlayingQueue(currentURI)) {
2642                     handleNotifForSharedQueue(currentURI, notificationURL, coordinator);
2643                 } else if (isPlaylistEmpty(coordinator)) {
2644                     handleNotifForEmptyQueue(notificationURL, coordinator);
2645                 } else {
2646                     logger.debug("Notification feature not yet implemented while the current media is being played");
2647                 }
2648                 synchronized (notificationLock) {
2649                     notificationLock.notify();
2650                 }
2651             } catch (IllegalStateException e) {
2652                 logger.debug("Cannot play notification sound ({})", e.getMessage());
2653             } catch (InterruptedException e) {
2654                 logger.debug("Play notification sound interrupted ({})", e.getMessage());
2655                 Thread.currentThread().interrupt();
2656             }
2657         }
2658     }
2659
2660     private boolean isPlaylistEmpty(ZonePlayerHandler coordinator) {
2661         return coordinator.getQueueSize() == 0;
2662     }
2663
2664     private boolean isPlayingQueue(@Nullable String currentURI) {
2665         return currentURI != null && currentURI.contains(QUEUE_URI);
2666     }
2667
2668     private boolean isPlayingStream(@Nullable String currentURI) {
2669         return currentURI != null && currentURI.contains(STREAM_URI);
2670     }
2671
2672     private boolean isPlayingRadio(@Nullable String currentURI) {
2673         // Google Play Music radio or Apple Music radio
2674         return currentURI != null && currentURI.contains(RADIO_URI);
2675     }
2676
2677     private boolean isPlayingRadioApp(@Nullable String currentURI) {
2678         // RadioApp music service
2679         return currentURI != null && currentURI.contains(RADIOAPP_URI);
2680     }
2681
2682     private boolean isPlayingRadioStartedByAmazonEcho(@Nullable String currentURI) {
2683         return currentURI != null && currentURI.contains(RADIO_MP3_URI) && currentURI.contains(OPML_TUNE);
2684     }
2685
2686     private boolean isPlayingStreamOrRadio(@Nullable String currentURI) {
2687         return isPlayingStream(currentURI) || isPlayingRadioStartedByAmazonEcho(currentURI)
2688                 || isPlayingRadio(currentURI) || isPlayingRadioApp(currentURI);
2689     }
2690
2691     private boolean isPlayingLineIn(@Nullable String currentURI) {
2692         return currentURI != null && (isPlayingAnalogLineIn(currentURI) || isPlayingOpticalLineIn(currentURI));
2693     }
2694
2695     private boolean isPlayingAnalogLineIn(@Nullable String currentURI) {
2696         return currentURI != null && currentURI.contains(ANALOG_LINE_IN_URI);
2697     }
2698
2699     private boolean isPlayingOpticalLineIn(@Nullable String currentURI) {
2700         return currentURI != null && currentURI.startsWith(OPTICAL_LINE_IN_URI) && currentURI.endsWith(SPDIF);
2701     }
2702
2703     private boolean isPlayingVirtualLineIn(@Nullable String currentURI) {
2704         return currentURI != null && currentURI.startsWith(VIRTUAL_LINE_IN_URI);
2705     }
2706
2707     /**
2708      * Does a chain of predefined actions when a Notification sound is played by
2709      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2710      * radio streaming is currently loaded
2711      *
2712      * @param currentStreamURI - the currently loaded stream's URI
2713      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2714      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2715      * @throws InterruptedException
2716      */
2717     private void handleNotifForRadioStream(@Nullable String currentStreamURI, Command notificationURL,
2718             ZonePlayerHandler coordinator) throws InterruptedException {
2719         String nextAction = coordinator.getTransportState();
2720         SonosMetaData track = coordinator.getTrackMetadata();
2721         SonosMetaData currentUriMetaData = coordinator.getCurrentURIMetadata();
2722
2723         handleNotificationSound(notificationURL, coordinator);
2724         if (currentStreamURI != null && track != null && currentUriMetaData != null) {
2725             coordinator.setCurrentURI(new SonosEntry("", currentUriMetaData.getTitle(), "", "", track.getAlbumArtUri(),
2726                     "", currentUriMetaData.getUpnpClass(), currentStreamURI));
2727             restoreLastTransportState(coordinator, nextAction);
2728         }
2729     }
2730
2731     /**
2732      * Does a chain of predefined actions when a Notification sound is played by
2733      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2734      * line in is currently loaded
2735      *
2736      * @param currentLineInURI - the currently loaded line-in URI
2737      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2738      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2739      * @throws InterruptedException
2740      */
2741     private void handleNotifForLineIn(@Nullable String currentLineInURI, Command notificationURL,
2742             ZonePlayerHandler coordinator) throws InterruptedException {
2743         logger.debug("Handling notification while sound from line-in was being played");
2744         String nextAction = coordinator.getTransportState();
2745
2746         handleNotificationSound(notificationURL, coordinator);
2747         if (currentLineInURI != null) {
2748             logger.debug("Restoring sound from line-in using URI {}", currentLineInURI);
2749             coordinator.setCurrentURI(currentLineInURI, "");
2750             restoreLastTransportState(coordinator, nextAction);
2751         }
2752     }
2753
2754     /**
2755      * Does a chain of predefined actions when a Notification sound is played by
2756      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2757      * virtual line in is currently loaded
2758      *
2759      * @param currentVirtualLineInURI - the currently loaded virtual line-in URI
2760      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2761      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2762      * @throws InterruptedException
2763      */
2764     private void handleNotifForVirtualLineIn(@Nullable String currentVirtualLineInURI, Command notificationURL,
2765             ZonePlayerHandler coordinator) throws InterruptedException {
2766         logger.debug("Handling notification while sound from virtual line-in was being played");
2767         String nextAction = coordinator.getTransportState();
2768         String currentUriMetaData = coordinator.getCurrentURIMetadataAsString();
2769
2770         handleNotificationSound(notificationURL, coordinator);
2771         if (currentVirtualLineInURI != null && currentUriMetaData != null) {
2772             logger.debug("Restoring sound from virtual line-in using URI {} and metadata {}", currentVirtualLineInURI,
2773                     currentUriMetaData);
2774             coordinator.setCurrentURI(currentVirtualLineInURI, currentUriMetaData);
2775             restoreLastTransportState(coordinator, nextAction);
2776         }
2777     }
2778
2779     /**
2780      * Does a chain of predefined actions when a Notification sound is played by
2781      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2782      * shared queue is currently loaded
2783      *
2784      * @param currentQueueURI - the currently loaded queue URI
2785      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2786      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2787      * @throws InterruptedException
2788      */
2789     private void handleNotifForSharedQueue(@Nullable String currentQueueURI, Command notificationURL,
2790             ZonePlayerHandler coordinator) throws InterruptedException {
2791         String nextAction = coordinator.getTransportState();
2792         String trackPosition = coordinator.getRefreshedPosition();
2793         long currentTrackNumber = coordinator.getRefreshedCurrenTrackNr();
2794         logger.debug(
2795                 "Handling notification while playing queue: currentQueueURI {} trackPosition {} currentTrackNumber {}",
2796                 currentQueueURI, trackPosition, currentTrackNumber);
2797
2798         handleNotificationSound(notificationURL, coordinator);
2799         String queueUri = QUEUE_URI + coordinator.getUDN() + "#0";
2800         if (queueUri.equals(currentQueueURI)) {
2801             coordinator.setPositionTrack(currentTrackNumber);
2802             coordinator.setPosition(trackPosition);
2803             restoreLastTransportState(coordinator, nextAction);
2804         }
2805     }
2806
2807     /**
2808      * Handle the execution of the notification sound by sequentially executing the required steps.
2809      *
2810      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2811      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2812      * @throws InterruptedException
2813      */
2814     private void handleNotificationSound(Command notificationURL, ZonePlayerHandler coordinator)
2815             throws InterruptedException {
2816         boolean sourceStoppable = !isPlayingOpticalLineIn(coordinator.getCurrentURI());
2817         String originalVolume = (isAdHocGroup() || isStandalonePlayer()) ? getVolume() : coordinator.getVolume();
2818         if (sourceStoppable) {
2819             coordinator.stop();
2820             coordinator.waitForNotTransportState(STATE_PLAYING);
2821             applyNotificationSoundVolume();
2822         }
2823         long notificationPosition = coordinator.getQueueSize() + 1;
2824         coordinator.addURIToQueue(notificationURL.toString(), "", notificationPosition, false);
2825         coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
2826         coordinator.setPositionTrack(notificationPosition);
2827         if (!sourceStoppable) {
2828             coordinator.stop();
2829             coordinator.waitForNotTransportState(STATE_PLAYING);
2830             applyNotificationSoundVolume();
2831         }
2832         coordinator.play();
2833         coordinator.waitForFinishedNotification();
2834         if (originalVolume != null) {
2835             setVolumeForGroup(DecimalType.valueOf(originalVolume));
2836         }
2837         coordinator.removeRangeOfTracksFromQueue(new StringType(Long.toString(notificationPosition) + ",1"));
2838     }
2839
2840     private void restoreLastTransportState(ZonePlayerHandler coordinator, @Nullable String nextAction)
2841             throws InterruptedException {
2842         if (nextAction != null) {
2843             switch (nextAction) {
2844                 case STATE_PLAYING:
2845                     coordinator.play();
2846                     coordinator.waitForTransportState(STATE_PLAYING);
2847                     break;
2848                 case STATE_PAUSED_PLAYBACK:
2849                     coordinator.pause();
2850                     break;
2851             }
2852         }
2853     }
2854
2855     /**
2856      * Does a chain of predefined actions when a Notification sound is played by
2857      * {@link ZonePlayerHandler#playNotificationSoundURI(Command)} in case
2858      * empty queue is currently loaded
2859      *
2860      * @param notificationURL - the notification url in the format of //host/folder/filename.mp3
2861      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2862      * @throws InterruptedException
2863      */
2864     private void handleNotifForEmptyQueue(Command notificationURL, ZonePlayerHandler coordinator)
2865             throws InterruptedException {
2866         String originalVolume = coordinator.getVolume();
2867         coordinator.applyNotificationSoundVolume();
2868         coordinator.playURI(notificationURL);
2869         coordinator.waitForFinishedNotification();
2870         coordinator.removeAllTracksFromQueue();
2871         if (originalVolume != null) {
2872             coordinator.setVolume(DecimalType.valueOf(originalVolume));
2873         }
2874     }
2875
2876     /**
2877      * Applies the notification sound volume level to the group (if not null)
2878      *
2879      * @param coordinator - {@link ZonePlayerHandler} coordinator for the SONOS device(s)
2880      */
2881     private void applyNotificationSoundVolume() {
2882         setNotificationSoundVolume(getNotificationSoundVolume());
2883     }
2884
2885     private void waitForFinishedNotification() throws InterruptedException {
2886         waitForTransportState(STATE_PLAYING);
2887
2888         // check Sonos state events to determine the end of the notification sound
2889         String notificationTitle = getCurrentTitle();
2890         long playstart = System.currentTimeMillis();
2891         while (System.currentTimeMillis() - playstart < (long) configuration.notificationTimeout * 1000) {
2892             Thread.sleep(50);
2893             String currentTitle = getCurrentTitle();
2894             if ((notificationTitle == null && currentTitle != null)
2895                     || (notificationTitle != null && !notificationTitle.equals(currentTitle))
2896                     || !STATE_PLAYING.equals(getTransportState())) {
2897                 break;
2898             }
2899         }
2900     }
2901
2902     private void waitForTransportState(String state) throws InterruptedException {
2903         if (getTransportState() != null) {
2904             long start = System.currentTimeMillis();
2905             while (!state.equals(getTransportState())) {
2906                 Thread.sleep(50);
2907                 if (System.currentTimeMillis() - start > (long) configuration.notificationTimeout * 1000) {
2908                     break;
2909                 }
2910             }
2911         }
2912     }
2913
2914     private void waitForNotTransportState(String state) throws InterruptedException {
2915         if (getTransportState() != null) {
2916             long start = System.currentTimeMillis();
2917             while (state.equals(getTransportState())) {
2918                 Thread.sleep(50);
2919                 if (System.currentTimeMillis() - start > (long) configuration.notificationTimeout * 1000) {
2920                     break;
2921                 }
2922             }
2923         }
2924     }
2925
2926     /**
2927      * Removes a range of tracks from the queue.
2928      * ({@code <x,y>} will remove y songs started by the song number x)
2929      *
2930      * @param command - must be in the format {@code <startIndex, numberOfSongs>}
2931      */
2932     public void removeRangeOfTracksFromQueue(Command command) {
2933         if (command instanceof StringType) {
2934             String[] rangeInputSplit = command.toString().split(",");
2935             // If range input is incorrect, remove the first song by default
2936             String startIndex = rangeInputSplit[0] != null ? rangeInputSplit[0] : "1";
2937             String numberOfTracks = rangeInputSplit[1] != null ? rangeInputSplit[1] : "1";
2938             executeAction(SERVICE_AV_TRANSPORT, ACTION_REMOVE_TRACK_RANGE_FROM_QUEUE,
2939                     Map.of("InstanceID", "0", "StartingIndex", startIndex, "NumberOfTracks", numberOfTracks));
2940         }
2941     }
2942
2943     public void clearQueue() {
2944         try {
2945             ZonePlayerHandler coordinator = getCoordinatorHandler();
2946
2947             coordinator.removeAllTracksFromQueue();
2948         } catch (IllegalStateException e) {
2949             logger.debug("Cannot clear queue ({})", e.getMessage());
2950         }
2951     }
2952
2953     public void playQueue() {
2954         try {
2955             ZonePlayerHandler coordinator = getCoordinatorHandler();
2956
2957             // set the current playlist to our new queue
2958             coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
2959
2960             // take the system off mute
2961             coordinator.setMute(OnOffType.OFF);
2962
2963             // start jammin'
2964             coordinator.play();
2965         } catch (IllegalStateException e) {
2966             logger.debug("Cannot play queue ({})", e.getMessage());
2967         }
2968     }
2969
2970     public void setLed(Command command) {
2971         if (command instanceof OnOffType || command instanceof OpenClosedType || command instanceof UpDownType) {
2972             String value = (command.equals(OnOffType.ON) || command.equals(UpDownType.UP)
2973                     || command.equals(OpenClosedType.OPEN)) ? "On" : "Off";
2974             executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_SET_LED_STATE, Map.of("DesiredLEDState", value));
2975             executeAction(SERVICE_DEVICE_PROPERTIES, ACTION_GET_LED_STATE, null);
2976         }
2977     }
2978
2979     public void removeMember(Command command) {
2980         if (command instanceof StringType) {
2981             try {
2982                 ZonePlayerHandler oldmemberHandler = getHandlerByName(command.toString());
2983
2984                 oldmemberHandler.becomeStandAlonePlayer();
2985                 SonosEntry entry = new SonosEntry("", "", "", "", "", "", "",
2986                         QUEUE_URI + oldmemberHandler.getUDN() + "#0");
2987                 oldmemberHandler.setCurrentURI(entry);
2988             } catch (IllegalStateException e) {
2989                 logger.debug("Cannot remove group member ({})", e.getMessage());
2990             }
2991         }
2992     }
2993
2994     public void previous() {
2995         executeAction(SERVICE_AV_TRANSPORT, ACTION_PREVIOUS, null);
2996     }
2997
2998     public void next() {
2999         executeAction(SERVICE_AV_TRANSPORT, ACTION_NEXT, null);
3000     }
3001
3002     public void stopPlaying(Command command) {
3003         if (command instanceof OnOffType) {
3004             try {
3005                 getCoordinatorHandler().stop();
3006             } catch (IllegalStateException e) {
3007                 logger.debug("Cannot handle stop command ({})", e.getMessage(), e);
3008             }
3009         }
3010     }
3011
3012     public void playRadio(Command command) {
3013         if (command instanceof StringType) {
3014             String station = command.toString();
3015             List<SonosEntry> stations = getFavoriteRadios();
3016
3017             SonosEntry theEntry = null;
3018             // search for the appropriate radio based on its name (title)
3019             for (SonosEntry someStation : stations) {
3020                 if (someStation.getTitle().equals(station)) {
3021                     theEntry = someStation;
3022                     break;
3023                 }
3024             }
3025
3026             // set the URI of the group coordinator
3027             if (theEntry != null) {
3028                 try {
3029                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3030                     coordinator.setCurrentURI(theEntry);
3031                     coordinator.play();
3032                 } catch (IllegalStateException e) {
3033                     logger.debug("Cannot play radio ({})", e.getMessage());
3034                 }
3035             } else {
3036                 logger.debug("Radio station '{}' not found", station);
3037             }
3038         }
3039     }
3040
3041     public void playTuneinStation(Command command) {
3042         if (command instanceof StringType) {
3043             String stationId = command.toString();
3044             List<SonosMusicService> allServices = getAvailableMusicServices();
3045
3046             SonosMusicService tuneinService = null;
3047             // search for the TuneIn music service based on its name
3048             if (allServices != null) {
3049                 for (SonosMusicService service : allServices) {
3050                     if ("TuneIn".equals(service.getName())) {
3051                         tuneinService = service;
3052                         break;
3053                     }
3054                 }
3055             }
3056
3057             // set the URI of the group coordinator
3058             if (tuneinService != null) {
3059                 try {
3060                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3061                     SonosEntry entry = new SonosEntry("", "TuneIn station", "", "", "", "",
3062                             "object.item.audioItem.audioBroadcast",
3063                             String.format(TUNEIN_URI, stationId, tuneinService.getId()));
3064                     Integer tuneinServiceType = tuneinService.getType();
3065                     int serviceTypeNum = tuneinServiceType == null ? TUNEIN_DEFAULT_SERVICE_TYPE : tuneinServiceType;
3066                     entry.setDesc("SA_RINCON" + Integer.toString(serviceTypeNum) + "_");
3067                     coordinator.setCurrentURI(entry);
3068                     coordinator.play();
3069                 } catch (IllegalStateException e) {
3070                     logger.debug("Cannot play TuneIn station {} ({})", stationId, e.getMessage());
3071                 }
3072             } else {
3073                 logger.debug("TuneIn service not found");
3074             }
3075         }
3076     }
3077
3078     private @Nullable List<SonosMusicService> getAvailableMusicServices() {
3079         if (musicServices == null) {
3080             Map<String, String> result = service.invokeAction(this, "MusicServices", "ListAvailableServices", null);
3081
3082             String serviceList = result.get("AvailableServiceDescriptorList");
3083             if (serviceList != null) {
3084                 List<SonosMusicService> services = SonosXMLParser.getMusicServicesFromXML(serviceList);
3085                 musicServices = services;
3086
3087                 String[] servicesTypes = new String[0];
3088                 String serviceTypeList = result.get("AvailableServiceTypeList");
3089                 if (serviceTypeList != null) {
3090                     // It is a comma separated list of service types (integers) in the same order as the services
3091                     // declaration in "AvailableServiceDescriptorList" except that there is no service type for the
3092                     // TuneIn service
3093                     servicesTypes = serviceTypeList.split(",");
3094                 }
3095
3096                 int idx = 0;
3097                 for (SonosMusicService service : services) {
3098                     if (!"TuneIn".equals(service.getName())) {
3099                         // Add the service type integer value from "AvailableServiceTypeList" to each service
3100                         // except TuneIn
3101                         if (idx < servicesTypes.length) {
3102                             try {
3103                                 Integer serviceType = Integer.parseInt(servicesTypes[idx]);
3104                                 service.setType(serviceType);
3105                             } catch (NumberFormatException e) {
3106                             }
3107                             idx++;
3108                         }
3109                     } else {
3110                         service.setType(TUNEIN_DEFAULT_SERVICE_TYPE);
3111                     }
3112                     logger.debug("Service name {} => id {} type {}", service.getName(), service.getId(),
3113                             service.getType());
3114                 }
3115             }
3116         }
3117         return musicServices;
3118     }
3119
3120     /**
3121      * This will attempt to match the station string with an entry in the
3122      * favorites list, this supports both single entries and playlists
3123      *
3124      * @param command favorite to match
3125      */
3126     public void playFavorite(Command command) {
3127         if (command instanceof StringType) {
3128             String favorite = command.toString();
3129             List<SonosEntry> favorites = getFavorites();
3130
3131             SonosEntry theEntry = null;
3132             // search for the appropriate favorite based on its name (title)
3133             for (SonosEntry entry : favorites) {
3134                 if (entry.getTitle().equals(favorite)) {
3135                     theEntry = entry;
3136                     break;
3137                 }
3138             }
3139
3140             // set the URI of the group coordinator
3141             if (theEntry != null) {
3142                 try {
3143                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3144
3145                     /**
3146                      * If this is a playlist we need to treat it as such
3147                      */
3148                     SonosResourceMetaData resourceMetaData = theEntry.getResourceMetaData();
3149                     if (resourceMetaData != null && resourceMetaData.getUpnpClass().startsWith("object.container")) {
3150                         coordinator.removeAllTracksFromQueue();
3151                         coordinator.addURIToQueue(theEntry);
3152                         coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
3153                         String firstTrackNumberEnqueued = stateMap.get("FirstTrackNumberEnqueued");
3154                         coordinator.seek("TRACK_NR", firstTrackNumberEnqueued);
3155                     } else {
3156                         coordinator.setCurrentURI(theEntry);
3157                     }
3158                     coordinator.play();
3159                 } catch (IllegalStateException e) {
3160                     logger.debug("Cannot paly favorite ({})", e.getMessage());
3161                 }
3162             } else {
3163                 logger.debug("Favorite '{}' not found", favorite);
3164             }
3165         }
3166     }
3167
3168     public void playTrack(Command command) {
3169         if (command instanceof DecimalType decimalCommand) {
3170             try {
3171                 ZonePlayerHandler coordinator = getCoordinatorHandler();
3172
3173                 String trackNumber = String.valueOf(decimalCommand.intValue());
3174
3175                 coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
3176
3177                 // seek the track - warning, we do not check if the tracknumber falls in the boundary of the queue
3178                 coordinator.setPositionTrack(trackNumber);
3179
3180                 // take the system off mute
3181                 coordinator.setMute(OnOffType.OFF);
3182
3183                 // start jammin'
3184                 coordinator.play();
3185             } catch (IllegalStateException e) {
3186                 logger.debug("Cannot play track ({})", e.getMessage());
3187             }
3188         }
3189     }
3190
3191     public void playPlayList(Command command) {
3192         if (command instanceof StringType) {
3193             String playlist = command.toString();
3194             List<SonosEntry> playlists = getPlayLists();
3195
3196             SonosEntry theEntry = null;
3197             // search for the appropriate play list based on its name (title)
3198             for (SonosEntry somePlaylist : playlists) {
3199                 if (somePlaylist.getTitle().equals(playlist)) {
3200                     theEntry = somePlaylist;
3201                     break;
3202                 }
3203             }
3204
3205             // set the URI of the group coordinator
3206             if (theEntry != null) {
3207                 try {
3208                     ZonePlayerHandler coordinator = getCoordinatorHandler();
3209
3210                     coordinator.addURIToQueue(theEntry);
3211
3212                     coordinator.setCurrentURI(QUEUE_URI + coordinator.getUDN() + "#0", "");
3213
3214                     String firstTrackNumberEnqueued = stateMap.get("FirstTrackNumberEnqueued");
3215                     coordinator.seek("TRACK_NR", firstTrackNumberEnqueued);
3216
3217                     coordinator.play();
3218                 } catch (IllegalStateException e) {
3219                     logger.debug("Cannot play playlist ({})", e.getMessage());
3220                 }
3221             } else {
3222                 logger.debug("Playlist '{}' not found", playlist);
3223             }
3224         }
3225     }
3226
3227     public void addURIToQueue(SonosEntry newEntry) {
3228         addURIToQueue(newEntry.getRes(), SonosXMLParser.compileMetadataString(newEntry), 1, true);
3229     }
3230
3231     public @Nullable String getZoneName() {
3232         return stateMap.get("ZoneName");
3233     }
3234
3235     public @Nullable String getZoneGroupID() {
3236         return stateMap.get("LocalGroupUUID");
3237     }
3238
3239     public @Nullable String getRunningAlarmProperties() {
3240         return stateMap.get("RunningAlarmProperties");
3241     }
3242
3243     public @Nullable String getRefreshedRunningAlarmProperties() {
3244         updateRunningAlarmProperties();
3245         return getRunningAlarmProperties();
3246     }
3247
3248     public @Nullable String getMute() {
3249         return stateMap.get("MuteMaster");
3250     }
3251
3252     public @Nullable String getLed() {
3253         return stateMap.get("CurrentLEDState");
3254     }
3255
3256     public @Nullable String getCurrentZoneName() {
3257         return stateMap.get("CurrentZoneName");
3258     }
3259
3260     public @Nullable String getRefreshedCurrentZoneName() {
3261         updateCurrentZoneName();
3262         return getCurrentZoneName();
3263     }
3264
3265     @Override
3266     public void onStatusChanged(boolean status) {
3267         if (status) {
3268             logger.info("UPnP device {} is present (thing {})", getUDN(), getThing().getUID());
3269             if (getThing().getStatus() != ThingStatus.ONLINE) {
3270                 updateStatus(ThingStatus.ONLINE);
3271                 scheduler.execute(this::poll);
3272             }
3273         } else {
3274             logger.info("UPnP device {} is absent (thing {})", getUDN(), getThing().getUID());
3275             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR);
3276         }
3277     }
3278
3279     private @Nullable String getModelNameFromDescriptor() {
3280         URL descriptor = service.getDescriptorURL(this);
3281         if (descriptor != null) {
3282             String sonosModelDescription = SonosXMLParser.parseModelDescription(descriptor);
3283             return sonosModelDescription == null ? null
3284                     : SonosXMLParser.buildThingTypeIdFromModelName(sonosModelDescription);
3285         } else {
3286             return null;
3287         }
3288     }
3289
3290     private boolean migrateThingType() {
3291         if (getThing().getThingTypeUID().equals(ZONEPLAYER_THING_TYPE_UID)) {
3292             String modelName = getModelNameFromDescriptor();
3293             if (modelName != null && isSupportedModel(modelName)) {
3294                 updateSonosThingType(modelName);
3295                 return true;
3296             }
3297         }
3298         return false;
3299     }
3300
3301     private boolean isSupportedModel(String modelName) {
3302         for (ThingTypeUID thingTypeUID : SUPPORTED_KNOWN_THING_TYPES_UIDS) {
3303             if (thingTypeUID.getId().equalsIgnoreCase(modelName)) {
3304                 return true;
3305             }
3306         }
3307         return false;
3308     }
3309
3310     private void updateSonosThingType(String newThingTypeID) {
3311         changeThingType(new ThingTypeUID(SonosBindingConstants.BINDING_ID, newThingTypeID), getConfig());
3312     }
3313
3314     /*
3315      * Set the sleeptimer duration
3316      * Use String command of format "HH:MM:SS" to set the timer to the desired duration
3317      * Use empty String "" to switch the sleep timer off
3318      */
3319     public void setSleepTimer(Command command) {
3320         if (command instanceof DecimalType decimalCommand) {
3321             this.service.invokeAction(this, SERVICE_AV_TRANSPORT, ACTION_CONFIGURE_SLEEP_TIMER, Map.of("InstanceID",
3322                     "0", "NewSleepTimerDuration", sleepSecondsToTimeStr(decimalCommand.longValue())));
3323         }
3324     }
3325
3326     protected void updateSleepTimerDuration() {
3327         executeAction(SERVICE_AV_TRANSPORT, ACTION_GET_REMAINING_SLEEP_TIMER_DURATION, null);
3328     }
3329
3330     private String sleepSecondsToTimeStr(long sleepSeconds) {
3331         if (sleepSeconds == 0) {
3332             return "";
3333         } else if (sleepSeconds < 68400) {
3334             long remainingSeconds = sleepSeconds;
3335             long hours = TimeUnit.SECONDS.toHours(remainingSeconds);
3336             remainingSeconds -= TimeUnit.HOURS.toSeconds(hours);
3337             long minutes = TimeUnit.SECONDS.toMinutes(remainingSeconds);
3338             remainingSeconds -= TimeUnit.MINUTES.toSeconds(minutes);
3339             long seconds = TimeUnit.SECONDS.toSeconds(remainingSeconds);
3340             return String.format("%02d:%02d:%02d", hours, minutes, seconds);
3341         } else {
3342             logger.debug("Sonos SleepTimer: Invalid sleep time set. sleep time must be >=0 and < 68400s (24h)");
3343             return "ERR";
3344         }
3345     }
3346
3347     private long sleepStrTimeToSeconds(String sleepTime) {
3348         String[] units = sleepTime.split(":");
3349         int hours = Integer.parseInt(units[0]);
3350         int minutes = Integer.parseInt(units[1]);
3351         int seconds = Integer.parseInt(units[2]);
3352         return 3600 * hours + 60 * minutes + seconds;
3353     }
3354
3355     private @Nullable String extractInfoFromMoreInfo(String searchedInfo) {
3356         String value = stateMap.get("MoreInfo");
3357         if (value != null) {
3358             String[] fields = value.split(",");
3359             for (int i = 0; i < fields.length; i++) {
3360                 String[] pair = fields[i].trim().split(":");
3361                 if (pair.length == 2 && searchedInfo.equalsIgnoreCase(pair[0].trim())) {
3362                     return pair[1].trim();
3363                 }
3364             }
3365         }
3366         return null;
3367     }
3368 }