[ 1.0.120 ] * Added service play_url_dlna. Play media from the given URL via the Bose DLNA API. This also allows you to set source-specific metadata (artist, album, track, and cover art url) for the playing UPNP content. Note that only HTTP URL's are supported (HTTPS is not, due to Bose DLNA limitations).

  * Updated service `play_url` to update HA state after processing, as state changes were not updating in a timely manner (or at all in some instances) after the service completed.
  * Updated underlying `bosesoundtouchapi` package requirement to version 1.0.79.

Author: thlucas1

CHANGELOG.md

@@ -6,6 +6,12 @@ Change are listed in reverse chronological order (newest to oldest).
 
 <span class="changelog">
 
+###### [ 1.0.120 ] - 2025/06/06
+
+  * Added service `play_url_dlna`. Play media from the given URL via the Bose DLNA API.  This also allows you to set source-specific metadata (artist, album, track, and cover art url) for the playing UPNP content.  Note that only HTTP URL's are supported (HTTPS is not, due to Bose DLNA limitations).
+  * Updated service `play_url` to update HA state after processing, as state changes were not updating in a timely manner (or at all in some instances) after the service completed.
+  * Updated underlying `bosesoundtouchapi` package requirement to version 1.0.79.
+
 ###### [ 1.0.119 ] - 2025/05/22
 
   * v1.0.118 release was FUBAR in github; updating release number by 1.

custom_components/soundtouchplus/__init__.py

@@ -84,6 +84,7 @@
 SERVICE_PLAY_HANDOFF = "play_handoff"
 SERVICE_PLAY_TTS = "play_tts"
 SERVICE_PLAY_URL = "play_url"
+SERVICE_PLAY_URL_DLNA = "play_url_dlna"
 SERVICE_PRESET_LIST = "preset_list"
 SERVICE_PRESET_REMOVE = "preset_remove"
 SERVICE_REBOOT_DEVICE = "reboot_device"
@@ -226,6 +227,19 @@
     }
 )
 
+SERVICE_PLAY_URL_DLNA_SCHEMA = vol.Schema(
+    {
+        vol.Required("entity_id"): cv.entity_id,
+        vol.Required("url"): cv.string,
+        vol.Optional("artist"): cv.string,
+        vol.Optional("album"): cv.string,
+        vol.Optional("track"): cv.string,
+        vol.Optional("art_url"): cv.string,
+        vol.Optional("update_now_playing_status", default=True): cv.boolean,
+        vol.Optional("delay", default=1): vol.All(vol.Range(min=0,max=10))
+    }
+)
+
 SERVICE_PRESET_LIST_SCHEMA = vol.Schema(
     {
         vol.Required("entity_id"): cv.entity_id,
@@ -532,6 +546,17 @@ async def service_handle_entity(service:ServiceCall) -> None:
                     _logsi.LogVerbose(STAppMessages.MSG_SERVICE_EXECUTE % (service.service, entity.name))
                     await hass.async_add_executor_job(entity.service_play_url, url, artist, album, track, volume_level, app_key, get_metadata_from_url_file)
 
+                elif service.service == SERVICE_PLAY_URL_DLNA:
+                    url = service.data.get("url")
+                    artist = service.data.get("artist")
+                    album = service.data.get("album")
+                    track = service.data.get("track")
+                    art_url = service.data.get("art_url")
+                    update_now_playing_status = service.data.get("update_now_playing_status")
+                    delay = service.data.get("delay")
+                    _logsi.LogVerbose(STAppMessages.MSG_SERVICE_EXECUTE % (service.service, entity.name))
+                    await hass.async_add_executor_job(entity.service_play_url_dlna, url, artist, album, track, art_url, update_now_playing_status, delay)
+
                 elif service.service == SERVICE_PRESET_REMOVE:
                     preset_id = service.data.get("preset_id")
                     _logsi.LogVerbose(STAppMessages.MSG_SERVICE_EXECUTE % (service.service, entity.name))
@@ -954,6 +979,15 @@ def _GetEntityFromServiceData(hass:HomeAssistant, service:ServiceCall, field_id:
             supports_response=SupportsResponse.NONE,
         )
 
+        _logsi.LogObject(SILevel.Verbose, STAppMessages.MSG_SERVICE_REQUEST_REGISTER % SERVICE_PLAY_URL_DLNA, SERVICE_PLAY_URL_DLNA_SCHEMA)
+        hass.services.async_register(
+            DOMAIN,
+            SERVICE_PLAY_URL_DLNA,
+            service_handle_entity,
+            schema=SERVICE_PLAY_URL_DLNA_SCHEMA,
+            supports_response=SupportsResponse.NONE,
+        )
+
         _logsi.LogObject(SILevel.Verbose, STAppMessages.MSG_SERVICE_REQUEST_REGISTER % SERVICE_PRESET_LIST, SERVICE_PRESET_LIST_SCHEMA)
         hass.services.async_register(
             DOMAIN,

custom_components/soundtouchplus/manifest.json

@@ -12,7 +12,7 @@
   "issue_tracker": "https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/issues",
   "loggers": [ "bosesoundtouchapi" ],
   "requirements": [
-    "bosesoundtouchapi==1.0.77",
+    "bosesoundtouchapi==1.0.79",
     "oauthlib>=3.2.2",
     "platformdirs>=4.1.0",
     "requests>=2.31.0",

custom_components/soundtouchplus/media_player.py

@@ -22,9 +22,11 @@
 import datetime as dt
 from functools import partial
 import logging
+from os import path
 import re
 from typing import Any
 import urllib.parse
+from urllib.parse import unquote
 from xml.etree import ElementTree
 from xml.etree.ElementTree import Element
 
@@ -909,9 +911,27 @@ def play_media(self, media_type:MediaType|str, media_id:str, **kwargs: Any) -> N
 
             # is the media an http or https url?
             elif re.match(r"http[s]?://", media_id):
-                
-                _logsi.LogVerbose("'%s': MediaPlayer play_media detected URL media: Url='%s'", self.name, media_id)
-                self._client.PlayUrl(media_id, artist=announceValue, album=announceValue, getMetaDataFromUrlFile=True, volumeLevel=0)
+
+                # get the track name portion of the url.
+                # example: media_id = "http://192.168.1.248:8123/media/local/01%20The%20First%20Noel.mp3?authSig=ey...nO4"
+                # trackName = "01 The First Noel.mp3"
+                trackName:str = self._GetUrlFilename(media_id)
+
+                # always use the PlayUrl service, as it supports both HTTP and HTTPS url's.
+                _logsi.LogVerbose("'%s': MediaPlayer play_media detected URL Notification media: Url='%s'", self.name, media_id)
+                self._client.PlayUrl(media_id, artist=announceValue, album=announceValue, track=trackName, getMetaDataFromUrlFile=True, volumeLevel=0)
+
+                # commented this code, as most Radio Stations are HTTPS format!!!
+                # for announcements, we will use the `PlayUrl` service; otherwise, use the `PlayUrlDlna` service.
+                # if announce:
+                #     _logsi.LogVerbose("'%s': MediaPlayer play_media detected URL Notification media: Url='%s'", self.name, media_id)
+                #     self._client.PlayUrl(media_id, artist=announceValue, album=announceValue, getMetaDataFromUrlFile=True, volumeLevel=0)
+                # else:
+                #     _logsi.LogVerbose("'%s': MediaPlayer play_media detected URL DLNA media: Url='%s'", self.name, media_id)
+                #     self._client.PlayUrlDlna(media_id, artist="", album="", track=trackName, artUrl="", updateNowPlayingStatus=True)
+
+                # inform Home Assistant of the status update.
+                self.schedule_update_ha_state(force_refresh=False)
 
             # is the media a spotify uri?
             elif re.match(r"spotify:", media_id):
@@ -1485,6 +1505,38 @@ def _FindEntityIdFromClientDeviceId(self, deviceId:str, serviceName:str) -> str:
         return entity_id
 
 
+    def _GetUrlFilename(self, url:str):
+        """
+        Returns the filename portion of a media_id url.
+        
+        Args:
+            url (str):
+                media_id url to parse for the file name.
+                
+        Returns:
+            The file name portion of the url if found; otherwise, an empty string.
+        """
+        try:
+
+            # get the filename portion of the media_id url.
+            # example: 
+            #   media_id = "http://192.168.1.248:8123/media/local/01%20The%20First%20Noel.mp3?authSig=ey...nO4"
+            #   fileName = "01 The First Noel.mp3"
+
+            fragment_removed = url.split("#")[0]  # keep to left of first #
+            query_string_removed = fragment_removed.split("?")[0]
+            scheme_removed = query_string_removed.split("://")[-1].split(":")[-1]
+            if scheme_removed.find("/") == -1:
+                return ""
+            filename:str = path.basename(scheme_removed)
+            result = unquote(filename)
+            return result
+
+        except Exception as ex:
+            # ignore exceptions.
+            return ""
+
+
     def _GetSourceItemByTitle(self, title:str) -> SourceItem:
         """
         Returns a `SourceItem` instance for the given source title value
@@ -2275,7 +2327,9 @@ def service_play_url(
         getMetadataFromUrlFile:bool,
         ) -> None:
         """
-        Play media content from a URL on a SoundTouch device.
+        Plays media from the given URL as a notification message, interrupting the currently playing 
+        media to play the specified url.  The currently playing will then resume playing once play of 
+        the specified URL is complete.  
         
         Args:
             url (str):
@@ -2310,11 +2364,86 @@ def service_play_url(
             apiMethodParms.AppendKeyValue("volumeLevel", volumeLevel)
             apiMethodParms.AppendKeyValue("appKey", appKey)
             apiMethodParms.AppendKeyValue("getMetadataFromUrlFile", getMetadataFromUrlFile)
-            _logsi.LogMethodParmList(SILevel.Verbose, "SoundTouch Play URL Service", apiMethodParms)
+            _logsi.LogMethodParmList(SILevel.Verbose, "SoundTouch Play URL Notification Service", apiMethodParms)
 
             # play url.
             self.data.client.PlayUrl(url, artist, album, track, volumeLevel, appKey, getMetadataFromUrlFile)
 
+            # inform Home Assistant of the status update.
+            self.schedule_update_ha_state(force_refresh=False)           
+
+        # the following exceptions have already been logged, so we just need to
+        # pass them back to HA for display in the log (or service UI).
+        except SoundTouchError as ex:
+            raise HomeAssistantError(ex.Message)
+        
+        finally:
+                
+            # trace.
+            _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
+
+
+    def service_play_url_dlna(
+        self, 
+        url:str, 
+        artist:str, 
+        album:str, 
+        track:str, 
+        artUrl:str, 
+        updateNowPlayingStatus:bool, 
+        delay:int,
+        ) -> None:
+        """
+        Plays media from the given URL via the Bose DLNA API.
+        
+        Args:
+            url (str):
+                The url to play.  
+                Note that HTTPS URL's are not supported by this service due to DLNA restrictions.
+            artist (str):
+                The message text that will appear in the NowPlaying Artist node for source-specific nowPlaying information.  
+                Default is "Unknown Artist"
+            album (str):
+                The message text that will appear in the NowPlaying Album node, for source-specific nowPlaying information.  
+                Default is "Unknown Album"
+            track (str):
+                The message text that will appear in the NowPlaying Track node, for source-specific nowPlaying information.  
+                Default is "Unknown Track"
+            artUrl (str):
+                A url link to a cover art image that represents the URL, for source-specific nowPlaying information.  
+                Default is None.  
+            updateNowPlayingStatus (bool):
+                True (default) to update the source-specific nowPlaying information;
+                False to not update the source-specific nowPlaying information.
+            delay (int):
+                Time delay (in seconds) to wait AFTER sending the play next track request if
+                the currently playing media is a notification source.
+                This delay will give the device time to process the change before another 
+                command is accepted.  
+                Default is 1; value range is 0 - 10.
+        """
+        apiMethodName:str = 'service_play_url'
+        apiMethodParms:SIMethodParmListContext = None
+
+        try:
+
+            # trace.
+            apiMethodParms = _logsi.EnterMethodParmList(SILevel.Debug, apiMethodName)
+            apiMethodParms.AppendKeyValue("url", url)
+            apiMethodParms.AppendKeyValue("artist", artist)
+            apiMethodParms.AppendKeyValue("album", album)
+            apiMethodParms.AppendKeyValue("track", track)
+            apiMethodParms.AppendKeyValue("artUrl", artUrl)
+            apiMethodParms.AppendKeyValue("updateNowPlayingStatus", updateNowPlayingStatus)
+            apiMethodParms.AppendKeyValue("delay", delay)
+            _logsi.LogMethodParmList(SILevel.Verbose, "SoundTouch Play URL DLNA Service", apiMethodParms)
+
+            # play url.
+            self.data.client.PlayUrlDlna(url, artist, album, track, artUrl, updateNowPlayingStatus, delay)
+
+            # inform Home Assistant of the status update.
+            self.schedule_update_ha_state(force_refresh=False)           
+
         # the following exceptions have already been logged, so we just need to
         # pass them back to HA for display in the log (or service UI).
         except SoundTouchError as ex:

custom_components/soundtouchplus/services.yaml

@@ -400,7 +400,7 @@ play_tts:
     volume_level:
       name: Volume Level
       description: The temporary volume level that will be used when the message is played.  Specify a value of zero to play at the current volume.  Default is zero.
-      example: 50
+      example: 10
       required: false
       selector:
         number:
@@ -418,8 +418,8 @@ play_tts:
         text:
 
 play_url:
-  name: Play URL Media
-  description: Play media content from a URL on a SoundTouch device.
+  name: Play URL Notification
+  description: Play media from the given URL as a notification message, interrupting the currently playing media to play the specified url.  The currently playing will then resume playing once play of the specified URL is complete.
   fields:
     entity_id:
       name: Entity ID
@@ -461,7 +461,7 @@ play_url:
     volume_level:
       name: Volume Level
       description: The temporary volume level that will be used when the media is played.  Specify a value of zero to play at the current volume.  Default is zero.
-      example: 50
+      example: 10
       required: false
       selector:
         number:
@@ -485,6 +485,72 @@ play_url:
       selector:
         boolean:
 
+play_url_dlna:
+  name: Play URL DLNA
+  description: Play media from the given URL via the Bose DLNA API.
+  fields:
+    entity_id:
+      name: Entity ID
+      description: Entity ID of the SoundTouchPlus device that will process the request.
+      example: "media_player.soundtouch_livingroom"
+      required: true
+      selector:
+        entity:
+          integration: soundtouchplus
+          domain: media_player
+    url:
+      name: URL
+      description: The url to play; HTTPS URL's are not supported by this service due to DLNA restrictions.
+      example: "http://edge-bauerall-01-gos2.sharp-stream.com/ghr70s.aac"
+      required: true
+      selector:
+        text:
+    artist:
+      name: Artist Status Text
+      description: The message text that will appear in the NowPlaying Artist node for source-specific nowPlaying information; if omitted, default is "Unknown Artist".
+      example: "Greatest Hits Radio"
+      required: false
+      selector:
+        text:
+    album:
+      name: Album Status Text
+      description: The message text that will appear in the NowPlaying Album node for source-specific nowPlaying information; if omitted, default is "Unknown Album".
+      example: "70's Classic Hits"
+      required: false
+      selector:
+        text:
+    track:
+      name: Track Status Text
+      description: The message text that will appear in the NowPlaying Track node for source-specific nowPlaying information; if omitted, default is "Unknown Track".
+      example: "ghr70s.aac"
+      required: false
+      selector:
+        text:
+    art_url:
+      name: Cover Artwork URL
+      description: A url link to a cover art image that represents the URL for source-specific nowPlaying information; if omitted, default is None.
+      example: "https://image-cdn-ak.spotifycdn.com/image/ab67706c0000da849d37dd221d8aa1b35c545057"
+      required: false
+      selector:
+        text:
+    update_now_playing_status:
+      name: Update NowPlaying Status?
+      description: True (default) to update the source-specific nowPlaying information; False to not update the source-specific nowPlaying information.
+      example: "true"
+      required: false
+      selector:
+        boolean:
+    delay:
+      name: Command Delay
+      description: Time delay (in seconds) to wait AFTER sending the play next track request if the currently playing media is a notification source. This delay will give the device time to process the change before another command is accepted. Default is 1; value range is 0 - 10.
+      example: "1"
+      required: false
+      selector:
+        number:
+          min: 0
+          max: 10
+          mode: box
+
 preset_list:
   name: Get Preset List
   description: Retrieves the list of presets defined to the device.